# legacydeveloper Api Meta - Full Documentation

<!-- document id=52585e5fe8022b0d494eb6043ef1b3afdb4bc0951df533ce463adfcd918bee12 url=/legacydeveloper/current/en-us/api_meta/meta_accountingfieldmapping.md -->

# AccountingFieldMapping

Represents the accounting field mappings to organize your data and bring it to ledger entry records.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AccountingFieldMapping components have the suffix .accountingFieldMapping and are stored in the accountingFieldMappings folder.

## Version

AccountingFieldMapping components are available in API version 58.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| accountingModelConfig | 
Field Type

string

Description

Required.

Record ID of the AccountingModelConfig record that the Field Mapping is associated with.



 |
| isForAllocationType | 

Field Type

boolean

Description

Reserved for internal use.



 |
| isForPaymentType | 

Field Type

boolean

Description

Reserved for internal use.



 |
| isForTransactionType | 

Field Type

boolean

Description

Reserved for internal use.



 |
| isProtected | 

Field Type

boolean

Description

Indicates whether this component is protected (true) or not protected (false).

Default value is false.





 |
| mappingBehavior | 

Field Type

MappingBehaviorType (enumeration of type string)

Description

Required.

Specifies how the target’s field data is mapped from the source field only when the journal entry is created. When set to CurrentValue, Subledger reverses and replaces journal entries whose value differs from the value in sourceField.

Valid values are:

- CurrentValue
- PointInTime





 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for AccountingFieldMapping, which is defined when the AccountingFieldMapping is created.



 |
| sourceField | 

Field Type

string

Description

The API name of the field on the source object that is mapped to the target field.



 |
| targetField | 

Field Type

string

Description

Required.

The API name of the field on the Transaction Journal record for this mapping.



 |

## Declarative Metadata Sample Definition

The following is an example of an AccountingFieldMapping component.

<?xml version="1.0" encoding="UTF-8"?>
<AccountingFieldMapping xmlns="http://soap.sforce.com/2006/04/metadata">
	<accountingModelConfig\>ModelConfigOne</accountingModelConfig\>
	<fullName\>FieldMappingOne</fullName\>
	<masterLabel\>FieldMappingOne</masterLabel\>
	<isForAllocationType\>true</isForAllocationType\>
	<isForPaymentType\>true</isForPaymentType\>
	<isForTransactionType\>true</isForTransactionType\>
	<mappingBehavior\>PointInTime</mappingBehavior\>
	<sourceField\>TransactionJournal.MappingTargetOne\_\_c</sourceField\>
	<targetField\>MappingTargetOne\_\_c</targetField\>
	<isProtected\>false</isProtected\>
</AccountingFieldMapping\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/​metadata">
	<types\>
		<members\>FieldMappingOne</members\>
		<name\>AccountingFieldMapping</name\>
	</types\>
	<version\>58.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=1ebd8d519e57df0107fe7f79bc080a4e92b085c12ff4d1e850962a966b4008c3 url=/legacydeveloper/current/en-us/api_meta/meta_accountingmodelconfig.md -->

# AccountingModelConfig

Represents the mapping of the financial data model to a logical data model and configuration for the generation of Transaction Journal records.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AccountingModelConfig components have the suffix .accountingModelConfig and are stored in the accountingModelConfigs folder.

## Version

AccountingModelConfig components are available in API version 57.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| accountingType | 
Field Type

AccountingType (enumeration of type string)

Description

Required.

Determines whether the accounting set generates revenue or expense type transaction journal records.

Valid values are:

- Expense
- Revenue





 |
| defaultAccrualAccountCode | 

Field Type

string

Description

The code for your accounting system's default accrual account.



 |
| defaultWriteOffAccountCode | 

Field Type

string

Description

Represents the name of your account for written off payments.



 |
| earliestCreatedDate | 

Field Type

dateTime

Description

Required.

The date used to filter source records for processing. The Accounting Subledger only considers records created on or after this date.



 |
| expectedCashFlowGrouping | 

Field Type

ExpectedCashFlowGrouping (enumeration of type string)

Description

Determines whether Accounting Subledger groups transaction journal records by fund account or by a combination of fund account and due date.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Changing this setting doesn't impact existing records; it only affects records created or reversed afterward.

Valid values are:

- GroupByFundAccount
- GroupByFundAndDueDate





 |
| financeBook | 

Field Type

string

Description

Reserved for internal use.



 |
| internalMappingDetails | 

Field Type

string

Description

Required.

Represents the structure of your financial data in JSON format.



 |
| isActive | 

Field Type

boolean

Description

Required.

Indicates whether only records that are true are processed when the Subledger Job runs.



 |
| isGroupedByFundAccount | 

Field Type

boolean

Description

Reserved for internal use.



 |
| isUsed | 

Field Type

boolean

Description

Required.

Indicates whether the Accounting Model has been used or activated at least once (true) or not (false).

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If the value is set to true, you can’t select another object for the object model or change the number of objects associated with that Accounting Model.















 |
| jobFilterCriteria | 

Field Type

string

Description

Reserved for internal use.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for AccountingModelConfig, which is defined when the AccountingModelConfig is created.



 |
| paidCashFlowGrouping | 

Field Type

PaidCashFlowGrouping (enumeration of type string)

Description

Determines the level of detail for generated transaction journal records.

Valid values are:

- GroupByFundAccount—Accounting Subledger splits all transaction journal records into fund accounts. Secondary records are created for payment type records but not for transaction type records.
- GroupBySummary—Accounting Subledger only splits credits for revenue and debits for expenses by fund accounts.





 |
| recordTypeFilter | 

Field Type

string

Description

Specify the record type IDs from the primary object to be processed. This field is case-sensitive.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If no record type is specified in the filter, all records are processed.















 |
| runOrder | 

Field Type

int

Description

Determines the load order sequence of the multiple Accounting Model. The lower number runs first. For example, load order 1 runs before load order 2.



 |

## Declarative Metadata Sample Definition

The following is an example of an AccountingModelConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<AccountingModelConfig
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<fullName\>ModelConfigOne</fullName\>
	<masterLabel\>ModelConfigOne</masterLabel\>
	<defaultAccrualAccountCode\>abc</defaultAccrualAccountCode\>
	<defaultWriteOffAccountCode\>abc</defaultWriteOffAccountCode\>
	<isUsed\>false</isUsed\>
	<isActive\>false</isActive\>
	<runOrder\>123</runOrder\>
	<recordTypeFilter\>abcabc</recordTypeFilter\>
	<earliestCreatedDate\>2021-12-01T00:00:00.000Z</earliestCreatedDate\>
	<internalMappingDetails\>abcabc</internalMappingDetails\>
	<accountingType\>Revenue</accountingType\>
	<expectedCashFlowGrouping\>GroupByFundAccount</expectedCashFlowGrouping\>
	<paidCashFlowGrouping\>GroupBySummary</paidCashFlowGrouping\>
</AccountingModelConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/​metadata">
	<types\>
		<members\>ModelConfigOne</members\>
		<name\>AccountingModelConfig</name\>
	</types\>
	<version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=dbaa098ee9d9b9950a20350d638953c7d8bc40b1128646fc08a43426f484847a url=/legacydeveloper/current/en-us/api_meta/meta_accountingsettings.md -->

# AccountingSettings

Represents the settings for the Accounting Subledger feature.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

AccountingSettings values are stored in the AccountingSettings.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

AccountingSettings components are available in API version 57.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| enableAccountingSubledger | 
Field Type

boolean

Description

Indicates whether Transaction Journal creation is enabled for the organization (true) or not (false).



 |
| enableAslDataCloud | 

Field Type

boolean

Description

Requires Data Cloud and Accounting Subledger access.

Indicates whether Data Cloud Runtime for Accounting Subledger feature is enabled for the organization (true) or not (false).

This field is available in API version 66.0 and later.



 |
| enableFinancePeriod | 

Field Type

boolean

Description

Reserved for internal use.



 |
| enablePaymentMethodAdjust | 

Field Type

boolean

Description

Indicates whether changes to the Payment Method generate adjustments on Transaction Journal records (true) or not (false).



 |
| enableScheduledJob | 

Field Type

boolean

Description

Reserved for internal use.



 |
| enableSkipReversalLogic | 

Field Type

boolean

Description

Indicates whether Skip Reversal Logic is enabled (true) or not (false).



 |

## Declarative Metadata Sample Definition

The following is an example of an AccountingSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<AccountingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableAccountingSubledger\>true</enableAccountingSubledger\>
	<enableAslDataCloud\>true</enableAslDataCloud\>
	<enablePaymentMethodAdjust\>true</enablePaymentMethodAdjust\>
	<enableSkipReversalLogic\>false</enableSkipReversalLogic\>
</AccountingSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/​metadata">
	<types\>
		<members\>Accounting</members\>
		<name\>Settings</name\>
	</types\>
	<version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=08dad16fe15a5b1e07d57cab1eb5d175c1442ba941f1a383c8b5f363ef8177d7 url=/legacydeveloper/current/en-us/api_meta/meta_accountinsightssettings.md -->

# AccountInsightsSettings

Represents an org’s Einstein Account Insights settings. This setting controls features that help your reps maintain their relationships with their customers.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This metadata type has been deprecated as of API version 59.0.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

AccountInsightsSettings values are stored in the AccountInsights.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AccountInsightsSettings is available in API versions 48.0 to 58.0.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableAccountInsights | boolean | Indicates whether Einstein Account Insights is enabled (true) or not (false). The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of the AccountInsights.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<AccountInsightsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableAccountInsights\>true</enableAccountInsights\>
</AccountInsightsSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the AccountInsights settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>AccountInsights</members\>
		<name\>Settings</name\>
	</types\>
	<version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=de35919f0d25daaf078b2ca2b1e52551ab90f068b1ff2c9b754e61345e94f4ff url=/legacydeveloper/current/en-us/api_meta/meta_accountintelligencesettings.md -->

# AccountIntelligenceSettings

Represents an org’s Account Intelligence settings. These settings control features that make it easy for sales reps to create accounts, see relevant news articles, and add logos to account records. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

AccountIntelligenceSettings values are stored in the AccountIntelligence.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AccountIntelligenceSettings is available in API versions 48.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d70550e102">Field Name</th>

              <th class="featureTableHeader  " id="d70550e105">Field Type</th>

              <th class="featureTableHeader  " id="d70550e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d70550e102" data-title="Field Name"><span class="keyword parmname">enableAccountLogos</span></td>

              <td class="entry" headers="d70550e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d70550e108" data-title="Description">Indicates whether your sales reps can see available company logos (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The logos are for US-based
                companies only. The default value is <samp class="codeph nolang">false</samp>.<p class="p"><span class="keyword parmname">enableAutomatedAccountFields</span>
                  must be <samp class="codeph nolang">true</samp> to use this
                  setting.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d70550e102" data-title="Field Name"><span class="keyword parmname">enableAutomatedAccountFields</span></td>

              <td class="entry" headers="d70550e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d70550e108" data-title="Description">Indicates whether Automated Account Fields is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. </td>

            </tr>

            <tr>
              <td class="entry" headers="d70550e102" data-title="Field Name"><span class="keyword parmname">enableNewsStories</span></td>

              <td class="entry" headers="d70550e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d70550e108" data-title="Description">Indicates whether News is enabled (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value
                is <samp class="codeph nolang">false</samp>.
                <p class="p"><span class="keyword parmname">enableAutomatedAccountFields</span> must be
                  <samp class="codeph nolang">true</samp> to use this
                  setting.
                </p>
              </td>

            </tr>


          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the AccountIntelligence.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<AccountIntelligenceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableAccountLogos\>true</enableAccountLogos\>
	<enableAutomatedAccountFields\>true</enableAutomatedAccountFields\>
	<enableNewsStories\>true</enableNewsStories\>
</AccountIntelligenceSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the AccountIntelligence settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>AccountIntelligence</members\>
		<name\>Settings</name\>
	</types\>
	<version\>48.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=9f5c9b09cea014bf2b2b3aae45503fb84d9080a1cb971d58f9add7a732e960b7 url=/legacydeveloper/current/en-us/api_meta/meta_accountplanobjmeascalcdef.md -->

# AccountPlanObjMeasCalcDef

Represents the metadata associated with an account plan objective measure calculation definition. An account plan objective measure calculation definition contains a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AccountPlanObjMeasCalcDef components have the suffix .accountPlanObjMeasCalcDef and are stored in the accountPlanObjMeasCalcDefs folder.

## Version

AccountPlanObjMeasCalcDef components are available in API version 63.0 and later.

## Special Access Rules

To access AccountPlanObjMeasCalcDef components, enable account plans.

## Fields

| Field Name | Description |
| --- | --- |
| conditions | 
Field Type

[AccountPlanObjMeasCalcCond](#AccountPlanObjMeasCalcCond)

Description

The field and value combinations for filtering records to include in the calculation definition.



 |
| description | 

Field Type

string

Description

A summary of the calculation definition that’s visible to users when they select the definition for an account plan objective measure.



 |
| developerName | 

Field Type

string

Description

Required.

The unique name of the object in the API. The name:

- must be 40 characters or fewer
- must begin with a letter
- can contain only underscores and alphanumeric characters
- can’t include spaces
- can’t end with an underscore
- can’t contain 2 consecutive underscores





 |
| masterLabel | 

Field Type

string

Description

Required.

Label for this calculation definition. This display value is the internal label that doesn't get translated.



 |
| rollupType | 

Field Type

string

Description

Required.

The method for calculating the account plan objective measure’s current value from records that match the calculation definition and any optional conditions.

Possible values are:

- Count
- Max
- Min
- Sum

In Setup, this field’s label is Calculation Type.



 |
| status | 

Field Type

string

Description

Required.

Specifies the status of the calculation definition. Possible values are:

- Active
- Draft
- Inactive

Only active calculation definitions are available for users to select when they specify an account plan objective measure.



 |
| targetField | 

Field Type

string

Description

The field on TargetObject to use for calculating the account plan objective measure’s current value. Rollup fields on the Campaign, Case, Contact, or Opportunity object are supported.

In Setup, this field’s label is Rollup Field.



 |
| targetObject | 

Field Type

string

Description

Required.

The object to use for calculating the account plan objective measure’s current value.

Possible values are:

- Campaign
- Case
- Contact
- Opportunity





 |

## AccountPlanObjMeasCalcCond

Represents a field and value combination for filtering records to include in the calculation of a sales account plan objective measure’s current value.

| Field Name | Description |
| --- | --- |
| fieldName | 
Field Type

string

Description

Required.

A field on the calculation definition’s TargetObject that you want to filter by. Fields on the Campaign, Case, Contact, or Opportunity objects are supported.



 |
| operation | 

Field Type

string

Description

Required.

The logical operator for matching records with the specified field value.

Possible values are:

- Contains
- Equals
- GreaterOrEqual
- GreaterThan
- LessOrEqual
- LessThan
- NotContain
- NotEqual
- StartsWith





 |
| value | 

Field Type

string

Description

Required.

The value to match for the specified field.



 |

## Declarative Metadata Sample Definition

The following is an example of an AccountPlanObjMeasCalcDef component.

<?xml version="1.0" encoding="UTF-8"?>
<AccountPlanObjMeasCalcDef xmlns="http://soap.sforce.com/2006/04/metadata">
	<conditions\>
		<fieldName\>StageName</fieldName\>
		<operation\>Equals</operation\>
		<value\>ClosedWon</value\>
	</conditions\>
	<description\>Define sales revenue goals. Current Value will be 
		auto-calculated as the sum of your selected Opportunities 
		Amount with 'Closed Won' Stage.
	</description\>
	<developerName\>Opportunity\_Revenue\_Targets</developerName\>
	<masterLabel\>Opportunity Revenue Targets</masterLabel\>
	<rollupType\>Sum</rollupType\>
	<status\>Active</status\>
	<targetField\>Amount</targetField\>
	<targetObject\>Opportunity</targetObject\>
</AccountPlanObjMeasCalcDef\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
     <types\>
         <members\>Opportunity\_Revenue\_Targets</members\>
         <name\>AccountPlanObjMeasCalcDef</name\>
     </types\>
     <version\>63.0</version\>
</Package\>

<!-- document id=fa1a5ec06f5e80bba3d4d691f3e328c6117b2cbde16f510716af061e50950f28 url=/legacydeveloper/current/en-us/api_meta/meta_accountplansettings.md -->

# AccountPlanSettings

Represents an org’s account plan settings. These settings control features that make it easy for sales reps to set objectives with actionable metrics and to store account research and analysis.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

AccountPlanSettings values are stored in the AccountPlan.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

AccountPlanSettings components are available in API version 63.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| enableAccountPlan | 
Field Type

boolean

Description

Indicates whether Account Plans is enabled (true) or not (false). The default value is false.



 |

## Declarative Metadata Sample Definition

The following is an example of an AccountPlanSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<AccountPlanSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableAccountPlan\>true</enableAccountPlan\>
</AccountPlanSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
     <types\>
         <members\>AccountPlan</members\>
         <name\>Settings</name\>
     </types\>
     <version\>63.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=b90ac0ac87b2965ab69a878482c3ed54aec7be2ec7c5237b3f13b2ea2f854720 url=/legacydeveloper/current/en-us/api_meta/meta_accountrelationshipsharerule.md -->

# AccountRelationshipShareRule

The rule that determines which object records are shared, how they’re shared, the account relationship type that shares the records, and the level of access granted to the records.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

## File Suffix and Directory Location

AccountRelationshipShareRule components have the suffix .accountRelationshipShareRule and are stored in the .accountRelationshipShareRules folder.

## Version

AccountRelationshipShareRule components are available in API version 45.0 and later.

## Special Access Rules

Access to the AccountRelationshipShareRule type requires orgs to enable the Account Relationships permission. The Manage Experiences permission is required for user access.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d72704e115">Field Name</th>

              <th class="featureTableHeader  " id="d72704e118">Field Type</th>

              <th class="featureTableHeader  " id="d72704e121">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d72704e115" data-title="Field Name"><span class="keyword parmname">accessLevel</span></td>

              <td class="entry" headers="d72704e118" data-title="Field Type">string</td>

              <td class="entry" headers="d72704e121" data-title="Description">Type of access granted by the share rule. Valid values are: <ul class="ul bulletList">
                  <li class="li">Read</li>

                  <li class="li">Edit</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d72704e115" data-title="Field Name"><span class="keyword parmname">accountToCriteriaField</span></td>

              <td class="entry" headers="d72704e118" data-title="Field Type">string</td>

              <td class="entry" headers="d72704e121" data-title="Description">Criteria that must be met for the data to be shared. Valid values include any
                custom or standard lookup to Account or User on top-level objects. <p class="p">To get the
                  full list for your org, do a Describe on the ARSR entity.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d72704e115" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d72704e118" data-title="Field Type">string</td>

              <td class="entry" headers="d72704e121" data-title="Description">A meaningful explanation of the sharing rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d72704e115" data-title="Field Name"><span class="keyword parmname">entityType</span></td>

              <td class="entry" headers="d72704e118" data-title="Field Type">string</td>

              <td class="entry" headers="d72704e121" data-title="Description">The type of data shared by this share rule. Valid values are: <ul class="ul bulletList">
                  <li class="li">Account</li>

                  <li class="li">Campaign</li>

                  <li class="li">Case</li>

                  <li class="li">Contact</li>

                  <li class="li">Custom Object</li>

                  <li class="li">Lead</li>

                  <li class="li">Opportunity</li>

                  <li class="li">Order</li>

                  <li class="li">Quote</li>

                </ul>
                API names of top-level custom objects in the org can also be used, for example,
                CustomObject__c.</td>

            </tr>

            <tr>
              <td class="entry" headers="d72704e115" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d72704e118" data-title="Field Type">string</td>

              <td class="entry" headers="d72704e121" data-title="Description">The label assigned to the sharing rule to identify it.</td>

            </tr>

            <tr>
              <td class="entry" headers="d72704e115" data-title="Field Name"><span class="keyword parmname">staticFormulaCriteria</span></td>

              <td class="entry" headers="d72704e118" data-title="Field Type">string</td>

              <td class="entry" headers="d72704e121" data-title="Description">A way to further filter what data gets shared. This string must be a
                deterministic formula, and spanning isn’t allowed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d72704e115" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d72704e118" data-title="Field Type">string</td>

              <td class="entry" headers="d72704e121" data-title="Description">Match the type of an account relationship for data to be shared according to
                the accountToCriteriaField and the staticFormulaCriteria fields.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an AccountRelationshipShareRule component.

<?xml version="1.0" encoding="UTF-8"?>
<AccountRelationshipShareRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <accessLevel\>Edit</accessLevel\>
    <accountToCriteriaField\>Account.OwnerId</accountToCriteriaField\>
    <description\>TestDescription</description\>
    <entityType\>Account</entityType\>
    <masterLabel\>TestName</masterLabel\>
    <staticFormulaCriteria\>YearStarted = &quot;1980&quot;</staticFormulaCriteria\>
    <type\>Dealer</type\>
</AccountRelationshipShareRule\>

The following is an example package.xml that references the previous definition.

<Package\>
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ArsrDevName</members\>
        <name\>AccountRelationshipShareRule</name\>
    </types\>
<version\>45.0</version\>
</Package\>

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file.

<!-- document id=d2d0e5ec543ae1583a330b73837a5c1b8a0bed68fd115950d78a3d6e59bdcf43 url=/legacydeveloper/current/en-us/api_meta/meta_accountsettings.md -->

# AccountSettings

Represents an org’s account settings for account teams, account owner report, and the **View Hierarchy** link.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

AccountSettings values are stored in the Account.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AccountSettings is available in API versions 29.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d73409e116">Field Name</th>

              <th class="featureTableHeader  " id="d73409e119">Field Type</th>

              <th class="featureTableHeader  " id="d73409e122">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d73409e116" data-title="Field Name"><span class="keyword parmname">enableAccountDiscovery</span></td>

              <td class="entry" headers="d73409e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d73409e122" data-title="Description">When <samp class="codeph nolang">true</samp>, sets up Einstein Account Management dashboards and installs the related CRM Analytics and Customer Insights apps. The dashboards give users access to account health analytics including metrics on open pipeline, risk, and engagement scores. <p class="p">Einstein Account Management is part of Revenue Intelligence, which is available for an additional cost.</p>
                <p class="p">Available in API version 57.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d73409e116" data-title="Field Name"><span class="keyword parmname">enableAccountHistoryTracking</span></td>

              <td class="entry" headers="d73409e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d73409e122" data-title="Description">Indicates whether history tracking is enabled for accounts (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. If history tracking is disabled, the History related list is removed from account page layouts. However, history data is still available for reporting up to the date and time when tracking was disabled. Available in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d73409e116" data-title="Field Name"><span class="keyword parmname">enableAccountInsightsInMobile</span></td>

              <td class="entry" headers="d73409e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d73409e122" data-title="Description">Deprecated in API version 59.0 and later because the feature is no longer available. Indicates whether users can see Einstein Account Insights on their mobile device (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Insights appear in the Einstein Insights component, which is on account records and the Home page.<p class="p">To use this feature, users must have the Einstein Account Insights permission.</p>
                <p class="p">Available in API version 47.0 to 58.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d73409e116" data-title="Field Name"><span class="keyword parmname">enableAccountOwnerReport</span></td>

              <td class="entry" headers="d73409e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d73409e122" data-title="Description">Indicates whether the Account Owner Report can (<samp class="codeph nolang">true</samp>) or can’t (<samp class="codeph nolang">false</samp>) be run by all users.</td>

            </tr>

            <tr>
              <td class="entry" headers="d73409e116" data-title="Field Name"><span class="keyword parmname">enableAccountTeams</span></td>

              <td class="entry" headers="d73409e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d73409e122" data-title="Description">Indicates whether account teams are enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">The Metadata API can’t be used to disable account teams.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d73409e116" data-title="Field Name"><span class="keyword parmname">enableContactHistoryTracking</span></td>

              <td class="entry" headers="d73409e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d73409e122" data-title="Description">Indicates whether history tracking is enabled for contacts (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d73409e116" data-title="Field Name"><span class="keyword parmname">enableRelateContactToMultipleAccounts</span></td>

              <td class="entry" headers="d73409e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d73409e122" data-title="Description">Indicates whether users can relate a contact to multiple accounts (<samp class="codeph nolang">true</samp>) or only one account (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. If this feature (Contacts to Multiple Accounts) is disabled, secondary contact–account relationships created while the feature was enabled are deleted. Available in API version 47.0 and later.<p class="p">Avoid using the Metadata API to enable this feature. Use the Account Settings page in Setup to enable Contacts to Multiple Accounts.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d73409e116" data-title="Field Name"><span class="keyword parmname">enableReportsToOnPersonAccount</span></td>

              <td class="entry" headers="d73409e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d73409e122" data-title="Description">Indicates whether the <strong class="ph uicontrol">Reports To</strong> field on Person Account, which corresponds to the <span class="keyword parmname">PersonReportsToId</span> field on the Account object, is enabled. The field allows users to associate person accounts and contacts with other person accounts or contacts that they report to.<p class="p">Available in API version 62.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d73409e116" data-title="Field Name"><span class="keyword parmname">showViewHierarchyLink</span></td>

              <td class="entry" headers="d73409e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d73409e122" data-title="Description">Indicates whether the default <strong class="ph uicontrol">View Hierarchy</strong> link on all business account detail pages is visible (<samp class="codeph nolang">true</samp>) or hidden (<samp class="codeph nolang">false</samp>).</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the Account.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<AccountSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableAccountDiscovery\>true</enableAccountDiscovery\>
	<enableAccountHistoryTracking\>true</enableAccountHistoryTracking\>
	<enableAccountInsightsInMobile\>false</enableAccountInsightsInMobile\>
	<enableAccountOwnerReport\>true</enableAccountOwnerReport\>
	<enableAccountTeams\>true</enableAccountTeams\>
	<enableContactHistoryTracking\>true</enableContactHistoryTracking\>
	<enableRelateContactToMultipleAccounts\>true</enableRelateContactToMultipleAccounts\>
	<enableReportsToOnPersonAccount\>true</enableReportsToOnPersonAccount\>
	<showViewHierarchyLink\>true</showViewHierarchyLink\>
</AccountSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Account settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>Account</members\>
		<name\>Settings</name\>
	</types\>
	<version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=db8aedc55eea006662304578002293da4cee936f2f1df4c7523376bdb0cb3278 url=/legacydeveloper/current/en-us/api_meta/meta_actionablelistdefinition.md -->

# ActionableListDefinition

Represents the data source definition details associated with an actionable list.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActionableListDefinition components have the suffix .actionableListDefinition and are stored in the actionableListDefinitions folder.

## Version

ActionableListDefinition components are available in API version 57.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| actionableListDatasetColumns | 
Field Type

[ActionableListDatasetColumn](#ActionableListDatasetColumn)\[\]

Description

The object that stores columns in a dataset associated with an actionable list.



 |
| actionableListMemberStatuses | 

Field Type

[ActionableListMemberStatus](#ActionableListMemberStatus)\[\]

Description

The object that stores the status and the corresponding status icon details of an individual actionable list member.



 |
| actionableListType | 

Field Type

static enum

Description

Specifies the type of actionable list. Available in API version 68.0 and later.



 |
| isactive | 

Field Type

boolean

Description

Indicates whether the actionable list definition is active (yes) or not (no). Available in API version 68.0 and later.



 |
| batchCalcJobDefinition | 

Field Type

string

Description

The batch calculation job definition that's associated with the creation of an actionable list. This field is a relationship field.



 |
| datasetName | 

Field Type

string

Description

The name of the dataset that is associated with the actionable list.



 |
| description | 

Field Type

text

Description

The description of the actionable list definition. Available in API version 68.0 and later.



 |
| edgeMart | 

Field Type

string

Description

The edgemart dataset that's associated with the actionable list. Available in API version 58.0 and later.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the actionable list definition is active (true) or not (false).

The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label of the actionable list definition.



 |
| objectName | 

Field Type

string

Description

Required.

The object for which the actionable list is created.

Possible values are organized by the API version in which they were introduced. Values are available in all versions after introduction unless noted otherwise.

Possible values are:

API version 60.0 and later:

PersonLifeEvent

API version 60.0 and later with Insurance Managed Package:

- Claim
- InsurancePolicy
- Quote

API version 59.0 and later with Health Cloud:

- CareFacilityBed
- CareRequest
- CareRequestItem
- CareServiceVisit
- CareServiceVisitPlan
- ClinicalServiceRequest

API version 59.0 and later with Loyalty Cloud:

- LoyaltyProgramMember

API version 59.0 and later:

- Case

API version 58.0 and later with Automotive Cloud:

- Vehicle

API version 58.0 and later:

- Asset
- Lead
- Opportunity

API version 57.0 and later:

- Account
- Contact





 |
| sourceObjectFieldName | 

Field Type

text

Description

The name of the source object field associated with the actionable list definition. Available in API version 68.0 and later.



 |
| sourceObjectName | 

Field Type

text

Description

The source object name for which the actionable list is created. Available in API version 68.0 and later.



 |

## ActionableListDatasetColumn

Represents the information about the columns in a dataset associated with an actionable list.

Table 1. Fields
| Field Name | Description |
| --- | --- |
| actionableListDefinition | 
Field Type

master/detail

Description

The actionable list definition that's associated with the column. Available in API version 68.0 and later.



 |
| dataDomain | 

Field Type

DatasetColumnDataType (enumeration of type string)

Description

The data domain that is mapped to the data type of the dataset column.

Possible values are:

- Dates
- Dimensions
- Measures





 |
| dataType | 

Field Type

DatatableDataType (enumeration of type string)

Properties

Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description

The data type of the dataset column in the actionable list. Available in API version 58.0 and later.

Possible values are:

- Boolean
- Currency
- Date
- DateTime
- Email
- Location
- Number
- Percent
- Phone
- Text
- Url





 |
| displayOrder | 

Field Type

int

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The order in which the actionable list dataset columns are displayed. Available in API version 58.0 and later.



 |
| isDefault | 

Field Type

boolean

Description

Indicates whether the dataset column is added to the actionable list by default (true) or not (false).

The default value is false.



 |
| isGroupedByListDefObj | 

Field Type

boolean

Description

Indicates whether the dataset column is grouped by the object defined in the actionable list definition (true) or not (false). Available in API version 59.0 and later.



 |
| IsTypeAheadSearchEnabled | 

Field Type

boolean

Description

Indicates whether the type-ahead search for filters is enabled (true) or not (false). Available in API version 60.0 and later.



 |
| isSourceObjectField | 

Field Type

boolean

Description

Indicates whether the dataset column belongs to source data model object or not. Available in API version 68.0 and later.



 |
| objectName | 

Field Type

string

Description

The name of the object that's associated with the dataset column.

Possible values are:

API version 60.0 and later:

PersonLifeEvent

API version 60.0 and later with Insurance Managed Package:

- Claim
- InsurancePolicy
- Quote

API version 59.0 and later with Health Cloud:

- CareFacilityBed
- CareRequest
- CareRequestItem
- CareServiceVisit
- CareServiceVisitPlan
- ClinicalServiceRequest

API version 59.0 and later with Loyalty Cloud:

- LoyaltyProgramMember

API version 59.0 and later:

- Case

API version 58.0 and later with Automotive Cloud:

- Vehicle

API version 58.0 and later:

- Asset
- Lead
- Opportunity

API version 57.0 and later:

- Account
- Contact





 |
| sourceColumnApiName | 

Field Type

string

Description

The API name of the column in the source dataset. Available in API version 68.0 and later.



 |
| sourceFieldName | 

Field Type

string

Description

The name of the field in the object for which the actionable list dataset is created.



 |

## ActionableListMemberStatus

Represents the status and the corresponding status icon details of an individual actionable list member.

Table 2. Fields
| Field Name | Description |
| --- | --- |
| iconName | 
Field Type

string

Description

The name of the icon that's mapped to the status.



 |
| status | 

Field Type

string

Description

The status of the actionable list member.



 |

## Declarative Metadata Sample Definition

The following is an example of a ActionableListDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<ActionableListDefinition
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<actionableListDatasetColumns\>
		<isDefault\>true</isDefault\>
		<sourceFieldName\>NewColumn1</sourceFieldName\>
	</actionableListDatasetColumns\>
	<actionableListDatasetColumns\>
		<sourceColumnApiName\>ApiName</sourceColumnApiName\>
		<dataDomain\>Dimensions</dataDomain\>
		<isDefault\>false</isDefault\>
		<sourceFieldName\>NewColumn2</sourceFieldName\>
		<objectName\>Account</objectName\>
		<displayOrder\>1</displayOrder\>
		<dataType\>Text</dataType\>
	</actionableListDatasetColumns\>
	<actionableListMemberStatuses\>
		<iconName\>NewMember1</iconName\>
		<status\>Active</status\>
	</actionableListMemberStatuses\>
	<isActive\>true</isActive\>
	<masterLabel\>NewMember2</masterLabel\>
	<objectName\>Account</objectName\>
	<isProtected\>true</isProtected\>
	<batchCalcJobDefinition\>Test1</batchCalcJobDefinition\>
	<datasetName\>AccountDef</datasetName\>
</ActionableListDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>ActionableListDefinition</name\>
   </types\>
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=25fa9f4a589191ef7497331aafda4edb5d78ab079036f21dd3ccbf87a3fad369 url=/legacydeveloper/current/en-us/api_meta/meta_actionlinkgrouptemplate.md -->

# ActionLinkGroupTemplate

Represents the action link group template. Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking on an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. Every action link belongs to an action link group and action links within the group are mutually exclusive.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActionLinkGroupTemplate components have the suffix .actionLinkGroupTemplate and are stored in the actionLinkGroupTemplates folder.

## Version

ActionLinkGroupTemplate components are available in API version 33.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d74375e98">Field Name</th>

              <th class="featureTableHeader  " id="d74375e101">Field Type</th>

              <th class="featureTableHeader  " id="d74375e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d74375e98" data-title="Field Name"><span class="keyword parmname">actionLinkTemplates</span></td>

              <td class="entry" headers="d74375e101" data-title="Field Type">
                <a class="xref" href="#actionLinkTemplate">ActionLinkTemplate</a>[]
              </td>

              <td class="entry" headers="d74375e104" data-title="Description">Action link templates that are associated with the action link group
                template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e98" data-title="Field Name"><span class="keyword parmname">category</span></td>

              <td class="entry" headers="d74375e101" data-title="Field Type">PlatformAction​GroupCategory (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d74375e104" data-title="Description">Required. The location of the action link group within the feed element. Values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Primary</samp>—The action link group is
                    displayed in the body of the feed element.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Overflow</samp>—The action link group is
                    displayed in the overflow menu of the feed element.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e98" data-title="Field Name"><span class="keyword parmname">executionsAllowed</span></td>

              <td class="entry" headers="d74375e101" data-title="Field Type">ActionLink​ExecutionsAllowed (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d74375e104" data-title="Description">Required. The number of times an action link can be executed. Values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Once</samp>—An action link can be
                    executed only once across all users.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OncePerUser</samp>—An action link can be
                    executed only once for each user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Unlimited</samp>—An action link can be
                    executed an unlimited number of times by each user. If the action link’s
                    <samp class="codeph nolang">actionType</samp> is <samp class="codeph nolang">Api</samp> or <samp class="codeph nolang">ApiAsync</samp>, you
                    can’t use this value.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e98" data-title="Field Name"><span class="keyword parmname">hoursUntilExpiration</span></td>

              <td class="entry" headers="d74375e101" data-title="Field Type">int</td>

              <td class="entry" headers="d74375e104" data-title="Description">Required. The number of hours from when the action link group is created until
                it's removed from associated feed elements and can no longer be executed. The
                maximum value is 8,760.</td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e98" data-title="Field Name"><span class="keyword parmname">isPublished</span></td>

              <td class="entry" headers="d74375e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d74375e104" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, the action link group
                template is published. Action link group templates shouldn’t be published until at
                least one action link template is associated with it.</td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e98" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d74375e101" data-title="Field Type">string</td>

              <td class="entry" headers="d74375e104" data-title="Description">Required. The name of the action link group template to use in code.</td>

            </tr>

          </tbody>

        </table>

## ActionLinkTemplate

ActionLinkTemplate components are used to create multiple action links that share properties.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d74375e268">Field Name</th>

              <th class="featureTableHeader  " id="d74375e271">Field Type</th>

              <th class="featureTableHeader  " id="d74375e274">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">actionUrl</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">string</td>

              <td class="entry" headers="d74375e274" data-title="Description">Required. The action link URL. For example, a <samp class="codeph nolang">Ui</samp> action link URL is a Web page. A <samp class="codeph nolang">Download</samp> action link URL is a link to the file to download. <samp class="codeph nolang">Ui</samp> and <samp class="codeph nolang">Download</samp>
                action link URLs are provided to clients. An <samp class="codeph nolang">Api</samp> or <samp class="codeph nolang">ApiAsync</samp> action link URL is
                a REST resource. <samp class="codeph nolang">Api</samp> and <samp class="codeph nolang">ApiAsync</samp> action link URLs aren’t provided to clients.
                Links to Salesforce can be relative. All other links must be absolute and start with
                <samp class="codeph nolang">https://</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">headers</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">string</td>

              <td class="entry" headers="d74375e274" data-title="Description">Template for the HTTP headers sent when corresponding action links are invoked.
                This field can be used only for <samp class="codeph nolang">Api</samp> and <samp class="codeph nolang">ApiAsync</samp> action links. This field can contain context
                variables and binding variables in the form <samp class="codeph apex_code">{!Bindings.<var class="keyword varname">key</var>}</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">isConfirmationRequired</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">boolean</td>

              <td class="entry" headers="d74375e274" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, a confirmation dialog
                appears before the action is executed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">isGroupDefault</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">boolean</td>

              <td class="entry" headers="d74375e274" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, action links derived
                from this template are the default or primary action in their action groups. There
                can be only one default action per action group.</td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">string</td>

              <td class="entry" headers="d74375e274" data-title="Description">A custom label to display on the action link button. If none of the
                <span class="keyword parmname">LabelKey</span> values make sense for an action link, use a custom
                label. Set the <span class="keyword parmname">LabelKey</span> field to <samp class="codeph nolang">None</samp> and enter a label name in the <span class="keyword parmname">Label</span>
                field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">labelKey</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">string</td>

              <td class="entry" headers="d74375e274" data-title="Description">Required. Key for the set of labels to display for these action link states:
                new, pending, success, failed. For example, the Approve set contains these labels:
                Approve, Pending, Approved, Failed. For a complete list of keys and labels, see
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_appendices_action_links_labels.htm" target="_blank" title="HTML (New Window)">Action Link Labels</a> in
                the <cite class="cite">Connect REST API Developer Guide</cite>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">linkType</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">ActionLinkType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d74375e274" data-title="Description">Required. The type of action link. One of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Api</samp>—The action link calls a synchronous
                    API at the action URL. Salesforce sets the status to <samp class="codeph nolang">SuccessfulStatus</samp> or <samp class="codeph nolang">FailedStatus</samp> based on the HTTP status code returned by your
                    server.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ApiAsync</samp>—The action link calls an
                    asynchronous API at the action URL. The action remains in a <samp class="codeph nolang">PendingStatus</samp> state until a third party makes a
                    request to <samp class="codeph nolang">/connect/action-links/<var class="keyword varname">actionLinkId</var></samp> to set the
                    status to <samp class="codeph nolang">SuccessfulStatus</samp> or <samp class="codeph nolang">FailedStatus</samp> when the asynchronous operation is
                    complete.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Download</samp>—The action link downloads a file
                    from the action URL.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Ui</samp>—The action link takes the user to a
                    web page at the action URL.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">method</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">ActionLink​HttpMethod (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d74375e274" data-title="Description">Required. HTTP method for the action URL. One of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">HttpDelete</samp>—Returns HTTP 204 on success.
                    Response body or output class is empty.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HttpGet</samp>—Returns HTTP 200 on success.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HttpHead</samp>—Returns HTTP 200 on success.
                    Response body or output class is empty.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HttpPatch</samp>—Returns HTTP 200 on success or
                    HTTP 204 if the response body or output class is empty.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HttpPost</samp>—Returns HTTP 201 on success or
                    HTTP 204 if the response body or output class is empty. Exceptions are the batch
                    posting resources and methods, which return HTTP 200 on success.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HttpPut</samp>—Return HTTP 200 on success or
                    HTTP 204 if the response body or output class is empty.
                  </li>

                </ul>
                <p class="p"><samp class="codeph nolang">Ui</samp> and <samp class="codeph nolang">Download</samp> action links must use <samp class="codeph nolang">HttpGet</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">position</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">int</td>

              <td class="entry" headers="d74375e274" data-title="Description">Required. An integer specifying the position of the action link template
                relative to other action links in the group. 0 is the first position.</td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">requestBody</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">string</td>

              <td class="entry" headers="d74375e274" data-title="Description">Template for the HTTP request body sent when corresponding action links are
                invoked. This field can be used only for <samp class="codeph nolang">Api</samp>
                and <samp class="codeph nolang">ApiAsync</samp> action links. This field can
                contain context variables and binding variables in the form <samp class="codeph apex_code">{!Bindings.<var class="keyword varname">key</var>}</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">userAlias</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">string</td>

              <td class="entry" headers="d74375e274" data-title="Description">If you selected <samp class="codeph nolang">CustomUser</samp> or <samp class="codeph nolang">CustomExcludedUser</samp> for
                <span class="keyword parmname">UserVisibility</span>, this field is the alias for the custom user.
                Use the alias in a template binding to specify the custom user when an action link
                group is created using the template.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d74375e268" data-title="Field Name"><span class="keyword parmname">userVisibility</span></td>

              <td class="entry" headers="d74375e271" data-title="Field Type">ActionLink​UserVisibility (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d74375e274" data-title="Description">Required. Who can see the action link. This value is set per action link, not
                per action link group. Values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Creator</samp>—Only the creator of the action
                    link can see the action link.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Everyone</samp>—Everyone can see the action
                    link.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EveryoneButCreator</samp>—Everyone but the
                    creator of the action link can see the action link.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Manager</samp>—Only the manager of the creator
                    of the action link can see the action link.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomUser</samp>—Only the custom user can see
                    the action link.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomExcludedUser</samp>—Everyone but the
                    custom user can see the action link.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an ActionLinkGroupTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<ActionLinkGroupTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
   <actionLinkTemplates\>
      <actionUrl\>/services/data/{!Bindings.word}/chatter/feed-elements</actionUrl\>
      <headers\>Content-Type:{!Bindings.word3}</headers\>
      <isConfirmationRequired\>true</isConfirmationRequired\>
      <isGroupDefault\>true</isGroupDefault\>
      <labelKey\>Add</labelKey\>
      <linkType\>API</linkType\>
      <method\>httpPost</method\>
      <position\>0</position\>
      <requestBody\>{"body":{"messageSegments":\[{"type": "Text",
      "text": "{!Bindings.word1}"}\]},"subjectId": "{!Bindings.word2}",
      "feedElementType": "feedItem"}</requestBody\>
      <userAlias\>customExcludedUser</userAlias\>
      <userVisibility\>CustomExcludedUser</userVisibility\>
   </actionLinkTemplates\>
   <category\>Primary</category\>
   <executionsAllowed\>OncePerUser</executionsAllowed\>
   <hoursUntilExpiration\>10</hoursUntilExpiration\>
   <isPublished\>true</isPublished\>
   <name\>MyPackage</name\>
</ActionLinkGroupTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ActionLinkGroupTemplate</name\>
    </types\>
    <version\>33.0</version\>
</Package\>

## Usage

If you modify action link group templates, you overwrite the related action link templates.

If you delete a published action link group template, you delete all related action link information which includes deleting all action links that were instantiated using the template from feed items.

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=46c0bd329026da6d763e165abee8d3e27ec08b778f0b66a2a134a9d07825bd83 url=/legacydeveloper/current/en-us/api_meta/actionoverride.md -->

# ActionOverride

Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can access ActionOverride only by accessing its encompassing CustomObject.

## Declarative Metadata File Suffix and Directory Location

Action overrides are defined as part of a standard or custom object.

## Version

Action overrides are available in API version 18.0 and later. As of Summer ’13, action overrides can be applied to both standard and custom objects. Previously, action overrides only applied to custom objects.

## Fields

Unless otherwise noted, all fields are creatable, filterable, and nillable.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d49301e82">Field Name</th>

              <th class="featureTableHeader  " id="d49301e85">Field Type</th>

              <th class="featureTableHeader  " id="d49301e88">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d49301e82" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d49301e85" data-title="Field Type">string</td>

              <td class="entry" headers="d49301e88" data-title="Description">Required. The
                possible values are the same as the actions you can override:<a name="actionName_values"><!-- --></a>
                <ul class="ul bulletList" id="actionName_values">
                  <li class="li"><samp class="codeph nolang">accept</samp></li>

                  <li class="li"><samp class="codeph nolang">clone</samp></li>

                  <li class="li"><samp class="codeph nolang">delete</samp></li>

                  <li class="li"><samp class="codeph nolang">edit</samp></li>

                  <li class="li"><samp class="codeph nolang">list</samp></li>

                  <li class="li"><samp class="codeph nolang">new</samp></li>

                  <li class="li"><samp class="codeph nolang">tab</samp></li>

                  <li class="li"><samp class="codeph nolang">view</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d49301e82" data-title="Field Name"><span class="keyword parmname">comment</span></td>

              <td class="entry" headers="d49301e85" data-title="Field Type">string</td>

              <td class="entry" headers="d49301e88" data-title="Description">Any comments you want
                associated with the override.</td>

            </tr>

            <tr>
              <td class="entry" headers="d49301e82" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d49301e85" data-title="Field Type">string</td>

              <td class="entry" headers="d49301e88" data-title="Description"><span class="ph" id="content_field_desc"><a name="content_field_desc"><!-- --></a>Set this field if
                  <span class="keyword parmname">type</span> is set to <samp class="codeph nolang">flexipage</samp>, <samp class="codeph nolang">lightningcomponent</samp>, <samp class="codeph nolang">scontrol</samp>, or <samp class="codeph nolang">visualforce</samp>. It refers to the
                  name of the Lightning page, Lightning component, s-control, or
                  Visualforce page to use as the override. To reference installed
                  components, use this format: <samp class="codeph nolang"><var class="keyword varname">Component_namespace</var>__<var class="keyword varname">Component_name</var></samp>.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d49301e82" data-title="Field Name"><span class="keyword parmname" id="actionoverride_formfactor"><a name="actionoverride_formfactor"><!-- --></a>formFactor</span></td>

              <td class="entry" headers="d49301e85" data-title="Field Type">FormFactor (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d49301e88" data-title="Description">
                <span class="ph" id="meta_actionOverride_formFactor_desc"><a name="meta_actionOverride_formFactor_desc"><!-- --></a>The size of the page
                  being overridden.</span>
                <p class="p">If the <span class="keyword parmname">type</span> field
                  is set to <samp class="codeph nolang">flexipage</samp>, set
                  this field to <samp class="codeph nolang">Large</samp> to
                  override the View action with a Lightning page in Lightning
                  Experience.</p>

                <p class="p" id="formfactor_value_desc"><a name="formfactor_value_desc"><!-- --></a>The <samp class="codeph nolang">Large</samp> value represents the
                  Lightning Experience desktop environment and is valid only for
                  the <samp class="codeph nolang">flexipage</samp> and <samp class="codeph nolang">lightningcomponent</samp> types. The
                  <samp class="codeph nolang">Small</samp> value represents
                  the Salesforce mobile app on a phone or tablet. The <samp class="codeph nolang">Medium</samp> value is reserved for
                  future use. The <samp class="codeph nolang">null</samp> value
                  (which is the same as specifying no value) represents Salesforce
                  Classic.
                </p>

                <p class="p">This field is available in API version 37.0 and
                  later and is part of the feature for creating and editing record
                  pages in Lightning Experience.</p>
                Lightning component overrides
                return different <span class="keyword parmname">FormFactor</span> values depending on
                the API version used. <ul class="ul bulletList">
                  <li class="li">In API version 41.0 and earlier, Lightning component
                    overrides return only the <samp class="codeph nolang">null</samp> value (no value), representing the
                    Salesforce Classic environment.</li>

                  <li class="li">In API version 42.0, if you specify different Lightning
                    component overrides for Lightning Experience and mobile, one
                    component is selected randomly for both overrides and its
                    <span class="keyword parmname">FormFactor</span> value is returned. If
                    there’s a conflict between Lightning components, and a
                    Visualforce page override is also specified for Salesforce
                    Classic, the Visualforce page takes precedence.
                  </li>

                  <li class="li">In API version 43.0 and later, a Lightning component
                    override for Lightning Experience returns the <samp class="codeph nolang">Large</samp> value and a Lightning
                    component override for mobile returns the <samp class="codeph nolang">Small</samp> value, as
                    expected.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d49301e82" data-title="Field Name"><span class="keyword parmname">skipRecordTypeSelect</span></td>

              <td class="entry" headers="d49301e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d49301e88" data-title="Description">
                <span class="ph" id="meta_actionOverride_skipRecordTypeSelect_desc"><a name="meta_actionOverride_skipRecordTypeSelect_desc"><!-- --></a>Set this
                  field to <samp class="codeph nolang">true</samp> if you prefer
                  that any new records created by this action override aren’t
                  forwarded to the record type selection page. This field is only
                  valid if the <span class="keyword parmname">actionName</span> is a “create” type
                  (like <samp class="codeph nolang">new</samp>), and
                  <span class="keyword parmname">type</span> is set to <samp class="codeph nolang">visualforce</samp>.</span> This field is
                available in API version 21.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d49301e82" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d49301e85" data-title="Field Type">ActionOverrideType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d49301e88" data-title="Description">Required. Represents the
                type of action override. Valid values are described in <a class="xref" href="#actionOverrideType_section">ActionOverrideType</a>.</td>

            </tr>

          </tbody>

        </table>

## ActionOverrideType

[ActionOverrideType](#actionOverrideType_section) is an enumeration of type string that defines which kind of action override to use. The valid values are:

- default—The override uses a custom override provided by an installed package. If there isn’t one available, the standard Salesforce behavior is used.
- flexipage—The override uses behavior from a Lightning page, and is only valid for the View action in Lightning Experience.
- lightningcomponent—The override uses behavior from a Lightning component.
- scontrol—The override uses behavior from an s-control.
- standard—The override uses regular Salesforce behavior.
- visualforce—The override uses behavior from a Visualforce page.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Existing s-controls can be used as overrides for Salesforce Classic under certain conditions. However, s-controls have been deprecated since the Spring ’09 release. We recommend using Visualforce pages instead.

## Usage

You can't delete ActionOverrides by deploying with destructiveChange.xml. To delete an ActionOverride, retrieve the CustomObject. In the definition file, find the <ActionOverrides> section, and remove the <content> row. Then, change the <type> value in that same section to Default. Do this for every override you want to reset. After making the changes, rezip the folder and deploy.

You can remove one override at a time each with its own deploy, or you can remove multiple overrides in a single deploy. However, we recommend that you do a fresh retrieve every time you want to delete a new override. Don’t use a previously retrieved file.

Org default flexipage override assignment metadata can’t be retrieved from a managed package.

## Declarative Metadata Sample Definitions

You can define action overrides, as in these examples for the Edit action.

A Visualforce page override for Salesforce Classic:

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides\>
        <actionName\>edit</actionName\>
        <type\>visualforce</type\>
        <content\>myEditVFPage</content\>
        <comment\>This edit action is a lot safer.</comment\>
     </actionOverrides\>
</CustomObject

This example includes no value for FormFactor. Using no value is the same as using the null value, which represents Salesforce Classic.

A Lightning component override for Lightning Experience:

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides\>
        <actionName\>edit</actionName\>
        <type\>lightningcomponent</type\>
        <content\>myEditLightningComponent</content\>
        <formFactor\>Large</formFactor\>
        <comment\>This edit action is a lot safer.</comment\>
     </actionOverrides\>
</CustomObject\>

A Lightning component override for the Salesforce mobile app:

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides\>
        <actionName\>edit</actionName\>
        <type\>lightningcomponent</type\>
        <content\>myEditLightningComponent</content\>
        <formFactor\>Small</formFactor\>
        <comment\>This edit action is a lot safer.</comment\>
     </actionOverrides\>
</CustomObject\>

When overrides are included in a managed package, the overrides are represented as default type in the metadata. Calling [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") presents the following:

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides\>
        <actionName\>edit</actionName\>
        <type\>default</type\>
     </actionOverrides\>
</CustomObject\>

If you subscribe to a managed package with default overrides, you can replace the default override behavior by editing the XML. For example, to replace the Visualforce page override with the Salesforce standard page for Salesforce Classic, use:

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides\>
        <actionName\>edit</actionName\>
        <type\>standard</type\>
     </actionOverrides\>
</CustomObject\>

To set a Lightning page action override on the View standard button in Lightning Experience, use:

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides\>
        <actionName\>View</actionName\>
        <content\>myLightningPage</content\>
        <formFactor\>Large</formFactor\>
        <type\>flexipage</type\>
    </actionOverrides\>
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_businessprocess.htm "BusinessProcess")

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")

<!-- document id=e36d9f7e3273bae572580508dd1a9976f06a6eaecce6650f018f725b176262af url=/legacydeveloper/current/en-us/api_meta/meta_actionplantemplate.md -->

# ActionPlanTemplate

Represents the instance of an action plan template.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActionPlanTemplate components have the suffix .apt and are stored in the actionPlanTemplates folder.

## Version

Action Plan Template components are available in API version 47.0 and later.

## Special Access Rules

To create or access action plan templates, you must have the Customize Application permission and the IndustriesActionPlans license.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d76339e107">Field Name</th>

              <th class="featureTableHeader  " id="d76339e110">Field Type</th>

              <th class="featureTableHeader  " id="d76339e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">actionPlanTemplateItem</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type"><a class="xref" href="#ActionPlanTemplateItem">ActionPlanTemplateItem</a></td>

              <td class="entry" headers="d76339e113" data-title="Description">The instance of an item on an action plan template version.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">actionPlanTemplateItemDependencies</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type"><a class="xref" href="#ActionPlanTemplateItemDependency">ActionPlanTemplateItemDependency[]</a></td>

              <td class="entry" headers="d76339e113" data-title="Description">Defines the dependencies between action plan template items. Available in API
                version 59.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">actionPlanType</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">ActionPlanTemplateType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d76339e113" data-title="Description">Type of the action plan template. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Industries</samp></li>

                  <li class="li"><samp class="codeph nolang">Retail</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ITSM</samp>—Available in API version 65.0
                    and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">PrvdEngmtCompliance</samp></li>

                  <li class="li"><samp class="codeph nolang">KAM</samp></li>

                </ul>
                <p class="p">Available in API version 63.0 and later. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">category</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Category for this action plan template. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">The description of the action plan template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">estimatedCompletionDays</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">int</td>

              <td class="entry" headers="d76339e113" data-title="Description">Estimated number of days required to complete the action plan. Available in API
                version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">fileBasedTemplatePath</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">File path for a file-based action plan template. Available in API version 64.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">isAdHocItemCreationEnabled</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d76339e113" data-title="Description">Required. Indicates whether ad hoc item creation is enabled for this action
                plan template (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 59.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Required. The name of the action plan template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">sourceType</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Source type of the action plan template. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Status of the action plan template. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">subcategory</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Subcategory for this action plan template. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">targetEntityType</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Required. The parent object this action plan template relates to. Supported
                parent objects are Account, BusinessMilestone, Campaign, Case, Claim, Contact,
                Contract, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity,
                PersonLifeEvent, and Visit and custom objects with activities enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">uniqueName</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Required. The unique identifier for this action plan template record.</td>

            </tr>

          </tbody>

        </table>

## ActionPlanTemplateItem

Represents the instance of an item on an action plan template version.

| Field Name | Field Type | Description |
| --- | --- | --- |
| actionPlanTemplateItemValue | [ActionPlanTemplateItemValue](#ActionPlanTemplateItemValue) | The value associated with the action plan template item. |
| displayOrder | int | The order in which this item is displayed within the action plan template version. |
| isRequired | boolean | Indicates whether the task created from this template item is required. |
| itemEntityType | string | Required. The name of the field on the action plan template item that this value is for. Available in API version 48.0 and later. |
| name | string | Required. The name of the action plan template item. |
| uniqueName | string | Required. The unique identifier for this action plan template item record. |

## ActionPlanTemplateItemDependency

Represents a dependency between action plan template items, defining the sequential relationship and creation timing of items. Available in API version 59.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| creationType | string | Required. Defines how the dependent item is created in the action plan. |
| name | string | Required. Name of the dependency relationship. |
| previousTemplateItem | [ActionPlanTemplateItem](#ActionPlanTemplateItem) | Required. Reference to the prerequisite template item that must be completed before the dependent item begins. |
| templateItem | [ActionPlanTemplateItem](#ActionPlanTemplateItem) | Required. Reference to the dependent template item that relies on the completion of the previous item. |

## ActionPlanTemplateItemValue

Represents the value associated with an action plan template item.

| Field Name | Field Type | Description |
| --- | --- | --- |
| itemEntityType | string | Required. The name of the field on the action plan template item that this value is for. Available in API version 48.0 and later. |
| name | string | Required. The name of the action plan template item value. |
| valueFormula | string | The formula for this action plan template item. |
| valueLiteral | string | The value for this action plan template item. |

## Declarative Metadata Sample Definition

The following is an example of an ActionPlanTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<ActionPlanTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionPlanTemplateItem\>
        <actionPlanTemplateItemValue\>
            <name\>Subject</name\>
            <valueLiteral\>APT 01 Account Packaging APTI 01</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>Priority</name\>
            <valueLiteral\>Normal</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>ActivityDate</name\>
            <valueFormula\>StartDate + 10</valueFormula\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <displayOrder\>1</displayOrder\>
        <isRequired\>true</isRequired\>
        <itemEntityType\>Task</itemEntityType\>
        <name\>APT 01 Account Packaging APTI 01</name\>
        <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_01\_2827f387\_9dbc\_11e9\_920a\_e95716848ddd</uniqueName\>
    </actionPlanTemplateItem\>
    <actionPlanTemplateItem\>
        <actionPlanTemplateItemValue\>
            <name\>Subject</name\>
            <valueLiteral\>APT 01 Account Packaging APTI 02</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>Priority</name\>
            <valueLiteral\>Normal</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>ActivityDate</name\>
            <valueFormula\>StartDate + 10</valueFormula\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <displayOrder\>1</displayOrder\>
        <isRequired\>true</isRequired\>
        <itemEntityType\>Task</itemEntityType\>
        <name\>APT 01 Account Packaging APTI 02</name\>
        <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_02\_3430da7b\_9dbc\_11e9\_920a\_b5d3292906c3</uniqueName\>
    </actionPlanTemplateItem\>
    <actionPlanTemplateItem\>
        <actionPlanTemplateItemValue\>
            <name\>Subject</name\>
            <valueLiteral\>APT 01 Account Packaging APTI 03</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>Priority</name\>
            <valueLiteral\>Normal</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>ActivityDate</name\>
            <valueFormula\>StartDate + 10</valueFormula\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <displayOrder\>1</displayOrder\>
        <isRequired\>true</isRequired\>
        <itemEntityType\>Task</itemEntityType\>
        <name\>APT 01 Account Packaging APTI 03</name\>
        <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_03\_2d0363d9\_9dbc\_11e9\_920a\_219a003f176d</uniqueName\>
    </actionPlanTemplateItem\>
    <actionPlanTemplateItemDependencies\>
        <name\>APT Task Dependency</name\>
        <creationType\>OnPreviousItemCompleted</creationType\>
        <previousTemplateItem\>
            <actionPlanTemplateItemValue\>
                <name\>Subject</name\>
                    <valueLiteral\>APT 01 Account Packaging APTI 01</valueLiteral\>
                    <itemEntityType\>Task</itemEntityType\>
                </actionPlanTemplateItemValue\>
                <actionPlanTemplateItemValue\>
                    <name\>Priority</name\>
                    <valueLiteral\>Normal</valueLiteral\>
                    <itemEntityType\>Task</itemEntityType\>
                </actionPlanTemplateItemValue\>
                <actionPlanTemplateItemValue\>
                    <name\>ActivityDate</name\>
                    <valueFormula\>StartDate + 10</valueFormula\>
                    <itemEntityType\>Task</itemEntityType\>
            </actionPlanTemplateItemValue\>
            <displayOrder\>1</displayOrder\>
            <isRequired\>true</isRequired\>
            <itemEntityType\>Task</itemEntityType\>
            <name\>APT 01 Account Packaging APTI 01</name\>
            <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_01\_2827f387\_9dbc\_11e9\_920a\_e95716848ddd</uniqueName\>
        </previousTemplateItem\>
        <templateItem\>
            <actionPlanTemplateItemValue\>
            <name\>Subject</name\>
            <valueLiteral\>APT 01 Account Packaging APTI 02</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
            </actionPlanTemplateItemValue\>
            <actionPlanTemplateItemValue\>
                <name\>Priority</name\>
                <valueLiteral\>Normal</valueLiteral\>
                <itemEntityType\>Task</itemEntityType\>
            </actionPlanTemplateItemValue\>
            <actionPlanTemplateItemValue\>
                <name\>ActivityDate</name\>
                <valueFormula\>StartDate + 10</valueFormula\>
                <itemEntityType\>Task</itemEntityType\>
            </actionPlanTemplateItemValue\>
            <displayOrder\>1</displayOrder\>
            <isRequired\>true</isRequired\>
            <itemEntityType\>Task</itemEntityType\>
            <name\>APT 01 Account Packaging APTI 02</name\>
            <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_02\_3430da7b\_9dbc\_11e9\_920a\_b5d3292906c3</uniqueName\>
        </templateItem\>
    </actionPlanTemplateItemDependencies\>
    <description\>APT 01 Account Packaging Description</description\>
    <name\>APT 01 Account Packaging</name\>
    <targetEntityType\>Account</targetEntityType\>
    <actionPlanType\>Industries</actionPlanType\>
    <uniqueName\>APT\_01\_Account\_Packaging\_0c9e8b15\_9dbc\_11e9\_920a\_8d6ecf990219</uniqueName\>
    <isAdHocItemCreationEnabled\>false</isAdHocItemCreationEnabled\>
    <category\>Onboarding</category\>
    <subcategory\>OnBoarding Product</subcategory\>
    <estimatedCompletionDays\>4</estimatedCompletionDays\>
    <sourceType\>Migrated From SandBox</sourceType\>
    <fileBasedTemplatePath\>Action Plan Template</fileBasedTemplatePath\>
    <status\>Draft</status\>
</ActionPlanTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ActionPlanTemplate</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based.htm "HTML (New Window)").

<!-- document id=b25cccf5f783e50581e9c5fd265eaaf1abf1eb6460fdb95e6906185443cc3261 url=/legacydeveloper/current/en-us/api_meta/meta_actionssettings.md -->

# ActionsSettings

Represents an org’s actions settings for default quick actions, multi-dimensional publisher, and third-party actions. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

ActionsSettings values are stored in the Actions.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

Components are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableDefaultQuickActionsOn | boolean | Indicates whether default quick actions are created in the org (true, the default setting) or not (false). |
| enableDynamicActionsMobileStdObj | boolean | Indicates whether Dynamic Actions on Mobile is enabled (true) or not (false, the default setting). |
| enableMdpEnabled | boolean | Indicates whether multi-dimensional publisher is enabled (true, the default setting) or not (false). |
| enableThirdPartyActions | boolean | Indicates whether third-party actions are displayed in the multi-dimensional publisher (true) or not (false, the default setting). |
| enableOfflineWebLinks | boolean | Indicates whether a button or link is available offline (true), or if it's only available online (false, the default setting). |

## Declarative Metadata Sample Definition

The following is an example of an ActionsSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ActionsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<DefaultQuickActionsOn\>true</DefaultQuickActionsOn\>
	<MdpEnabled\>true</MdpEnabled\>
	<ThirdPartyActions\>true</ThirdPartyActions\>
</ActionsSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=c4c99e9c55ad2c2e6a067732583e9de3c76124fa5379f22d8422af89f81c0d53 url=/legacydeveloper/current/en-us/api_meta/meta_activationplatform.md -->

# ActivationPlatform

Represents the ActivationPlatform configuration, such as platform name, delivery schedule, output format, and destination folder.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActivationPlatform components have the suffix .activationPlatform and are stored in the activationPlatforms folder.

## Version

ActivationPlatform components are available in API version 54.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| activationPlatformConnectorType | 
Field Type

ActivationPlatformConnectorType (enumeration of type string)

Description

Reserved for future use.



 |
| activationPlatformAdditionalMetadata | 

Field Type

string

Description

Provides additional details about the activation platform, including subscriber override options, partner supported IDs, and file output properties such as maximum file size, compression settings, and the maximum number of records per file.



 |
| dataConnector | 

Field Type

string

Description

Reference to the ActvPfrmDataConnectorS3 metadata type, which contains S3 bucket and export directory information into which Data 360 writes data.



 |
| description | 

Field Type

string

Description

Required.

The description for ActivationPlatform.



 |
| enabled | 

Field Type

boolean

Description

Required.

Indicates whether the ActivationPlatform is enabled (true) or not (false). The default is false.



 |
| includeSegmentNames | 

Field Type

boolean

Description

Indicates whether to include the segment name in metadata (true) or not (false).



 |
| logoUrl | 

Field Type

string

Description

URL of the logo for the activation channel destination.



 |
| masterLabel | 

Field Type

string

Description

Required.

The name for the activation channel destination.



 |
| notes | 

Field Type

string

Description

Notes for this ActivationPlartform.



 |
| outputFormat | 

Field Type

ActivationPlatformFileOutputFormat (enumeration of type string)

Description

Required.

The output format of the file.

Valid values are:

- CSV
- JSON
- PARQUET





 |
| outputGrouping | 

Field Type

ActivationPlatformFileOutputGrouping (enumeration of type string)

Description

Required.

The grouping of the output.

Valid values are:

- PER\_ACCOUNT
- PER\_SEGMENT
- PER\_USER





 |
| periodicRefreshFrequecy | 

Field Type

ActivationPlatformPeriodicFullRefresh (enumeration of type string)

Description

The frequency (in days) for periodic full refreshes when using incremental refresh mode.

Valid values are:

- REFRESH\_30
- REFRESH\_60





 |
| platformType | 

Field Type

ActivationPlatformType (enumeration of type string)

Description

Required.

The type of the Activation Platform.

Valid values are:

- Advertising
- Analytics
- Marketing
- Publishing
- Technology





 |
| refreshFrequency | 

Field Type

ActivationPlatformRefreshFrequency (enumeration of type string)

Description

Required.

Indicates how often the activation platform accepts data delivery.

Valid value is:

- TWENTY\_FOUR





 |
| refreshMode | 

Field Type

ActivationPlatformRefreshMode (enumeration of type string)

Description

Required.

Defines how the refresh method handles refreshing files.

Valid values are:

- FULL
- INCREMENTAL





 |

## Declarative Metadata Sample Definition

The following is an example of an ActivationPlatform component.

<?xml version="1.0" encoding="UTF-8"?>
<ActivationPlatform xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataConnector\>S3Connector</dataConnector\>
    <description\>Activation Platform Description</description\>
    <enabled\>false</enabled\>
    <includeSegmentNames\>false</includeSegmentNames\>
    <logoUrl\>link to logo</logoUrl\>
    <masterLabel\>MyExternalPlatform</masterLabel\>
    <notes\>Notes about this Platform</notes\>
    <outputFormat\>CSV</outputFormat\>
    <outputGrouping\>PER\_ACCOUNT</outputGrouping\>
    <refreshMode\>FULL</refreshMode\>
    <refreshFrequency\>TWENTY\_FOUR</refreshFrequency\>
    <periodicRefreshFrequecy\>NEVER</periodicRefreshFrequecy\>
    <platformType\>Advertising</platformType\>
</ActivationPlatform\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>MyActivationPlatform</fullName\>
    <types\>
        <members\>APlatform</members\>
        <name\>ActivationPlatform</name\>
    </types\>
    <types\>
        <members\>AccountIdField</members\>
        <name\>ActivationPlatformField</name\>
    </types\>
    <types\>
        <members\>S3Connector</members\>
        <name\>ActvPfrmDataConnectorS3</name\>
    </types\>
    <types\>
        <members\>EmailIdentifier</members\>
        <name\>ActvPlatformAdncIdentifier</name\>
    </types\>
    <types\>
        <members\>AccountIdFieldValue</members\>
        <name\>ActvPlatformFieldValue</name\>
    </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=51828e77bd5bf7c93289cf1a7d530fc501610170b4814d2fbacd71b6246a6d0d url=/legacydeveloper/current/en-us/api_meta/meta_activationplatformactvattr.md -->

# ActivationPlatformActvAttr

Represents the information about activation attributes. Reserved for future use.

<!-- document id=de32baef98f2ae75f408c6b385b59750c907bef28f57bed21d46bb8b60d779f0 url=/legacydeveloper/current/en-us/api_meta/meta_activationplatformfield.md -->

# ActivationPlatformField

Represents the information about the fields used in ActivationPlatform.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActivationPlatformField components have the suffix .activationPlatformField and are stored in the activationPlatformFields folder.

## Version

ActivationPlatformField components are available in API version 54.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| activationPlatform | 
Field Type

string

Description

Required.

Reference to the ActivationPlatform metadata type.



 |
| helpText | 

Field Type

string

Description

Information about ActivationPlatformField.



 |
| isHidden | 

Field Type

boolean

Description

Required.

Indicates whether ActivationPlatformField can be overridden by marketer (false) or not (true). The default is false. Field can’t be overridden by marketer when set to true.



 |
| isRequired | 

Field Type

boolean

Description

Required.

Indicates whether this ActivationPlatformField is required (true) or not (false). The default is false.



 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the ActivationPlaformField.



 |
| type | 

Field Type

ActivationPlatformFieldDataType (enumeration of type string)

Description

Represents the datatype of the field.

Valid value is:

- Text





 |

## Declarative Metadata Sample Definition

The following is an example of an ActivationPlatformField component.

<?xml version="1.0" encoding="UTF-8"?>
<ActivationPlatformField xmlns="http://soap.sforce.com/2006/04/metadata">
    <activationPlatform\>APlatform</activationPlatform\>
    <isHidden\>false</isHidden\>
    <isRequired\>true</isRequired\>
    <masterLabel\>AccountId</masterLabel\>
</ActivationPlatformField\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>MyActivationPlatform</fullName\>
    <types\>
        <members\>APlatform</members\>
        <name\>ActivationPlatform</name\>
    </types\>
    <types\>
        <members\>AccountIdField</members\>
        <name\>ActivationPlatformField</name\>
    </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=1626fb81c966abf155097eeaee06e8afade8cf82d778e32551ace0a7cdab5bee url=/legacydeveloper/current/en-us/api_meta/meta_activitiessettings.md -->

# ActivitiesSettings

Represents an org's activity settings, and its user interface settings for the calendar. This type extends the Metadata metadata type and inherits its fullName field.

Use the ActivitiesSettings component type to control the following activity settings:

- Configure group and recurring tasks, recurring and multiday events, and email tracking
- Relate multiple contacts to tasks and events (shared activities)
- Display custom logos in meeting requests

Also use the ActivitiesSettings component type to control user interface settings for the calendar, including hover links and drag-and-drop editing.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

ActivitiesSettings values are stored in the Activities.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ActivitiesSettings is available in API versions 28.0 and later.

## Fields

Settings for all types listed below are controlled on the Activity Settings page or the User Interface settings page as noted.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d81320e124">Field Name</th>

              <th class="featureTableHeader  " id="d81320e127">Field Type</th>

              <th class="featureTableHeader  " id="d81320e130">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname" id="allow_shared_activities"><a name="allow_shared_activities"><!-- --></a>allowUsersToRelateMultipleContactsToTasksAndEvents</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">
                <span class="ph" id="allow_shared_activities_desc"><a name="allow_shared_activities_desc"><!-- --></a>This field indicates
                  whether Shared Activities is enabled. When the value is true,
                  allows users to relate multiple contacts to a task or event.
                </span>
                <div class="box message confirm" id="shared_activities_mdapi_note">
                  <a name="shared_activities_mdapi_note"><!-- --></a>
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                        <div class="mediaBd">
                          <h4 class="mbs">Important</h4>
                          <p>Beginning with API v36.0, this field is read-only in all
                            versions of the API. You can’t change the value of this field.
                            Even though this field was updateable before Spring '16,
                            changing this field’s value wasn't supported and could have
                            resulted in an incorrect integration. If you have code in older
                            API versions that changes the value of this field, ensure that
                            you update that code to prevent any errors.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname" id="auto_relate_attendees"><a name="auto_relate_attendees"><!-- --></a>autoRelateEventAttendees</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">When users add attendees to
                events, events are automatically related to up to 50 contacts or one
                lead. An attendee is matched by their email address to a contact or
                lead. <p class="p">Admins control this field on the Activity Settings
                  page.</p>
                <p class="p">Available in API version 42.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableActivityReminders</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enables popup activity reminders for an organization.<p class="p">Admins
                  control this field on the Activity Settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableCalendarHomeLWC</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enables Lightning Web Components for Calendar. Increases the
                default item limit in Calendar Home and applies styling enhancements
                to improve readability. <p class="p">Admins control this field on the Activity
                  Settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableClickCreateEvents</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Lets users create events in day and weekly calendar views by
                double-clicking a specific time slot and entering the details of the
                event in an overlay. Hovering over an event displays an overlay
                where users can view the event details or delete the event without
                leaving the page. Admins use a mini page layout to configure the
                fields shown in the overlays. Doesn’t support recurring events or
                multi-person events.<p class="p">Admins control this field on the User
                  Interface settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableDragAndDropScheduling</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Lets users create events associated with records by dragging a
                record from a list view onto a calendar view and entering the
                details of the event in an overlay. Hovering over an event displays
                an overlay where users can view the event details or delete the
                event without leaving the page. Admins use a mini page layout to
                configure the fields shown in the overlays.<p class="p">Admins control this
                  field on the User Interface settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableEmailTracking</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enables tracking of outbound HTML emails if an organization uses
                HTML email templates.<p class="p">Admins control this field on the Activity
                  Settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableFlowTaskNotifsViaApex</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">If Apex invokes Process Builder to create a task, determines
                whether an email is sent (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableGroupTasks</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Lets users assign independent copies of a new task to multiple
                users.<p class="p">Admins control this field on the Activity Settings
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableHideChildEventsPreference</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enables hiding child events from the calendar or activity views.
                This setting is useful if you have complex event hierarchies and
                want to simplify the views by hiding less relevant details. This
                field is available in API version 50.0 and later.<p class="p">Admins control
                  this field on the Activity Settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableListViewScheduling</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Extends the functionality of
                <span class="keyword parmname">enableDragAndDropScheduling</span> and
                <span class="keyword parmname">enableClickCreateEvents</span> to list view
                calendars.<p class="p">Admins control this field on the User Interface
                  settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableLogNote</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enables the option to create and associate a note on an existing
                record.</td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableMLSingleClientProfile</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enable creating a client profile using machine learning. When
                this setting is enabled, Salesforce uses machine learning algorithms
                to analyze and consolidate client data, providing a more
                comprehensive client profile. This can help sales and service teams
                to better understand their clients and provide more personalized
                interactions. This field is available in API version 50.0 and
                later.<p class="p">Admins control this field on the Activity Settings
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableMultidayEvents</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enables creation of events that end more than 24 hours after they
                start.<p class="p">Admins control this field on the Activity Settings
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableRecurringEvents</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enables creation of events that repeat at specified
                intervals.<p class="p">Admins control this field on the Activity Settings
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableRecurringTasks</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enables creation of tasks that repeat at specified
                intervals.<p class="p">Admins control this field on the Activity Settings
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableRollUpActivToContactsAcct</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Enables a contact’s activities to be rolled up and
                displayed on the contact’s primary account. Default value is
                <samp class="codeph nolang">true</samp>.<p class="p">Available in API
                  versions 47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableSidebarCalendarShortcut</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">In the sidebar, displays a shortcut link to a user’s
                last-used calendar view.<p class="p">Admins control this field on the Activity
                  Settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableSimpleTaskCreateUI</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Allows admins to specify whether tapping New Task in Salesforce
                opens a regular task record edit page or a page that displays key
                task fields first.<p class="p">Admins control this field on the Activity
                  Settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableTimelineCompDateSort</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Allows admins to sort past activities by completed date (<samp class="codeph nolang">true</samp>). If <samp class="codeph nolang">false</samp>, activities are sorted by due
                date.<p class="p">Admins control this field on the Activity Settings
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableUNSTaskDelegatedToNotifications</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">On the Activity Settings page, exposes a setting for Admins to
                hide or show a user setting that lets individual users enable or
                disable email notifications when tasks are assigned to them.</td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">enableUserListViewCalendars</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Allows users to create and view user list view calendars in
                Lightning Experience. Available in API versions 47.0 and
                later</td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">meetingRequestsLogo</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">string</td>

              <td class="entry" headers="d81320e130" data-title="Description">Available when <span class="keyword parmname">showCustomLogoMeetingRequests</span>
                is enabled. Uploads a custom logo. An administrator can select only
                a logo that has been uploaded to certain folders in the Documents
                tab.<p class="p">Admins control this field on the Activity Settings
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">showCustomLogoMeetingRequests</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Displays a custom logo in meeting request emails and on a
                meeting’s Web page. Invitees see the logo when a user either
                invites them to an event or requests a meeting.<p class="p">Admins control
                  this field on the Activity Settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">showEventDetailsMultiUserCalendar</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">Displays event details on-screen rather than in hover
                text.<p class="p">Admins control this field on the Activity Settings
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">showHomePageHoverLinksForEvents</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">In the calendar section of the Home tab:<ul class="ul bulletList">
                  <li class="li">When a user hovers over the subject of an event, a hover
                    link displays an overlay with selected event details. (Hover
                    links are always available in other calendar views.)</li>

                  <li class="li">When a user clicks the subject of an event, displays the
                    event detail page.</li>

                </ul>
                <p class="p">Admins use a mini page layout to configure the fields shown
                  in the overlay.</p>
                <p class="p">Admins control this field on the User
                  Interface settings page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d81320e124" data-title="Field Name"><span class="keyword parmname">showMyTasksHoverLinks</span></td>

              <td class="entry" headers="d81320e127" data-title="Field Type">boolean</td>

              <td class="entry" headers="d81320e130" data-title="Description">In the My Tasks section of the Home tab and on the calendar day view:<ul class="ul bulletList">
                  <li class="li">When a user hovers over the subject of a task, a hover link
                    displays an overlay with selected task details.</li>

                  <li class="li">When a user clicks the subject of a task, displays the task
                    detail page.</li>

                </ul>
                <p class="p">Admins use a mini page layout to configure the fields shown
                  in the overlay.</p>
                <p class="p">Admins control this field on the User
                  Interface settings page.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the activity settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Activities</members\>
        <name\>Settings</name\>
    </types\>
    <version\>28.0</version\>
</Package\>

## Declarative Metadata Sample Definition

The following is an example of an activity settings file:

<?xml version="1.0" encoding="UTF-8"?>
<ActivitiesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableActivityReminders\>true</enableActivityReminders\>
    <autoRelateEventAttendees\>true</autoRelateEventAttendees\>
    <enableClickCreateEvents\>true</enableClickCreateEvents\>
    <enableDragAndDropScheduling\>true</enableDragAndDropScheduling\>
    <enableEmailTracking\>true</enableEmailTracking\>
    <enableGroupTasks\>true</enableGroupTasks\>
    <enableListViewScheduling\>true</enableListViewScheduling\>
    <enableMultidayEvents\>true</enableMultidayEvents\>
    <enableRecurringEvents\>true</enableRecurringEvents\>
    <enableRollUpActivToContactsAcct\>true</enableRollUpActivToContactsAcct\>
    <enableRecurringTasks\>true</enableRecurringTasks\>
    <enableTimelineCompDateSort\>true</enableTimelineCompDateSort\>
    <enableUserListViewCalendars\>true</enableUserListViewCalendars\>
    <enableSidebarCalendarShortcut\>true</enableSidebarCalendarShortcut\>
    <meetingRequestsLogo\>Folder02/logo03.png</meetingRequestsLogo\>
    <showCustomLogoMeetingRequests\>true</showCustomLogoMeetingRequests\>
    <showEventDetailsMultiUserCalendar\>true</showEventDetailsMultiUserCalendar\>
    <showHomePageHoverLinksForEvents\>true</showHomePageHoverLinksForEvents\>
    <showMyTasksHoverLinks\>true</showMyTasksHoverLinks\>
</ActivitiesSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Document](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_document.htm "Represents a Document. All documents must be in a document folder, such as sampleFolder/TestDocument.")

<!-- document id=c45d4ad6c95e10b3a5d6951fb76bab32216308a291958e14332dab98fb196095 url=/legacydeveloper/current/en-us/api_meta/meta_actvpfrmdataconnectors3.md -->

# ActvPfrmDataConnectorS3

Represents the Amazon S3 bucket name and export directory.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActvPfrmDataConnectorS3 components have the suffix .actvPfrmDataConnectorS3 and are stored in the actvPfrmDataConnectorS3s folder.

## Version

ActvPfrmDataConnectorS3 components are available in API version 54.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| bucketName | 
Field Type

string

Description

Required.

The Amazon S3 bucket name.



 |
| exportDirectory | 

Field Type

string

Description

This is an optional field that is reserved for internal use.



 |
| masterLabel | 

Field Type

string

Description

Required.

The display name of ActvPfrmDataConnectorS3.



 |

## Declarative Metadata Sample Definition

The following is an example of an ActvPfrmDataConnectorS3 component.

<?xml version="1.0" encoding="UTF-8"?>
<ActvPfrmDataConnectorS3 xmlns="http://soap.sforce.com/2006/04/metadata">
    <bucketName\>MyS3Bucket</bucketName\>
    <exportDirectory\>Output</exportDirectory\>
    <masterLabel\>S3Connector</masterLabel\>
</ActvPfrmDataConnectorS3\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>MyActivationPlatform</fullName\>
    <types\>
        <members\>APlatform</members\>
        <name\>ActivationPlatform</name\>
    </types\>
    <types\>
        <members\>S3Connector</members\>
        <name\>ActvPfrmDataConnectorS3</name\>
    </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=e3defcd59588aff12ebcceead3991dec227929786079b213cecdf54dfcdcdc84 url=/legacydeveloper/current/en-us/api_meta/meta_actvplatformadncidentifier.md -->

# ActvPlatformAdncIdentifier

Represents the information about the identifiers to be activated, such as Email, Phone, Mobile Advertiser (MAID) ID, and Over-the-top (OTT) ID.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActvPlatformAdncIdentifier components have the suffix .actvPlatformAdncIdentifier and are stored in the actvPlatformAdncIdentifiers folder.

## Version

ActvPlatformAdncIdentifier components are available in API version 54.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| activationPlatform | 
Field Type

string

Description

Required.

Reference to the ActivationPlatform metadata type.Reference to ActivationPlatform.



 |
| identifierHashMethod | 

Field Type

ActivationPlatformIdentifierHashMethod (enumeration of type string)

Description

The hash method of the identifier type. The supported hash method for Email and Phone is SHA256. The supported hash method for MAID and OTT is NONE.



 |
| identifierType | 

Field Type

ActivationPlatformIdentifierType (enumeration of type string)

Description

Required.

The type of identifier to be activated.

Valid values are:

- EMAIL
- MAID
- OTT
- PHONE





 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the identifier.



 |

## Declarative Metadata Sample Definition

The following is an example of an ActvPlatformAdncIdentifier component.

<?xml version="1.0" encoding="UTF-8"?>
<ActvPlatformAdncIdentifier xmlns="http://soap.sforce.com/2006/04/metadata">
    <activationPlatform\>APlatform</activationPlatform\>
    <identifierHashMethod\>SHA256</identifierHashMethod\>
    <identifierType\>EMAIL</identifierType\>
    <masterLabel\>EmailIdentifier</masterLabel\>
</ActvPlatformAdncIdentifier\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>MyActivationPlatform</fullName\>
    <types\>
        <members\>APlatform</members\>
        <name\>ActivationPlatform</name\>
    </types\>
    <types\>
        <members\>EmailIdentifier</members\>
        <name\>ActvPlatformAdncIdentifier</name\>
    </types\> 
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=eb62f6e4f07a3dd36c2235f3791ecbc62789d0588e69d48e9156971722a1f192 url=/legacydeveloper/current/en-us/api_meta/meta_actvplatformfieldvalue.md -->

# ActvPlatformFieldValue

Represents the field values for the ActivationPlatformFields.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActvPlatformFieldValue components have the suffix .actvPlatformFieldValue and are stored in the actvPlatformFieldValues folder.

## Version

ActvPlatformFieldValue components are available in API version 54.0 and later.

## Special Access Rules

## Fields

| Field Name | Description |
| --- | --- |
| activationPlatformField | 
Field Type

string

Description

Required.

Reference to the ActivationPlatform metadata type.



 |
| isDefault | 

Field Type

boolean

Description

Required.

Indicates whether the value is default (true) or not (false). The default is false. Picklist isn’t supported in API version 54.0



 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the field.



 |
| value | 

Field Type

string

Description

The value of activationPlatformField.



 |

## Declarative Metadata Sample Definition

The following is an example of an ActvPlatformFieldValue component.

Field with no value:

<ActvPlatformFieldValue xmlns="http://soap.sforce.com/2006/04/metadata">
    <activationPlatformField\>AccountIdField</activationPlatformField\>
    <isDefault\>true</isDefault\>
    <masterLabel\>AccountIdValue</masterLabel\>
    <value\>null</value\>
</ActvPlatformFieldValue\>

Field with value:

<ActvPlatformFieldValue xmlns="http://soap.sforce.com/2006/04/metadata">
    <activationPlatformField\>AccountIdField</activationPlatformField\>
    <isDefault\>true</isDefault\>
    <masterLabel\>AccountIdValue</masterLabel\>
    <value\>1234</value\>
</ActvPlatformFieldValue\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>MyActivationPlatform</fullName\>
    <types\>
        <members\>APlatform</members\>
        <name\>ActivationPlatform</name\>
    </types\>
    <types\>
        <members\>AccountIdField</members\>
        <name\>ActivationPlatformField</name\>
    </types\>
    <types\>
        <members\>AccountIdValue</members\>
        <name\>ActvPlatformFieldValue</name\>
    </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=9210d1509c9f7714d625502e2fddea79e31a1a42908e136bec6518719e4e2337 url=/legacydeveloper/current/en-us/api_meta/meta_addresssettings.md -->

# AddressSettings

Represents the configuration of country/territory and state picklists. Use the AddressSettings component type to configure state and country/territory data in your organization so that you can convert text-based values into standard picklist values. To convert your state and country/territory values, from Setup, enter State and Country/Territory Picklists in the Quick Find box, then select **State and Country/Territory Picklists**.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## Declarative Metadata File Suffix and Directory Location

AddressSettings values are stored in a single file named Address.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AddressSettings is available in API versions 27.0 and later.

## Salesforce CLI Usage

When working with the Salesforce CLI, use the metadata type Settings:Address to deploy or retrieve address settings.

## CountriesAndStates

This complex metadata type represents valid definitions of states and countries/territories in picklists.

| Field | Field Type | Description |
| --- | --- | --- |
| countries | Country\[\] | The countries and territories available in picklists. |

## Country

This metadata type provides the definition for a country/territory in a picklist.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d84981e191">Field</th>

              <th class="featureTableHeader  " id="d84981e194">Field Type</th>

              <th class="featureTableHeader  " id="d84981e197">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d84981e191" data-title="Field"><span class="ph" id="active_field"><a name="active_field"><!-- --></a><span class="keyword parmname">active</span></span></td>

              <td class="entry" headers="d84981e194" data-title="Field Type">boolean</td>

              <td class="entry" headers="d84981e197" data-title="Description">
                <span class="ph" id="active_def"><a name="active_def"><!-- --></a>Determines whether the value is available in the
                  API.</span>
                <div class="box message confirm" id="active_note">
                  <a name="active_note"><!-- --></a>
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                        <div class="mediaBd">
                          <h4 class="mbs">Important</h4>
                          <p>After you enable state and
                            country/territory picklists in your Salesforce organization, you can’t set the
                            <span class="keyword parmname">active</span> status to
                            <kbd class="ph userinput">false</kbd>.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e191" data-title="Field"><span class="ph" id="iv_field"><a name="iv_field"><!-- --></a><span class="keyword parmname">integrationValue</span></span></td>

              <td class="entry" headers="d84981e194" data-title="Field Type">string</td>

              <td class="entry" headers="d84981e197" data-title="Description">
                <div class="p" id="iv_def">
                  <a name="iv_def"><!-- --></a>A customizable text value that is linked to a state or
                  country/territory code. Integration values for standard states, countries, and
                  territories default to the full ISO-standard state, country, and territory names.
                  Integration values function similarly to the API names of custom fields and
                  objects. Configuring integration values allows integrations that you set up before
                  enabling state and country/territory picklists to continue to work.<div class="box message confirm">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                          <div class="mediaBd">
                            <h4 class="mbs">Important</h4>
                            <p>If you don’t specify integration values before enabling state
                              and country/territory picklists in your organization, records use the default
                              value provided by Salesforce. If you change integration values later, records
                              created or updated from that point on use your edited values.</p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e191" data-title="Field"><span class="ph" id="code_field"><a name="code_field"><!-- --></a><span class="keyword parmname">isoCode</span></span></td>

              <td class="entry" headers="d84981e194" data-title="Field Type">string</td>

              <td class="entry" headers="d84981e197" data-title="Description">
                <span class="ph" id="code_def"><a name="code_def"><!-- --></a>The ISO-standard code populates this field when you issue a
                  <samp class="codeph nolang">retrieve()</samp> call. </span> You can’t edit the
                <span class="keyword parmname">isoCode</span> of <span class="keyword parmname">standard</span> states, countries,
                and territories.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e191" data-title="Field"><span class="ph" id="label_field"><a name="label_field"><!-- --></a><span class="keyword parmname">label</span></span></td>

              <td class="entry" headers="d84981e194" data-title="Field Type">string</td>

              <td class="entry" headers="d84981e197" data-title="Description"><span class="ph" id="label_def"><a name="label_def"><!-- --></a>The label is what users see in picklists in
                  Salesforce.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e191" data-title="Field"><span class="ph" id="orgdef_field"><a name="orgdef_field"><!-- --></a><span class="keyword parmname">orgDefault</span></span></td>

              <td class="entry" headers="d84981e194" data-title="Field Type">boolean</td>

              <td class="entry" headers="d84981e197" data-title="Description"><span class="ph" id="orgdef_desc"><a name="orgdef_desc"><!-- --></a>Sets a country or territory as the default value for new
                  records in the Salesforce organization.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e191" data-title="Field"><span class="ph" id="std_field"><a name="std_field"><!-- --></a><span class="keyword parmname">standard</span></span></td>

              <td class="entry" headers="d84981e194" data-title="Field Type">boolean</td>

              <td class="entry" headers="d84981e197" data-title="Description"><span class="ph" id="std_def"><a name="std_def"><!-- --></a>Standard states and countries are states and countries that
                  are included with Salesforce. You can’t edit the <span class="keyword parmname">standard</span>
                  attribute.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e191" data-title="Field"><span class="keyword parmname">states</span></td>

              <td class="entry" headers="d84981e194" data-title="Field Type">State[]</td>

              <td class="entry" headers="d84981e197" data-title="Description">The states or provinces that are part of the country or territory.</td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e191" data-title="Field"><span class="ph" id="vis_field"><a name="vis_field"><!-- --></a><span class="keyword parmname">visible</span></span></td>

              <td class="entry" headers="d84981e194" data-title="Field Type">boolean</td>

              <td class="entry" headers="d84981e197" data-title="Description"><span class="ph" id="vis_def"><a name="vis_def"><!-- --></a>Makes the state, country, or territory available to users in
                  Salesforce. States, countries, or territories that are
                  <span class="keyword parmname">visible</span> must also be
                  <span class="keyword parmname">active</span>.</span></td>

            </tr>

          </tbody>

        </table>

## State

This metadata type provides the definition for a state in a picklist.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d84981e380">Field</th>

              <th class="featureTableHeader  " id="d84981e383">Field Type</th>

              <th class="featureTableHeader  " id="d84981e386">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d84981e380" data-title="Field"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d84981e383" data-title="Field Type">boolean</td>

              <td class="entry" headers="d84981e386" data-title="Description">Determines whether the value is available in the API.<div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                        <div class="mediaBd">
                          <h4 class="mbs">Important</h4>
                          <p>After you enable state and country/territory picklists in your Salesforce
                            organization, you can’t set the <span class="keyword parmname">active</span> status to
                            <kbd class="ph userinput">false</kbd>.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e380" data-title="Field"><span class="keyword parmname">integrationValue</span></td>

              <td class="entry" headers="d84981e383" data-title="Field Type">string</td>

              <td class="entry" headers="d84981e386" data-title="Description">
                <div class="p">A customizable text value that is linked to a state or country/territory code.
                  Integration values for standard states, countries, and territories default to the
                  full ISO-standard state, country, and territory names. Integration values function
                  similarly to the API names of custom fields and objects. Configuring integration
                  values allows integrations that you set up before enabling state and
                  country/territory picklists to continue to work.<div class="box message confirm">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                          <div class="mediaBd">
                            <h4 class="mbs">Important</h4>
                            <p>If you
                              don’t specify integration values before enabling state and country/territory
                              picklists in your organization, records use the default value provided by
                              Salesforce. If you change integration values later, records created or updated
                              from that point on use your edited values.</p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e380" data-title="Field"><span class="keyword parmname">isoCode</span></td>

              <td class="entry" headers="d84981e383" data-title="Field Type">string</td>

              <td class="entry" headers="d84981e386" data-title="Description"> The ISO-standard code populates this field when you issue a <samp class="codeph nolang">retrieve()</samp> call. </td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e380" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d84981e383" data-title="Field Type">string</td>

              <td class="entry" headers="d84981e386" data-title="Description">The label is what users see in picklists in Salesforce.</td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e380" data-title="Field"><span class="keyword parmname">standard</span></td>

              <td class="entry" headers="d84981e383" data-title="Field Type">boolean</td>

              <td class="entry" headers="d84981e386" data-title="Description">Standard states and countries are states and countries that are included with
                Salesforce. You can’t edit the <span class="keyword parmname">standard</span> attribute.</td>

            </tr>

            <tr>
              <td class="entry" headers="d84981e380" data-title="Field"><span class="keyword parmname">visible</span></td>

              <td class="entry" headers="d84981e383" data-title="Field Type">boolean</td>

              <td class="entry" headers="d84981e386" data-title="Description">Makes the state, country, or territory available to users in Salesforce.
                States, countries, or territories that are <span class="keyword parmname">visible</span> must also be
                <span class="keyword parmname">active</span>.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is sample XML that configures state and country picklists for the United States and Canada for use in an organization. It also makes the country of Greenland available only in the API. This example is supported in API version 68.0.

<?xml version="1.0" encoding="UTF-8"?>
<AddressSettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <countriesAndStates\>
    <countries\>
      <country\>
        <active\>true</active\>
        <integrationValue\>United States</integrationValue\>
        <isoCode\>US</isoCode\>
        <label\>United States</label\>
        <orgDefault\>true</orgDefault\>
        <standard\>true</standard\>
        <states\>
          <state\>
            <active\>true</active\>
            <integrationValue\>Alabama</integrationValue\>
            <isoCode\>AL</isoCode\>
            <label\>Alabama</label\>
            <standard\>true</standard\>
            <visible\>true</visible\>
          </state\>
          <state\>
            <active\>true</active\>
            <integrationValue\>Alaska</integrationValue\>
            <isoCode\>AK</isoCode\>
            <label\>Alaska</label\>
            <standard\>true</standard\>
            <visible\>true</visible\>
          </state\>
        </states\>
        <visible\>true</visible\>
      </country\>
      <country\>
        <active\>true</active\>
        <integrationValue\>Canada</integrationValue\>
        <isoCode\>CA</isoCode\>
        <label\>Canada</label\>
        <orgDefault\>false</orgDefault\>
        <states\>
          <state\>
            <active\>true</active\>
            <integrationValue\>Alberta</integrationValue\>
            <isoCode\>AB</isoCode\>
            <label\>Alberta</label\>
             <standard\>true</standard\>
             <visible\>true</visible\>
          </state\>
          <state\>
            <active\>true</active\>
            <integrationValue\>British Columbia</integrationValue\>
            <isoCode\>BC</isoCode\>
            <label\>British Columbia</label\>
            <standard\>true</standard\>
            <visible\>true</visible\>
          </state\>
        </states\>
        <visible\>true</visible\>
      </country\>
      <country\>
        <active\>true</active\>
        <integrationValue\>Greenland</integrationValue\>
        <isoCode\>GL</isoCode\>
        <label\>Greenland</label\>
        <standard\>true</standard\>
        <visible\>false</visible\>
      </country\>
    </countries\>
  </countriesAndStates\>
</AddressSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6feead7cc3006928ba26f0d36617866dba37660230b58fe5fca4d1ff36171f92 url=/legacydeveloper/current/en-us/api_meta/meta_advaccountforecastset.md -->

# AdvAccountForecastSet

Represents the forecast sets that define the forecast configurations for each business unit or different groups of accounts. With separate forecast sets at account or business unit level, you can focus on account-specific data and manage configuration updates for one business unit without impacting any other business unit’s data.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AdvAccountForecastSet components have the suffix .advAccountForecastSet and are stored in the AdvAccountForecastSet folder.

## Version

AdvAccountForecastSet components are available in API version 53.0 and later.

## Special Access Rules

The advanced account forecasting feature setting for Manufacturing Cloud is required to create an advanced account forecast set.

## Fields

| Field Name | Description |
| --- | --- |
| accountFieldName | 
Field Type

string

Description

The field name for the account in the advanced account forecast fact record.



 |
| calculationFrequency | 

Field Type

AdvAcctFcstCalcFrequency (enumeration of type string)

Description

The frequency at which the forecast set is recalculated automatically.

Possible values are:

- Monthly
- Quarterly
- Weekly
- Yearly

The default value is Monthly.



 |
| description | 

Field Type

string

Description

The description of the advanced account forecast set record.



 |
| dimensions | 

Field Type

[AdvAcctForecastDimension\[\]](#AdvAcctForecastDimension)

Description

The dimensions selected for an advanced account forecast set to categorize the forecast data.



 |
| displayGroups | 

Field Type

[AdvAcctFrcstDisplayGroup\[\]](#AdvAcctFrcstDisplayGroup)

Description

The information about the groups for the advanced account forecast set measures or dimensions.



 |
| forecastAdjPeriods | 

Field Type

[AdvAcctForecastAdjPeriod\[\]](#AdvAcctForecastAdjPeriod)

Description

The details about the adjustment period of the advanced account forecast values.



 |
| forecastFactObjectName | 

Field Type

string

Description

Required.

The API name of the object that contains the advanced forecast fact records.



 |
| forecastFormulas | 

Field Type

[AdvAccountForecastFormula\[\]](#AdvAccountForecastFormula)

Description

The formulas based on which forecast values are calculated.



 |
| forecastPeriodGroupName | 

Field Type

string

Description

Required.

The name of the advanced account forecast period group record.



 |
| forecastQuantityFieldName | 

Field Type

string

Description

The field name for the forecast quantity in the advanced account forecast fact record.



 |
| forecastRevenueFieldName | 

Field Type

string

Description

The field name for the forecast revenue in the advanced account forecast record.



 |
| forecastSetFieldName | 

Field Type

string

Description

The field name for the Forecast Set ID in the advanced account forecast fact record.



 |
| forecastSetName | 

Field Type

string

Description

Required.

The name of the advanced account forecast set record.



 |
| forecastStatusFieldName | 

Field Type

string

Description

The field name for the status in the advanced account forecast fact record.



 |
| generationDpeDefName | 

Field Type

string

Description

The name of the data processing engine (DPE) definition that’s used to generate advanced account forecast fact records.



 |
| measureDefinitions | 

Field Type

[AdvAcctForecastMeasureDef\[\]](#AdvAcctForecastMeasureDef)

Description

The measures to display in the advanced account forecasts grid for the forecast set.



 |
| periodFieldName | 

Field Type

string

Description

The field name for the period in the advanced account forecast fact record.



 |
| recalculateDpeDefName | 

Field Type

string

Description

The name of the data processing engine definition that’s used to recalculate the advanced account forecast fact records.



 |
| regenerationDpeDefName | 

Field Type

string

Description

The name of the data processing engine definition that’s used to regenerate the advanced account forecast fact records.



 |
| rolloverDpeDefName | 

Field Type

string

Description

The data processing engine definition that’s used to generate the rollover advanced account forecast fact records.



 |
| rolloverFrequency | 

Field Type

AdvAcctFcstCalcFrequency (enumeration of type string)

Description

The frequency of rollover of the advanced account forecast records.

Possible values are:

- Monthly
- Quarterly
- Weekly
- Yearly

The default value is Monthly.



 |
| status | 

Field Type

AdvAccForecastSetStatus (enumeration of type string)

Description

Required.

The status of the advanced account forecast set.

Possible values are:

- Active
- Inactive





 |

## AdvAccountForecastFormula

Represents the formulas that are used to calculate forecast values in real time after applying the DPE calculations. For example, processing forecast rollover for all accounts at the start of a month.

| Field Name | Description |
| --- | --- |
| endPeriod | 
Field Type

int

Description

Required.

The period until when the forecast formula is applicable.



 |
| formulaExpression | 

Field Type

string

Description

Required.

The formula based on which forecast values are calculated.



 |
| formulaType | 

Field Type

AdvAcctFcstFormulaType (enumeration of type string)

Description

Required.

Specifies the calculation type for the formula.

Possible values are:

- QUANTITY
- REVENUE

The default value is QUANTITY.



 |
| startPeriod | 

Field Type

int

Description

Required.

The period from when the forecast formula is applicable.



 |

## AdvAcctForecastAdjPeriod

Represents details about the adjustment period of the advanced account forecast values.

| Field Name | Description |
| --- | --- |
| adjustmentDayCount | 
Field Type

int

Description

Required.

The number of days during which you can make forecast adjustments.



 |
| frequency | 

Field Type

PeriodTypes (enumeration of type string)

Description

Required.

The frequency that’s applicable to make any forecast adjustments.

Possible values are:

- Month
- Quarter
- Week
- Year

The default value is Month.



 |
| profileName | 

Field Type

string

Description

The name of the profile with which you can adjust the forecast set.



 |
| startDay | 

Field Type

int

Description

Required.

The start date for forecast adjustments.



 |

## AdvAcctForecastDimension

Represents the dimensions selected for an advanced account forecast set to categorize the data. For example, a business unit requires forecast data for each account aggregated by product and ship-from location.

| Field Name | Description |
| --- | --- |
| advAcctForecastDimName | 
Field Type

string

Description

Required.

The name of the advanced account forecast dimension.



 |
| dimensionFieldName | 

Field Type

string

Description

Required.

The API name of the field for the dimension in the custom object that contains the generated advanced account forecast records.



 |
| dimensionSourceName | 

Field Type

string

Description

The name of the dimension source associated with the advanced account forecast set dimension record.



 |
| hierarchySequenceNumber | 

Field Type

int

Description

Required.

The sequence number of the dimension source associated with the forecast set.



 |

## AdvAcctForecastMeasureDef

Represents information about the measures to display in the advanced account forecasts grid for the forecast set.

| Field Name | Description |
| --- | --- |
| advAcctForecastMeasureDefName | 
Field Type

string

Description

Required.

The name of the definition for the advanced account forecast measure.



 |
| aggregationType | 

Field Type

AdvAcctFcstAggregationType (enumeration of type string)

Description

Required.

The type of aggregation that’s used for calculating the advanced account forecast values.

Possible values are:

- AVERAGE
- MAXIMUM
- MINIMUM
- SUM

The default value is SUM.



 |
| computationMethod | 

Field Type

AdvAcctFcstComputationMethod (enumeration of type string)

Description

Required.

The method that’s used for calculating the advanced account forecast values.

Values are:

- CUSTOM
- DATA\_PROCESSING\_ENGINE\_DEFINITION
- FORMULA

The default value is DATA\_PROCESSING\_ENGINE\_DEFINITION.



 |
| forecastDataMeasureName | 

Field Type

string

Description

Required.

The field of the facts object used for the advanced account forecast measure.



 |
| forecastMeasureName | 

Field Type

string

Description

Required.

The name for the advanced account forecast measure to show on UI.



 |
| forecastMeasureType | 

Field Type

AdvAcctFcstMeasureType (enumeration of type string)

Description

Required.

The measure type that’s used for the generated advanced forecast values.

Possible values are:

- QUANTITY
- REVENUE

The default value is QUANTITY.



 |
| isAdjustmentTracked | 

Field Type

boolean

Description

Indicates whether the adjustments made to the advanced account forecast values for this metric are tracked (true) or not (false).



 |

## AdvAcctFrcstDisplayGroup

Represents information about the groups for the advanced account forecast set measures or dimensions.

| Field Name | Description |
| --- | --- |
| advAcctFrcstDisplayGroupName | 
Field Type

string

Description

Required.

The name of the advanced account forecast display group.



 |
| displayGroupItems | 

Field Type

[AdvAcctFrcstDplyGroupItem\[\]](#AdvAcctFrcstDplyGroupItem)

Description

The items associated with a display group for an advanced account forecast set.



 |
| displayGroupType | 

Field Type

AdvAcctFrcstDisplayGroupType (enumeration of type string)

Description

The category of the display group.

Possible value is:

- MEASURE





 |
| isDefault | 

Field Type

boolean

Description

Indicates whether the display group is the default group (true) or not (false).



 |
| userProfileName | 

Field Type

string

Description

The name of the profile for which the display group is applicable.



 |

## AdvAcctFrcstDplyGroupItem

Represents information about the items associated with a display group for an advanced account forecast set.

| Field Name | Description |
| --- | --- |
| advAcctFrcstDplyGroupItemName | 
Field Type

string

Description

Required.

The name of the advanced account forecast display group that’s associated with the group item.



 |
| displayOrder | 

Field Type

int

Description

Required.

The display order of the display group item.



 |
| measureReferenceName | 

Field Type

string

Description

The ID of the measure associated with the display group item.



 |

## Declarative Metadata Sample Definition

The following is an example of an AdvAccountForecastSet component.

<?xml version="1.0" encoding="UTF-8"?>
<AdvAccountForecastSet xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <calculationFrequency\>Quarterly</calculationFrequency\>
    <forecastAdjPeriods\>
        <adjustmentDayCount\>5</adjustmentDayCount\>
        <frequency\>Quarter</frequency\>
        <profileName xsi:nil="true"/>
        <startDay\>1</startDay\>
    </forecastAdjPeriods\>
    <forecastFormulas\>
        <endPeriod\>12</endPeriod\>
        <formulaExpression\>6</formulaExpression\>
        <startPeriod\>2</startPeriod\>
        <formulaType\>QUANTITY</formulaType\>
    </forecastFormulas\>
    <forecastPeriodGroupName\>PeriodGroup1</forecastPeriodGroupName\>
    <accountFieldName\>Account</accountFieldName\>
    <periodFieldName\>Period</periodFieldName\>
    <forecastQuantityFieldName\>ForecastedQuantity</forecastQuantityFieldName\>
    <forecastRevenueFieldName\>ForecastedRevenue</forecastRevenueFieldName\>
    <forecastFactObjectName\>AdvAccountForecastFact</forecastFactObjectName\>
    <forecastSetFieldName\>AdvAcctForecastSetPartner</forecastSetFieldName\>
    <rolloverFrequency\>Monthly</rolloverFrequency\>
    <forecastStatusFieldName\>Status</forecastStatusFieldName\>
    <description\>sample forecast set</description\>
    <regenerationDpeDefName xsi:nil="true"/>
    <rolloverDpeDefName xsi:nil="true"/>
    <recalculateDpeDefName xsi:nil="true"/>
    <generationDpeDefName xsi:nil="true"/>
    <status\>Inactive</status\>
    <forecastSetName\>Forecast Set 1</forecastSetName\>
    <dimensions\>
        <dimensionFieldName\>Account</dimensionFieldName\>
        <dimensionSourceName\>DimSource1</dimensionSourceName\>
        <hierarchySequenceNumber\>1</hierarchySequenceNumber\>
        <advAcctForecastDimName\>DimensionName</advAcctForecastDimName\>
    </dimensions\>
    <measureDefinitions\>
        <forecastDataMeasureName\>MeasureName</forecastDataMeasureName\>
        <advAcctForecastMeasureDefName\>Sample Def Name</advAcctForecastMeasureDefName\>
        <isAdjustmentTracked\>true</isAdjustmentTracked\>
        <forecastMeasureName\>Samplemeasure name</forecastMeasureName\>
        <aggregationType\>MINIMUM</aggregationType\>
        <computationMethod\>DATA\_PROCESSING\_ENGINE\_DEFINITION</computationMethod\>
        <forecastMeasureType\>QUANTITY</forecastMeasureType\>
    </measureDefinitions\>
    <displayGroups\>
        <advAcctFrcstDisplayGroupName\>Sample Measure Group</advAcctFrcstDisplayGroupName\>
        <displayGroupType\>MEASURE</displayGroupType\>
        <isDefault\>false</isDefault\>
        <userProfileName xsi:nil="true"/>
        <displayGroupItems\>
            <advAcctFrcstDplyGroupItemName\>Sample Quantity</advAcctFrcstDplyGroupItemName\>
            <measureReferenceName\>Sample Def Name</measureReferenceName\>
            <displayOrder\>1</displayOrder\>
        </displayGroupItems\>
    </displayGroups\>
</AdvAccountForecastSet\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
       <members\>\*</members\>
       <name\>AdvAccountForecastSet</name\>
    </types\>
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=d82916d171b0b864b870a8510f018ba26e2c17d95a2228bfdac80911ce608810 url=/legacydeveloper/current/en-us/api_meta/fundraising_affinityscoredefinition_metadata_api.md -->

# AffinityScoreDefinition

Represents the affinity information used in calculations to analyze and categorize contacts for marketing purposes.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AffinityScoreDefinition components have the suffix .affinityScoreDefinition and are stored in the affinityScoreDefinitions folder.

## Version

AffinityScoreDefinition components are available in API version 68.0 and later.

## Special Access Rules

This metadata type is available only if the Fundraising Access license is enabled for the org and the Fundraising admin permission is assigned to users.

## Fields

### affinityScoreDefinitionDesc

- **Field Type**: string
- **Description**: Description of the affinity score definition.

### affinityScoreDefinitionName

- **Field Type**: string
- **Description**: Name of the affinity score definition.

### affinityScoreType

- **Field Type**: AffinityScoreType (enumeration of type string)
- **Description**: Type of the affinity score that's defined. Valid values are CAP—Capacity, Ability, Propensity (CAP), or RFM—Recency, Frequency, Monetary (RFM).
- **Default value**: RFM

### masterLabel

- **Field Type**: string
- **Description**: Label for this affinity score definition value. This display value is the internal label that doesn't get translated.

### numberOfMonths

- **Field Type**: int
- **Description**: Number of months to analyze the records for calculating the affinity score.

### numberOfRanges

- **Field Type**: int
- **Description**: Required. Number of ranges to use in the calculation, ranging from 0 to 9. Provide the corresponding range list values in the scoreRangeList field.

### scoreRangeList

- **Field Type**: string
- **Description**: Required. Ranges that are referenced in the affinity score calculation. This field is used with scoreRangeList. For example, to calculate RFM with numberOfRanges value as 3, provide the values for the scoreRangeList field.

### sourceFieldApiNameList

- **Field Type**: string
- **Description**: Required. API names of the source fields that are referenced in the score calculation.

### sourceObjectApiNameList

- **Field Type**: string
- **Description**: API names of the source objects that are referenced in the score calculation.

### targetFieldApiNameList

- **Field Type**: string
- **Description**: Required. API names of the target fields where the calculated scores are added.

### targetObjectApiName

- **Field Type**: string
- **Description**: API name of the target object where the calculated scores are added.

Example scoreRangeList format:

{
    "R ranges":"0-30, 31-100, 100+",
    "F ranges":"0-10, 11-100, 100+",
    "M ranges":"0-1000, 1001-5000, 5000+"
}

## Declarative Metadata Sample Definition

This example shows a sample of an AffinityScoreDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<AffinityScoreDefinition
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<affinityScoreDefinitionDesc\>RFM Affinity Score</affinityScoreDefinitionDesc\>
	<affinityScoreDefinitionName\>AffinityScoreDefinition\_RFM</affinityScoreDefinitionName\>
	<affinityScoreType\>RFM</affinityScoreType\>
	<masterLabel\>MasterLabel</masterLabel\>
	<numberOfMonths\>12</numberOfMonths\>
	<numberOfRanges\>3</numberOfRanges\>
	<scoreRangeList\>
        \[
          {
            "name": "R Ranges",
            "direction": "ascending",
            "ranges": \[30,90,180\]
          },
          {
            "name": "F Ranges",
            "direction": "descending",
            "ranges": \[10,15,100\]
          },
          {
            "name": "M Ranges",
            "direction": "descending",
            "ranges": \[500,1000,5000\]
          }
     \]
      </scoreRangeList\>
	<sourceFieldApiNameList\>
        \[
          {
            "name": "R Source",
            "values": 
                \[
                  {
                    "fieldName": "DonorGiftSummary.DaysSinceLastGift",
                    "fieldWeight": 1
                  }
                \]
          },
          {
            "name": "F Source",
            "values": 
                \[
                  {
                    "fieldName": "DonorGiftSummary.GiftCount",
                    "fieldWeight": 1
                  }
                \]
          },
          {
            "name": "M Source",
            "values": 
                \[
                  {
                    "fieldName": "DonorGiftSummary.TotalGiftsCount",
                    "fieldWeight": 1
                  }
                \]
          }
        \]
      </sourceFieldApiNameList\>
	<targetFieldApiNameList\>
        \[
          {
            "name": "R Target",
            "values": 
                \[
                  {
                    "fieldName": "DonorGiftSummary.RecencyScore",
                    "fieldWeight": 1
                  }
                \]
          },
          {
            "name": "F Target",
            "values": 
                \[
                  {
                    "fieldName": "DonorGiftSummary.FrequencyScore",
                    "fieldWeight": 1
                  }
                \]
          },
          {
            "name": "M Target",
            "values": 
                \[
                  {
                    "fieldName": "DonorGiftSummary.MonetaryScore",
                    "fieldWeight": 1
                  }
                \]
          }
        \]
      </targetFieldApiNameList\>
</AffinityScoreDefinition\>

This example shows a sample of the package.xml file that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>AffinityScoreDefinition</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=62f3cb2b3a4fdcfa60cc925f0dd317789b77c04e2f0471e80a389967d90a1b62 url=/legacydeveloper/current/en-us/api_meta/meta_agentforceaccountmanagementsettings.md -->

# AgentforceAccountManagementSettings

Represents an org’s Agentforce Account Management settings.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

AgentforceAccountManagementSettings values are stored in the AgentforceAccountManagement.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AgentforceAccountManagementSettings components are available in API version 65.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| enableAccountManagement | 
Field Type

boolean

Description

Indicates whether Agentforce Account Management is enabled (true) or not (false).



 |

## Declarative Metadata Sample Definition

The following is an example of the AgentforceAccountManagement.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<AgentforceAccountManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAccountManagement\>true</enableAccountManagement\>
</AgentforceAccountManagementSettings\>

The following is an example package.xml manifest that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>AgentforceAccountManagement</members\>
        <name\>Settings</name\>
    </types\>
    <version\>65.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=4c54b169a9a2aa28491250c5282e9a0fcb86e27c8059c548e9daf5d3f51038ea url=/legacydeveloper/current/en-us/api_meta/meta_agentforcefordeveloperssettings.md -->

# AgentforceForDevelopersSettings

Represents Agentforce for Developers settings.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all org settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

AgentforceForDevelopersSettings values are stored in the AgentforceForDevelopers.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AgentforceForDevelopersSettings are available in API versions 62.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| agentforceForDevelopersOptOut | boolean | Indicates whether Agentforce for Developers is enabled: true or false. If true, Agentforce for Developers isn't enabled in your org, which means that you've opted out of using it. If false, Agentforce for Developers is enabled. The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of the AgentforceForDevelopers.settings file:

<?xml version="1.0" encoding="UTF-8"?>
        <AgentforceForDevelopersSettings xmlns="http://soap.sforce.com/2006/04/metadata">
        <agentforceForDevelopersOptOut\>false</agentforceForDevelopersOptOut\>
        </AgentforceForDevelopersSettings\>

The following is an example package.xml manifest that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
     <types\>
         <members\>AgentforceForDevelopersSettings</members\>
         <name\>Settings</name\>
     </types\>
     <version\>62.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=594f0a6555a6239556d6971b4a72554afa0525622cea05acc1ba6e724b996a99 url=/legacydeveloper/current/en-us/api_meta/meta_agentplatformsettings.md -->

# AgentPlatformSettings

Represents settings for Agentforce.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

AgentPlatformSettings values are stored in the AgentPlatformSettings.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

AgentPlatformSettings components are available in API version 64.0 and later.

## Special Access Rules

Einstein Generative AI (EinsteinGptSettings.enableEinsteinGptPlatform) must be enabled for your org.

## Fields

| Field Name | Description |
| --- | --- |
| enableAgentPlatform | 
Field Type

boolean

Description

Indicates whether Agentforce is turned on. The default value is false.



 |

## Declarative Metadata Sample Definition

The following is an example of an AgentPlatformSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<AgentPlatformSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAgentPlatform\>true</enableAgentPlatform\>
</AgentPlatformSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>AgentPlatform</members\>
        <name\>Settings</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=fa9096d3ccd6024effb48a7dedbd2f6e5da977566d16c69ffb2406a50fbcc4dc url=/legacydeveloper/current/en-us/api_meta/meta_aiagentdefinition.md -->

# AiAgentDefinition

Represents an Agentforce agent and the settings that apply to all its versions, such as its type and its context variables. Each version of the agent is a separate AiAgentDefinitionVersion component. For information about retrieving and deploying an Agentforce agent, see Use [Use Metadata to Move an Agent to a New Org](https://developer.salesforce.com/docs/ai/agentforce/guide/agent-dx-deploy-metadata.html).

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

The fullName is the agent's API name, for example, MyAgent. Each version of the agent is an AiAgentDefinitionVersion component named with a version number, for example MyAgent#1 or MyAgent#2.

## File Suffix and Directory Location

AiAgentDefinition components have the suffix .aiAgentDefinition and are stored in the aiAgents folder. For example, aiAgents/MyAgent.aiAgentDefinition.

## Version

AiAgentDefinition components are available in API version 68.0 and later.

## Special Access Rules

AiAgentDefinition is available only if Agents is enabled in your org.

## Fields

| Field Name | Description |
| --- | --- |
| agentDescription | 
Field Type

string

Description

A description of the agent.



 |
| agentDSLEnabled | 

Field Type

boolean

Description

Indicates whether the agent is defined using Agent Script (true) or not (false). When you deploy a new agent with this field set to true, include the agent's AiAuthoringBundle in the deployment unless the target org already has it.



 |
| agentType | 

Field Type

string

Description

The type of agent, for example, EinsteinServiceAgent. Required when type is InternalCopilot or ExternalCopilot\`. For InternalCopilot agents, you can't change this value after the agent is created.Valid values are:

- AgentforceEmployeeAgent
- Analytics
- AppDevAgent
- BankingServiceAgent
- BuyerAgent
- CustomAgent
- EinsteinSDR
- EinsteinServiceAgent
- Employee
- ExperienceBuilder
- FieldServiceAgent
- GoalBasedAgent
- GuidedShoppingAgent
- LightningAppBuilder
- ProspectingAgent
- SalesCanvasAgent
- SalesDealAgent
- SalesEinsteinCoach
- ScaleAgent
- ServicePlanner
- Setup
- ShopperAgent
- ThirdPartyA2AAgent





 |
| botUser | 

Field Type

string

Description

The username of the user that the agent runs as. Use the username, not the user's name or ID. The user must be an active standard user with access to the agent. Not supported when agentType is Employee or AgentforceEmployeeAgent.



 |
| contextVariables | 

Field Type

[ConversationContextVariable\[\]](#ConversationContextVariable)

Description

The context variables that store data available to the agent during a conversation.



 |
| logPrivateConversationData | 

Field Type

boolean

Description

Indicates whether private conversation data is logged (true) or not (false).



 |
| richContentEnabled | 

Field Type

boolean

Description

Indicates whether the agent supports rich content in its responses (true) or not (false).



 |
| type | 

Field Type

string

Description

The configuration type of the agent. Always set this field. If you omit this field when you create an agent, the agent gets type Bot and is retrieved as a Bot component, not an AiAgentDefinition component. You can't change the type after the agent is created. Valid values are:

- AgentforceOrchestrator
- Bot
- ExternalCopilot—An external-facing agent. For example, an Agentforce Service agent.
- InternalCopilot—An internal-facing agent. For example, an Agentforce Employee agent.





 |

## ConversationContextVariable

Represents the context variable that stores data available to the agent during a conversation.

| Field Name | Description |
| --- | --- |
| contextVariableMappings | 
Field Type

[ConversationContextVariableMapping\[\]](#ConversationContextVariableMapping)

Description

The mappings that associate the context variable with a source field.



 |
| dataType | 

Field Type

ConversationDataType (enumeration of type string)

Description

Required.

Valid values are:

- Boolean
- Currency
- Date
- DateTime
- Id
- Object
- Number
- Text





 |
| description | 

Field Type

string

Description

A description of this context variable. This value may be used by the Agentforce planner service.



 |
| developerName | 

Field Type

string

Description

Required.

This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.



 |
| includeInPrompt | 

Field Type

boolean

Description

Indicates whether the context variable is injected into the prompt sent to the Agentforce model (true) or not (false).



 |
| label | 

Field Type

string

Description

Required.

Label that identifies a context variable throughout the Salesforce user interface.



 |
| SObjectType | 

Field Type

string

Description

Specifies the SObjectType of the ID stored in the context variable.



 |

## ConversationContextVariableMapping

Represents the variable that associates the context variable with a source field.

| Field Name | Description |
| --- | --- |
| fieldName | 
Field Type

string

Description

Required.

The name of the field mapped to the context variable.



 |
| messageType | 

Field Type

MessageType (enumeration of type string)

Description

Required.

The type of message that the mapping applies to. Valid values are:

- Alexa
- AppleBusinessChat
- Custom
- Email
- EmbeddedMessaging
- Facebook
- GoogleChat
- GoogleHome
- InternalCopilot
- Line
- MsCopilot
- Omega
- Phone
- PstnVoice
- Rcs
- SipVoice
- Slack
- Text
- Voice
- VoiceIntegrationPilot
- WebChat
- WeChat
- WhatsApp
- WhatsAppVoice





 |
| SObjectType | 

Field Type

string

Description

Required.

Specifies the SObjectType of the ID used in the context variable mapping.



 |

## Declarative Metadata Sample Definition

Here's an example of an AiAgentDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<AiAgentDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <agentDSLEnabled>true</agentDSLEnabled>
    <agentDescription>Answers common customer questions and escalates complex issues.</agentDescription>
    <agentType>EinsteinServiceAgent</agentType>
    <botUser>myagent.user@example.com</botUser>
    <contextVariables>
        <contextVariableMappings>
            <SObjectType>MessagingSession</SObjectType>
            <fieldName>MessagingSession.ChannelType</fieldName>
            <messageType>EmbeddedMessaging</messageType>
        </contextVariableMappings>
        <dataType>Text</dataType>
        <description>The channel the customer is messaging from.</description>
        <developerName>ChannelType</developerName>
        <includeInPrompt>false</includeInPrompt>
        <label>Channel Type</label>
    </contextVariables>
    <logPrivateConversationData>false</logPrivateConversationData>
    <richContentEnabled>true</richContentEnabled>
    <type>ExternalCopilot</type>
</AiAgentDefinition>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=f465e81a0e745bc40a36654ef8380ba1838e81f755e6f69aec4c747326309adf url=/legacydeveloper/current/en-us/api_meta/meta_aiagentdefinitionversion.md -->

# AiAgentDefinitionVersion

Represents a version of an Agentforce agent definition, conversation variables, planner configuration, and behavior settings. For information about retrieving and deploying an Agentforce agent, see Use [Use Metadata to Move an Agent to a New Org](https://developer.salesforce.com/docs/ai/agentforce/guide/agent-dx-deploy-metadata.html).

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

The fullName is the agent's API name, for example, MyAgent. Each version of the agent is an AiAgentDefinitionVersion component named with a version number, for example MyAgent#1 or MyAgent#2.

## File Suffix and Directory Location

AiAgentDefinitionVersion components have the suffix .aiAgentDefinitionVersion-meta.xml suffix and are stored in a subfolder for the agent in the AiAgentDefinitionVersions folder. Agent components are stored in these subfolders:

- plannerActions/
- localActions/
- agentGraph/
- agentScript/—contains a compiled copy of the script, not the Agent Script source

## Version

AiAgentDefinitionVersion components are available in API version 68.0 and later.

## Special Access Rules

AiAgentDefinitionVersion is available only if Agents is enabled in your org.

## Usage

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Fields

| Field Name | Description |
| --- | --- |
| aiAgentFieldLevelRecordAccesses | 
Field Type

[AiAgentDefinitionFieldLevelRecordAccess\[\]](#AiAgentDefinitionFieldLevelRecordAccess)

Description

The field-level record access settings that define which object fields the agent can read or write.



 |
| articleAnswersGPTEnabled | 

Field Type

boolean

Description

Indicates whether the agent generates answers from knowledge articles using generative AI (true) or not (false).



 |
| billingMode | 

Field Type

AgentBillingMode (enumeration of type string)

Description

The billing model for the agent. Valid values are:

- ActionBased
- OutcomeBased





 |
| botDialogs | 

Field Type

[BotDialog\[\]](#BotDialog)

Description

The list of dialogs in this agent version.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field isn't returned when you retrieve the metadata. To set the welcome, error, and escalation messages, use welcomeMessage, errorMessage, and escalationMessage. You can't specify this field together with any of those message fields in the same agent version.















 |
| citationsEnabled | 

Field Type

boolean

Description

Indicates whether the agent includes citations in its responses (true) or not (false).



 |
| company | 

Field Type

string

Description

Reserved for internal use.



 |
| conversationVariables | 

Field Type

[ConversationVariable\[\]](#ConversationVariable)

Description

A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs.



 |
| copilotPrimaryLanguage | 

Field Type

Language (enumeration of type string)

Description

The primary language that the agent uses in conversations.



 |
| copilotSecondaryLanguages | 

Field Type

string

Description

The additional languages that the agent supports beyond the primary language.



 |
| entryDialog | 

Field Type

string

Description

A reference to the first dialog that the agent presents to your customer.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field isn't returned when you retrieve the metadata. To set the welcome, error, and escalation messages, use welcomeMessage, errorMessage, and escalationMessage.















 |
| errorMessage | 

Field Type

string

Description

The message that the agent displays when it encounters an error.



 |
| escalationMessage | 

Field Type

string

Description

The message that the agent displays when it escalates a conversation to a human.



 |
| genAiPlannerName | 

Field Type

string

Description

The API name of the planner that powers the agent's reasoning and actions.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field isn't returned when you retrieve the metadata. To set the welcome, error, and escalation messages, use welcomeMessage, errorMessage, and escalationMessage.















 |
| isScriptCompatibleAgent | 

Field Type

boolean

Description

Indicates whether the agent is compatible with Agent Script (true) or not (false).



 |
| knowledgeActionEnabled | 

Field Type

boolean

Description

Indicates whether the agent can use knowledge actions to answer questions (true) or not (false).



 |
| knowledgeFallbackEnabled | 

Field Type

boolean

Description

Indicates whether the agent falls back to knowledge articles when no other action applies (true) or not (false).



 |
| mainMenuDialog | 

Field Type

string

Description

A reference to the dialog identified as the main menu dialog.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field isn't returned when you retrieve the metadata. To set the welcome, error, and escalation messages, use welcomeMessage, errorMessage, and escalationMessage.



 |
| planner | 

Field Type

[AiAgentDefinitionPlanner](#AiAgentDefinitionPlanner)

Description

The planner configuration that defines how the agent selects and runs actions.



 |
| role | 

Field Type

string

Description

A description of the agent's role and purpose.



 |
| smallTalkEnabled | 

Field Type

boolean

Description

Indicates whether the agent responds to small talk (true) or not (false).



 |
| staticPromptsEnabled | 

Field Type

boolean

Description

Indicates whether the agent uses static prompts (true) or not (false).



 |
| status | 

Field Type

BotStatusCode (enumeration of type string)

Description

The activation status of the agent. Valid values are:

- Active
- Inactive





 |
| stopRecPrompts | 

Field Type

boolean

Description

Indicates whether the agent stops showing recommended prompts (true) or not (false).



 |
| surfacesEnabled | 

Field Type

boolean

Description

Indicates whether the agent is available across its configured surfaces (true) or not (false).



 |
| toneType | 

Field Type

GenAiBotToneType (enumeration of type string)

Description

The conversational tone that the agent uses in its responses. Valid values are:

- Casual
- Formal
- Neutral





 |
| version | 

Field Type

int

Description

The version number of the agent definition.



 |
| welcomeMessage | 

Field Type

string

Description

The message that the agent displays at the start of a conversation.



 |

## AiAgentDefinitionFieldLevelRecordAccess

Represents the field-level record access settings that define which object fields the agent can read or write.

| Field Name | Description |
| --- | --- |
| accessLevel | 
Field Type

AiAgentRecordAccessLevel (enumeration of type string)

Description

Required.

The level of access that the agent has to the specified field. Valid values are:

- ReadWrite





 |
| field | 

Field Type

string

Description

Required.

The API name of the field that the access setting applies to.



 |
| object | 

Field Type

string

Description

Required.

The API name of the object that the access setting applies to.



 |

## AiAgentDefinitionPlanner

Represents the planner configuration that defines how the agent selects and runs actions.

| Field Name | Description |
| --- | --- |
| attributeMappings | 
Field Type

GenAiPlannerAttrMapping\[\]

Description

The attribute mappings that the planner uses.



 |
| botTemplate | 

Field Type

string

Description

The API name of the bot template that the planner is based on.



 |
| capabilities | 

Field Type

string

Description

The capabilities available to the planner.



 |
| description | 

Field Type

string

Description

A description of the planner.



 |
| genAiFunctions | 

Field Type

GenAiPlannerFunctionDef\[\]

Description

The functions available to the planner.



 |
| genAiPlugins | 

Field Type

GenAiPlannerFunctionDef\[\]

Description

The plugins available to the planner.



 |
| masterLabel | 

Field Type

string

Description

Required.

The label displayed in the Salesforce user interface.



 |
| plannerSurfaces | 

Field Type

AiPlannerSurfaceDef\[\]

Description

The surfaces on which the planner is available.



 |
| plannerType | 

Field Type

PlannerType (enumeration of type string)

Description

Required.

The type of planner that powers the agent. Valid values are:

- AiCopilot\_\_AgileAppDev
- AiCopilot\_\_ReAct
- AiCopilot\_\_SequentialPlannerIntentClassifier
- Atlas\_\_ConcurrentMultiAgentOrchestration
- Atlas\_\_VoiceAgent
- BYOP\_\_waiiplanner
- SentOS\_\_SearchAgent





 |
| ruleExpressionAssignments | 

Field Type

GenAiPlannerRuleExprAsgn\[\]

Description

The rule expression assignments for the planner.



 |
| ruleExpressions | 

Field Type

GenAiPlannerRuleExprDef\[\]

Description

The rule expressions defined for the planner.



 |

## BotDialog

Represents the dialogs in this agent version. This metadata type isn’t returned during a retrieve operation. You can't deploy both dialogs and the messages (welcomeMessage, errorMessage, or escalationMessage) in the same deploy. We recommend using messages instead of dialogs.

| Field Name | Description |
| --- | --- |
| botDialogGroup | 
Field Type

string

Description

The bot dialog group that contains this bot dialog.



 |
| botSteps | 

Field Type

BotStep\[\]

Description

The ordered steps that make up this dialog.



 |
| description | 

Field Type

string

Description

A description of the bot dialog.



 |
| developerName | 

Field Type

string

Description

Required.

This unique name prevents conflicts with other dialogs associated with the same bot version. This name can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.















 |
| isPlaceholderDialog | 

Field Type

boolean

Description

In a bot block, indicates whether a dialog is a placeholder (true) or not (false). In a bot template or bot version not associated with a bot block, this field is read-only and the value is false.



 |
| label | 

Field Type

string

Description

Required.

A label that identifies the dialog throughout the Salesforce user interface.



 |
| mlIntent | 

Field Type

string

Description

Required.

The name of the intent associated with a dialog.



 |
| mlIntentTrainingEnabled | 

Field Type

boolean

Description

Indicates whether Einstein is turned on to train an intent model for the dialog intent (true) or turned off for the exact match option (false). The default value is false.



 |
| showInFooterMenu | 

Field Type

boolean

Description

Indicates whether to show this dialog in the Bot Options menu. The default value is false.



 |

## ConversationVariable

Represents a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs.

| Field Name | Description |
| --- | --- |
| SObjectType | 
Field Type

string

Description

Specifies the SObjectType of the ID stored in a bot variable. Valid values are:

- BotDefinition
- Queue





 |
| collectionType | 

Field Type

ConversationVariableCollectionType (enumeration of type string)

Description

This field defines whether a variable is designated as a List Variable. Valid value is List.



 |
| dataType | 

Field Type

ConversationDataType (enumeration of type string)

Description

Required.

Valid values are:

- Boolean
- Currency
- Date
- DateTime
- Id
- Object
- Number
- Text





 |
| description | 

Field Type

string

Description

A description of this variable. This value can be used by the Agentforce planner service.





 |
| developerName | 

Field Type

string

Description

Required.

This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.



 |
| includeInPrompt | 

Field Type

boolean

Description

Indicates whether the variable is injected into the prompt sent to the Agentforce model. If true, the variable appears in the **Included Fields** section of the UI.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The default variables Id, EndUserId, and EndUserLanguage always appear in the **Included Fields** section of the UI, regardless of their value of includeInPrompt. We recommend that you don't change the value of includeInPrompt for these default variables, as changing the value can prevent your agent from accessing important session data.















 |
| label | 

Field Type

string

Description

Required.

Label that identifies a variable throughout the Salesforce user interface.



 |
| visibility | 

Field Type

ConversationVariableVisibilityType (enumeration of type string)

Description

Determines which components can set this variable. If the visibility is internal, the variable can only be set by action outputs. If the visibility is external, the variable can also be set by the API.

Valid values are:

- internal
- external





 |

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=eaffb9256fc93e445e582fbd8a6d9175860fab521e984f52e239e24d7bb3fa8e url=/legacydeveloper/current/en-us/api_meta/meta_aiapplication.md -->

# AIApplication

Represents an instance of an AI application. For example, Einstein Prediction Builder.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

AIApplication components have the suffix .ai and are stored in the aiApplications folder.

## Version

AIApplication is available in API version 50.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d98566e97">Field Name</th>

              <th class="featureTableHeader  " id="d98566e100">Field Type</th>

              <th class="featureTableHeader  " id="d98566e103">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d98566e97" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d98566e100" data-title="Field Type">string</td>

              <td class="entry" headers="d98566e103" data-title="Description">Required. Represents the name of the application. Can contain only underscores and
                alphanumeric characters and must be unique in your org. It must begin with a letter,
                not include spaces, not end with an underscore, and not contain two consecutive
                underscores.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Only users with View DeveloperName OR View Setup and
                            Configuration permission can view, group, sort, and filter this
                            field.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d98566e97" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d98566e100" data-title="Field Type">string</td>

              <td class="entry" headers="d98566e103" data-title="Description">Label that identifies the AI application throughout the Salesforce user
                interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d98566e97" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d98566e100" data-title="Field Type">AIApplicationStatus (enumeration of type string)</td>

              <td class="entry" headers="d98566e103" data-title="Description">Required. The status of the application. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Disabled</samp></li>

                  <li class="li"><samp class="codeph nolang">Draft</samp></li>

                  <li class="li"><samp class="codeph nolang">Enabled</samp></li>

                  <li class="li"><samp class="codeph nolang">Migrated</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d98566e97" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d98566e100" data-title="Field Type">AIApplicationType (enumeration of type string)</td>

              <td class="entry" headers="d98566e103" data-title="Description">The type of AI application. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">PredictionBuilder</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=badae1cbfb7d22581144ab60860ffbc1d31c91d7cab8d5b4f155a532c381985a url=/legacydeveloper/current/en-us/api_meta/meta_aiapplicationconfig.md -->

# AIApplicationConfig

Additional prediction information related to an AI application. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

AIApplicationConfig components have the suffix .aiapplicationconfig and are stored in the aiApplicationConfigs folder.

## Version

AIApplicationConfig is available in API version 50.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d99064e83">Field Name</th>

              <th class="featureTableHeader  " id="d99064e86">Field Type</th>

              <th class="featureTableHeader  " id="d99064e89">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d99064e83" data-title="Field Name"><span class="keyword parmname">aiApplicationDeveloperName</span></td>

              <td class="entry" headers="d99064e86" data-title="Field Type">string</td>

              <td class="entry" headers="d99064e89" data-title="Description">Required. Represents&nbsp;the AIApplication to which AIApplicationConfig belongs. Can
                contain only underscores and alphanumeric characters and must be unique in your org. It must
                begin with a letter, not include spaces, not end with an underscore, and not contain two
                consecutive underscores.&nbsp;Available in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d99064e83" data-title="Field Name"><span class="keyword parmname">applicationId</span></td>

              <td class="entry" headers="d99064e86" data-title="Field Type">string</td>

              <td class="entry" headers="d99064e89" data-title="Description">Required. The ID of the parent AI application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d99064e83" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d99064e86" data-title="Field Type">string</td>

              <td class="entry" headers="d99064e89" data-title="Description">Represents the name of the application config. Can contain only underscores and
                alphanumeric characters and must be unique in your org. It must begin with a letter, not
                include spaces, not end with an underscore, and not contain two consecutive
                underscores.</td>

            </tr>

            <tr>
              <td class="entry" headers="d99064e83" data-title="Field Name"><span class="keyword parmname">insightReasonEnabled</span></td>

              <td class="entry" headers="d99064e86" data-title="Field Type">boolean</td>

              <td class="entry" headers="d99064e89" data-title="Description">Required. When <samp class="codeph nolang">true</samp>, generates the predictors, or
                field values, that were used to generate the prediction value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d99064e83" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d99064e86" data-title="Field Type">string</td>

              <td class="entry" headers="d99064e89" data-title="Description">Required. Label that identifies the AI application configuration throughout the
                Salesforce user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d99064e83" data-title="Field Name"><span class="keyword parmname">rank</span></td>

              <td class="entry" headers="d99064e86" data-title="Field Type">int</td>

              <td class="entry" headers="d99064e89" data-title="Description">Required. Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d99064e83" data-title="Field Name"><span class="keyword parmname">scoringMode</span></td>

              <td class="entry" headers="d99064e86" data-title="Field Type">AIScoringMode (enumeration of type string)</td>

              <td class="entry" headers="d99064e89" data-title="Description">Required. Frequency with which the prediction scores are written back. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Batch</samp></li>

                  <li class="li"><samp class="codeph nolang">OnDemand</samp></li>

                  <li class="li"><samp class="codeph nolang">Streaming</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=3388cc22a23ec6baf42eedb063bad0c22ce1f94325730560f3986ce504905ff5 url=/legacydeveloper/current/en-us/api_meta/meta_aiauthoringbundle.md -->

# AiAuthoringBundle

Represents an AI authoring bundle, which is a container for AI-related authoring content. For example, an AI authoring bundle for an Agentforce agent contains an Agent Script file and the associated metadata content.

AiAuthoringBundle packages and manages AI authoring artifacts with version control features. This metadata type provides a structured way to organize, version, and target AI-related content within your Salesforce org.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type.

## Directory Structure

AiAuthoringBundle agents are stored in an aiAuthoringBundles folder with a specific structure. Here’s an example of the structure.

+--aiAuthoringBundles
    +--my\_service\_agent (1)
        +--my\_service\_agent.agent (2)
        +--my\_service\_agent.bundle-meta.xml (3)
    +--my\_employee\_agent (1)
        +--my\_employee\_agent.agent (2)
        +--my\_employee\_agent.bundle-meta.xml (3)

The bundle includes the following resources:

- A folder (1) for each agent. If the folder suffix contains an underscore followed by a number (for example, my\_service\_agent\_5), that number indicates the agent version. If there isn't a number in the suffix, the agent definition applies to the latest version of the agent.
- Each agent folder contains a file that defines the agent (2). For example, this file can be an Agent Script definition. See [Agent Script in the Agentforce Developer Guide](https://developer.salesforce.com/docs/einstein/genai/guide/get-started.html) for details.
- Each agent folder contains the metadata associated with the agent (3). Be sure to review the description for the target field to understand how to distinguish committed agent versions from uncommitted versions.

## Version

AiAuthoringBundle is available in API version 65.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| bundleType | 
AiAuthoringBundleType (enumeration of type string)

Description

Specifies the type or category of the AI authoring bundle, indicating the kind of AI authoring content contained within the bundle. Currently, this value must be AGENT, which represents an Agent Script agent. See [Agent Script in the Agentforce Developer Guide](https://developer.salesforce.com/docs/einstein/genai/guide/get-started.html) for details.



 |
| target | 

string

Description

Specifies the context or destination for the AI authoring bundle, defining how the bundle content should be applied or deployed.

To commit an agent version, Agentforce agents must specify the developerName for the [Bot](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_bot.htm "Represents a definition of an Einstein Bot configuration that can have one or more versions. Only one version can be active.") and [BotVersion](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_botversion.htm "Represents the configuration details for a specific Einstein Bot version, including dialogs and variables.") components, separated by a period: {Bot}.{BotVersion}. For example, Agentforce\_Service\_Agent.v2. These two components tie the AI authoring bundle to a specific agent and a specific agent version.

This field is automatically populated when you publish an agent with [Agentforce DX](https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx.html). Publishing an agent with this field present is the equivalent to committing the agent in Agentforce Builder with the **Commit Version** button.

If you want to deploy an agent to your org in draft state, omit this field.





 |
| versionDescription | 

string

Description

Provides a human-readable description of the bundle version, documenting what changes or features are included in this version of the AI authoring bundle.



 |
| versionTag | 

string

Description

Defines a version identifier or tag for the AI authoring bundle. This value can be used for version tracking and management of different bundle iterations.



 |

## Declarative Metadata Sample Definition

The following package.xml file is an example of an AiAuthoringBundle component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>New\_Agent</members\>
        <name\>AiAuthoringBundle</name\>
    </types\>
    <version\>65.0</version\>
</Package\>

In the .zip file for this bundle, each agent is nested in the aiAuthoringBundles folder. This example shows the directory structure in the .zip file for an agent named New\_Agent. Each agent bundle folder must contain an agent file and a metadata file.

+--aiAuthoringBundles
    +--New\_Agent
        +--New\_Agent.agent
        +--New\_Agent.bundle-meta.xml

To see an example of an Agent Script agent file, see [Agent Script in the Agentforce Developer Guide](https://developer.salesforce.com/docs/einstein/genai/guide/get-started.html).

This example shows the metadata XML for the agent in the file New\_Agent.bundle-meta.xml. The example commits the agent version because it contains a target value. Uncommitted versions don't contain this field.

<?xml version="1.0" encoding="UTF-8"?>
<AiAuthoringBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <bundleType>AGENT</bundleType>
    <target>Agentforce\_Service\_Agent.v2</target>
    <versionTag>DF 2026.3</versionTag>
</AiAuthoringBundle>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=1c5e1933be037049d48d9d1b320f5681ea6a1d6d28dcba3d9d77707fba64570c url=/legacydeveloper/current/en-us/api_meta/meta_aievaluationdefinition.md -->

# AiEvaluationDefinition

Represents an agent evaluation, including subject metadata and a set of test cases.

In Metadata API, you can create test definitions, including specifying inputs and expected outcomes, and deploy them to different orgs. In Connect API, you can execute test scenarios, poll for results, and retrieve test outcomes.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. For more information on testing agents, see the [Testing API Developer Guide](https://developer.salesforce.com/docs/einstein/genai/guide/testing-api.html).

## File Suffix and Directory Location

AiEvaluationDefinition components have the suffix .aiEvaluationDefinition and are stored in the aiEvaluationDefinitions folder.

## Version

AiEvaluationDefinition is available in API version 63.0 and later. Individual fields may have specific minimum API version requirements as noted in the field descriptions.

## Special Access Rules

AiEvaluationDefinition is available only if Agentforce is enabled. See [Set Up Agents](https://help.salesforce.com/s/articleView?id=ai.copilot_setup.htm&language=en_US) in Salesforce Help.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
string

Description

The purpose of the test.



 |
| name | 

string

Description

Required. The API name of the test. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| subjectName | 

string

Description

Required. A unique identifier for the agent being tested. Make sure that this identifier matches the API name of the agent, which you can find on the agent details page in Setup.



 |
| subjectType | 

string

Description

Required. The type of subject being tested. The only currently supported value is AGENT.



 |
| subjectVersion | 

string

Description

The agent version to test. If not provided, the latest active version is used by default. You can find the version in the BotVersion metadata type.



 |
| testCase | 

[AiEvaluationTestCase\[\]](#AiEvaluationTestCase)

Description

A list of test cases.



 |

## AiEvaluationTestCase

Represents a test case.

| Field Name | Description |
| --- | --- |
| expectation | 
[AiEvaluationExpectation\[\]](#AiEvaluationExpectation)

Description

The criteria used to test the artifact's responses.



 |
| inputs | 

[AiEvaluationAgentTestCaseInput\[\]](#AiEvaluationAgentTestCaseInput)

Description

The specific input provided to the artifact being tested.



 |
| number | 

int

Description

The unique number for the test case. If not provided, the value is automatically calculated.



 |

## AiEvaluationExpectation

Represents the expected outcome for a test case.

| Field Name | Description |
| --- | --- |
| expectedValue | 
string

Description

The expected outcome of the test. The format of this field depends on the value of the name field. The expected outcome is compared against the response generated when you run the test using [Connect REST API](https://developer.salesforce.com/docs/einstein/genai/guide/testing-api-connect.html)



 |
| label | 

string

Description

An optional label for an expectation. Typically added when using the same custom expectation name multiple times in a test case. If provided, this label appears in the test results; otherwise, the expectation name appears.



 |
| name | 

string

Description

Required. The expectation name. Valid values are:

- topic\_sequence\_match: The expectedValue field value is a string representing the topic that the agent is expected to use, such as OOTBSingleRecordSummary. For a list of agent topics, see Standard Agent Topic Reference in Salesforce Help.
- action\_sequence\_match: The expectedValue field value is a string\[\] representing a list of actions that you expect the artifact to take during the test, such as \['IdentifyRecordByName', 'action2'\]. For a list of agent actions, see Standard Agent Action Reference in Salesforce Help. This option was previously called action\_sequence\_match.
- bot\_response\_rating: The expectedValue field value is a string representing the expected response generated by the artifact, such as Summarization of the Global Media account.
- coherence: A generated answer is coherent if it’s easy to understand and has no grammatical errors. If you use this quality check, you don't need an expectedValue field value.
- completeness: A generated answer is complete if it includes all the essential information. If you use this quality check, you don't need an expectedValue field value.
- conciseness: A generated answer is concise if it's brief but comprehensive. Shorter is better. If you use this quality check, you don't need an expectedValue field value.
- output\_latency\_milliseconds: Latency in milliseconds from sending a request until a response is received. If you use this quality check, you don't need an expectedValue field value.
- string\_comparison: A custom evaluation criteria that tests a response for a specified string value.
- numeric\_comparison: A custom evaluation criteria that tests a response for a specified numeric value.





 |
| parameter | 

[AiEvaluationTestCaseCritParam\[\]](#AiEvaluationTestCaseCritParam)

Description

Required for custom test criteria. An array of parameters for the specific custom criteria defined by expectation.name. This field replaces expectedValue for custom test criteria.



 |

## AiEvaluationTestCaseCritParam

Defines a criterion parameter for expectations, including name, value, and whether it references another value. Available in API version 64.0 and later.

| Field Name | Description |
| --- | --- |
| isReference | 
boolean

Description

If true, indicates that value is a JSONPath expression referencing runtime data from the generatedData object returned by the Get Test Results resource. If true, the value must be a JSONPath string. The default value is false.



 |
| name | 

string

Description

Required for custom evaluation criteria. The name of the parameter required by the evaluation. Valid values are: operator—type of comparison; actual—runtime value to evaluate; expected—target value to compare against. For operator, valid options include:

- equals: Checks if the actual value exactly matches the expected value (string or numeric).
- contains: Checks if the actual string contains the expected string.
- startswith: Checks if the actual string begins with the expected string.
- endswith: Checks if the actual string ends with the expected string.
- greater\_than\_or\_equal: Checks if the numeric actual value is greater than or equal to the numeric expected value (\>=).
- greater\_than: Checks if the numeric actual value is greater than the numeric expected value (\>).
- less\_than: Checks if the numeric actual value is less than the numeric expected value (<).
- less\_than\_or\_equal: Checks if the numeric actual value is less than or equal to the numeric expected value (<=).





 |
| value | 

string

Description

Required for custom evaluation criteria. The value for the parameter. This field can be a literal value or a JSONPath expression if isReference is true. Typically, JSONPath expressions are used to dynamically retrieve actual parameters.



 |

## AiEvaluationAgentTestCaseInput

Represents the inputs for a test case, including variables, conversation history, and the utterance.

| Field Name | Description |
| --- | --- |
| contextVariable | 
[AiEvalCopilotTestCaseCntxtVar\[\]](#AiEvalCopilotTestCaseCntxtVar)

Description

An XML array of context variables sent to the agent.



 |
| conversationHistory | 

[AiEvalCopilotTestCaseConv\[\]](#AiEvalCopilotTestCaseConv)

Description

An XML array of conversation history elements sent to the agent.



 |
| utterance | 

string

Description

Required. The request sent to the agent.



 |

## AiEvalCopilotTestCaseCntxtVar

An XML array of context variables sent to the agent.

| Field Name | Description |
| --- | --- |
| variableName | 
string

Description

Required. The name of the context variable.



 |
| variableValue | 

string

Description

Required. The value of the context variable.



 |

## AiEvalCopilotTestCaseConv

An XML array of conversation history sent to the agent.

| Field Name | Description |
| --- | --- |
| index | 
integer

Description

A zero based index for this conversation message.



 |
| message | 

string

Description

The text from the user or agent.



 |
| role | 

string

Description

The role associated with a message. Valid values are user or agent. A conversation must begin with a message from the user.



 |
| topic | 

string

Description

Required for agent messages. Represents the topic the agent used to generate a response.



 |

## Declarative Metadata Sample Definition

Here's an example of an AiEvaluationDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<AiEvaluationDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>My Sample Tests</description\>
    <name\>my\_test\_n1</name\>
    <subjectName\>Agentforce\_for\_Salesforce</subjectName\>
    <subjectType\>AGENT</subjectType\>
    <subjectVersion\>v1</subjectVersion\>
    <testCase\>
        <number\>1</number\>
        <inputs\>
          <utterance\>Summarize the Global Media account</utterance\>
        </inputs\>
        <expectation\>
            <name\>topic\_sequence\_match</name\>
            <expectedValue\>OOTBSingleRecordSummary</expectedValue\>
        </expectation\>
        <expectation\>
            <name\>action\_sequence\_match</name\>
            <expectedValue\>\['IdentifyRecordByName'\]</expectedValue\>
        </expectation\>
        <expectation\>
            <name\>bot\_response\_rating</name\>
            <expectedValue\>Summarization of the Global Media account</expectedValue\>
        </expectation\>
        <expectation\>
            <name\>conciseness</name\>
        </expectation\>
    </testCase\>
    <testCase\>
        <number\>2</number\>
        <inputs\>
          <utterance\>give me a pizza recipe</utterance\>
        </inputs\>
        <expectation\>
            <name\>topic\_sequence\_match</name\>
            <expectedValue\>Small\_Talk</expectedValue\>
        </expectation\>
        <expectation\>
            <name\>action\_sequence\_match</name\>
            <expectedValue\>\[\]</expectedValue\>
        </expectation\>
        <expectation\>
            <name\>bot\_response\_rating</name\>
            <expectedValue\>the agent cannot answer this</expectedValue\>
        </expectation\>
    </testCase\>
</AiEvaluationDefinition\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e9d0f95b823991e42a7013df7ca08f6fdf402c70b7c413188dd015c68ba344c7 url=/legacydeveloper/current/en-us/api_meta/meta_aiplannervoicedef.md -->

# AiPlannerVoiceDef

Represents a voice definition for an Agentforce voice agent. It stores the speech-to-text and text-to-speech configuration settings used during voice interactions, including model selection, voice persona, and audio synthesis parameters.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AiPlannerVoiceDef components have the suffix .aiPlannerVoiceDef and are stored in the aiPlannerVoiceDef folder.

## Version

AiPlannerVoiceDef components are available in API version 63.0 and later.

## Special Access Rules

AiPlannerVoiceDef is available only if Agents and Agentforce Voice are enabled in your org.

## Fields

| Field Name | Description |
| --- | --- |
| additionalConfigs | 
Field Type

string

Description

A JSON string for extensible configuration settings not covered by explicit fields. Allows additional voice parameters to be stored without requiring schema changes.



 |
| developerName | 

Field Type

string

Description

Required. Represents the API name of the voice definition. This name must be unique across all voice definitions. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| inboundFillerWordsBool | 

Field Type

boolean

Description

Specifies whether filler words (such as "um" or "uh") are included when processing inbound audio. When true, filler words are preserved in the transcription output. When false, they are stripped.



 |
| inboundKeywords | 

Field Type

string

Description

A JSON object of keywords or phrases with optional boost weights that improve speech recognition accuracy for inbound audio. Positive values increase recognition priority; negative values suppress. Example: {"keywords": {"Salesforce": 5, "Agentforce": 5, "cancel": -10}}.



 |
| inboundModel | 

Field Type

string

Description

The speech-to-text model used to transcribe inbound audio. References a deployed model record in MktMLAIModel (e.g., sfdc\_ai\_\_Default\_Nova\_2\_PhoneCall).



 |
| label | 

Field Type

string

Description

The user-facing label for this AiPlannerVoiceDef component as it appears in the Salesforce UI.



 |
| languageCode | 

Field Type

string

Description

The BCP 47 language code specifying the language used for voice processing, for example en-US for American English or ja-JP for Japanese.



 |
| outboundFillerSentences | 

Field Type

string

Description

A JSON object of filler sentences the voice agent speaks while processing a response, organized by category. Helps maintain natural conversational flow during pauses. Example: {"fillerSentences": {"waiting": \["Let me look into that...", "Just a moment..."\], "confirmation": \["Got it, let me confirm that."\], "fallback": \["Sorry, could you repeat that?"\]}}.



 |
| outboundModel | 

Field Type

string

Description

The text-to-speech model used to synthesize outbound audio. References a deployed model record in MktMLAIModel (e.g., sfdc\_ai\_\_Default\_Eleven\_Flash\_V2).



 |
| outboundSimilarity | 

Field Type

double

Description

A value between 0 and 1 that controls how closely the synthesized voice matches the selected voice profile. Higher values produce a more faithful reproduction; lower values allow more natural variation. Default is typically 0.75.



 |
| outboundSpeedNum | 

Field Type

double

Description

A multiplier that controls the speaking rate of the outbound voice. A value of 1.0 represents normal speed. Typical range is 0.7 (slower) to 1.2 (faster), depending on the voice persona's configured bounds.



 |
| outboundStability | 

Field Type

double

Description

A value between 0 and 1 that controls the consistency of the outbound voice tone and delivery. Higher values produce a more stable, predictable output; lower values introduce more expressive variation. Default is typically 0.65.



 |
| outboundStyleExaggeration | 

Field Type

double

Description

A value between 0 and 1 that amplifies the speaking style of the selected voice. Higher values increase expressiveness and emotional range in the synthesized speech. A value of 0 produces neutral delivery.



 |
| outboundVoice | 

Field Type

string

Description

The name of the voice persona used for text-to-speech synthesis in outbound audio (e.g., elevenlabs-Mark-en\_US). Maps to a voice configuration defined in the voice metadata layer.



 |
| pronunciationDict | 

Field Type

string

Description

A custom pronunciation dictionary that defines phonetic overrides for how specific words or phrases are pronounced by the text-to-speech engine. Useful for brand names, technical terms, or unusual proper nouns.



 |
| voiceIdentifier | 

Field Type

string

Description

A unique identifier for the voice configuration, typically the pre-computed hash ID from the voice metadata layer (e.g., f64af13e6fb0). Used to reference or distinguish this voice setup across planner configurations.



 |

## Declarative Metadata Sample Definition

The following is an example of an AiPlannerVoiceDef component.

<?xml version="1.0" encoding="UTF-8"?>
<GenAiPlannerBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>This agent is either testing you, or you&apos;re testing it.</description\>
    <masterLabel\>My Test Agent</masterLabel\>
    <plannerType\>AiCopilot\_\_ReAct</plannerType\>
    <voiceDefinition\>
        <developerName\>dev2Automation</developerName\>
        <inboundFillerWordsBool\>false</inboundFillerWordsBool\>
        <inboundKeywords\>key2</inboundKeywords\>
        <inboundModel\>sfdc\_ai\_\_DefaultOpenAIGPT35Turbo</inboundModel\>
        <label\>label2</label\>
        <outboundFillerSentences\>test2</outboundFillerSentences\>
        <outboundModel\>sfdc\_ai\_\_DefaultOpenAIGPT35Turbo</outboundModel\>
        <outboundSimilarity\>0.8</outboundSimilarity\>
        <outboundSpeedNum\>1.2</outboundSpeedNum\>
        <outboundStability\>0.5</outboundStability\>
        <outboundStyleExaggeration\>1.8</outboundStyleExaggeration\>
        <outboundVoice\>test2</outboundVoice\>
        
    </voiceDefinition\>
</GenAiPlannerBundle\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>GenAiPlannerBundle</name\>
    </types\>
    <version\>63.0</version\>
</Package\>

<!-- document id=9a022b12ab8ff8bf07bbc2c8b3fea85087bfe0b9be4d62359c111e3163059956 url=/legacydeveloper/current/en-us/api_meta/meta_aipluginutterancedef.md -->

# AiPluginUtteranceDef

Represents an utterance that can be used to pick a topic during runtime.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AiPluginUtteranceDef components are part of other components, such as GenAiPlugin, and aren't used separately.

## Version

AiPluginUtteranceDef components are available in API version 63.0 and later.

## Special Access Rules

AiPluginUtteranceDef is available only if Agents is enabled in your org.

## Fields

| Field Name | Description |
| --- | --- |
| developerName | 
Field Type

string

Description

Required.

Represents the API name of the utterance. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| language | 

Field Type

string

Description

Required.

The language of the utterance.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label for the utterance.



 |
| utterance | 

Field Type

string

Description

Required.

The utterance.



 |

## Declarative Metadata Sample Definition

See [GenAiPlugin](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm "Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents.").

<!-- document id=bb923b06bbadd05074b5e5d5a81fc981f9b1d8aa461cbd3070ac18e656e1a88a url=/legacydeveloper/current/en-us/api_meta/meta_aireplyrecommendationssettings.md -->

# AIReplyRecommendationsSettings

Represents the metadata used to manage settings for Einstein Reply Recommendations. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

Einstein Reply Recommendations settings are stored in a single file named aireplyrecommendations.settings in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AIReplyRecommendationsSettings is available in API version 49.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableAIReplyRecommendations | boolean | If true (default), Einstein Reply Recommendations is enabled. If false, it is disabled. |
| enableGenReplyRecommendations | boolean | If true (default), Einstein Service Replies is enabled. If false, it is disabled. Available in API version 58.0 or later. |
| enableServiceEinsteinGPTGrounding | boolean | If true (default), Service AI Grounding is enabled. If false, it is disabled. Available in API version 58.0 or later. |

## Declarative Metadata Sample Definition

The following is an example aireplyrecommendations.settings metadata file:

<?xml version="1.0" encoding="UTF-8"?>
<AIReplyRecommendationsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableAIReplyRecommendations\>true</enableAIReplyRecommendations\>
</AIReplyRecommendationsSettings\>

## Example Package Manifest

The following is an example package.xml manifest that references the AIReplyRecommendationsSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>AIReplyRecommendations</members\>
		<name\>Settings</name\>
	</types\>
	<version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

## Copyright

Rights of ALBERT EINSTEIN are used with permission of The Hebrew University of Jerusalem. Represented exclusively by Greenlight.

<!-- document id=8eb94dddd8607c35b03cf24ccbb2fe7b2cee1dfec2ba1e173c804a12119c6c4d url=/legacydeveloper/current/en-us/api_meta/meta_aiscoringmodeldefinition.md -->

# AIScoringModelDefinition

Represents information about a machine learning model that’s used by the Scoring Framework for Industries Cloud Einstein. The machine learning model is used for scoring, including its configuration.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AIScoringModelDefinition components have the suffix .aiScoringModelDefinition and are stored in the aiScoringModelDefinitions folder.

## Version

AIScoringModelDefinition components are available in API version 58.0 and later.

## Special Access Rules

To access this metadata type, you must have the AI Accelerator User permission set with Scoring Framework enabled for Industries Cloud Einstein from Salesforce Setup. The Salesforce org must have the CRM Plus license and the product’s CRM license.

## Fields

| Field Name | Description |
| --- | --- |
| aiModelConfig | 
Field Type

string

Description

Required.

ID of an AI model configuration related to the AI scoring model record.



 |
| aiScoringModelDefVersions | 

Field Type

[AIScoringModelDefVersion\[\]](#AIScoringModelDefVersion)

Description

Represents information of various versions of a model.



 |
| description | 

Field Type

string

Description

Description for an AIScoringModelDefinition record.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for the AIScoringModelDefinition metadata component, which is defined when the AIScoringModelDefinition metadata component is created.



 |

## AIScoringModelDefVersion

Represents information about a version of an AI scoring model.

| Field Name | Description |
| --- | --- |
| aiScoringModelDefinition | 
Field Type

string

Description

Required.

Parent AIScoringModelDefinition record that’s related to an AIScoringModelDefVersion record.



 |
| aiScoringSteps | 

Field Type

[AIScoringStep\[\]](#AIScoringStep)

Description

Represents information about a step associated with an AI scoring model version.



 |
| developerName | 

Field Type

string

Description

Required.

The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for the AIScoringModelDefVersion component name, which is defined when the AIScoringModelDefVersion component name is created.



 |
| modelMode | 

Field Type

AIScoringModelDefVersionMode (enumeration of type string)

Description

Required.

Mode of an AI scoring model.

Values are:

- DEPLOY
- TRAIN
- TRAIN\_AND\_DEPLOY





 |

## AIScoringStep

Represents information about a step associated with an AI scoring model version. For example, an AI scoring step can include steps, such as propensity to purchase products or prediction scores for accounts.

| Field Name | Description |
| --- | --- |
| aiModelConfigStep | 
Field Type

string

Description

Required.

ID of the AI model config step that’s related to the AIScoringStep record.



 |
| stepDetail | 

Field Type

string

Description

Scoring step details in JSON format.



 |

## Declarative Metadata Sample Definition

Here’s an example of an AIScoringModelDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<AIScoringModelDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <aiModelConfig\>Prediction\_Scores\_for\_Accounts</aiModelConfig\>
    <aiScoringModelDefVersions\>
        <fullName\>V1</fullName\>
        <aiScoringModelDefinition\>Test</aiScoringModelDefinition\>
        <aiScoringSteps\>
            <aiModelConfigStep\>Prediction\_Scores\_for\_Accounts.GrainSelector</aiModelConfigStep\>
            <stepDetail\>{label:Account,name:Account}</stepDetail\>
        </aiScoringSteps\>
        <aiScoringSteps\>
            <aiModelConfigStep\>Prediction\_Scores\_for\_Accounts.AugmentedDataset</aiModelConfigStep\>
        </aiScoringSteps\>
        <aiScoringSteps\>
            <aiModelConfigStep\>Prediction\_Scores\_for\_Accounts.TargetConditionBuilder</aiModelConfigStep\>
            <stepDetail\>{specificOutcomeDefined:Yes,label:Financial accounts are associated with an account,name:FA\_Target}</stepDetail\>
        </aiScoringSteps\>
        <aiScoringSteps\>
            <aiModelConfigStep\>Prediction\_Scores\_for\_Accounts.InputVariableSelector</aiModelConfigStep\>
        </aiScoringSteps\>
        <aiScoringSteps\>
            <aiModelConfigStep\>Prediction\_Scores\_for\_Accounts.CustomFilter</aiModelConfigStep\>
        </aiScoringSteps\>
        <aiScoringSteps\>
            <aiModelConfigStep\>Prediction\_Scores\_for\_Accounts.WriteBackConnector</aiModelConfigStep\>
        </aiScoringSteps\>
        <developerName\>V1</developerName\>
        <masterLabel\>V1</masterLabel\>
        <modelMode\>TRAIN\_AND\_DEPLOY</modelMode\>
    </aiScoringModelDefVersions\>
    <description\>Test for metadata</description\>
    <masterLabel\>Test</masterLabel\>
</AIScoringModelDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>AIScoringModelDefVersion</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>AIScoringModelDefinition</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=6bd53da48bf15589a1440ecf0ce1c6d0d9ed105b08f6f016eca96907f56404cf url=/legacydeveloper/current/en-us/api_meta/meta_aiusecasedefinition.md -->

# AIUsecaseDefinition

Represents a collection of fields in your Salesforce org used to define a machine learning use case and get real-time predictions.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AIUsecaseDefinition components have the suffix .aiUsecaseDefinitions and are stored in the aiUsecaseDefinitions folder.

## Version

AIUsecaseDefinition components are available in API version 56.0 and later.

## Special Access Rules

The AIUsecaseDefinition object is available when the admin settings for AI Accelerator and for the product related to the use case are enabled. The Salesforce org must have the CRM Plus license and the product’s CRM license.

## Fields

| Field Name | Description |
| --- | --- |
| aiUsecaseFieldMappings | 
Field Type

[AIUsecaseFieldMapping\[\]](#AIUsecaseFieldMapping)

Description

The field mappings for the use case definition. Each use case definition can have multiple field mappings.



 |
| aiUsecaseModels | 

Field Type

[AIUsecaseModel\[\]](#AIUsecaseModel)

Description

The models for the use case definition. Each use case definition can have multiple use case models.



 |
| creatorType | 

Field Type

CreatorType (enumeration of type string)

Description

Required.

The type of user who created the use case definition that's used by AI Accelerator. Valid values are:

- INTERNAL\_USER
- SALESFORCE\_ADMIN

Available in API version 57.0 and later.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for the use case definition, which is defined when the use case definition is created.



 |
| maximumInsightCount | 

Field Type

int

Description

The maximum number of insights returned by the scoring response.



 |
| maximumRecommendationCount | 

Field Type

int

Description

The maximum number of recommendations returned by the Next Best Action Strategy.



 |
| maximumSuggestionCount | 

Field Type

int

Description

The maximum number of suggestions returned by the scoring response.



 |
| primaryResponseObject | 

Field Type

string

Description

The primary object in which the scoring response is stored based on the specified field mapping.



 |
| recommendationResponseObject | 

Field Type

string

Description

The recommendation response object associated with the use case definition.



 |
| recommendationSource | 

Field Type

RcmdSourceType (enumeration of type string)

Description

The tool or platform that generates recommendations. Valid values are:

- Next\_Best\_Action\_Flow
- None

Available in API version 57.0 and later.



 |
| secondaryResponseObject | 

Field Type

string

Description

The object in which the scoring response is stored based on the specified field mapping.



 |
| shouldSaveFeatures | 

Field Type

boolean

Description

Indicates whether to save the features extracted for the scoring request (true) or not (false).

The default value is false.



 |
| shouldSaveInsights | 

Field Type

boolean

Description

Indicates whether to save the prediction insights that are used to generate the score (true) or not (false).

The default value is false.



 |
| shouldSaveRecommendation | 

Field Type

boolean

Description

Indicates whether to save the recommendation (true) or not (false).

The default value is false.



 |
| shouldSaveRequestResponse | 

Field Type

boolean

Description

Indicates whether to save the request response (true) or not (false).

The default value is false.



 |
| shouldSaveScore | 

Field Type

boolean

Description

Indicates whether to save the prediction score (true) or not (false).

The default value is false.



 |
| shouldSaveSuggestions | 

Field Type

boolean

Description

Indicates whether to save the suggestions for improving the prediction score (true) or not (false).

The default value is false.



 |
| suggestionImpactMinimumPct | 

Field Type

int

Description

The minimum eligible percentage for improving the existing prediction score based on the suggestions. Suggestions with an impact greater than the specified percentage on the score are displayed on the prediction scorecard.



 |
| usecaseName | 

Field Type

string

Description

Required.

The name of the use case definition.



 |

## AIUsecaseFieldMapping

Represents information about the field mapping to store extracted features, prediction scores, prediction insights, and use case suggestions in the response object.

| Field Name | Description |
| --- | --- |
| developerName | 
Field Type

string

Description

The unique name for the field mapping in the use case definition.

Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**.



 |
| mappedFieldName | 

Field Type

string

Description

Required.

The name of the field where the scoring response is stored.



 |
| mappedFieldType | 

Field Type

MappedFieldType (enumeration of type string)

Description

Required.

The type of the mapped field.

Valid values are:

- FEATURE
- PREDICTION\_SCORE
- INSIGHT
- SUGGESTION
- SECONDARY\_RESPONSE\_RECORD\_ID
- RECOMMENDATION\_RESPONSE\_RECORD\_ID
- RECOMMENDATION

The default value is FEATURE.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for the use case field mapping, which is defined when the field mapping is created.



 |
| responseFieldName | 

Field Type

string

Description

Required.

The name of the response object’s field that’s mapped to the field storing the score.



 |
| responseObject | 

Field Type

string

Description

Required.

The object whose field is mapped to the field storing the score. It’s either the PrimaryResponseObject or the SecondaryResponseObject specified in the AIUsecaseDefinition object.



 |
| sequenceNumber | 

Field Type

int

Description

The sequence number for the information stored in the field mapping.



 |

## AIUsecaseModel

Represents information about the machine learning models that generate predictions for your use case.

| Field Name | Description |
| --- | --- |
| aiFeatureExtractors | 
Field Type

[AIFeatureExtractor\[\]](#AIFeatureExtractor)

Description

The AI feature extractors to retrieve the input data.



 |
| defaultFeatureExtractor | 

Field Type

[AIFeatureExtractor](#AIFeatureExtractor)

Description

The default AI feature extractor to retrieve the input data.



 |
| developerName | 

Field Type

string

Description

The unique name for the use case model.

Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for the use case model, which is defined when the use case model is created.



 |
| predictionDefinition | 

Field Type

string

Description

The unique identifier of the prediction definition that’s related to the use case model. This identifier can be an external ID. If you use Einstein Discovery to create models, the predictionDefinition field stores the developer name of the record.



 |
| predictionPlatform | 

Field Type

PredictionPlatform (enumeration of type string)

Description

Required.

The platform on which the machine learning model is created and deployed. Valid values are:

- Data\_Cloud
- Default—For internal use only.
- Einstein\_Discovery
- Einstein\_on\_Data\_Cloud—Available in API version 63.0 and later.

The default value is Einstein\_Discovery. Available in API version 57.0 and later.



 |

## AIFeatureExtractor

Represents information about the feature extractor that’s used to retrieve the input data for the use case model that’s used to generate predictions.

| Field Name | Description |
| --- | --- |
| batchInputSourceIdentifier | 
Field Type

string

Description

The identifier of the input source of the features computed by batch jobs, which can be used by a model for generating predictions. Available in API version 57.0 and later.



 |
| batchInputSourceInformation | 

Field Type

string

Description

The information about the batch input source, including query parameters, objects, field mappings, and filter criteria. Available in API version 63.0 and later.



 |
| batchInputSourceType | 

Field Type

BatchInputSourceType (enumeration of type string)

Description

The input source of the features computed in batch jobs.

Possible values are:

- CRMA
- Data Cloud

The default value is CRMA.



 |
| className | 

Field Type

string

Description

Required.

The ID of the Apex class created for the feature extractor.



 |
| developerName | 

Field Type

string

Description

The unique name for the feature extractor.

Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**.



 |
| extractorType | 

Field Type

ExtractorType (enumeration of type string)

Description

Required.

The type of the feature extractor.

Valid values are:

- APEX
- JAVA
- HYBRID

The default value is APEX.



 |
| featureInputType | 

Field Type

string

Description

Required.

The type of feature input that’s used in generating predictions. Valid values are:

- Realtime\_Input
- Sample\_Input
- Batch\_Input
- Batch\_And\_Realtime\_Input

Available in API version 57.0 and later.



 |
| inputContext | 

Field Type

string

Description

The JSON file with features that act as context for the feature extractor. This data can also include the data in the uploaded CSV file. Available in API version 57.0 and later.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for the feature extractor, which is defined when the feature extractor is created.



 |

## Declarative Metadata Sample Definition

The following is an example of an AIUsecaseDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<AIUsecaseDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <aiUsecaseFieldMappings\>
        <developerName\>DevNamee1</developerName\>
        <mappedFieldName\>Name</mappedFieldName\>
        <mappedFieldType\>INSIGHT</mappedFieldType\>
        <masterLabel\>DevName</masterLabel\>
        <responseFieldName\>AnnualRevenue</responseFieldName\>
        <responseObject\>Lead</responseObject\>
        <sequenceNumber\>2</sequenceNumber\>
    </aiUsecaseFieldMappings\>
    <aiUsecaseFieldMappings\>
        <developerName\>DevNamee2</developerName\>
        <mappedFieldName\>Value</mappedFieldName\>
        <mappedFieldType\>INSIGHT</mappedFieldType\>
        <masterLabel\>DevName</masterLabel\>
        <responseFieldName\>Id</responseFieldName\>
        <responseObject\>Account</responseObject\>
        <sequenceNumber\>2</sequenceNumber\>
    </aiUsecaseFieldMappings\>
    <aiUsecaseFieldMappings\>
        <developerName\>DevNamee3</developerName\>
        <mappedFieldName\>Score</mappedFieldName\>
        <mappedFieldType\>PREDICTION\_SCORE</mappedFieldType\>
        <masterLabel\>DevName</masterLabel\>
        <responseFieldName\>Company</responseFieldName\>
        <responseObject\>Lead</responseObject\>
    </aiUsecaseFieldMappings\>
    <aiUsecaseFieldMappings\>
        <developerName\>DevNamee4</developerName\>
        <mappedFieldName\>RecordId</mappedFieldName\>
        <mappedFieldType\>SECONDARY\_RESPONSE\_RECORD\_ID</mappedFieldType\>
        <masterLabel\>DevName</masterLabel\>
        <responseFieldName\>Address</responseFieldName\>
        <responseObject\>Lead</responseObject\>
        <joinFieldInformation\>joinFieldInformation</joinFieldInformation\>
    </aiUsecaseFieldMappings\>
    <aiUsecaseFieldMappings\>
        <developerName\>DevName5</developerName\>
        <mappedFieldName\>DevName4</mappedFieldName\>
        <mappedFieldType\>PREDICTION\_SCORE\_INPUT</mappedFieldType\>
        <masterLabel\>DevName</masterLabel\>
        <responseFieldName\>Address</responseFieldName\>
        <responseObject\>Lead\_Dmo</responseObject\>
        <joinFieldInformation\>{"recordIdField":"Value2","recordIdObject":"Value1","recordJoinRelation":"Value3"}</joinFieldInformation\>
    </aiUsecaseFieldMappings\>
    <aiUsecaseFieldMappings\>
        <developerName\>DevName6</developerName\>
        <mappedFieldName\>DevName5</mappedFieldName\>
        <mappedFieldType\>PREDICTION\_SCORE\_INPUT</mappedFieldType\>
        <masterLabel\>DevName</masterLabel\>
        <responseFieldName\>Address</responseFieldName\>
        <responseObject\>Lead\_Dmo</responseObject\>
        <joinFieldInformation\>{"recordIdField":"Value2","recordIdObject":"Value1","recordJoinRelation":"Value3"}</joinFieldInformation\>
        <additionalFieldInformation\>{"customPredictionAttributes":\[{"id":1,"fieldLabel":"Label 1","sourceField":"Total\_Spend\_c\_\_c"},{"id":2,"fieldLabel":"Label 2","sourceField":"Predicted\_Churned2\_recommendation\_impact\_\_c"}\]}</additionalFieldInformation\>
        <customPredictionLabel\>%%SCORE%%</customPredictionLabel\>
    </aiUsecaseFieldMappings\>
    <aiUsecaseModels\>
        <aiFeatureExtractors\>
            <className\>01pxx0000004X2CAAU</className\>
            <extractorType\>APEX</extractorType\>
            <developerName\>DevNamee2</developerName\>
            <masterLabel\>DevName</masterLabel\>
            <featureInputType\>Realtime\_Input</featureInputType\>
            <inputContext>"{columnNames=\[column1, column2\], rawData=\[S, 315090\]}"</inputContext\>
            <batchInputSourceIdentifier\>DatasetName</batchInputSourceIdentifier\>
            <batchInputSourceType\>CRMA</batchInputSourceType\>
            <batchInputSourceInformation\>{"streamingTransformName":"SDT\_Name","recordIdField":"fieldname","featureFieldsMapping":{"feature1":"field1","feature2":"field2"},"streaminTransformLabel":"SDT\_Label","batchInputSourceLabel":"DMO\_Label"}</batchInputSourceInformation\>
        </aiFeatureExtractors\>
        <defaultFeatureExtractor\>
            <className\>01pxx0000004X0aAAE</className\>
            <extractorType\>APEX</extractorType\>
            <developerName\>DevNamee1</developerName\>
            <masterLabel\>DevName</masterLabel\>
            <featureInputType\>Realtime\_Input</featureInputType\>
            <inputContext>"{columnNames=\[column1, column2\], rawData=\[S, 315090\]}"</inputContext\>
            <batchInputSourceIdentifier\>DatasetName</batchInputSourceIdentifier\>
            <batchInputSourceType\>CRMA</batchInputSourceType\>
            <batchInputSourceInformation\>{"streamingTransformName":"SDT\_Name","recordIdField":"fieldname","featureFieldsMapping":{"feature1":"field1","feature2":"field2"},"streaminTransformLabel":"SDT\_Label","batchInputSourceLabel":"DMO\_Label"}</batchInputSourceInformation\>
        </defaultFeatureExtractor\>
        <developerName\>DevNamee1</developerName\>
        <masterLabel\>DevName</masterLabel\>
        <predictionDefinition\>PredictionDefinitionD</predictionDefinition\>
        <predictionPlatform\>Einstein\_Discovery</predictionPlatform\>
        <arePredctGenInRealTime\>true</arePredctGenInRealTime\>
    </aiUsecaseModels\>
    <aiUsecaseModels\>
        <developerName\>DevNamee2</developerName\>
        <masterLabel\>DevName</masterLabel\>
        <predictionDefinition\>PredictionDefinitionBA</predictionDefinition\>
        <predictionPlatform\>Einstein\_Discovery</predictionPlatform\>
        <arePredctGenInRealTime\>true</arePredctGenInRealTime\>
    </aiUsecaseModels\>
    <aiUsecaseModels\>
        <developerName\>DevNamee3</developerName\>
        <masterLabel\>DevName</masterLabel\>
        <predictionDefinition\>PredictionDefinitionCA</predictionDefinition\>
        <predictionPlatform\>Einstein\_Discovery</predictionPlatform\>
        <arePredctGenInRealTime\>true</arePredctGenInRealTime\>
    </aiUsecaseModels\>
    <aiUsecaseModels\>
        <developerName\>DevName4</developerName\>
        <masterLabel\>DevName</masterLabel\>
        <predictionDefinition\>Model1</predictionDefinition\>
        <predictionPlatform\>Data\_Cloud</predictionPlatform\>
        <arePredctGenInRealTime\>false</arePredctGenInRealTime\>
    </aiUsecaseModels\>
    <aiUsecaseModels\>
        <developerName\>DevName5</developerName\>
        <masterLabel\>DevName</masterLabel\>
        <predictionDefinition\>Model1</predictionDefinition\>
        <predictionPlatform\>Einstein\_on\_Data\_Cloud</predictionPlatform\>
        <arePredctGenInRealTime\>false</arePredctGenInRealTime\>
    </aiUsecaseModels\>
    <masterLabel\>DevName</masterLabel\>
    <maximumInsightCount\>3</maximumInsightCount\>
    <maximumSuggestionCount\>3</maximumSuggestionCount\>
    <maximumRecommendationCount\>3</maximumRecommendationCount\>
    <primaryResponseObject\>Lead</primaryResponseObject\>
    <secondaryResponseObject\>Account</secondaryResponseObject\>
    <recommendationResponseObject\>Contact</recommendationResponseObject\>
    <shouldSaveFeatures\>true</shouldSaveFeatures\>
    <shouldSaveInsights\>true</shouldSaveInsights\>
    <shouldSaveRecommendation\>false</shouldSaveRecommendation\>
    <shouldSaveRequestResponse\>false</shouldSaveRequestResponse\>
    <shouldSaveScore\>true</shouldSaveScore\>
    <shouldSaveSuggestions\>true</shouldSaveSuggestions\>
    <suggestionImpactMinimumPct\>50</suggestionImpactMinimumPct\>
    <usecaseName\>FTestSampleMLUsecase</usecaseName\>
    <recommendationSource\>Next\_Best\_Action\_Flow</recommendationSource\>
    <creatorType\>INTERNAL\_USER</creatorType\>
</AIUsecaseDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>\*AIUsecaseDefinition\*</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=05b22554ef405fe35610eaa9e38c5c4cb9c33ef88aebef6750d8047504a91b76 url=/legacydeveloper/current/en-us/api_meta/meta_allornoneheader.md -->

# AllOrNoneHeader

Indicates whether to roll back all metadata changes when some of the records in a call result in failures.

## Version

This header is available in API version 34.0 and later.

## Supported Calls

[createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously."), [updateMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_updateMetadata.htm "Updates one or more metadata components in your organization synchronously."), [upsertMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_upsertMetadata.htm "Creates or updates one or more metadata components in your organization synchronously."), [deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm "Deletes one or more metadata components from your organization synchronously.")

## Usage

If this header isn’t used in API version 34.0 and later, by default a call can save a partial set of records (equivalent to AllOrNoneHeader=false)—the records that are processed successfully are saved and records that have failures aren’t saved.

## Fields

### allOrNone

- **Type**: boolean
- **Description**: Set to true to cause all metadata changes to be rolled back if any records in the call cause failures. Set to false to enable saving only the records that are processed successfully when other records in the call cause failures.

## Sample Code—Java

Add the AllOrNoneHeader to the metadata connection before you perform a call as follows:

metadataConnection.setAllOrNoneHeader(true);

This next example shows how to use the AllOrNoneHeader when creating two custom objects. Because the second custom object doesn’t have the required Name field, the create() call can’t create this custom object and rolls back the first custom object. The output is shown after this code sample.

import com.sforce.soap.metadata.\*;
import com.sforce.soap.metadata.Error;
import com.sforce.ws.ConnectionException;

public class CallWithHeader {
	
    MetadataConnection metadataConnection = null;
    
    public static void main(String\[\] args) throws ConnectionException {
    	CallWithHeader samples = new CallWithHeader();
        samples.createWithHeader();
    }

    public CallWithHeader() throws ConnectionException {
        metadataConnection = MetadataLoginUtil.login();
    }
    
    public void createWithHeader() throws ConnectionException {
        // Define two custom objects to be inserted.
        CustomObject co1 = new CustomObject();
        String name1 = "MyCustomObject1";
        co1.setFullName(name1 + "\_\_c");
        co1.setDeploymentStatus(DeploymentStatus.Deployed);
        co1.setDescription("Created by the Metadata API");
        co1.setEnableActivities(true);
        co1.setLabel(name1 + " Object");
        co1.setPluralLabel(co1.getLabel() + "s");
        co1.setSharingModel(SharingModel.ReadWrite);

        CustomField nf = new CustomField();
        nf.setType(FieldType.Text);
        nf.setLabel(co1.getFullName() + " Name");
        co1.setNameField(nf);
        
        // The second custom object doesn't have a Name field
        CustomObject co2 = new CustomObject();
        String name2 = "MyCustomObject2";
        co2.setFullName(name2 + "\_\_c");
        co2.setDeploymentStatus(DeploymentStatus.Deployed);
        co2.setDescription("Created by the Metadata API");
        co2.setEnableActivities(true);
        co2.setLabel(name2 + " Object");
        co2.setPluralLabel(co2.getLabel() + "s");
        co2.setSharingModel(SharingModel.ReadWrite);

        
        // Setting the allOrNone header to true to cause
        //  the call to not commit any record if one or more 
        //  records in this call have failures.
        metadataConnection.setAllOrNoneHeader(true);

        // Now that the header has been set, make the create call.
        SaveResult\[\] results = metadataConnection
                .createMetadata(new Metadata\[\] { co1, co2 });

        // Iterate through the call results
        for (SaveResult r : results) {
            if (r.isSuccess()) {
                System.out.println("Created component: " + r.getFullName());
            } else {
                System.out
                        .println("Errors were encountered while creating "
                                + r.getFullName());
                for (Error e : r.getErrors()) {
                    System.out.println("Error message: " + e.getMessage());
                    System.out.println("Status code: " + e.getStatusCode());
                }
            }
        }
    }

}

This is the output that the sample returns. The first record is rolled back and the second has a failure.

Errors were encountered while creating MyCustomObject1\_\_c
Error message: Record rolled back because not all records were valid and the request was using AllOrNone header
Status code: ALL\_OR\_NONE\_OPERATION\_ROLLED\_BACK
Errors were encountered while creating MyCustomObject2\_\_c
Error message: Must specify a nameField of type Text or AutoNumber
Status code: FIELD\_INTEGRITY\_EXCEPTION

<!-- document id=50f04c1d45fcd8b83eae208dd7f82db847a65d286d925595e392f3f80a49aa9e url=/legacydeveloper/current/en-us/api_meta/meta_analyticsdashboard.md -->

# AnalyticsDashboard

Represents a Tableau Next dashboard.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AnalyticsDashboard components have the suffix .uadash and are stored in the analyticsDashboards folder.

## Version

AnalyticsDashboard components are available in API version 64.0 and later.

## Limits

| Definition | Limit |
| --- | --- |
| The maximum number of AnalyticsDashboard components in a single deploy operation. | 50 |
| The maximum number of AnalyticsDashboard components in a single retrieve operation. | 100 |
| The maximum number of AnalyticsDashboard components across all deploy operations in a 24-hour window. | 100 |
| The maximum number of AnalyticsDashboard components across all retrieve operations in a 24-hour window. | 200 |

## Fields

| Field Name | Description |
| --- | --- |
| analyticsWorkspace | 
Field Type

string

Description

Required.

The Tableau Next workspace the dashboard belongs to.



 |
| backgroundSource | 

Field Type

string

Description

The source for the dashboard background.



 |
| customConfig | 

Field Type

string

Description

A custom configuration for the dashboard.



 |
| description | 

Field Type

string

Description

The description of the dashboard.



 |
| lastDraftModifiedDate | 

Field Type

dateTime

Description

The date the dashboard draft was last modified.



 |
| lastPublishedDate | 

Field Type

dateTime

Description

The date the dashboard was last published.



 |
| layouts | 

Field Type

[AnalyticsDashboardLayout\[\]](#AnalyticsDashboardLayout)

Description

The layouts for the dashboard. A dashboard has 0 or more layouts.



 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the dashboard.



 |
| style | 

Field Type

string

Description

The style of the dashboard. This is a JSON string.

Example:

{"widgetStyle":{"backgroundColor":"#ffffff","borderEdges":\[\],"borderColor":"#cccccc","borderWidth":1,"borderRadius":0}}
								







 |
| templateAssetSourceName | 

Field Type

string

Description

If the dashboard was created from a template, the name of the source dashboard in the template.



 |
| templateSource | 

Field Type

string

Description

If the dashboard was created from a template, the name of the source template.



 |
| version | 

Field Type

double

Description

The API version of the dashboard.



 |
| widgets | 

Field Type

[AnalyticsDashboardWidget\[\]](#AnalyticsDashboardWidget)

Description

A list of widgets in the dashboard. A dashboard has 0 or more widgets.



 |
| workspaceAssetRelationships | 

Field Type

[AnalyticsWorkspaceAsset\[\]](meta_analyticsworkspace.htm#AnalyticsWorkspaceAsset)

Description

A list of analytics assets in the workspace this dashboard is associated with. A dashboard has 0 or more workspace asset relationships.



 |

## AnalyticsDashboardLayout

Represents a layout for a Tableau Next dashboard. A dashboard can have multiple layouts, like Desktop and Mobile.

| Field Name | Description |
| --- | --- |
| analyticsDashboard | 
Field Type

string

Description

Required.

The name of the dashboard the layout is associated with.



 |
| analyticsDashboardVersion | 

Field Type

string

Description

The version of the dashboard the layout is associated with.



 |
| columnCount | 

Field Type

string

Description

The number of columns in the layout.



 |
| label | 

Field Type

string

Description

The label for the layout.



 |
| layoutName | 

Field Type

string

Description

The name of the layout.



 |
| maxWidth | 

Field Type

string

Description

The max width of the layout, in pixels.



 |
| pages | 

Field Type

[AnalyticsDashboardPage\[\]](#AnalyticsDashboardPage)

Description

The pages to display for this dashboard layout. A layout has 0 or more pages.



 |
| rowHeight | 

Field Type

string

Description

The row height for layout rows.



 |
| style | 

Field Type

string

Description

The style for the layout. This is a JSON string.

Example:

{"backgroundColor":"#ffffff","gutterColor":"#f3f3f3","cellSpacingX":8,"cellSpacingY":8







 |
| version | 

Field Type

double

Description

The API version of the dashboard layout.



 |

## AnalyticsDashboardPage

Represents a page in a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| index | 
Field Type

int

Description

The index of the page in the dashboard. An index of 0 is the first page of the dashboard. No index is required if there is only the default page of the dashboard.



 |
| label | 

Field Type

string

Description

The label for the dashboard page.



 |
| pageName | 

Field Type

string

Description

The generated unique ID for the dashboard page.



 |
| pageWidgets | 

Field Type

[AnalyticsDashPageWidget\[\]](#AnalyticsDashPageWidget)

Description

A list of dashboard page widgets. A page has 0 or more page widgets.



 |

## AnalyticsDashPageWidget

Represents an dashboard page widget for a Tableau Next dashboard page.

| Field Name | Description |
| --- | --- |
| analyticsDashboardWidget | 
Field Type

string

Description

Required.

The name of dashboard widget, defined in the list of widgets for the dashboard.





 |
| colspan | 

Field Type

string

Description

The column span for the widget on the page. This is a numeric value.



 |
| column | 

Field Type

string

Description

The column the widget is placed in on the page. This is a numeric value.



 |
| row | 

Field Type

string

Description

The row the widget is placed in on the page. This is a numeric value.



 |
| rowspan | 

Field Type

string

Description

The row span for the widget on the page. This is a numeric value.



 |

## AnalyticsDashboardWidget

Represents a widget on a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| analyticsDashboard | 
Field Type

string

Description

Required.

The API name of the dashboard the widget is associated with.





 |
| buttonWidgetDefs | 

Field Type

[AnalyticsButtonWidgetDef\[\]](#AnalyticsButtonWidgetDef)

Description

A list of button widget type definitions. A dashboard has 0 or more button widgets. Required if button widget are defined.



 |
| containerWidgetDefs | 

Field Type

[AnalyticsContainerWidgetDef\[\]](#AnalyticsContainerWidgetDef)

Description

A list of container widget type definitions. A dashboard has 0 or more container widgets. Required if container widgets are defined.



 |
| dynamicTokens | 

Field Type

[AnlytDshbrdWdgtDynamicTkn\[\]](#AnlytDshbrdWdgtDynamicTkn)

Description

A list of dynamic widget tokens. A dashboard has 0 or more dynamic tokens.



 |
| filterWidgetDefs | 

Field Type

[AnalyticsFilterWidgetDef\[\]](#AnalyticsFilterWidgetDef)

Description

A list of filter widget type definitions. A dashboard has 0 or more filter widgets. Required if filter widgets are defined.



 |
| imageWidgetDefs | 

Field Type

[AnalyticsImageWidgetDef\[\]](#AnalyticsImageWidgetDef)

Description

A list of image widget type definitions. A dashboard has 0 or more image widgets. Required if image widgets are defined.



 |
| label | 

Field Type

string

Description

The label for the widget.



 |
| metricWidgetDefs | 

Field Type

[AnalyticsMetricWidgetDef\[\]](#AnalyticsMetricWidgetDef)

Description

A list of metric widget type defintions. A dashboard has 0 or more metric widgets. Required if metric widget are defined.



 |
| navigationWidgetDefs | 

Field Type

[AnalyticsNavWidgetDef\[\]](#AnalyticsNavWidgetDef)

Description

A list of navigation widget type definitions. A dashboard has 0 or more navigation widgets. Required if navigation widgets are defined.



 |
| parameterWidgetDefs | 

Field Type

[AnalyticsParamWidgetDef\[\]](#AnalyticsParamWidgetDef)

Description

A list of parameter widget type defintions. A dashboard has 0 or more parameter widgets. Required for parameter widgets are defined.



 |
| textWidgetDefs | 

Field Type

[AnalyticsTextWidgetDef\[\]](#AnalyticsTextWidgetDef)

Description

TA list of text widget type definitions. A dashboard has 0 or more text widgets. Required if text widgets are defined.



 |
| type | 

Field Type

AnalyticsWidgetType (enumeration of type string)

Description

Required.

The widget type.

Values are:

- button
- container
- extension
- filter
- image
- metric
- parameter
- navigation
- text
- summary
- visualization





 |
| vizWidgetDefs | 

Field Type

[AnalyticsVizWidgetDef\[\]](#AnalyticsVizWidgetDef)

Description

A list of visualization widget type definitions. A dashboard has 0 or more visualization widgets. Required if visualization widgets are defined.



 |
| widgetActions | 

Field Type

[AnalyticsAssetAction\[\]](#AnalyticsAssetAction)

Description

The actions for the widget. A widget has 0 or more text widgets.



 |
| widgetName | 

Field Type

string

Description

The API name of the widget. Use this for the analyticsDashboardWidget value in AnalyticsDashPageWidget.



 |

## AnalyticsAssetAction

Represents an action for a Tableau Next asset.

| Field Name | Description |
| --- | --- |
| actionType | 
Field Type

AnalyticsActionType (enumeration of type string)

Description

Required.

The action type.

Values are:

- filter
- flow
- navigate
- parameter
- recordaction





 |
| analyticsAssetVersion | 

Field Type

string

Description

Optional.

The version of the Analytics asset the action is associated with.





 |
| eventType | 

Field Type

AnalyticsActionEventType (enumeration of type string)

Description

Required.

The action event type.

Values are:

- click
- select





 |
| parameters | 

Field Type

string

Description

The parameter for the action. This is a JSON string.

Example:

{"destination":{"type":"url","target":"www.salesforce.com"}}







 |
| version | 

Field Type

double

Description

The API version of the action.



 |

## AnalyticsButtonWidgetDef

Represents a button widget definition for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| parameters | 
Field Type

string

Description

The parameters for the button widget. This is a JSON String.

Example:

{"text":"Button","alignmentX":"center","alignmentY":"center","fontSize":16}
								







 |

## AnalyticsContainerWidgetDef

Represents a container widget definition for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| parameters | 
Field Type

string

Description

The parameters for the container widget. This is a JSON String.

Example:

{"widgetStyle":{"backgroundColor":"#1295FF","borderEdges":\[\]}}







 |

## AnlytDshbrdWdgtDynamicTkn

Represents a widget dynamic token for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The description for the dynamic token.



 |
| label | 

Field Type

string

Description

The label for the dynamic token.



 |
| source | 

Field Type

string

Description

The source object of the dynamic token.



 |
| tokenName | 

Field Type

string

Description

The name of the dynamic token.



 |
| tokenSpec | 

Field Type

string

Description

The specification for the dynamic token.



 |
| type | 

Field Type

AnalyticsDynamicTokenType

Description

The type of dynamic token.

Values are:

- query
- insights
- metric
- reference





 |

## AnalyticsFilterWidgetDef

Represents a filter widget definition for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| initialValues | 
Field Type

string

Description

The initial values for the filter.



 |
| parameters | 

Field Type

string

Description

The parameters for the filter widget. This is a JSON String.

Example:

{"receiveFilterSource":{"filterMode":"all","widgetIds":\[\]},"filterOption":{"objectName":"Account","fieldName":"Account\_Id","dataType":"Text","selectionType":"multiple"},"isLabelHidden":false}
								







 |
| source | 

Field Type

string

Description

The data source to apply the filter to.



 |

## AnalyticsImageWidgetDef

Represents a image widget definition for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| parameters | 
Field Type

string

Description

The parameters for the image widget. This is a JSON String.



 |
| source | 

Field Type

string

Description

The data source the image is associated with.



 |

## AnalyticsMetricWidgetDef

Represents a metric widget definition for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| parameters | 
Field Type

string

Description

The parameters for the filter widget. This is a JSON String.

Example:

{"metricOption":{"layout":{"componentVisibility":{"details":true,"title":true,"value":true,"comparison":true,"chart":true,"insights":false}},"sdmApiName":"AccountModel","sdmId":"2SMxx0000004CFUGA2"},"receiveFilterSource":{"filterMode":"all","widgetIds":\[\]}}
								







 |
| semanticModel | 

Field Type

string

Description

The semantic model the metric is associated with.



 |
| source | 

Field Type

string

Description

The data source the metric is associated with.



 |
| sourceDeprecated | 

Field Type

string

Description

Present if the data source the metric is associated with is deprecated.



 |
| version | 

Field Type

double

Description

The API version of the metric.



 |

## AnalyticsNavWidgetDef

Represents a navigation widget definition for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| parameters | 
Field Type

string

Description

The parameters for the navigation widget. This is a JSON String.



 |

## AnalyticsParamWidgetDef

Represents a parameters widget definition for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| initialValues | 
Field Type

string

Description

The initial values for the parameters.



 |
| parameters | 

Field Type

string

Description

The parameters for the filter widget. This is a JSON String.

Example:

{"parameterName":"AccountParameter\_prm","isLabelHidden":false}







 |
| source | 

Field Type

string

Description

The data source the parameters are associated with.



 |

## AnalyticsTextWidgetDef

Represents a text widget definition for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| parameters | 
Field Type

string

Description

The parameters for the filter widget. This is a JSON String.

Example:

{"content":\[{"attributes":{"color":"#000000","size":"12px"},"insert":"full dashboard"},{"attributes":{"align":"left"},"insert":"\\n"}\]}
								







 |

## AnalyticsVizWidgetDef

Represents a visualization widget definition for a Tableau Next dashboard.

| Field Name | Description |
| --- | --- |
| analyticsVisualization | 
Field Type

string

Description

The API name of the visualization.



 |
| analyticsVizVersion | 

Field Type

string

Description

The version of the visualization.



 |
| parameters | 

Field Type

string

Description

The parameters for the filter widget. This is a JSON String.

Example:

{"legendPosition":"Right","receiveFilterSource":{"filterMode":"all","widgetIds":\[\]}}







 |

## Declarative Metadata Sample Definition

The following is an example of an AnalyticsDashboard component.

<?xml version="1.0" encoding="UTF-8"?>
<AnalyticsDashboard xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <analyticsWorkspace\>My\_Workspace</analyticsWorkspace\>
    <description\>A dashboard</description\>
    <layouts\>
        <analyticsDashboard\>My\_Dashboard</analyticsDashboard\>
        <columnCount\>36</columnCount\>
        <layoutName\>default</layoutName\>
        <maxWidth\>1200</maxWidth\>
        <label\>layoutLabel</label\>
        <pages\>
            <index\>0</index\>
            <label\>Page 1</label\>
            <pageName\>e412bc11-d43b-4fba-ab44-b31bb842b49a</pageName\>
            <pageWidgets\>
                <analyticsDashboardWidget\>visualization\_1</analyticsDashboardWidget\>
                <colspan\>11</colspan\>
                <column\>1</column\>
                <row\>2</row\>
                <rowspan\>10</rowspan\>
            </pageWidgets\>
            <pageWidgets\>
                <analyticsDashboardWidget\>button\_1</analyticsDashboardWidget\>
                <colspan\>9</colspan\>
                <column\>13</column\>
                <row\>8</row\>
                <rowspan\>2</rowspan\>
            </pageWidgets\>
            <pageWidgets\>
                <analyticsDashboardWidget\>container\_1</analyticsDashboardWidget\>
                <colspan\>11</colspan\>
                <column\>23</column\>
                <row\>2</row\>
                <rowspan\>10</rowspan\>
            </pageWidgets\>
            <pageWidgets\>
                <analyticsDashboardWidget\>text\_2</analyticsDashboardWidget\>
                <colspan\>9</colspan\>
                <column\>13</column\>
                <row\>5</row\>
                <rowspan\>2</rowspan\>
            </pageWidgets\>
            <pageWidgets\>
                <analyticsDashboardWidget\>metric\_1</analyticsDashboardWidget\>
                <colspan\>11</colspan\>
                <column\>1</column\>
                <row\>13</row\>
                <rowspan\>10</rowspan\>
            </pageWidgets\>
            <pageWidgets\>
                <analyticsDashboardWidget\>list\_4</analyticsDashboardWidget\>
                <colspan\>9</colspan\>
                <column\>13</column\>
                <row\>13</row\>
                <rowspan\>2</rowspan\>
            </pageWidgets\>
            <pageWidgets\>
                <analyticsDashboardWidget\>list\_1</analyticsDashboardWidget\>
                <colspan\>9</colspan\>
                <column\>13</column\>
                <row\>2</row\>
                <rowspan\>2</rowspan\>
            </pageWidgets\>
        </pages\>
        <rowHeight\>24</rowHeight\>
        <style\>{&quot;backgroundColor&quot;:&quot;#ffffff&quot;,&quot;gutterColor&quot;:&quot;#f3f3f3&quot;,&quot;cellSpacingX&quot;:8,&quot;cellSpacingY&quot;:8}</style\>
    </layouts\>
    <masterLabel\>My Dashboard</masterLabel\>
    <style\>{&quot;widgetStyle&quot;:{&quot;backgroundColor&quot;:&quot;#ffffff&quot;,&quot;borderEdges&quot;:\[\],&quot;borderColor&quot;:&quot;#cccccc&quot;,&quot;borderWidth&quot;:1,&quot;borderRadius&quot;:0}}</style\>
    <version\>64.0</version\>
    <widgets\>
        <analyticsDashboard\>My\_Dashboard</analyticsDashboard\>
        <type\>visualization</type\>
        <vizWidgetDefs\>
            <analyticsVisualization\>New\_Visualization</analyticsVisualization\>
            <parameters\>{&quot;legendPosition&quot;:&quot;Right&quot;,&quot;receiveFilterSource&quot;:{&quot;filterMode&quot;:&quot;all&quot;,&quot;widgetIds&quot;:\[\]}}</parameters\>
        </vizWidgetDefs\>
        <widgetName\>visualization\_1</widgetName\>
    </widgets\>
    <widgets\>
        <analyticsDashboard\>My\_Dashboard</analyticsDashboard\>
        <buttonWidgetDefs\>
            <parameters\>{&quot;text&quot;:&quot;Button&quot;,&quot;alignmentX&quot;:&quot;center&quot;,&quot;alignmentY&quot;:&quot;center&quot;,&quot;fontSize&quot;:16}</parameters\>
        </buttonWidgetDefs\>
        <type\>button</type\>
        <widgetActions\>
            <actionType\>navigate</actionType\>
            <eventType\>click</eventType\>
            <parameters\>{&quot;destination&quot;:{&quot;type&quot;:&quot;url&quot;,&quot;target&quot;:&quot;www.salesforce.com&quot;}}</parameters\>
            <version\>63.0</version\>
        </widgetActions\>
        <widgetName\>button\_1</widgetName\>
    </widgets\>
    <widgets\>
        <analyticsDashboard\>My\_Dashboard</analyticsDashboard\>
        <containerWidgetDefs\>
            <parameters\>{&quot;widgetStyle&quot;:{&quot;backgroundColor&quot;:&quot;#1295FF&quot;,&quot;borderEdges&quot;:\[\]}}</parameters\>
        </containerWidgetDefs\>
        <type\>container</type\>
        <widgetName\>container\_1</widgetName\>
    </widgets\>
    <widgets\>
        <analyticsDashboard\>My\_Dashboard</analyticsDashboard\>
        <textWidgetDefs\>
            <parameters\>{&quot;content&quot;:\[{&quot;attributes&quot;:{&quot;color&quot;:&quot;#000000&quot;,&quot;size&quot;:&quot;12px&quot;},&quot;insert&quot;:&quot;full dashboard&quot;},{&quot;attributes&quot;:{&quot;align&quot;:&quot;left&quot;},&quot;insert&quot;:&quot;\\n&quot;}\]}</parameters\>
        </textWidgetDefs\>
        <type\>text</type\>
        <widgetName\>text\_2</widgetName\>
    </widgets\>
    <widgets\>
        <analyticsDashboard\>My\_Dashboard</analyticsDashboard\>
        <metricWidgetDefs\>
            <parameters\>{&quot;metricOption&quot;:{&quot;layout&quot;:{&quot;componentVisibility&quot;:{&quot;details&quot;:true,&quot;title&quot;:true,&quot;value&quot;:true,&quot;comparison&quot;:true,&quot;chart&quot;:true,&quot;insights&quot;:false}},&quot;sdmApiName&quot;:&quot;AccountModel&quot;,&quot;sdmId&quot;:&quot;2SMxx0000004CFUGA2&quot;},&quot;receiveFilterSource&quot;:{&quot;filterMode&quot;:&quot;all&quot;,&quot;widgetIds&quot;:\[\]}}</parameters\>
            <source\>AccountMetric\_mtc</source\>
        </metricWidgetDefs\>
        <type\>metric</type\>
        <widgetName\>metric\_1</widgetName\>
    </widgets\>
    <widgets\>
        <analyticsDashboard\>My\_Dashboard</analyticsDashboard\>
        <filterWidgetDefs\>
            <initialValues\>null</initialValues\>
            <parameters\>{&quot;receiveFilterSource&quot;:{&quot;filterMode&quot;:&quot;all&quot;,&quot;widgetIds&quot;:\[\]},&quot;filterOption&quot;:{&quot;objectName&quot;:&quot;Account&quot;,&quot;fieldName&quot;:&quot;Account\_Id&quot;,&quot;dataType&quot;:&quot;Text&quot;,&quot;selectionType&quot;:&quot;multiple&quot;},&quot;isLabelHidden&quot;:false}</parameters\>
            <source\>AccountModel</source\>
        </filterWidgetDefs\>
        <label\>Account Id</label\>
        <type\>filter</type\>
        <widgetName\>list\_4</widgetName\>
    </widgets\>
    <widgets\>
        <analyticsDashboard\>My\_Dashboard</analyticsDashboard\>
        <label\>AccountParameter</label\>
        <parameterWidgetDefs\>
            <initialValues\>null</initialValues\>
            <parameters\>{&quot;parameterName&quot;:&quot;AccountParameter\_prm&quot;,&quot;isLabelHidden&quot;:false}</parameters\>
            <source\>AccountModel</source\>
        </parameterWidgetDefs\>
        <type\>parameter</type\>
        <widgetName\>list\_1</widgetName\>
    </widgets\>
    <templateSource\></templateSource\>
    <templateAssetSourceName\></templateAssetSourceName\>
    <workspaceAssetRelationships\>
        <asset xsi:nil="true"/>
        <assetType\>AnalyticsDashboard</assetType\>
        <assetUsageType\>Created</assetUsageType\>
        <workspace\>My\_Workspace</workspace\>
    </workspaceAssetRelationships\>
</AnalyticsDashboard\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>My\_Dashboard</members\>
        <name\>AnalyticsDashboard</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=102cdaacbed19d8ad87166926355c134c353122278da9bbef9c12ce536fdf4ee url=/legacydeveloper/current/en-us/api_meta/meta_analyticsnapshot.md -->

# AnalyticSnapshot

Represents a reporting snapshot. A reporting snapshot lets you report on historical data. Authorized users can save tabular or summary report results to fields on a custom object, then map those fields to corresponding fields on a target object. They can then schedule when to run the report to load the custom object's fields with the report's data. Reporting snapshots enable you to work with report data similarly to how you work with other records in Salesforce.

## Declarative Metadata File Suffix and Directory Location

Lightning Platform AnalyticSnapshot components are stored in the analyticSnapshots directory of the corresponding package directory. The file name matches the unique name of the reporting snapshot, and the extension is .snapshot.

## Version

Lightning Platform AnalyticSnapshot components are available in API version 16.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | A description of the reporting snapshot. |
| groupColumn | string | A column that specifies which level to extract data from the source report. It’s only applicable for summary reports. |
| mappings | [AnalyticSnapshotMapping](#AnalyticSnapshotMapping)\[\] | A list of reporting snapshot mappings. For valid values, see [AnalyticSnapshotMapping](#AnalyticSnapshotMapping). |
| name | string | Required. The display name of the reporting snapshot. |
| runningUser | string | The username of the user whose role and sharing settings are used to run the reporting snapshot. |
| sourceReport | string | Required. The report where data is extracted from. |
| targetObject | string | Required. The custom object where data is inserted. |

## AnalyticSnapshotMapping

AnalyticSnapshotMapping defines the mapping for the reporting snapshot. Valid values are:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d116068e229">Field</th>

              <th class="featureTableHeader  " id="d116068e232">Field Type</th>

              <th class="featureTableHeader  " id="d116068e235">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d116068e229" data-title="Field"><span class="keyword parmname">aggregateType</span></td>

              <td class="entry" headers="d116068e232" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm#ReportSummaryType">ReportSummaryType</a>[] (enumeration of type string)
              </td>

              <td class="entry" headers="d116068e235" data-title="Description">List that defines if and how each report field is summarized. For
                valid values, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm#ReportSummaryType">ReportSummaryType</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d116068e229" data-title="Field"><span class="keyword parmname"><span class="ph" id="sourceField"><a name="sourceField"><!-- --></a>sourceField</span></span></td>

              <td class="entry" headers="d116068e232" data-title="Field Type">string</td>

              <td class="entry" headers="d116068e235" data-title="Description">The sourceField can be one of the following:<ul class="ul bulletList">
                  <li class="li">The field on the sourceReport that you want to map to the
                    targetField in the targetObject</li>

                  <li class="li">A summary of a filed on the sourceReport (for Summary
                    reports only)</li>

                  <li class="li">A field on the reporting snapshot, such as JobName,
                    RunningUser, or ExecutionTime (set through the user
                    interface)</li>

                </ul>
                <p class="p"><strong class="ph b">Note:</strong> The sourceField must correspond to the
                  sourceType you specify.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d116068e229" data-title="Field"><span class="keyword parmname"><span class="ph" id="sourceType"><a name="sourceType"><!-- --></a>sourceType</span></span></td>

              <td class="entry" headers="d116068e232" data-title="Field Type">
                <a class="xref" href="#ReportJobSourceTypes">ReportJobSourceTypes</a>[] (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)
              </td>

              <td class="entry" headers="d116068e235" data-title="Description">List that defines the report format for the reporting snapshot.
                For valid values, see <a class="xref" href="#ReportJobSourceTypes">ReportJobSourceTypes</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d116068e229" data-title="Field"><span class="keyword parmname"><span class="ph" id="targetField"><a name="targetField"><!-- --></a>targetField</span></span></td>

              <td class="entry" headers="d116068e232" data-title="Field Type">string</td>

              <td class="entry" headers="d116068e235" data-title="Description">A field on the targetObject into which this particular
                sourceField is inserted.</td>

            </tr>

          </tbody>

        </table>

## ReportJobSourceTypes

An enumeration of type string that defines the report format for the reporting snapshot. Valid values are:

| Enumeration Value | Description |
| --- | --- |
| snapshot | Use this option if the sourceField contains snapshot-specific information such as JobName, RunningUser, or ExecutionTime. |
| summary | Use this option if referencing a summary (Sum, Average, Minimum, Maximum) of a field from the sourceReport. |
| tabular | Use this option if referencing an available column from the sourceReport. |

## Declarative Metadata Sample Definition

Here’s a sample XML definition of a reporting snapshot.

<?xml version="1.0" encoding="UTF-8"?>
<AnalyticSnapshot xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>my description</description\>
    <groupColumn\>INDUSTRY</groupColumn\>
    <mappings\>
        <aggregateType\>Average</aggregateType\>
        <sourceField\>SALES</sourceField\>
        <sourceType\>summary</sourceType\>
        <targetField\> myObject \_\_c.Name</targetField\>
    </mappings\>
    <mappings\>
        <sourceField\>ExecutionTime</sourceField\>
        <sourceType\>snapshot</sourceType\>
        <targetField\> myObject \_\_c.field3\_\_c</targetField\>
    </mappings\>
    <mappings\>
        <sourceField\>INDUSTRY</sourceField\>
        <sourceType\>tabular</sourceType\>
        <targetField\>testObject\_\_c.Name</targetField\>
    </mappings\>
    <name\>my snapshot</name >
    <runningUser\>user@salesforce.com</runningUser\>
    <sourceReport\>myFolder/mytSummaryReport</sourceReport\>
    <targetObject\>myObject\_\_c</targetObject\>
</AnalyticSnapshot\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

#### See Also

- [Report](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm "Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.")

<!-- document id=dd6d0cdd601bf2c45edde65cfbe77748671bc1cadababbb2e76b2406133e6ec3 url=/legacydeveloper/current/en-us/api_meta/meta_analyticssettings.md -->

# AnalyticsSettings

Represents Analytics settings in Salesforce. CRM Analytics lets you explore all your data quickly and easily by providing AI-powered advanced Analytics right inside Salesforce. Manage your datasets, query data with Salesforce Analytics Query Language (SAQL), and customize dashboards. You can use these settings to configure which Analytics features are available to users in your organization.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AnalyticsSettings values are stored in the Analytics.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AnalyticsSettings components are available in API version 46.0 and later.

## Special Access Rules

The AnalyticsSettings metadata type is accessible in all organizations. The fields that pertain to Reports and Dashboards are available in all organizations. Fields that pertain to CRM Analytics, Data 360 Reports and Dashboards, Tableau, and Tableau Next are only available in orgnizations with CRM Analytics, Data 360, Tableau, and Tableau Next licenses and enablement.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d117324e111">Field Name</th>

              <th class="featureTableHeader  " id="d117324e114">Field Type</th>

              <th class="featureTableHeader  " id="d117324e117">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">always​Gen​Previews</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Analytics asset previews are generated (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">analytics​Adoption​Metadata</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Adoption Analytics metadata collection can be installed via a
                  dataflow in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">analytics​Calendar​App</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Analytics Calendar app for Industry templates can be
                  installed in Salesforce (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 49.0.
                  Removed in API version 50.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">auto​Install​Apps</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether CRM Analytics apps can be auto-installed in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 54.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">bundle​Caching​Opt​Out</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the default CRM Analytics dashboard bundle caching behavior is disabled (<samp class="codeph nolang">true</samp>) or enabled (<samp class="codeph nolang">false</samp>). Available in API version 58.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">can​Access​Analytics​Via​API</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Analytics assets can be accessed via the Analytics REST API in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">can​Annotate​Dashboards</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Analytics dashboards Chatter annotation feature is enabled
                  in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">can​Enable​BYOM​Zero​Day​Scoring</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether zero day scoring on user uploaded Einstein Discover model is
                  enabled in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 54.0 to 56.0.
                  Removed in API version 57.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">can​Enable​Live​Metrics</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Data Discovery live model metrics calculation feature is
                  enabled in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and 49.0.
                  Removed in API version 50.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">can​Enable​Saved​View</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the saved view feature for Analytics dashboards is enabled in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">can​Explore​Data​Conversationally</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Analytics data can be explored via NLQ (<samp class="codeph nolang">true</samp>) rather than using strict SAQL statements
                  (<samp class="codeph nolang">false</samp>). For example, "Show me all accounts
                  that are closed won". Available in API version 47.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">can​Share​Apps​With​Communities</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Analytics apps can be shared with Experience Builder sites and
                  their users, outside of the standard Analytics Studio experience (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">can​Subscribe​Dashboard​Widgets</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether a user can subscribe to Analytics dashboard widgets in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 to 50.0.
                  Removed in API version 51.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">can​View​Thumbnail​Assets</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the thumbnail representations of Analytics lenses and
                  dashboards are viewable (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">cdp​Query​Caching​Opt​In</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether caching is enabled for direct queries to Data 360 (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 65.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">concurrency​Limit​Sharing</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the concurrency limits of Data Prep dataflows and recipes can be shared (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 60.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">disable​Incremental​Dataset​Creation</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether incremental dataset optimization is disabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 65.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Ai​Sentiment​In​Dcr​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether AI sentiment analysis is enabled for Data 360 reports (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Amazon​Redshift​Output​Connector</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Amazon Redshift Output connector is enabled in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 58.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Analytics​Encryption</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether encryption is enabled for Analytics in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Analytics​Sharing​Enable</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Analytics sharing is enabled in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Analyze​In​Tableau​Next</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Analyze in Tableau Next feature is enabled in Data 360 reports (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Auto​Complete​Combo</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether using auto-complete when choosing reports and dashboards is
                  enabled in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Autonomous​Experience</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Ask Salesforce for Data is enabled in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available as Beta in API version 54.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Azure​DL​Gen2​Output​Connector</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Azure DL Gen2 output connector is enabled in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 54.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​C360​Global​Profile​Data</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Customer 360 data validation dashboard connector is enabled
                  in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 or later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Cdp​Beta​Connectors</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether beta Data 360 connectors are enabled for Tableau Next (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Cio​History​Reporting​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether CIO history reporting is enabled
                  for Data 360 reports (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 or later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Create​Legacy​Dataflows</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether access to creating dataflows is available in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 55.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Crma​Data​Cloud​Integration</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether platform integration between CRM Analytics and Data 360 is enabled
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 58.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Crma​Subs​For​Exp​Cloud</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether CRM Analtyics subscriptions are available in Experience Cloud
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Cross​Cloud​Csi</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether cross-cloud calculated insights (CSI) are enabled for Data 360 reports and Tableau Next (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Crt​Setup​Lightning​UiPref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the enhanced custom report type setup pages is enabled in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 64.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Currency​Support​In​DCR​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether currency fields are enabled
                  for Data 360 reports (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 or later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Dashboard​Change​Owner​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether changing ownership of Lightning Experience dashboards from one owner to another owner is enabled in Salesforce (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 59.0.
                  Removed in API version 60.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Dashboard​Cmp​Refresh​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Lightning Experience dashboard component refresh is enabled in Salesforce (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 64.0. Removed in API 65.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Dashboard​Component​Snapshot</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether posting dashboard component snapshots to feeds that are visible
                  to all users is enabled in Salesforce (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0
                  and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Dashboard​Flexi​Table</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether access is enabled to flexible dashboard tables for all users in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Dashboard​To​PDF​Enable</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether a dashboard can be exported to a PDF in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Dashboard​Sub​Org​Email​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the unique org email for Lightning Experience dashboard subscriptions is
                  enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 64.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Data​Cloud​Reporting​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Data 360 reporting with the analytics query engine is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 59.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Data​Blending</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Analytics Explorer data blending feature is available in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and 49.0.
                  Removed in API version 50.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Dimensional​Hierarchy​In​DCR​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether dimenional hierarchy is enabled
                  for Data 360 reports (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 or later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Easy​Setup​AI</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Easy Setup AI experience is enabled for Tableau Next (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Email​Reports​To​Portal​Users</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether this org allows Classic reports and dashboards to be sent to
                  Portal Users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Explore​In​Tableau</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Explore in Tableau feature is enabled for Salesforce analytics features (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 60.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Firebird​Editor</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Firebird editor is available in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Floating​Report​Headers</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether report results display floating headers when scrolling (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Headless​Browser​Service​TOS</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the terms of service for the Analytics headless browser service are available in Salesforce (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Include​Disclaimer​Message</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether confidental data disclaimers are included with analytics assets (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 64.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Incremental​Upsert</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">Indicates whether the incremental upsert operation is enabled for CRM Analytics
                recipe output nodes (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 66.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Insights</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether CRM Analytics is enabled in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Insights​HC​Mode</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether CRM Analytics for Public Cloud is enabled in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 58.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Joined​Report​In​DCR​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether joined reports are enabled
                  for Data 360 reports (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 or later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Lightning​Dashboard​LWR​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Lightning Web Runtime (LWR) is enabled for Lightning Experience
                  dashboards (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                  Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Lightning​Report​Builder</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Lightning Report Builder feature can be enabled or disabled
                  on the Setup page in Salesforce (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Lightning​Report​LWR​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Lightning Web Runtime (LWR) is enabled for Lightning Experience reports
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Lotus​Notes​Images</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the use of Lotus Notes-friendly images in dashboards and report
                  emails is available in Salesforce (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 47.0
                  and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Lwc​In​Dashboards</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Lightning Web Components are enabled for use in CRM Analytics
                  Dashboards (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available as Beta in API version 53.0.
                  Removed for GA in API version 54.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​MDW</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the metadata warehouse (MDW) is enabled for semantic authoring in Salesforce Analytics
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 64.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Mass​Enable​Report​Builder</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Report Builder is available in Salesforce (<samp class="codeph nolang">true</samp>), overriding profile level settings, or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Native​Tableau​LWC</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether native Tableau Lightning Web Components are enabled in Salesforce (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 64.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​New​Charts​Engine</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the New Charts Engine for reports and dashboards is available
                  in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Null​Dimension</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether null values are supported as a grouping key value in a SAQL
                  query in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Org​Can​See​Live​Previews</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether admins can enable live previews of data in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 57.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Org​Can​View​Tableau</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether admins can enable Tableau dashboards in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 55.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Org​Can​View​Thumbnail​For​OA</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether admins can enable thumbnails for Lightning Experience reports
                  and dashboards in Salesforce (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 57.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Org​Has​Mobile​Offline​Enabled</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether admins can enable mobile offline access in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 51.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Org​Has​Watchlist​Enabled</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether admins can turn on watchlists for assets in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 50.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Org​Hierarchy</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the org hierarchy feature is enabled for Tableau Next
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Org​Hierarchy​In​Dcr​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether org hierarchy is enabled for Data 360 reports (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Org​Wide​Email​Notification</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether a unique org email for CRM Analytics dashboard subscriptions and notifications is
                  enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 65.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Power​Insights</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether admins can turn on Power Insights for this org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Removed in API version 51.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Predict​Function</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the creating Predict Caluculated Fields is enabled for semantic authoring in Salesforce Analytics
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Pupparazzi​For​Notifications</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">Indicates whether the CRM Analytics Hyperforce headless browser service is
                enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 66.0 and
                above.</td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Query​Live​Connectors</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether querying live connectors is available in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Recommended​Report​Type​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether recommended report types for Lightning Reports are available in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 54.0 to 56.0.
                  Removed in API version 57.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Remote​Home​Org​Ops</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether remote home org operations are enabled for the App Template Framework in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 65.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Remove​Footer​For​Rep​Display</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the default disclaimer for the report run page and printable
                  view page is removed (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) in Salesforce. Available in API version 47.0
                  and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Remove​Footer​From​Rep​Exp</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the default footer from the exported (csv/excel) report is
                  removed (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) in Salesforce. Available in API version 47.0
                  and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Cdn​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the content delivery network (CDN) feature in Lightning Experience
                  Reports is available in Salesforce (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 64.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Custom​Text​Export​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">Indicates whether the export of custom text in Lightning Experience Reports is
                available in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 66.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Escape​Chars​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the sanitization of malicious characters in CSV exports to prevent formula injection feature in Lightning Experience
                  Reports is available in Salesforce (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 65.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Field​To​Field​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the field-to-field filters feature in Lightning Experience
                  Reports is available in Salesforce (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 47.0.
                  Removed in API version 48.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Crt​Auto​Add​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the feature to automatically add new fields to relevant custom
                  Lightning Experience report types when they’re created is available in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 50.0 and 51.0. Removed in API version
                  52.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Hide​Xls​Export​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the XLS export feature for Lightning Experience Reports is
                  visible in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 51.0 and
                  later.</p>

                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>To manage this setting, users must have the Export
                            Reports user permission.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Inline​Edit​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the inline editing feature for Lightning Experience Reports is
                  available in Salesforce (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 53.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Interface​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">Indicates whether interfaces on Data 360 reports during packaging are enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                Available in API version 66.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Notifications​Enable</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the notification feature for Lightning Experience Reports is
                  available in Salesforce (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Record​Preview​Org​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the report record preview feature is enabled for Data 360 reports
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Sub​Org​Email​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the unique org email for Lightning Experience Report subscriptions is
                  enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 61.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Unique​Row​Count​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the unique row count aggregate feature in Lightning Experience
                  Reports is available in Salesforce (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 47.0.
                  Removed in API version 48.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Report​Type​Search​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether report type search is enabled for Data 360 reports
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Reporting​On​SDM​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether reporting on Data 360 semantic models (SDM) is enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 63.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Request​Priority​Schdl</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether priority-based dataflow request scheduling is available in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 50.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​S1​Analytics​Eclair​Enable</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether EclairNG charts can be enabled for S1 Mobile Analytics in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​S3​Output​Connector</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the S3 output data connector is available in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 49.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​SFX​Joined​Reports​Enable</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Lightning Experience joined report feature can be enabled
                  or disabled on the Setup page in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available
                  in API version 47.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Salesforce​Output​Connector</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Salesforce output data connector is available in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 51.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Secure​Image​Sharing</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether secure image sharing and downloading is enabled in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 50.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Smart​Data​Discovery</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the org admin can enable Einstein Discovery in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 49.0 and 50.0. Removed in API version
                  51.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Semantic​Authoring​AI</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether semantic authoring AI is enabled for Salesforce Analytics
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Show​High​Contrast​Chart</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether high-contrast charts are enabled for Tableau Next dashboards
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 63.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Snowflake​Output​Connector</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Snowflake output data connector is available in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 49.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Summary​Filter​Org​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Lightning Experience Report summary filters are
                  enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 60.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Sql​Dataset</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether SQL datasets are available in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 52.0. Removed in API version
                  53.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Sql​Live​Dataset</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether SQL live datasets are available in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 51.0 and 52.0. Removed in API version
                  53.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​TN​App​Auto​Install</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next templated apps can be auto-installed in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​TN​App​Auto​Update</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next templated apps are automatically updated in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Adoption​Insights</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Admin Adoption Insights is enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Agent</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Agent is enabled in Agentforce (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Agent​Analyze​Data</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the standard Tableau Agent Data Analysis topic and Analyze Data action are enabled in Agentforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Agent​Beacon</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Agent Beacon, which generates analytical insights that surface relevant business findings and recommendations
                  proactively, is enabled in Agentforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Agent​Create​Alert</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the standard Tableau Agent Data Alert Management topic and Create Data Alert action are enabled in Agentforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Agent​Data​Exploration</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Agent Data Connection and Analytics Creation are enabled in Agentforce (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Agent​Data​Pro</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the standard Tableau Agent Semantic Model Curation topic and Create Calculated Field actions are enabled in Agentforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Agent​Description​Generation</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Agent Description Generation action is enabled in Agentforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Agentic​Transforms</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Agent agentic transforms are enabled in Agentforce (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Analytics​Feedback​Streaming</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Agent analytics feedback streaming is enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Analytics​Interactions</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Agent analytics interactions testing center is enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Annotations</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau annotations are enabled for Slack (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Asset​Compare​Use​Llm</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau asset comparison API uses LLM-powered comparison (<samp class="codeph nolang">true</samp>)
                  or the deterministic engine (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Asset​Thumbnail</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next asset thumbnails are enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Audit</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next auditing is enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Client​Monitor</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Next client monitor is enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Concierge​V2</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next Concierge V2 is enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Enhanced​Visualization​Authoring</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether beta features for Tableau Next visualization authoring are enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​External​Data​Exploration</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next external data exploration is enabled (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Following</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Next following feature is enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Generate​Visualization</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Agent generate visualization feature is enabled in Agentforce (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Hyper​Output​Connector</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau hyper output data connector is available in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 51.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​MI​Summary</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Next metrics insights (MI) summary is enabled
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Maps</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next maps are enabled
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Personal​Org</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next personal orgs are enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Personal​Org​Sf​Support</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Salesforce support login as SysAmdin is enabled for Tableau Next personal orgs (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Platform</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Next platform is enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Private​Marketplace​Consume​Flow</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next marketplace is enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Private​Marketplace​Metric​Consume​Flow</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next marketplace metric templates are enabled (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Private​Marketplace​Template​Builder​Flow</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Next marketplace template builder is enabled (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Sdm​Ai​Optimization</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau semantic model (SDM) AI optimization is enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Seamless​Auth</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Tableau Next configuration for token-based authentication is enabled (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Slack​App</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Next Slack app is enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Slack​Collab</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Next integration for Slack is enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Tableau​Template​Bldr</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Tableau Next template builder is enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 68.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Use​Old​Charts​Look​And​Feel</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether this org allows the old charts look and feel for Lightning
                  Experience reports and dashboards (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 47.0
                  and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Assets​New​Date​Version</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the new date version for timezone support in Analytics assets
                  is enabled in Salesforce (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 51.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Custom​Fiscal</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether custom fiscal year is enabled for Analytics in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, custom fiscal year lets admins import custom
                  fiscal year definitions from Salesforce to Analytics. Available in API version
                  50.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Iframe​Dashboard</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether using legacy iframe embedding instead of LWC for CRM Analytics dashboards is enabled
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 57.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Index​MV​Dim</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether multivalve dimension indexing is enabled in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 50.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Index​MV​Dim​V2</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether version 2 multivalve dimension indexing is enabled in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 52.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Multi​Currency</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether CRM Analytics multiple currencies is
                  enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 56.0 and
                  later. (Beta)</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Lwc​Dashboards</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether embedded Analytics dashboards are rendered in Lightning
                  Experience using a Lightning Web Component (<samp class="codeph nolang">true</samp>) or the legacy Aura Component (<samp class="codeph nolang">false</samp>). Available in API version 55.0 and 56.0. Removed in API version
                  57.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Record​Navigation</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether browser tab navigation for record actions from Analytics is
                  enabled in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Replication</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether replication (extract) for Salesforce objects is enabled in
                  Salesforce (<samp class="codeph nolang">true</samp>) instead of SFDC Digest
                  (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Sharing​Inheritance</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Analytics data can inherit sharing and security settings for
                  their source object in Salesforce (<samp class="codeph nolang">true</samp>) or
                  not (<samp class="codeph nolang">false</samp>). Available in API version 47.0
                  and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Sql​CF​Indexing</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether indexing for custom fiscal dates in SQL queries is enabled in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 58.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Sql​In​Query​Api</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether SQL is enabled for CRM Analytics in the Query API in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available as Beta in API version 53.0. Removed for GA in API
                  version 54.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Template</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Analytics templates are enabled for this org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Removed in API version 51.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Wave​Trended​Dataset​Cleanup</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether this org allows automatic deletion of inactive trended datasets
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 47.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">enable​Write​To​Data​Cloud</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether CRM Analytics recipe output to Data 360 is
                  enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 60.0 and
                  later. (Beta)</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">etl​Orchestration​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Data Prep recipe orchestration is
                  enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 54.0 and
                  later. (Beta)</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">incremental​Upsert​Enabled</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">Indicates whether the incremental upsert operation is enabled for CRM Analytics
                recipe output nodes (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 66.0. Removed in API version 68.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">inherit​Sharing​For​Non​Oppty​Objects</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether medium visibility support for Analytics sharing inheritance for
                  all Salesforce objects besides the Opportunity object is available in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and 49.0. Removed in API version
                  50.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">inherit​Sharing​For​Oppty​Object</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether medium visibility support for Analytics sharing inheritance for
                  the Opportunity object is available in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available
                  in API version 48.0 and 49.0. Removed in API version 50.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">is​Discovery​Optimization​Enabled</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Einstein Discovery optimization is
                  enabled (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). Available in API version 58.0 and
                  later. (Beta)</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">is​High​Volume​Pushback​Enabled</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether Einstein Discovery high volume push back is enabled in
                  Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 58.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">max​Hours​App​In​Progress</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">integer</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">The maximum number of hours an embedded application can have the status
                  <span class="keyword parmname">InProgress</span> before it’s canceled. Available in API version
                  50.0 and later.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">query​Caching​Opt​Out</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the option to cache query results is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available
                  in API version 59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">recipe​Direct​Data​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the option to enable Data Prep recipe direct data loading is
                  available (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 53.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">recipe​Fiscal​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the option to enable Data Prep recipe custom fiscal settings is
                  available (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 53.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">recipe​Pre​Caching​Opt​Out</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the option to disable Data Prep recipe pre-step caching is
                  available (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 53.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">recipe​Schedule​Export​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether exporting schedules for CRM Analytics recipes is enabled
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 67.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">recipe​Staged​Data​Pref</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether staged data for Data Prep recipes is available in Salesforce
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 53.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">replace​Blank​Measures​With​Nulls</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether null values are supported in measures (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If enabled (<samp class="codeph nolang">true</samp>), the
                  implicit default value for blank measures is null. Available in API version 48.0
                  and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">set​Wave​Is​Year​End​Fiscal​Year</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Analytics year end is the fiscal year end (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This preference is only applicable when <samp class="codeph nolang">enableWaveCustomFiscal</samp> is <samp class="codeph nolang">true</samp>. If <samp class="codeph nolang">false</samp>, the fiscal year end is the calendar year end. Available in API
                  version 50.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">sonic​Enabled</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the Sonic feature is available in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 51.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d117324e111" data-title="Field Name"><span class="keyword parmname">turn​On​Time​Zones</span></td>

              <td class="entry" headers="d117324e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d117324e117" data-title="Description">
                <p class="p">Indicates whether the timezone feature is available in Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and later.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the Analytics.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<AnalyticsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableWaveTemplate\>true</enableWaveTemplate\>
    <enableInsights\>true</enableInsights\>
    <canAccessAnalyticsViaAPI\>true</canAccessAnalyticsViaAPI\>
</AnalyticsSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Analytics settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Analytics</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=43173570e31f812269daf6eadff6c0ea39e3c7729e2322cbcd98e5e781c519fb url=/legacydeveloper/current/en-us/api_meta/meta_analyticsvisualization.md -->

# AnalyticsVisualization

Represents a Tableau Next visualization.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AnalyticsVisualization components have the suffix .uaviz and are stored in the analyticsVisualizations folder.

## Version

AnalyticsVisualization components are available in API version 64.0 and later.

## Limits

| Definition | Limit |
| --- | --- |
| The maximum number of AnalyticsVisualization components in a single deploy operation. | 50 |
| The maximum number of AnalyticsVisualization components in a single retrieve operation. | 100 |
| The maximum number of AnalyticsVisualization components across all deploy operations in a 24-hour window. | 100 |
| The maximum number of AnalyticsVisualization components across all retrieve operations in a 24-hour window. | 200 |

## Fields

| Field Name | Description |
| --- | --- |
| actions | 
Field Type

[AnalyticsAssetAction\[\]](meta_analyticsdashboard.htm#AnalyticsAssetAction)

Description

The actions for the visualization. A visualization has 0 or more actions.



 |
| analyticsWorkspace | 

Field Type

string

Description

Required.

The Tableau Next workspace the visualization belongs to.



 |
| creationSource | 

Field Type

string

Description

The creation source for the visualization.



 |
| dataSource | 

Field Type

string

Description

Required.

The data source for the visualization.



 |
| description | 

Field Type

string

Description

The description for the visualization.



 |
| fields | 

Field Type

[AnalyticsVizField\[\]](#AnalyticsVizField)

Description

A list of data fields for the visualization. A visualization has 0 or more fields.



 |
| lastDraftModifiedDate | 

Field Type

dateTime

Description

The date and time the workspace draft was last modified.



 |
| lastPublishedDate | 

Field Type

dateTime

Description

The date and time the workspace was last published.



 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the visualization.



 |
| templateAssetSourceName | 

Field Type

string

Description

If the visualization was created from a template, the name of the source visualization in the template.



 |
| templateSource | 

Field Type

string

Description

If the visualization was created from a template, the name of the source template.



 |
| version | 

Field Type

double

Description

The API version of the visualization.



 |
| views | 

Field Type

[AnalyticsVizViewDef\[\]](#AnalyticsVizViewDef)

Description

A list of views for the visualization. A visualization has 0 or more views.



 |
| visualSpecification | 

Field Type

base64Binary

Description

Required.

The visual specification for the visualization.



 |
| workspaceAssetRelationships | 

Field Type

[AnalyticsWorkspaceAsset\[\]](meta_analyticsworkspace.htm#AnalyticsWorkspaceAsset)

Description

A list of analytics assets in the workspace this visualization is associated with. A visualization has 0 or more workspace asset relationships.



 |

## AnalyticsVizField

Represents a data field in a visualization.

| Field Name | Description |
| --- | --- |
| adHocCalc | 
Field Type

string

Description

The expression to do an ad-hoc calculation with.



 |
| analyticsVizVersion | 

Field Type

string

Description

The version of the visualization the field is associated with.



 |
| computeUsing | 

Field Type

string

Description

The expression to compute the field value with.



 |
| displayCategory | 

Field Type

VisualizationFieldDisplayCategoryType (enumeration of type string)

Description

The display category type for the visualization field.

Values are:

- Continuous
- Discrete





 |
| fieldKey | 

Field Type

string

Description

Required.

The key for the field.



 |
| fieldName | 

Field Type

string

Description

The name of the field.



 |
| function | 

Field Type

VisualizationFieldFunctionType (enumeration of type string)

Description

The function type of the visualization field.

Values are:

- Attr
- Avg
- Count
- CountD
- DatePartDay
- DatePartHour
- DatePartMinute
- DatePartMonth
- DatePartQuarter
- DatePartSecond
- DatePartWeek
- DatePartWeekDay
- DatePartYear
- DateTruncDay
- DateTruncHour
- DateTruncMinute
- DateTruncMonth
- DateTruncQuarter
- DateTruncSecond
- DateTruncWeek
- DateTruncYear
- FiscalDatePartMonth
- FiscalDatePartQuarter
- FiscalDatePartWeek
- FiscalDatePartYear
- FiscalDateTruncMonth
- FiscalDateTruncQuarter
- FiscalDateTruncWeek
- FiscalDateTruncYear
- Max
- Mdy
- Median
- Min
- My
- Stdev
- Stdevp
- Sum
- UserAgg
- Var
- Varp





 |
| hierarchyName | 

Field Type

string

Description

The hierarchy name for the field.



 |
| hierarchyLevel | 

Field Type

integer

Description

The hierarchy level for the field.



 |
| label | 

Field Type

string

Description

The label for the field.



 |
| latitudeOrY | 

Field Type

string

Description

The latitude or Y value for the field.



 |
| longitudeOrX | 

Field Type

string

Description

The longitude or X value for the field.



 |
| objectName | 

Field Type

string

Description

The name of the data source object for the field.



 |
| positionName | 

Field Type

string

Description

The position name for the field.



 |
| positional | 

Field Type

base64binary

Description

The positional data for the field.

REMOVED in v68.0.





 |
| quickTableCalc | 

Field Type

string

Description

The expression to do a quick table calculation with.



 |
| role | 

Field Type

VisualizationFieldRoleType (enumeration of type string)

Description

The role type of the visualization field.

Values are:

- Dimension
- Measure





 |
| type | 

Field Type

VisualizationFieldType (enumeration of type string)

Description

The type of the visualization field.

Values are:

- Field
- MapPosition
- MeasureNames
- MeasureValues





 |

## AnalyticsVizViewDef

Represents a view definition for a Tableau Next visualization.

| Field Name | Description |
| --- | --- |
| analyticsVizVersion | 
Field Type

string

Description

The version of the visualization the view is associated with.



 |
| fullName | 

Field Type

string

Description

Required.

The full name of the view definition.



 |
| isOriginal | 

Field Type

boolean

Description

Required.

Indicates whether the view is original (true) or not (false).



 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the view definition.



 |
| version | 

Field Type

double

Description

The API version of the visualization view.



 |
| viewSpecification | 

Field Type

string

Description

The specification for the view definition.



 |

## Declarative Metadata Sample Definition

The following is an example of an AnalyticsVisualization component.

<?xml version="1.0" encoding="UTF-8"?>
<AnalyticsVisualization xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <analyticsWorkspace\>My\_Workspace</analyticsWorkspace\>
  <description\>A visualization</description\>
  <dataSource\>My\_Semantic\_Model</dataSource\>
  <fields\>
    <displayCategory\>Discrete</displayCategory\>
    <fieldKey\>Field1</fieldKey\>
    <fieldName\>Lead\_Source18</fieldName\>
    <objectName\>Opportunity\_Home</objectName\>
    <role\>Dimension</role\>
     <type\>Field</type\>
  </fields\>
  <fields\>
    <fieldKey\>Field2</fieldKey\>
    <displayCategory\>Continuous</displayCategory\>
    <fieldName\>Amount</fieldName\>
    <function\>Sum</function\>
    <objectName\>Opportunity\_Home</objectName\>
    <role\>Measure</role\>
    <type\>Field</type\>
  </fields\>
  <views\>
    <fullName\>default</fullName\>
    <masterLabel\>My\_Visualization\_default</masterLabel\>
    <viewSpecification\>
      {&quot;filters&quot;:\[{&quot;fieldKey&quot;:&quot;Field1&quot;,&quot;filterInfos&quot;:\[{&quot;isCustom&quot;:false,&quot;isExcludes&quot;:false,&quot;type&quot;:&quot;In&quot;,&quot;useAll&quot;:false,&quot;values&quot;:\[&quot;NewBusiness&quot;\]},{&quot;includeAllValuesWhenEmpty&quot;:true,&quot;isExcludes&quot;:false,&quot;operator&quot;:&quot;Contains&quot;,&quot;type&quot;:&quot;WildCard&quot;,&quot;value&quot;:&quot;&quot;}\],&quot;isContext&quot;:false}\],&quot;sorts&quot;:\[{&quot;byField&quot;:&quot;Field2&quot;,&quot;fieldKey&quot;:&quot;Field1&quot;,&quot;order&quot;:&quot;Ascending&quot;,&quot;type&quot;:&quot;Nested&quot;}\]}</viewSpecification\>
    <isOriginal\>true</isOriginal\>
  </views\>
  <masterLabel\>My\_Visualization</masterLabel\>
  <version\>64.0</version\>
  <templateSource\></templateSource\>
  <templateAssetSourceName\></templateAssetSourceName\>
  <workspaceAssetRelationships\>
    <asset xsi:nil="true"/>
    <assetType\>AnalyticVisualization</assetType\>
    <assetUsageType\>Created</assetUsageType\>
    <workspace\>My\_Workspace</workspace\>
  </workspaceAssetRelationships\>
</AnalyticsVisualization\>

The following is an example package.xml that references the metadata definition.

<?xml version="1.0" encoding="UTF-8"?>
	<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
	<members\>My\_Visualization</members\>
	<name\>AnalyticsVisualization</name\>
	</types\>
	<version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=bd9920bd13cc499ea307ce8757455c4faf71bc2a1fc4a391402fc637e0ddb2b1 url=/legacydeveloper/current/en-us/api_meta/meta_analyticsworkspace.md -->

# AnalyticsWorkspace

Represents a Tableau Next workspace.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AnalyticsWorkspace components have the suffix .analtyicsWorkspace and are stored in the analyticsWorkspaces folder.

## Version

AnalyticsWorkspace components are available in API version 64 and later.

## Limits

| Definition | Limit |
| --- | --- |
| The maximum number of AnalyticsWorkspace components in a single deploy operation. | 50 |
| The maximum number of AnalyticsWorkspace components in a single retrieve operation. | 100 |
| The maximum number of AnalyticsWorkspace components across all deploy operations in a 24-hour window. | 100 |
| The maximum number of AnalyticsWorkspace components across all retrieve operations in a 24-hour window. | 200 |

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The workspace description.



 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the workspace.



 |
| workspaceAssetRelationships | 

Field Type

[AnalyticsWorkspaceAsset\[\]](#AnalyticsWorkspaceAsset)

Description

The workspace assets associated with the workspace. A workspace has 1 or more assets.



 |

## AnalyticsWorkspaceAsset

Represents a Tableau Next analytics asset.

| Field Name | Description |
| --- | --- |
| asset | 
Field Type

string

Description

Required.

The name of workspace asset



 |
| assetType | 

Field Type

AnalyticsWorkspaceAssetType (enumeration of type string)

Description

Required.

The workspace asset type

Values are:

- AnalyticsDashboard (Tableau Next Dashboard)
- AnalyticsVisualization (Tableau Next Visualization)
- MktCalculatedInsightObject (Data 360 Calculated Insight Object)
- MktDataConnection (Data 360 Connection)
- MktDataLakeObject (Data 360 Data Lake Object)
- MktDataModelObject (Data 360 Data Model Object)
- SemanticModel (Semantic Model)





 |
| assetUsageType | 

Field Type

AnalyticsWorkspaceAssetUsageType (enumeration of type string)

Description

Required.

The workspace asset usage type.

Values are:

- Created
- Referenced





 |
| metadataSourceType | 

Field Type

AnalyticsWorkspaceAssetMetadataSourceType (enumeration of type string)

Description

The workspace asset metadata source type.

Values are:

- Promoted
- Reused





 |
| workspace | 

Field Type

string

Description

Required.

The workspace the asset belongs to.



 |

## Declarative Metadata Sample Definition

The following is an example of an AnalyticsWorkspace component.

<?xml version="1.0" encoding="UTF-8"?>
  <AnalyticsWorkspace xmlns="http://soap.sforce.com/2006/04/metadata">
  <description\>An example for Analytics Workspace</description\>
  <masterLabel\>Analytics Workspace</masterLabel\>
  <workspaceAssetRelationships\>
  	  <asset\>My Test Dashboard</asset\>
  	  <assetType\>AnalyticsDashboard</assetType\>
  	  <assetUsageType\>Created</assetUsageType\>
  	  <metadataSourceType\>Promoted</metadataSourceType\>
  	  <workspace\>Analytics Workspace</workspace\>
  </workspaceAssetRelationships\>
</AnalyticsWorkspace\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types\>
    <members\>\*</members\>
    <name\>AnalyticsWorkspace</name\>
  </types\>
  <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=d37d7bf161ea0a52dd2c856b8b80ac800c9eb38ce8e4e649b8540117ef72fc28 url=/legacydeveloper/current/en-us/api_meta/meta_animationrule.md -->

# AnimationRule

Represents criteria for determining when an animation is displayed to Path users.This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

AnimationRule components have the suffix animationRule and are stored in the animationRules folder.

## Version

AnimationRule components are available in API version 46.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d135640e91">Field Name</th>

              <th class="featureTableHeader  " id="d135640e94">Field Type</th>

              <th class="featureTableHeader  " id="d135640e97">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d135640e91" data-title="Field Name"><span class="keyword parmname">animationFrequency</span></td>

              <td class="entry" headers="d135640e94" data-title="Field Type">picklist</td>

              <td class="entry" headers="d135640e97" data-title="Description">Required. The frequency with which an animation is displayed when a user
                selects the designated picklist values in a path. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">always</samp></li>

                  <li class="li"><samp class="codeph nolang">often</samp></li>

                  <li class="li"><samp class="codeph nolang">sometimes</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">rarely</samp>
                  </li>

                </ul>
                A value of <samp class="codeph nolang">always</samp> triggers an animation
                every time. The values <samp class="codeph nolang">often</samp>, <samp class="codeph nolang">sometimes</samp>, and <samp class="codeph nolang">rarely</samp> trigger an animation progressively less frequently.</td>

            </tr>

            <tr>
              <td class="entry" headers="d135640e91" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d135640e94" data-title="Field Type">string</td>

              <td class="entry" headers="d135640e97" data-title="Description">Required. The developer name for the animation rule.
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Only users with View DeveloperName OR View Setup and Configuration permission
                            can view, group, sort, and filter this field.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d135640e91" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d135640e94" data-title="Field Type">boolean</td>

              <td class="entry" headers="d135640e97" data-title="Description">Required. Indicates whether the animation rule is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d135640e91" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d135640e94" data-title="Field Type">string</td>

              <td class="entry" headers="d135640e97" data-title="Description">Required. The label for the animation rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d135640e91" data-title="Field Name"><span class="keyword parmname">recordTypeContext</span></td>

              <td class="entry" headers="d135640e94" data-title="Field Type">picklist</td>

              <td class="entry" headers="d135640e97" data-title="Description">Required. An enum to track whether this AnimationRule applies to all record
                types for the associated sObject, or only to a single or
                main
                record type. Valid values are <samp class="codeph nolang">All</samp>, <samp class="codeph nolang">Master</samp>, or <samp class="codeph nolang">Custom</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d135640e91" data-title="Field Name"><span class="keyword parmname">recordTypeName</span></td>

              <td class="entry" headers="d135640e94" data-title="Field Type">reference</td>

              <td class="entry" headers="d135640e97" data-title="Description">The record type selected for the sObject in which the animation is
                displayed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d135640e91" data-title="Field Name"><span class="keyword parmname">sobjectType</span></td>

              <td class="entry" headers="d135640e94" data-title="Field Type">string</td>

              <td class="entry" headers="d135640e97" data-title="Description">The object on which the animation rule is run.</td>

            </tr>

            <tr>
              <td class="entry" headers="d135640e91" data-title="Field Name"><span class="keyword parmname">targetField</span></td>

              <td class="entry" headers="d135640e94" data-title="Field Type">string</td>

              <td class="entry" headers="d135640e97" data-title="Description">Required. Name of the field used to determine when to display an
                animation.</td>

            </tr>

            <tr>
              <td class="entry" headers="d135640e91" data-title="Field Name"><span class="keyword parmname">targetFieldChangeToValues</span></td>

              <td class="entry" headers="d135640e94" data-title="Field Type">string</td>

              <td class="entry" headers="d135640e97" data-title="Description">Required. Values used to determine when to display an animation. When a user
                selects a value in <span class="keyword parmname">targetField</span> that matches a value stored in
                <span class="keyword parmname">targetFieldChangeToValues</span>, the animation is
                displayed.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an AnimationRule component.

<?xml version="1.0" encoding="UTF-8"?>
<AnimationRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <animationFrequency\>Always</animationFrequency\>
    <developerName\>AnimationRule\_DeveloperName</developerName\>
    <isActive\>true</isActive\>
    <masterLabel\>AnimationRule Label</masterLabel\>
    <recordTypeContext\>All</recordTypeContext\>
    <recordTypeName\>\_\_MASTER\_\_</recordTypeName\>
    <sobjectType\>Opportunity</sobjectType\>
    <targetField\>StageName</targetField\>
    <targetFieldChangeToValues\>Delivered, Negotiating, Closed Won</targetFieldChangeToValues\>
</AnimationRule\>

The following is an example package.xml that references the AnimationRule component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>PathAssistant</members>
        <name>Settings</name>
    </types>
    <types>
        <members>AnimationRule\_Developer\_Name</members>
        <name>AnimationRule</name>
    </types>
    <version>46.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=7f3a84952dd21e3f14b8f0b887137f7db3de1f62a02f34ecb0089cda47c07437 url=/legacydeveloper/current/en-us/api_meta/meta_classes.md -->

# ApexClass

Represents an Apex class. An Apex class is a template or blueprint from which Apex objects are created. Classes consist of other classes, user-defined methods, variables, exception types, and static initialization code.

For more information, see the [Lightning Platform Apex Code Developer's Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/ "html (New Window)"). This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

By default, you can’t deploy updates to an Apex class if there are one or more active jobs for that class. To deploy updates in this case, do one of the following.

- Cancel Apex jobs before deploying changes to Apex code. Reschedule the jobs after the deployment.
- Enable deployments with Apex jobs in the Salesforce user interface in the Deployment Settings page.

## Supported Calls

All Metadata API calls except [CRUD-Based Calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects."), which prevents deployment outside of proper deployment lifecycle and test-execution constraints.

## Declarative Metadata File Suffix and Directory Location

The file suffix is .cls for the class file. The accompanying metadata file is named ClassName.cls-meta.xml.

Apex classes are stored in the classes folder in the corresponding package directory.

## Version

Apex classes are available in API version 10.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d244591e144">Field Name</th>

              <th class="featureTableHeader  " id="d244591e147">Field Type</th>

              <th class="featureTableHeader  " id="d244591e150">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d244591e144" data-title="Field Name"><span class="keyword parmname" id="api_version"><a name="api_version"><!-- --></a>apiVersion</span></td>

              <td class="entry" headers="d244591e147" data-title="Field Type">double</td>

              <td class="entry" headers="d244591e150" data-title="Description">
                <p class="p" id="apiversion_desc"><a name="apiversion_desc"><!-- --></a>The API version for this class. Every class
                  has an API version specified at creation.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d244591e144" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d244591e147" data-title="Field Type">base64</td>

              <td class="entry" headers="d244591e150" data-title="Description">
                <span class="ph" id="content_desc"><a name="content_desc"><!-- --></a>The Apex class definition.</span> Base 64-encoded binary data.
                Before making an API call, client applications must encode the
                binary attachment data as base64. Upon receiving a response, client
                applications must decode the base64 data to binary. This conversion
                is handled for you by a SOAP client. <span class="ph" id="inherited_MetadataWithContent"><a name="inherited_MetadataWithContent"><!-- --></a>This field is inherited from
                  the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm" title="MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.">MetadataWithContent</a>
                  component.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d244591e144" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d244591e147" data-title="Field Type">string</td>

              <td class="entry" headers="d244591e150" data-title="Description">The Apex class name. <span class="ph" id="fullName_allowed_chars"><a name="fullName_allowed_chars"><!-- --></a>The name can only contain
                  characters, letters, and the underscore (_) character, must
                  start with a letter, and can’t end with an underscore or contain
                  two consecutive underscore characters.</span> This field is
                inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d244591e144" data-title="Field Name"><span class="keyword parmname" id="field_packageVersions"><a name="field_packageVersions"><!-- --></a>packageVersions</span></td>

              <td class="entry" headers="d244591e147" data-title="Field Type">
                <a class="xref" href="#PackageVersion">PackageVersion</a>[]
              </td>

              <td class="entry" headers="d244591e150" data-title="Description">
                <span class="ph" id="field_packageVersions_desc"><a name="field_packageVersions_desc"><!-- --></a>The list of installed managed package versions
                  that are referenced by this Apex class.</span>
                <p class="p" id="versions_more_info"><a name="versions_more_info"><!-- --></a>For more
                  information about managed packages, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_dev2gp.htm" target="_blank" title="HTML (New Window)">Second-Generation Managed
                    Packages</a> in the <cite class="cite">Salesforce DX Developer
                    Guide</cite>. This field is available in API version 16.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d244591e144" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d244591e147" data-title="Field Type">ApexCodeUnitStatus (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d244591e150" data-title="Description">
                <p class="p" id="status_desc"><a name="status_desc"><!-- --></a>The status of the Apex class. The following string values are valid:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Active</samp> - The class is
                    active.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">Deleted</samp> - The class is marked for deletion. This
                    value is useful for managed packages, because it allows a
                    class to be deleted when a managed package is updated.
                  </li>

                </ul>

                <p class="p">ApexCodeUnitStatus includes an <samp class="codeph nolang">Inactive</samp> option, but
                  it’s only supported for <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_triggers.htm" title="Represents an Apex trigger. A trigger is Apex code that executes before or after specific data manipulation language (DML) events occur, such as before object records are inserted into the database, or after records have been deleted.">ApexTrigger</a>; it isn’t supported
                  for ApexClass.</p>

              </td>

            </tr>

          </tbody>

        </table>

## PackageVersion

PackageVersion identifies a version of a managed package. A package version is a number that identifies the set of components included in a package. The version number has the format majorNumber.minorNumber.patchNumber (for example, 2.1.3). The major and minor numbers increase to a chosen value during every major release. The patchNumber is generated and updated only for a patch release. It’s available in API version 16.0 and later.

See [Set Package Versions for Apex Classes and Triggers](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_manpkgs_subscriber_version.htm "HTML (New Window)") in the Apex Developer Guide.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d244591e334">Field Name</th>

              <th class="featureTableHeader  " id="d244591e337">Field Type</th>

              <th class="featureTableHeader  " id="d244591e340">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d244591e334" data-title="Field Name"><span class="keyword parmname">namespace</span></td>

              <td class="entry" headers="d244591e337" data-title="Field Type">string</td>

              <td class="entry" headers="d244591e340" data-title="Description">Required. In a packaging context, a namespace prefix is a one to
                15-character alphanumeric identifier that distinguishes your package
                and its contents from packages of other developers on AppExchange.
                Namespace prefixes are case-insensitive. For example, ABC and abc
                aren’t recognized as unique. Your namespace prefix must be globally
                unique across all Salesforce orgs.<p class="p">Salesforce automatically
                  prepends your namespace prefix, followed by two underscores
                  (“__”), to all unique component names in your
                  Salesforce organization. A unique package component is one that
                  requires a name that no other component has within Salesforce,
                  such as custom objects, custom fields, custom links, s-controls,
                  and validation rules. For more information about namespaces, see
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev_dev2gp_create_namespace.htm" target="_blank">Create
                    and Register Your Namespace</a> in the
                  <cite class="cite">Second-Generation Managed Packaging Developer
                    Guide</cite>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d244591e334" data-title="Field Name"><span class="keyword parmname">majorNumber</span></td>

              <td class="entry" headers="d244591e337" data-title="Field Type">int</td>

              <td class="entry" headers="d244591e340" data-title="Description">Required. The major number of the package version. <span class="ph" id="version_number_format"><a name="version_number_format"><!-- --></a>A package version number has a
                  <var class="keyword varname">majorNumber.minorNumber</var>
                  format.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d244591e334" data-title="Field Name"><span class="keyword parmname">minorNumber</span></td>

              <td class="entry" headers="d244591e337" data-title="Field Type">int</td>

              <td class="entry" headers="d244591e340" data-title="Description">Required. The minor number of the package version. A package
                version number has a <var class="keyword varname">majorNumber.minorNumber</var>
                format.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following sample creates the MyhelloWorld.cls class, and the corresponding MyHelloWorld.cls-meta.xml metadata file.

MyHelloWorld.cls file:

public class MyHelloWorld {
// This method updates the Hello field on a list
// of accounts.
public static void addHelloWorld(Account\[\] accs){
	for (Account a:accs){
		if (a.Hello\_\_c != 'World')
		a.Hello\_\_c = 'World';
		}
	}
}

MyHelloWorld.cls-meta.xml:

<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion\>68.0</apiVersion\>
</ApexClass\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [ApexTrigger](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_triggers.htm "Represents an Apex trigger. A trigger is Apex code that executes before or after specific data manipulation language (DML) events occur, such as before object records are inserted into the database, or after records have been deleted.")

<!-- document id=72632d11e2c479022ae744b9d04f5bda4ccef704e9f81334bb6d9aef13660d5b url=/legacydeveloper/current/en-us/api_meta/meta_component.md -->

# ApexComponent

Represents a Visualforce component.

For more information, see Visualforce in Salesforce Help and [StaticResource: MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_staticresource.htm#extends_metadatawithcontent)

## Declarative Metadata File Suffix and Directory Location

The file suffix is .component for the page file. The accompanying metadata file is named ComponentName\-meta.xml.

Visualforce components are stored in the components folder in the corresponding package directory.

## Version

Visualforce components are available in API version 12.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d261707e101">Field Name</th>

              <th class="featureTableHeader  " id="d261707e104">Field Type</th>

              <th class="featureTableHeader  " id="d261707e107">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d261707e101" data-title="Field Name"><span class="keyword parmname" id="field_apiVersion"><a name="field_apiVersion"><!-- --></a>apiVersion</span></td>

              <td class="entry" headers="d261707e104" data-title="Field Type">double</td>

              <td class="entry" headers="d261707e107" data-title="Description">
                <span class="ph" id="field_apiVersion_desc"><a name="field_apiVersion_desc"><!-- --></a>The API version for this Visualforce component. Every
                  component has an API version specified at creation.</span> This field is available in API
                version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d261707e101" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d261707e104" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d261707e107" data-title="Description">The component content. Base 64-encoded binary data. Before making an API call, client
                applications must encode the binary attachment data as base64. Upon receiving a
                response, client applications must decode the base64 data to binary. This conversion
                is handled for you by a SOAP client. This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm" title="MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.">MetadataWithContent</a>
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d261707e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d261707e104" data-title="Field Type">string</td>

              <td class="entry" headers="d261707e107" data-title="Description">A description of what the component does.</td>

            </tr>

            <tr>
              <td class="entry" headers="d261707e101" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d261707e104" data-title="Field Type">string</td>

              <td class="entry" headers="d261707e107" data-title="Description">The component developer name used as a unique identifier for API access. The
                <span class="keyword parmname">fullName</span> can contain only underscores and alphanumeric
                characters. It must be unique, begin with a letter, not include spaces, not end with
                an underscore, and not contain two consecutive underscores. This field is inherited
                from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>
                component.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d261707e101" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d261707e104" data-title="Field Type">string</td>

              <td class="entry" headers="d261707e107" data-title="Description">Required. The label for this component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d261707e101" data-title="Field Name"><span class="keyword parmname" id="field_packageVersions"><a name="field_packageVersions"><!-- --></a>packageVersions</span></td>

              <td class="entry" headers="d261707e104" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_classes.htm#PackageVersion">PackageVersion</a>[]
              </td>

              <td class="entry" headers="d261707e107" data-title="Description">
                <span class="ph" id="field_packageVersions_desc"><a name="field_packageVersions_desc"><!-- --></a>The list of installed managed package versions
                  that are referenced by this Visualforce component.</span>
                <p class="p">Package components and Visualforce custom component are distinct concepts. A
                  package is comprised of many elements, such as custom objects, Apex classes and
                  triggers, and custom pages and components.</p>

                <p class="p">For more information about managed packages, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_dev2gp.htm" target="_blank" title="HTML (New Window)">Second-Generation Managed Packages</a> in the <cite class="cite">Salesforce DX Developer
                    Guide</cite>. This field is available in API version 16.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [ApexPage](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pages.htm "Represents a Visualforce page.")

<!-- document id=e947539e66236a2fe9323f3ace2fb7ffcee597b54aa896f9aa6f887b70a079ec url=/legacydeveloper/current/en-us/api_meta/meta_apexemailnotifications.md -->

# ApexEmailNotifications

The ApexEmailNotifications type allows you to define users and email addresses that receive email for unhandled Apex errors. Flow errors can also use this metadata type.

## Declarative Metadata File Suffix and Directory Location

The component filename is apexEmailNotifications.notifications. The Apex email notification file is stored in the apexEmailNotifications folder in the corresponding package directory.

## Version

ApexEmailNotifications components are available in API version 49.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| apexEmailNotification | [ApexEmailNotification](#ApexEmailNotification) | A specific Apex email notification. You can specify multiple notifications. |

## ApexEmailNotification

Represents an Apex email notification.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Each ApexEmailNotification can contain an email or a user but not both.

| Field Name | Field Type | Description |
| --- | --- | --- |
| email | string | The external email address to which the notification is sent. Mutually exclusive with the user field. |
| user | string | The username of the Salesforce user to be notified. Mutually exclusive with the email field. |

## Usage

Deploying ApexEmailNotifications deletes all previous notifications in the org. For example, consider two notifications, test1@example.com and test2@example.com, that are deployed in an org. When the following apexEmailNotifications.notifications is deployed, test1@example.com is deleted, because it's not in the deployed list.

<?xml version="1.0" encoding="UTF-8"?>
<ApexEmailNotifications xmlns="http://soap.sforce.com/2006/04/metadata">
    <apexEmailNotification>
        <email>test2@example.com</email>
    </apexEmailNotification>
</ApexEmailNotifications>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The ApexEmailNotifications metadata type isn't supported in destructiveChanges.xml. To delete specific ApexEmailNotification items, deploy a new ApexEmailNotifications without those items. To delete all Apex email notifications in an org, deploy an empty list of ApexEmailNotifications.

## Declarative Metadata Sample Definition

To deploy Apex email notifications, you can specify either the exact file name or use a wildcard in package.xml.

This example specifies the exact file name in package.xml.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>apexEmailNotifications</members>
        <name>ApexEmailNotifications</name>
    </types>
    <version>49.0</version>
</Package>

This example uses a wildcard in package.xml.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>ApexEmailNotifications</name>
    </types>
    <version>49.0</version>
</Package>

This sample deploys an Apex email notification that notifies a Salesforce user in the org.

<?xml version="1.0" encoding="UTF-8"?>
<ApexEmailNotifications xmlns="http://soap.sforce.com/2006/04/metadata">
    <apexEmailNotification>
        <user>user1@example.com</user>
    </apexEmailNotification>
</ApexEmailNotifications>

This sample deploys an Apex email notification that notifies an external email address.

<?xml version="1.0" encoding="UTF-8"?>
<ApexEmailNotifications xmlns="http://soap.sforce.com/2006/04/metadata">
    <apexEmailNotification>
        <email>test@example.com</email>
    </apexEmailNotification>
</ApexEmailNotifications>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a94f448ffe25f18f71871f8d51aad89ce1684f6fac533061333a2ccd3e2fa45c url=/legacydeveloper/current/en-us/api_meta/meta_pages.md -->

# ApexPage

Represents a Visualforce page.

For more information, see Visualforce in Salesforce Help. This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

## Declarative Metadata File Suffix and Directory Location

The file suffix is .page for the page file. The accompanying metadata file is named PageName\-meta.xml.

Visualforce pages are stored in the pages folder in the corresponding package directory.

## Version

Visualforce pages are available in API version 11.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d732627e116">Field Name</th>

              <th class="featureTableHeader  " id="d732627e119">Field Type</th>

              <th class="featureTableHeader  " id="d732627e122">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname" id="api_version"><a name="api_version"><!-- --></a>apiVersion</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">double</td>

              <td class="entry" headers="d732627e122" data-title="Description">Required. The API version for this page. Every page has an API
                version specified at creation. This field is available in API
                version 15.0 and later. If you set this field to a number lower than
                15.0, it’s changed to 15.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d732627e122" data-title="Description">The page content. Base 64-encoded binary data. Before making an
                API call, client applications must encode the binary attachment data
                as base64. Upon receiving a response, client applications must
                decode the base64 data to binary. This conversion is handled for you
                by a SOAP client. This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm" title="MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.">MetadataWithContent</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">string</td>

              <td class="entry" headers="d732627e122" data-title="Description">A description of what the page does.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">string</td>

              <td class="entry" headers="d732627e122" data-title="Description">The page developer name used as a unique identifier for API
                access. The <span class="keyword parmname">fullName</span> can contain only
                underscores and alphanumeric characters. It must be unique, begin
                with a letter, not include spaces, not end with an underscore, and
                not contain two consecutive underscores. This field is inherited
                from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">availableInTouch</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d732627e122" data-title="Description">Indicates if Visualforce tabs associated with the Visualforce
                page can be used in the Salesforce mobile app. (Use of this field
                for Salesforce Touch is deprecated.). This field is available in API
                version 27.0 and later. <p class="p">Standard object tabs that are overridden
                  with a Visualforce page aren’t supported in the Salesforce
                  mobile app, even if you set this field for the page. The default
                  page for the object is displayed instead of the Visualforce
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">confirmationTokenRequired</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d732627e122" data-title="Description">
                <span class="ph" id="visualforce_metadata_isconfirmationtokenrequired_def"><a name="visualforce_metadata_isconfirmationtokenrequired_def"><!-- --></a>Indicates whether <samp class="codeph nolang">GET</samp>
                  requests for the page require a CSRF confirmation token.</span>
                This field is available in API version 28.0 and later. <p class="p"><span class="ph" id="visualforce_metadata_isconformationtokenrequired_caveat"><a name="visualforce_metadata_isconformationtokenrequired_caveat"><!-- --></a>If you change this field’s value from <samp class="codeph nolang">false</samp> to <samp class="codeph nolang">true</samp>, links to the page
                    require a CSRF token to be added to them, or the page is
                    inaccessible.</span></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">string</td>

              <td class="entry" headers="d732627e122" data-title="Description">Required. The label for this page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname" id="field_packageVersions"><a name="field_packageVersions"><!-- --></a>packageVersions</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_classes.htm#PackageVersion">PackageVersion</a>[]
              </td>

              <td class="entry" headers="d732627e122" data-title="Description">
                <span class="ph" id="field_packageVersions_desc"><a name="field_packageVersions_desc"><!-- --></a>The list of installed managed
                  package versions that are referenced by this Visualforce
                  page.</span>
                <p class="p">For more information about
                  managed packages, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_dev2gp.htm" target="_blank" title="HTML (New Window)">Second-Generation Managed
                    Packages</a> in the <cite class="cite">Salesforce DX Developer
                    Guide</cite>. This field is available in API version 16.0
                  and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following sample creates the MyPage.page page, and the corresponding MyPage.page-meta.xml metadata file.

SampleApexPage.page file:

<apex:page\>
<h1\>Congratulations</h1\>
This is your new Page.
</apex:page\>

SampleApexPage.page-meta.xml:

<?xml version="1.0" encoding="UTF-8"?>
<ApexPage xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>This is a sample Visualforce page.</description\>
    <label\>SampleApexPage</label\>
</ApexPage\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [ApexComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_component.htm "Represents a Visualforce component.")

<!-- document id=eb0c969c51c1a079d7590f3b4f24a8ab4f7628951f52ecbcdd2debec7b2e2c1c url=/legacydeveloper/current/en-us/api_meta/meta_apexsettings.md -->

# ApexSettings

Represents Apex-related org settings. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

ApexSettings values are stored in the Apex.settings file 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

ApexSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d137042e102">Field Name</th>

              <th class="featureTableHeader  " id="d137042e105">Field Type</th>

              <th class="featureTableHeader  " id="d137042e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">asyncApexExecutionsOverride</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">integer</td>

              <td class="entry" headers="d137042e108" data-title="Description">Use this field to specify an override value that is less than the
                licensed rolling 24-hour asynchronous Apex job limit. The org
                defaults to the licensed asynchronous limit if the override is
                <samp class="codeph nolang">0</samp>, <samp class="codeph nolang">null</samp>, or omitted. Applicable to
                only nonproduction orgs, including sandboxes, scratch orgs, and
                Developer Edition orgs. Used for testing elastic processing
                behavior. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_limits_elastic_limits.htm" target="_blank">Elastic Limits for Asynchronous
                  Apex Jobs (Beta)</a>. Available in API version 68.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">DefaultQueueableDelay</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">integer</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates the admin-controlled minimum delay (in seconds) that
                applies to all enqueued jobs that were scheduled without a delay
                parameter. The minimum delay is one second and the maximum is 600
                seconds. The default behavior, when the setting is omitted, is no
                delay in scheduling enqueued jobs.</td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableAggregateCodeCoverageOnly</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether aggregate (not detailed) totals are tracked for
                Apex test coverage data (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). The default
                value is <samp class="codeph nolang">false</samp>. </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableApexAccessRightsPref</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Deprecated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableApexApprovalLockUnlock</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether approval process lock and unlock operations
                from Apex code are allowed (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableApexCtrlImplicitWithSharingPref</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether the Use <samp class="codeph apex_code">with
                  sharing</samp> for <samp class="codeph apex_code">@AuraEnabled</samp> Apex Controllers with Implicit Sharing
                critical update is activated (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). For more details, see the <a class="xref" href="http://releasenotes.docs.salesforce.com/en-us/winter20/release-notes/rn_lc_apex_with_sharing_cruc.htm" target="_blank" title="HTML (New Window)">Winter ’20 Release
                  Notes</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableApexPropertyGetterPref</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether the Enforce Access Modifiers on Apex Properties
                in Lightning Component Markup critical update is activated (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). For more details, see the
                <a class="xref" href="http://releasenotes.docs.salesforce.com/en-us/winter20/release-notes/rn_lc_enforce_prop_modifiers_cruc.htm" target="_blank" title="HTML (New Window)">Winter ’20 Release
                  Notes</a>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableAsyncApexElasticExecutions</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_limits_elastic_limits.htm" target="_blank">Use elastic limits for
                  asynchronous Apex jobs (Beta)</a> setting is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>. Available in API
                version 67.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableAuraApexCtrlAuthUserAccessCheckPref</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether the Restrict Access to <samp class="codeph apex_code">@AuraEnabled</samp> Apex Methods for
                Authenticated Users Based on User Profile critical update is
                activated (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). For more details,
                see the <a class="xref" href="http://releasenotes.docs.salesforce.com/en-us/winter20/release-notes/rn_lc_restrict_apex_authenticated_users.htm" target="_blank" title="HTML (New Window)">Winter ’20 Release
                  Notes</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableAuraApexCtrlGuestUserAccessCheckPref</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether the Restrict Access to <samp class="codeph apex_code">@AuraEnabled</samp> Apex Methods for
                Guest and Portal Users Based on User Profile critical update is
                activated (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). For more details,
                see the <a class="xref" href="http://releasenotes.docs.salesforce.com/en-us/winter20/release-notes/rn_lc_restrict_apex_guest_users.htm" target="_blank" title="HTML (New Window)">Winter ’20 Release
                  Notes</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableBlockPackagedApexExecAnon</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether the <a class="xref" href="https://help.salesforce.com/s/articleView?id=release-notes.rn_apex_block_exec_anon_ru.htm&amp;release=264&amp;type=5&amp;language=en_US" target="_blank">Block Apex Anonymous Code
                  Execution from Managed Packages</a> release update is enabled
                (<samp class="codeph apex_code"><span class="keyword">true</span></samp>) or not (<samp class="codeph apex_code"><span class="keyword">false</span></samp>). The default value is
                <samp class="codeph apex_code"><span class="keyword">false</span></samp>. Available in API
                version 67.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableCompileOnDeploy</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether Apex code is automatically recompiled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to <samp class="codeph nolang">true</samp>, code is recompiled before
                completing a metadata deployment, change set deployment, package
                installation, or package upgrade. For production orgs and full
                sandboxes, the default value is <samp class="codeph nolang">true</samp>. For all other orgs, the default value is <samp class="codeph nolang">false</samp>. <div class="box message info" id="note_mby_z4g_4cc">
                  <a name="note_mby_z4g_4cc"><!-- --></a>
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>This setting can’t be disabled in production orgs.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableDisableParallelApexTesting</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether Apex tests are serially executed (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>. <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Even when
                            parallel testing is enabled by setting this value to <samp class="codeph nolang">false</samp>, tests that are run
                            during deployments are always run serially.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableDebugLogsDuringDeployment</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether debug logs are enabled during metadata
                deployment (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>), in conjunction
                with an active debug log trace flag. If this setting is <samp class="codeph nolang">true</samp> but the trace flag is not
                active, debug logs are not enabled during metadata deployment. The
                default value is <samp class="codeph nolang">false</samp>.
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Enabling the debug log in the <samp class="codeph nolang">DebuggingHeader</samp> overrides this
                            setting.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableEnforceSummer26ApexHeapLimit</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether a nonproduction org is restricted to the lower
                Summer ’26 Apex heap limits (<samp class="codeph apex_code"><span class="keyword">true</span></samp>) or not (<samp class="codeph apex_code"><span class="keyword">false</span></samp>). The default value is <samp class="codeph apex_code"><span class="keyword">false</span></samp>. This setting is available
                only in Winter ’27. In Spring ’27, the higher Apex heap limits are
                enforced globally regardless of the setting status. For more
                details, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=release-notes.rn_apex_heap_limit.htm&amp;release=264&amp;type=5&amp;language=en_US" target="_blank">Handle Larger Datasets with
                  Increased Apex Heap Limits</a>. Available in API version
                68.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableGaplessTestAutoNum</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether autonumbering gaps are prevented by Apex test
                executions not incrementing autonumber fields for non-test records
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableMngdCtrlActionAccessPref</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description"> Indicates whether the Disable Access to Non-global Apex
                Controller Methods in Managed Packages critical update is activated
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). For more details, see the
                <a class="xref" href="http://releasenotes.docs.salesforce.com/en-us/winter20/release-notes/rn_lc_apex_methods_packages_cruc.htm" target="_blank" title="HTML (New Window)">Winter ’20 Release
                  Notes</a>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableNonCertifiedApexMdCrud</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether Apex classes can access metadata, public or
                protected, through classes in the <samp class="codeph nolang">Metadata</samp> namespace (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableRestrictCommunityExecAnon</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether guest users are restricted from executing
                anonymous Apex. The restriction applies regardless of whether the
                <samp class="codeph nolang">Author Apex</samp> permission is
                set. The default value is <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableSecureNoArgConstructorPref</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Not used. Critical update is automatically enforced. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=release-notes.rn_apex_publicConstructorsInMgdPackages.htm&amp;release=224&amp;language=en_US" target="_blank">Restrict Reflective Access to
                  Non-Global Constructors in Packages (Critical
                  Update)</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d137042e102" data-title="Field Name"><span class="keyword parmname">enableTestSetupSkipTestResults</span></td>

              <td class="entry" headers="d137042e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d137042e108" data-title="Description">Indicates whether Apex test results are generated for @TestSetup
                methods (<samp class="codeph nolang">false</samp>) or not (<samp class="codeph nolang">true</samp>). Available in API version
                61.0 and later.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of ApexSettings components.

<?xml version="1.0" encoding="UTF-8"?>
<ApexSettings xmlns="http://soap.sforce.com/2006/04/metadata">
   <enableDisableParallelApexTesting\>true</enableDisableParallelApexTesting\>
</ApexSettings\>

The following is an example package.xml manifest that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Apex</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a9dae5e0107f4acfc7d5e136a9d5369e8c716c54f65c32d5d487e5349f4c2937 url=/legacydeveloper/current/en-us/api_meta/meta_apextestsuite.md -->

# ApexTestSuite

Represents a suite of Apex test classes to include in a test run.

## File Suffix and Directory Location

ApexTestSuite components have the suffix .testSuite and are stored in the testSuites folder.

## Version

ApexTestSuite components are available in API version 38.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| testClassName | string\[\] | A list of Apex test classes, specified by name, to include in this test suite. |

## Declarative Metadata Sample Definition

To include namespaced tests in an Apex test suite, specify each namespace individually. Local Apex tests consist of all tests in the org that don’t originate from managed packages.

<?xml version="1.0" encoding="UTF-8"?>
<ApexTestSuite xmlns="http://soap.sforce.com/2006/04/metadata">
   <testClassName\>LocalTestClass</testClassName\>
      <!-- LocalTestClass adds the test class named LocalTestClass. -->
   <testClassName\>A\*Class</testClassName\>
      <!-- A\*Class adds AClass, AnotherClass, AwesomeClass, and so on. -->
   <testClassName\>Namespace1.NamespacedTestClass</testClassName\>
   <testClassName\>\*</testClassName\> <!-- Adds all local tests. -->
   <testClassName\>Namespace1.\*</testClassName\> <!-- Adds all tests in Namespace1. -->
   <testClassName\>Namespace2.\*</testClassName\> <!-- Adds all tests in Namespace2. -->
</ApexTestSuite\>

These syntaxes are supported in package.xml. If the test classes in your suites are already present in the target org, you can omit the ApexClass type in package.xml.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>ApexClass</name\>
   </types\>
   <types\>
      <members\>\*</members\>
      <name\>ApexTestSuite</name\>
   </types\>
   <version\>38.0</version\>
</Package\>

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>ApexClass</name\>
   </types\>
   <types\>
      <members\>Suite1</members\>
      <members\>Suite2</members\>
      <name\>ApexTestSuite</name\>
   </types\>
   <version\>38.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=deecd0b98da0ce891795cca4601b0a2ac2a2cf8c56d631dec5e976ec16b28b35 url=/legacydeveloper/current/en-us/api_meta/meta_triggers.md -->

# ApexTrigger

Represents an Apex trigger. A trigger is Apex code that executes before or after specific data manipulation language (DML) events occur, such as before object records are inserted into the database, or after records have been deleted.

For more information, see “Manage Apex Triggers” in Salesforce Help. This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

## Supported Calls

All Metadata API calls except [CRUD-Based Calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects."), which prevents deployment outside of proper deployment lifecycle and test-execution constraints.

## Declarative Metadata File Suffix and Directory Location

The file suffix is .trigger for the trigger file. The accompanying metadata file is named TriggerName\-meta.xml.

Apex triggers are stored in the triggers folder in the corresponding package directory.

## Version

Triggers are available in API version 10.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d926032e129">Field Name</th>

              <th class="featureTableHeader  " id="d926032e132">Field Type</th>

              <th class="featureTableHeader  " id="d926032e135">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d926032e129" data-title="Field Name"><span class="keyword parmname" id="api_version"><a name="api_version"><!-- --></a>apiVersion</span></td>

              <td class="entry" headers="d926032e132" data-title="Field Type">double</td>

              <td class="entry" headers="d926032e135" data-title="Description">Required. <span class="ph" id="trigger_apiversion_desc"><a name="trigger_apiversion_desc"><!-- --></a>The API version for this trigger.
                  Every trigger has an API version specified at creation.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d926032e129" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d926032e132" data-title="Field Type">base64</td>

              <td class="entry" headers="d926032e135" data-title="Description">The Apex trigger definition. This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm" title="MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.">MetadataWithContent</a>
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d926032e129" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d926032e132" data-title="Field Type">string</td>

              <td class="entry" headers="d926032e135" data-title="Description">The Apex trigger name. <span class="ph" id="fullName_allowed_chars"><a name="fullName_allowed_chars"><!-- --></a>The name can only
                  contain characters, letters, and the underscore (_) character, must start with a
                  letter, and can’t end with an underscore or contain two consecutive underscore
                  characters.</span> This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d926032e129" data-title="Field Name"><span class="keyword parmname" id="field_packageVersions"><a name="field_packageVersions"><!-- --></a>packageVersions</span></td>

              <td class="entry" headers="d926032e132" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_classes.htm#PackageVersion">PackageVersion</a>[]
              </td>

              <td class="entry" headers="d926032e135" data-title="Description">
                <span class="ph" id="field_packageVersions_desc"><a name="field_packageVersions_desc"><!-- --></a>The list of installed managed package
                  versions that are referenced by this Apex trigger.</span>
                <p class="p">For more information
                  about managed packages, see the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev_dev2gp.htm" target="_blank" title="PDF (New Window)">Second-Generation Managed
                    Packaging Developer Guide</a>. This field is available in API version 16.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d926032e129" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d926032e132" data-title="Field Type">ApexCodeUnitStatus (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d926032e135" data-title="Description">Required. The status of the Apex trigger. The following string values are valid:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Active</samp> - The trigger is active.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Inactive</samp> - The trigger is inactive, but
                    not deleted.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Deleted</samp> - The trigger is marked for
                    deletion. Useful for managed packages, because it allows a trigger to be deleted
                    when a managed package is updated.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following sample creates the MyhelloWorld.trigger trigger, and the corresponding MyHelloWorld.trigger-meta.xml metadata file.

MyHelloWorld.trigger file:

trigger helloWorldAccountTrigger on Account (before insert) {

  Account\[\] accs = Trigger.new;

   MyHelloWorld.addHelloWorld(accs);
}

MyHelloWorld.trigger-meta.xml:

<?xml version="1.0" encoding="UTF-8"?>
<ApexTrigger xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion\>68.0</apiVersion\>
</ApexTrigger\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [ApexClass](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_classes.htm "Represents an Apex class. An Apex class is a template or blueprint from which Apex objects are created. Classes consist of other classes, user-defined methods, variables, exception types, and static initialization code.")

<!-- document id=a55cad828d1a8bab94bc15b15bae3404e2c2237a7fb83206abe60e120758bc8e url=/legacydeveloper/current/en-us/api_meta/meta_api_eol.md -->

# API End-of-Life Policy

See which Metadata REST and SOAP API versions are supported, unsupported, or unavailable.

Salesforce is committed to supporting each API version for a minimum of 3 years from the date of first release. To improve the quality and performance of the API, versions that are over 3 years old sometimes are no longer supported.

Salesforce notifies customers who use an API version scheduled for deprecation at least 1 year before support for the version ends.

<table class="featureTable sort_table" summary="">



        <thead class="thead sorted" align="left">
          <tr>
            <th class="featureTableHeader  " id="d41957e54">Salesforce API Versions</th>

            <th class="featureTableHeader  " id="d41957e57">Version Support Status</th>

            <th class="featureTableHeader  " id="d41957e60">Version Retirement Info</th>

          </tr>

        </thead>

        <tbody class="tbody">
          <tr>
            <td class="entry" headers="d41957e54" data-title="Salesforce API Versions">Versions 41.0 through <span class="ph">68.0</span>
            </td>

            <td class="entry" headers="d41957e57" data-title="Version Support Status">Supported.</td>

            <td class="entry" headers="d41957e60" data-title="Version Retirement Info"></td>

          </tr>

          <tr>
            <td class="entry" headers="d41957e54" data-title="Salesforce API Versions">Versions 31.0 through 40.0</td>

            <td class="entry" headers="d41957e57" data-title="Version Support Status">
              <p class="p">Supported.</p>

              <p class="p">Deprecated and unsupported from Summer ’27.</p>

              <p class="p">Retired from Summer ’28.</p>

            </td>

            <td class="entry" headers="d41957e60" data-title="Version Retirement Info"><a class="xref" href="https://help.salesforce.com/s/articleView?id=005321531&amp;type=1&amp;language=en_US" target="_blank">Salesforce Platform API Versions 31.0
                through 40.0 Retirement</a></td>

          </tr>

          <tr>
            <td class="entry" headers="d41957e54" data-title="Salesforce API Versions">Versions 21.0 through 30.0</td>

            <td class="entry" headers="d41957e57" data-title="Version Support Status">As of Summer ’25, these versions are retired and unavailable.</td>

            <td class="entry" headers="d41957e60" data-title="Version Retirement Info"><a class="xref" href="https://help.salesforce.com/s/articleView?id=000389618&amp;type=1&amp;language=en_US" target="_blank">Salesforce Platform API Versions 21.0
                through 30.0 Retirement</a></td>

          </tr>

          <tr>
            <td class="entry" headers="d41957e54" data-title="Salesforce API Versions">Versions 7.0 through 20.0</td>

            <td class="entry" headers="d41957e57" data-title="Version Support Status">As of Summer ’22, these versions are retired and unavailable.</td>

            <td class="entry" headers="d41957e60" data-title="Version Retirement Info"><a class="xref" href="https://help.salesforce.com/s/articleView?id=000380623&amp;type=1&amp;language=en_US" target="_blank">Salesforce Platform API Versions 7.0
                through 20.0 Retirement</a></td>

          </tr>

        </tbody>

      </table>

If you request any resource or use an operation from a retired API version, REST API returns the 410:GONE error code.

If you request any resource or use an operation from a retired API version, SOAP API returns 500:UNSUPPORTED\_API\_VERSION error code.

To identify requests made from old or unsupported API versions, use the [API Total Usage](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apitotalusage.htm) event type.

<!-- document id=79c2aeda628b0a741fb7c1c46f3e2ccd65d6f5ed73ee6caced38280ed0d44f41 url=/legacydeveloper/current/en-us/api_meta/meta_appanalyticssettings.md -->

# AppAnalyticsSettings

Represents settings to retrieve AppExchange App Analytics usage data.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

AppAnalyticsSettings values are stored in the AppAnalytics.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AppAnalyticsSettings is available in API versions 50.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableAppAnalyticsOptOut | boolean | Indicates whether the collection of AppExchange App Analytics package usage data from this org is disabled (true) or not (false). Available in API version 60.0 and later. Default is false. |
| enableSimulationMode | boolean | Indicates whether AppExchange App Analytics simulation mode is enabled (true) or disabled (false). Available in API version 50.0 and later. Default is false. |

## Declarative Metadata Sample Definition

The following is an example of the AppAnalytics.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<AppAnalyticsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableSimulationMode\>true</enableSimulationMode\>
	<enableAppAnalyticsOptOut\>false</enableAppAnalyticsOptOut\>
</AppAnalyticsSettings\>

## Example Package Manifest

This example package manifest deploys or retrieves AppAnalytics settings metadata.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>AppAnalytics</members\>
		<name\>Settings</name\>
	</types\>
	<version\>50.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6916dc5ff69b2333429a1a1a92aba8063b4bf13042e8c3437c7945ae10c6eb36 url=/legacydeveloper/current/en-us/api_meta/meta_appexperiencesettings.md -->

# AppExperienceSettings

Represents settings for the app experience.This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

AppExperienceSettings values are stored in the .settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

## Version

AppExperienceSettings components are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| doesHideAllAppsInAppLauncher | boolean | If set to false (default), all standard and custom apps show up on the App Launcher. If set to true, the admin must select which standard and custom apps to display on the App Launcher. |

## Declarative Metadata Sample Definition

The following is an example of an AppExperienceSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<AppExperienceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <doesHideAllAppsInAppLauncher\>false</doesHideAllAppsInAppLauncher\>
</AppExperienceSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the AppExperienceSettings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>AppExperience</members\>
        <name\>Settings</name\>
    </types\>
<version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=f1be65b2dd385902d2bd12c9ca8fe29b80f85d061f6a123ce1d5843319ee4f54 url=/legacydeveloper/current/en-us/api_meta/meta_appframeworkapp.md -->

# AppFrameworkApp

Represents an installed app framework app.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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\[\]](#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.

<?xml version="1.0" encoding="UTF-8"?>
<AppFrameworkApp xmlns="http://soap.sforce.com/2006/04/metadata">
    <appAssetVersion\>68.0</appAssetVersion\>
    <appTemplate\>basic\_template</appTemplate\>
    <description\>Basic template app</description\>
    <installedAssets\>
        <appAssetVersion\>68.0</appAssetVersion\>
        <asset\>Workspace1</asset\>
        <templateAssetSourceName\>Workspace1</templateAssetSourceName\>
        <type\>Workspace</type\>
    </installedAssets\>
    <installedAssets\>
        <appAssetVersion\>68.0</appAssetVersion\>
        <asset\>Dashboard1</asset\>
        <templateAssetSourceName\>Dashboard1</templateAssetSourceName\>
        <type\>Dashboard</type\>
    </installedAssets\>
    <installedAssets\>
        <appAssetVersion\>68.0</appAssetVersion\>
        <asset\>Dashboard2</asset\>
        <templateAssetSourceName\>Dashboard2</templateAssetSourceName\>
        <type\>Dashboard</type\>
    </installedAssets\>
    <installedAssets\>
        <appAssetVersion\>68.0</appAssetVersion\>
        <asset\>Dashboard3</asset\>
        <templateAssetSourceName\>Dashboard3</templateAssetSourceName\>
        <type\>Dashboard</type\>
    </installedAssets\>
    <label\>Basic Test Template app</label\>
    <templateType\>APP</templateType\>
    <templateVersion\>1.0</templateVersion\>
</AppFrameworkApp\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Dashboard1</members\>
        <members\>Dashboard2</members\>
        <members\>Dashboard3</members\>
        <name\>AnalyticsDashboard</name\>
    </types\>
    <types\>
        <members\>Workspace1</members\>
        <name\>AnalyticsWorkspace</name\>
    </types\>
    <types\>
        <members\>BasicTemplate\_app</members\>
        <name\>AppFrameworkApp</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=95f1a23a9adec71b01e3cf55b6a5930fadc6fe025b882dece062f677e6f52598 url=/legacydeveloper/current/en-us/api_meta/meta_appframeworktemplatebundle.md -->

# AppFrameworkTemplateBundle

Represents the app framework template bundle. Use these templates for Data 360 and Tableau Next assets.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

An app framework template bundle is a folder that contains definition files for a template. Unlike other metadata components, a AppFrameworkTemplateBundle component isn’t represented with a single component file, but instead by a collection of JSON and other definition files. Each definition file represents a resource in a template, such as semantic models, workspaces, visualizations, and dashboards. For example, this directory structure shows the hierarchy of the folders and files for one app framework template definition, myTemplate.

appTemplates
  myTemplate
    template-info.json
    create-chain.json
    rules.json
    variables.json 
    layout.json
    workspaces
      myWorkspace.json
    dashboards
      myDashboard.json

App framework template bundles must be under a top-level folder that’s named appTemplates. Each bundle must have its own subfolder under the appTemplate folder and named with the template's fully qualified API name. The bundle folder must contain a template-info.json file to specify the metadata about the template and the references to other definition files. An entire bundle doesn’t have a suffix and definition files can have one of the these suffixes.

| Suffix | Component Type |
| --- | --- |
| .json | JSON file |
| .html | HTML file |

## Version

AppFrameworkTemplateBundle components are available in API version 64.0 and later.

## Special Access Rules

Create definitions in both managed and unmanaged packages.

## Fields

| Field Name | Description |
| --- | --- |
| assetVersion | 
Field Type

double

Description

The API version of the template bundle.



 |
| description | 

Field Type

string

Description

The description for the template.



 |
| label | 

Field Type

string

Description

Required

The label for the template.



 |
| maxAppCount | 

Field Type

int

Description

The maximum number of apps that can be created from this template.



 |
| templateBadgeIcon | 

Field Type

string

Description

The badge icon for the template. This must be a .png file type.



 |
| templateStatus | 

Field Type

string

Description

The status of the template.



 |
| templateSubtype | 

Field Type

string

Description

The subtype of the template.



 |
| templateType | 

Field Type

string

Description

The type of the template.



 |

## Declarative Metadata Sample Definition

This is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
    <members\>myTemplate</members\>
    <name\>AppFrameworkTemplateBundle</name\>
</types\>
<version\>64.0</version\>
</Package\>

## Wildcard Support in the Manifest File

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a0ad22db378807651e9503a62ed271ad1f622c003b317997aaea8129c4cc2243 url=/legacydeveloper/current/en-us/api_meta/meta_appmenu.md -->

# AppMenu

Represents the app menu or the Salesforce mobile navigation menu. Reserved for future use.

<!-- document id=e3e1bf9a9848b45358e3186bfcb161b0f2441b42244da515f6ba5561cb065962 url=/legacydeveloper/current/en-us/api_meta/meta_appointmentassignmentpolicy.md -->

# AppointmentAssignmentPolicy

Represents the information about a resource assignment rule. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

AppointmentAssignmentPolicy components have the suffix .policy and are stored in the appointmentAssignmentPolicies folder.

## Version

AppointmentAssignmentPolicy components are available in API version 53.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d142874e91">Field Name</th>

              <th class="featureTableHeader  " id="d142874e94">Field Type</th>

              <th class="featureTableHeader  " id="d142874e97">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d142874e91" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d142874e94" data-title="Field Type">string</td>

              <td class="entry" headers="d142874e97" data-title="Description">Required. The label for the appointment assignment policy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d142874e91" data-title="Field Name"><span class="keyword parmname">policyApplicableDuration</span></td>

              <td class="entry" headers="d142874e94" data-title="Field Type">string</td>

              <td class="entry" headers="d142874e97" data-title="Description">Required. The frequency at which the utilization of service resources is
                calculated. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Monthly</samp></li>

                  <li class="li"><samp class="codeph nolang">ParameterBased</samp></li>

                  <li class="li"><samp class="codeph nolang">Weekly</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d142874e91" data-title="Field Name"><span class="keyword parmname">policyType</span></td>

              <td class="entry" headers="d142874e94" data-title="Field Type">string</td>

              <td class="entry" headers="d142874e97" data-title="Description">Required. The type of appointment assignment policy. Valid value is:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">loadBalancing</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d142874e91" data-title="Field Name"><span class="keyword parmname">utilizationFactor</span></td>

              <td class="entry" headers="d142874e94" data-title="Field Type">string</td>

              <td class="entry" headers="d142874e97" data-title="Description">Required. Specifies the count type for the resource utilization. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">NumberOfAppointments</samp></li>

                  <li class="li"><samp class="codeph nolang">TotalAppointmentDuration</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an appointmentAssignmentPolicy component.

<?xml version="1.0" encoding="UTF-8"?>
<AppointmentAssignmentPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
   <masterLabel\>loadBalancing Assignment Policy</masterLabel\>
   <policyType\>loadBalancing</policyType\>
   <policyApplicableDuration\>Weekly</policyApplicableDuration\>
   <utilizationFactor\>TotalAppointmentDuration</utilizationFactor\>
</AppointmentAssignmentPolicy\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
 <Package xmlns="[http://soap.sforce.com/2006/04/metadata](http://soap.sforce.com/2006/04/metadata)">
   <types>
     <members>sample</members>
     <name>AppointmentAssignmentPolicy</name>
   </types>
   <version>53.0</version>
 </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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6e860c8fea544f346049dcb766ba75ad070c28d10c82fa126dae2f120f033524 url=/legacydeveloper/current/en-us/api_meta/meta_appointmentschedulingpolicy.md -->

# AppointmentSchedulingPolicy

Represents a set of rules for scheduling appointments using Lightning Scheduler. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

AppointmentSchedulingPolicy components have the suffix .policy and are stored in the appointmentSchedulingPolicies folder.

## Version

AppointmentSchedulingPolicy components are available in API version 47.0 and later.

## Special Access Rules

You must have the ViewSetup and CustomizeApplication user permissions to access the AppointmentSchedulingPolicy type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d143422e100">Field Name</th>

              <th class="featureTableHeader  " id="d143422e103">Field Type</th>

              <th class="featureTableHeader  " id="d143422e106">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">appointmentAssignmentPolicy</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">string</td>

              <td class="entry" headers="d143422e106" data-title="Description">The name of the appointment assignment policy. This field is available in API
                version 53.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">appointmentStartTimeInterval</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">picklist</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. The proposed time interval in minutes between appointment start
                times. For example, if you set the interval to <samp class="codeph nolang">15</samp>, appointments can then begin at the top of the hour and at 15-minute
                intervals thereafter (10:00 AM, 10:15 AM, 10:30 AM, and so on). Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">5</samp></li>

                  <li class="li"><samp class="codeph nolang">10</samp></li>

                  <li class="li"><samp class="codeph nolang">15</samp></li>

                  <li class="li"><samp class="codeph nolang">20</samp></li>

                  <li class="li"><samp class="codeph nolang">30</samp></li>

                  <li class="li"><samp class="codeph nolang">45</samp></li>

                  <li class="li"><samp class="codeph nolang">60</samp></li>

                  <li class="li"><samp class="codeph nolang">90</samp></li>

                  <li class="li"><samp class="codeph nolang">120</samp></li>

                  <li class="li"><samp class="codeph nolang">150</samp></li>

                  <li class="li"><samp class="codeph nolang">180</samp></li>

                  <li class="li"><samp class="codeph nolang">240</samp></li>

                  <li class="li"><samp class="codeph nolang">300</samp></li>

                  <li class="li"><samp class="codeph nolang">360</samp></li>

                  <li class="li"><samp class="codeph nolang">420</samp></li>

                  <li class="li"><samp class="codeph nolang">480</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">extCalEventHandler</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">lookup</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. The API name of the custom Apex class that checks service resources’
                external calendar events and returns the time slots where service resources are
                already booked. Available in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">isSvcTerritoryMemberShiftUsed</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether to consider shifts of service territory members
                when determining the availability of service resources for appointments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field is available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">isSvcTerrOpHoursWithShiftsUsed</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether to consider the intersection of shifts and service
                territory operating hours when determining the availability of service resources for
                appointments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field is available in API version 54.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">string</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. The label for the appointment scheduling policy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">shouldCheckExternalCalendar</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether to check the external calendar for resource
                availability (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field is available in API version 53.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">shouldConsiderCalendarEvents</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether to consider events on the Salesforce calendar to
                determine the availability of service resources to be assigned to appointments
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">shouldEnforceExcludedResource</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether this appointment scheduling policy prevents
                excluded service resources from being assigned to appointments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">shouldEnforceRequiredResource</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether this appointment scheduling policy allows only
                required service resources to be assigned to appointments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">shouldMatchSkill</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether this appointment scheduling policy allows only
                required service resources who have certain skills to be assigned to appointments
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">shouldMatchSkillLevel</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether this appointment scheduling policy allows only
                required service resources who have certain skills and skill levels to be assigned
                to appointments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">shouldRespectVisitingHours</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether this appointment scheduling policy prevents users
                from scheduling appointments outside of an account’s visiting hours (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">shouldUsePrimaryMembers</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether this appointment scheduling policy allows only
                service resources who are primary members of a service territory to be assigned to
                appointments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d143422e100" data-title="Field Name"><span class="keyword parmname">shouldUseSecondaryMembers</span></td>

              <td class="entry" headers="d143422e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d143422e106" data-title="Description">Required. Indicates whether this appointment scheduling policy allows service
                resources who are secondary members of a service territory to be assigned to
                appointments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an appointmentSchedulingPolicy component.

<?xml version="1.0" encoding="UTF-8"?>
<AppointmentSchedulingPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
  <appointmentAssignmentPolicy\>ResourceAssignmentRule1</appointmentAssignmentPolicy\>
  <appointmentStartTimeInterval\>15</appointmentStartTimeInterval\>
  <masterLabel\>Default Appointment Scheduling Policy</masterLabel\>
  <shouldCheckExternalCalendar\>true</shouldCheckExternalCalendar\>
  <shouldConsiderCalendarEvents\>true</shouldConsiderCalendarEvents\>
  <shouldEnforceExcludedResource\>true</shouldEnforceExcludedResource\>
  <shouldEnforceRequiredResource\>true</shouldEnforceRequiredResource\>
  <shouldMatchSkill\>true</shouldMatchSkill\>
  <shouldMatchSkillLevel\>false</shouldMatchSkillLevel\>
  <shouldRespectVisitingHours\>true</shouldRespectVisitingHours\>
  <shouldUsePrimaryMembers\>true</shouldUsePrimaryMembers\>
  <shouldUseSecondaryMembers\>true</shouldUseSecondaryMembers\>
</AppointmentSchedulingPolicy\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
 <Package xmlns="[http://soap.sforce.com/2006/04/metadata](http://soap.sforce.com/2006/04/metadata)">
   <types>
     <members>sample</members>
     <name>AppointmentSchedulingPolicy</name>
   </types>
   <version>47.0</version>
 </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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e2ec98895ee0345ebc650e5d724673e209f34f71d3aa682c41df7210327da6c4 url=/legacydeveloper/current/en-us/api_meta/meta_approvalprocess.md -->

# ApprovalProcess

Represents the metadata associated with an approval process. An approval process automates how records are approved in Salesforce. An approval process specifies each step of approval, including who to request approval from and what to do at each point of the process.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

- To use approval processes on Salesforce Knowledge articles with the Metadata API, the article type must be deployed. For article version (\_kav) in approval processes, the supported action types are: Knowledge Action, Email Alert, Field Update, and Outbound Message.
- Send actions and approval processes for email drafts aren’t supported in the Metadata API.
- The metadata doesn’t include the order of active approval processes. Sometimes you have to reorder the approval processes in the destination org after deployment.

## File Suffix and Directory Location

ApprovalProcess components have the suffix .approvalProcess and are stored in the approvalProcesses folder.

## Version

ApprovalProcess components are available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d144874e115">Field Name</th>

              <th class="featureTableHeader  " id="d144874e118">Field Type</th>

              <th class="featureTableHeader  " id="d144874e121">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d144874e121" data-title="Description">Required. Whether the approval process is active.<p class="p">After an
                  approval process is activated, you can’t add, delete, or change
                  the order of the steps or change its reject or skip behavior,
                  even if the process is inactive.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">allowRecall</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d144874e121" data-title="Description">Whether to allow submitters to recall approval requests.<p class="p">If set
                  to <samp class="codeph nolang">false</samp>, only
                  administrators can recall approval requests.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">allowedSubmitters</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">
                <a class="xref" href="#ApprovalSubmitter">ApprovalSubmitter</a>[]
              </td>

              <td class="entry" headers="d144874e121" data-title="Description">Required. An array of users who are allowed to submit records for
                approval.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">approvalPageFields</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type"><a class="xref" href="#ApprovalPageField">ApprovalPageField</a></td>

              <td class="entry" headers="d144874e121" data-title="Description">Specifies which fields to display on the approval page, where the
                approver goes to approve or reject the record. By default, the
                approval page displays the following:<ul class="ul bulletList">
                  <li class="li">
                    <span class="keyword parmname">Name</span> field
                  </li>

                  <li class="li">
                    <span class="keyword parmname">Owner</span> field (except for child
                    objects)
                  </li>

                </ul>
                <p class="p">If you enable notifications in the Salesforce mobile app, keep in mind
                  that approvers can view this list of fields on a mobile device.
                  Select only the fields necessary for users to decide whether to
                  approve or reject records.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">approvalStep</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">
                <a class="xref" href="#ApprovalStep">ApprovalStep</a>[]
              </td>

              <td class="entry" headers="d144874e121" data-title="Description">An array of approval step definitions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e121" data-title="Description">Describes the approval process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">emailTemplate</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e121" data-title="Description">Specifies which Classic email template to use for approval
                requests. If not specified, the default email template is used.
                <p class="p">Lightning email templates aren’t packageable. We recommend
                  using a Classic email template.</p>
                <p class="p">When an approval process
                  assigns an approval request to a user, Salesforce sends the user
                  an approval request email.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">enableMobileDeviceAccess</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d144874e121" data-title="Description">Whether users can access an external version of the approval page
                from any browser, including browsers on mobile devices, without
                logging in to Salesforce. Corresponds to <span class="keyword parmname">Security
                  Settings</span> in the user interface.<p class="p">If set to <samp class="codeph nolang">true</samp>, approval steps can’t have
                  approvers of <span class="keyword parmname">type</span>
                  <samp class="codeph nolang">adhoc</samp>.
                </p>
                <p class="p">If set to
                  <samp class="codeph nolang">false</samp>, approvers must
                  log in to Salesforce to access the approval page.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">entryCriteria</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type"><a class="xref" href="#ApprovalEntryCriteria">ApprovalEntryCriteria</a></td>

              <td class="entry" headers="d144874e121" data-title="Description">Determines which records can enter the approval process. Exclude
                this field to allow all records to enter the approval process.
                <p class="p">When you deploy an approval process with no entry criteria to
                  overwrite an existing approval process with entry criteria, then
                  the entry criteria from the existing process are applied to the
                  deployed process.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">finalApprovalActions</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type"><a class="xref" href="#ApprovalAction">ApprovalAction</a></td>

              <td class="entry" headers="d144874e121" data-title="Description">Specifies which workflow actions to execute when all required
                approvals have been given for a record.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">finalApprovalRecordLock</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d144874e121" data-title="Description">Whether to keep the record locked after it receives all necessary
                approvals. Default: <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname" id="field_finalRejectionActions_name"><a name="field_finalRejectionActions_name"><!-- --></a>finalRejectionActions</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type"><a class="xref" href="#ApprovalAction">ApprovalAction</a></td>

              <td class="entry" headers="d144874e121" data-title="Description">Specifies which workflow actions to execute after a record enters
                the final rejection state.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">finalRejectionRecordLock</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d144874e121" data-title="Description">Whether to keep the record locked after it’s finally rejected.
                Default: <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">initialSubmissionActions</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type"><a class="xref" href="#ApprovalAction">ApprovalAction</a></td>

              <td class="entry" headers="d144874e121" data-title="Description">Specifies which workflow actions to execute when a record is
                initially submitted for approval.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e121" data-title="Description">Required. Name of the approval process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname" id="field_nextAutomatedApprover_name"><a name="field_nextAutomatedApprover_name"><!-- --></a>nextAutomatedApprover</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type"><a class="xref" href="#NextAutomatedApprover">NextAutomatedApprover</a></td>

              <td class="entry" headers="d144874e121" data-title="Description">Specifies a standard or custom user hierarchy field that can be
                used to automatically assign the approver for an approval step.<p class="p">If
                  you exclude this field, then no approval step can use a user
                  hierarchy field to automatically assign the
                  approver.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">postTemplate</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e121" data-title="Description">Post template to use for Approvals in Chatter. <p class="p">Chatter post
                  approval notifications are only available for approval processes
                  associated with an object that has been enabled for feed
                  tracking.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">recallActions</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type"><a class="xref" href="#ApprovalAction">ApprovalAction</a></td>

              <td class="entry" headers="d144874e121" data-title="Description">Specifies which workflow actions to execute when a pending
                approval request is withdrawn.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">recordEditability</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">RecordEditabilityType (enumeration of type string)</td>

              <td class="entry" headers="d144874e121" data-title="Description">Specifies which users can edit records that are pending approval.
                When a record is submitted for approval, it’s automatically locked
                to prevent other users from editing it during the approval process.
                Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AdminOnly</samp>—Records pending approval can be
                    edited by:<ul class="ul bulletList">
                      <li class="li">Users with the “Modify All Data”
                        permission</li>

                      <li class="li">Users with the “Modify All Records”
                        object-level permission for the given object</li>

                    </ul>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AdminOrCurrentApprover</samp>—Records pending
                    approval can be edited by:<ul class="ul bulletList">
                      <li class="li">Users with the “Modify All Data”
                        permission</li>

                      <li class="li">Users with the “Modify All Records”
                        object-level permission for the given object</li>

                      <li class="li">The assigned approver, who must have edit access to
                        the record through user permissions and the
                        organization-wide sharing defaults for the given
                        object</li>

                    </ul>
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e115" data-title="Field Name"><span class="keyword parmname">showApprovalHistory</span></td>

              <td class="entry" headers="d144874e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d144874e121" data-title="Description">Whether to add the Approval History related list to the approval
                page, which is where the approver can view the approval request
                details and approve or reject the record. The Approval History
                related list tracks a record through the approval process.<p class="p">If you
                  also want to add the Approval History related list to record
                  detail and edit pages, use the Salesforce user interface to
                  customize the page layouts for the given object.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ApprovalSubmitter

Represents a user or set of users who can submit records for approval.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d144874e527">Field Name</th>

              <th class="featureTableHeader  " id="d144874e530">Field Type</th>

              <th class="featureTableHeader  " id="d144874e533">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d144874e527" data-title="Field Name"><span class="keyword parmname">submitter</span></td>

              <td class="entry" headers="d144874e530" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e533" data-title="Description">Identifies a specific user or set of users who can submit records
                for approval. This field is required, except when the following
                types are specified and the <span class="keyword parmname">submitter</span> field is ignored:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">owner</samp></li>

                  <li class="li"><samp class="codeph nolang">creator</samp></li>

                  <li class="li"><samp class="codeph nolang">allInternalUsers</samp></li>

                </ul>
                <div class="p">Example:<div class="codeSection xml">
                    <pre class="codeblock xml"><span class="tag">&lt;allowedSubmitters</span>&gt; 
    <span class="tag">&lt;type</span>&gt;allInternalUsers<span class="tag">&lt;/type</span>&gt;
<span class="tag">&lt;/allowedSubmitters</span>&gt;  
<span class="tag">&lt;allowedSubmitters</span>&gt;
  &nbsp; <span class="tag">&lt;submitter</span>&gt;myGroup<span class="tag">&lt;/submitter</span>&gt;
    <span class="tag">&lt;type</span>&gt;group<span class="tag">&lt;/type</span>&gt;
<span class="tag">&lt;/allowedSubmitters</span>&gt;</pre>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e527" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d144874e530" data-title="Field Type">ProcessSubmitterType (enumeration of type string)</td>

              <td class="entry" headers="d144874e533" data-title="Description">Required. Type of user or set of users who can submit records for
                approval. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">group</samp></li>

                  <li class="li"><samp class="codeph nolang">role</samp></li>

                  <li class="li"><samp class="codeph nolang">user</samp></li>

                  <li class="li"><samp class="codeph nolang">roleSubordinates</samp></li>

                  <li class="li"><samp class="codeph nolang">roleSubordinatesInternal</samp></li>

                  <li class="li"><samp class="codeph nolang">owner</samp></li>

                  <li class="li"><samp class="codeph nolang">creator</samp></li>

                  <li class="li"><samp class="codeph nolang">partnerUser</samp></li>

                  <li class="li"><samp class="codeph nolang">customerPortalUser</samp></li>

                  <li class="li"><samp class="codeph nolang">portalRole</samp></li>

                  <li class="li"><samp class="codeph nolang">portalRoleSubordinates</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">allInternalUsers</samp>—all Salesforce users in
                    the organization
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ApprovalPageField

Represents the selection of fields to display on the approval page, where an approver can view the approval request details and approve or reject the record.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string\[\] | An array of fields that are displayed on the page for the approver to approve or reject the record. |

## ApprovalStep

Represents a step in the approval process. Approval steps define the chain of approval for a particular approval process. Each step determines which records can advance to that step, who to assign approval requests to, and whether to let each approver’s delegate respond to the requests. The first step specifies what to do if a record doesn’t advance to that step. Later steps specify what happens if an approver rejects the request.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

- The order of the ApprovalStep entries in the approval process definition determines the order in which the approval steps are executed.
- After an approval process is activated, you can’t add, delete, or change the order of the steps or change its reject or skip behavior, even if the process is inactive.
- Each approval process supports up to 30 steps.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d144874e741">Field Name</th>

              <th class="featureTableHeader  " id="d144874e744">Field Type</th>

              <th class="featureTableHeader  " id="d144874e747">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">allowDelegate</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type">boolean</td>

              <td class="entry" headers="d144874e747" data-title="Description">Whether to allow delegated approvers in this step of the approval
                process. A delegated approver is a user appointed by an assigned
                approver as an alternate for approval requests.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">approvalActions</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type"><a class="xref" href="#ApprovalAction">ApprovalAction</a></td>

              <td class="entry" headers="d144874e747" data-title="Description">Specifies which workflow actions to execute when a record is
                approved in this step of the approval process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">assignedApprover</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type"><a class="xref" href="#ApprovalStepApprover">ApprovalStepApprover</a></td>

              <td class="entry" headers="d144874e747" data-title="Description">Specifies the assigned approvers for this step of the approval
                process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e747" data-title="Description">Describes the approval step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">entryCriteria</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type"><a class="xref" href="#ApprovalEntryCriteria">ApprovalEntryCriteria</a></td>

              <td class="entry" headers="d144874e747" data-title="Description">Determines which records can enter this step of the approval
                process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">ifCriteriaNotMet</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type">StepCriteriaNotMetType (enumeration of type string)</td>

              <td class="entry" headers="d144874e747" data-title="Description">Specifies what to do for records that don't meet the entry
                criteria. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ApproveRecord</samp>—Approve the request and
                    execute all final approval actions.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RejectRecord</samp>—Reject the request and execute
                    all final rejection actions. This option is available only
                    for the first step in the approval process.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">GotoNextStep</samp>—Skip to the next approval
                    step. If you select this option for the first approval step,
                    and a record doesn’t meet the entry criteria for any other
                    step, the record is rejected.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e747" data-title="Description">Required. Name of the approval step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e747" data-title="Description">Required. Unique name of the approval step. It must contain only
                underscores and alphanumeric characters, begin with a letter, not
                include spaces, not end with an underscore, and not contain two
                consecutive underscores. The requirement for uniqueness is only
                within the specific approval process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">rejectBehavior</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type"><a class="xref" href="#ApprovalStepRejectBehavior">ApprovalStepRejectBehavior</a></td>

              <td class="entry" headers="d144874e747" data-title="Description">Required, except for the first step in the approval process.
                Specifies what happens if the approver rejects the request during
                this approval step, unless it's the first step in the
                approval process.<p class="p">If the approver rejects the request in the first
                  step in the approval process, the reject behavior is determined
                  by the <span class="keyword parmname">finalRejectionActions</span>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e741" data-title="Field Name"><span class="keyword parmname">rejectionActions</span></td>

              <td class="entry" headers="d144874e744" data-title="Field Type"><a class="xref" href="#ApprovalAction">ApprovalAction</a></td>

              <td class="entry" headers="d144874e747" data-title="Description">Specifies which workflow actions to execute when a record is
                rejected in this step of the approval process.</td>

            </tr>

          </tbody>

        </table>

## ApprovalAction

Represents the actions that occur as a result of an approval process.

| Field Name | Field Type | Description |
| --- | --- | --- |
| action | [WorkflowActionReference](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_workflow.htm#WorkflowActionReference)\[\] | An array of workflow actions to execute. |

## ApprovalStepApprover

Represents the assigned approvers for an approval step. Each step supports up to 25 approvers.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d144874e998">Field Name</th>

              <th class="featureTableHeader  " id="d144874e1001">Field Type</th>

              <th class="featureTableHeader  " id="d144874e1004">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d144874e998" data-title="Field Name"><span class="keyword parmname">approver</span></td>

              <td class="entry" headers="d144874e1001" data-title="Field Type">
                <a class="xref" href="#Approver">Approver</a>[]
              </td>

              <td class="entry" headers="d144874e1004" data-title="Description">An array of assigned approvers for this step of the approval
                process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e998" data-title="Field Name"><span class="keyword parmname">whenMultipleApprovers</span></td>

              <td class="entry" headers="d144874e1001" data-title="Field Type">RoutingType (enumeration of type string)</td>

              <td class="entry" headers="d144874e1004" data-title="Description">Specifies how to handle approval or rejection when multiple
                approvers are assigned to the step. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Unanimous</samp>—(Default) Require unanimous
                    approval from all approvers for this step. If any of the
                    approvers reject the request, the approval request for this
                    step is rejected.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FirstResponse</samp>—Approve or reject based on
                    the first response.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Approver

Represents an assigned approver for an approval step. Check out Considerations for Setting Approvers in Salesforce Help.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d144874e1081">Field Name</th>

              <th class="featureTableHeader  " id="d144874e1084">Field Type</th>

              <th class="featureTableHeader  " id="d144874e1087">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d144874e1081" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d144874e1084" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e1087" data-title="Description">Identifies an assigned approver. This field is required, except
                when the <span class="keyword parmname">type</span> is one of the following and the
                <span class="keyword parmname">name</span> is ignored:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">adhoc</samp></li>

                  <li class="li"><samp class="codeph nolang">userHierarchyField</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e1081" data-title="Field Name"><span class="keyword parmname" id="field_type_name"><a name="field_type_name"><!-- --></a>type</span></td>

              <td class="entry" headers="d144874e1084" data-title="Field Type">NextOwnerType (enumeration of type string)</td>

              <td class="entry" headers="d144874e1087" data-title="Description">Combined with the specified <span class="keyword parmname">name</span>,
                <span class="keyword parmname">type</span> identifies an assigned approver. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang" id="NextOwnerType_value_adhoc"><a name="NextOwnerType_value_adhoc"><!-- --></a>adhoc</samp>—The approver for the step must be
                    selected manually. For the first step, the submitter selects
                    the approver. For the second and later steps, the approver
                    for the previous step selects the approver. For this value,
                    exclude the <span class="keyword parmname">name</span> field.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">user</samp>—A user in
                    your organization. For this value, enter a username for the
                    <span class="keyword parmname">name</span> field.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="NextOwnerType_value_userHierarchyField"><a name="NextOwnerType_value_userHierarchyField"><!-- --></a>userHierarchyField</samp>—A
                    user specified in a standard or custom user hierarchy field,
                    such as the standard <span class="keyword parmname">Manager</span> field. For
                    this value, exclude the <span class="keyword parmname">name</span> field. The
                    user hierarchy field must be defined in the
                    nextAutomatedApprovers for the approval process.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">relatedUserField</samp>—A user specified in a user
                    lookup field on the submitted record, such as the
                    <span class="keyword parmname">Last Modified By</span> field. For this
                    value, enter the name of the user lookup field for the
                    <span class="keyword parmname">name</span> field.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">queue</samp>—Automatically assign to a queue. For
                    this value, enter the name of the queue for the
                    <span class="keyword parmname">name</span> field.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ApprovalEntryCriteria

Represents the criteria that records must meet to enter the approval process or an approval step. Specify either filter criteria or a formula, but not both.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d144874e1216">Field Name</th>

              <th class="featureTableHeader  " id="d144874e1219">Field Type</th>

              <th class="featureTableHeader  " id="d144874e1222">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d144874e1216" data-title="Field Name"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d144874e1219" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e1222" data-title="Description">Filter logic for <span class="keyword parmname">criteriaItems</span>. Exclude this
                field if you enter a <span class="keyword parmname">formula</span>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e1216" data-title="Field Name"><span class="keyword parmname">criteriaItems</span></td>

              <td class="entry" headers="d144874e1219" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a>[]
              </td>

              <td class="entry" headers="d144874e1222" data-title="Description">Filter criteria that a record must meet to enter the approval
                process or approval step.<p class="p">Approval processes don’t support
                  <span class="keyword parmname">valueField</span> entries in filter
                  criteria.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d144874e1216" data-title="Field Name"><span class="keyword parmname">formula</span></td>

              <td class="entry" headers="d144874e1219" data-title="Field Type">string</td>

              <td class="entry" headers="d144874e1222" data-title="Description">Formula that must evaluate to true for a record to enter the
                approval process or approval step.</td>

            </tr>

          </tbody>

        </table>

## ApprovalStepRejectBehavior

Represents what happens if the approver rejects the request during this approval step, unless it's the first step in the approval process. For the first step in the approval process, the reject behavior is determined by the approval process's final rejection actions.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d144874e1309">Field Name</th>

              <th class="featureTableHeader  " id="d144874e1312">Field Type</th>

              <th class="featureTableHeader  " id="d144874e1315">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d144874e1309" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d144874e1312" data-title="Field Type">StepRejectBehaviorType (enumeration of type string)</td>

              <td class="entry" headers="d144874e1315" data-title="Description">Not allowed in the first step of the approval process. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">RejectRequest</samp>—Rejects the request even if
                    previous steps were approved. Salesforce performs all
                    rejection actions specified for this step and all final
                    rejection actions.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">BackToPrevious</samp>—Rejects the request, and
                    returns the approval request to the previous approver.
                    Salesforce performs all rejection actions specified for this
                    step.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## NextAutomatedApprover

Represents the user hierarchy field to use as the next automated approver for the approval process. If defined, the user specified in the hierarchy field can be automatically assigned as the approver in one or more approval steps.

| Field Name | Field Type | Description |
| --- | --- | --- |
| useApproverFieldOfRecordOwner | boolean | Required. Whether the first executed approval step uses the specified userHierarchyField in the record owner’s user record—instead of the submitter’s user record—as the approver. All remaining steps use the specified userHierarchyField in the user record of the preceding step’s approver. |
| userHierarchyField | string | Required. Standard or custom user hierarchy field whose value specifies which user to assign as the approver. For example, the standard Manager hierarchy field can be used to assign approvers for employee PTO (paid time off) requests. |

## Declarative Metadata Sample Definition

The following is an example of an ApprovalProcess component:

<?xml version="1.0" encoding="UTF-8"?>
<ApprovalProcess xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>false</active\>
    <allowRecall\>false</allowRecall\>
    <allowedSubmitters\>
        <type\>owner</type\>
    </allowedSubmitters\>
    <allowedSubmitters\>
        <submitter\>USSalesRep</submitter\>
        <type\>role</type\>
    </allowedSubmitters\>
    <allowedSubmitters\>
        <submitter\>MarketingGroup</submitter\>
        <type\>group</type\>
    </allowedSubmitters\>
    <allowedSubmitters\>
        <submitter\>kcooper@example.com</submitter\>
        <type\>user</type\>
    </allowedSubmitters\>
    <approvalPageFields\>
        <field\>Name</field\>
        <field\>Owner</field\>
        <field\>MyLeadCustomField\_\_c</field\>
        <field\>Address</field\>
    </approvalPageFields\>
    <approvalStep\>
        <allowDelegate\>false</allowDelegate\>
        <approvalActions\>
            <action\>
                <name\>LeadApprovedTask1</name\>
                <type\>Task</type\>
            </action\>
            <action\>
                <name\>LeadApprovedTask2</name\>
                <type\>Task</type\>
            </action\>
        </approvalActions\>
        <assignedApprover\>
            <approver\>
                <type\>adhoc</type\>
            </approver\>
        </assignedApprover\>
        <label\>Step1</label\>
        <name\>Step1</name\>
        <rejectionActions\>
            <action\>
                <name\>LeadRejectedTask</name\>
                <type\>Task</type\>
            </action\>
        </rejectionActions\>
    </approvalStep\>
    <approvalStep\>
        <allowDelegate\>false</allowDelegate\>
        <assignedApprover\>
            <approver\>
                <type\>userHierarchyField</type\>
            </approver\>
        </assignedApprover\>
        <entryCriteria\>
            <criteriaItems\>
                <field\>Lead.CreatedDate</field\>
                <operation\>greaterThan</operation\>
                <value\>3/25/2013</value\>
            </criteriaItems\>
            <criteriaItems\>
                <field\>User.IsActive</field\>
                <operation\>notEqual</operation\>
                <value\>true</value\>
            </criteriaItems\>
        </entryCriteria\>
        <ifCriteriaNotMet\>ApproveRecord</ifCriteriaNotMet\>
        <label\>Step2</label\>
        <name\>Step2</name\>
        <rejectBehavior\>
            <type\>RejectRequest</type\>
        </rejectBehavior\>
    </approvalStep\>
    <approvalStep\>
        <allowDelegate\>true</allowDelegate\>
        <assignedApprover\>
            <approver\>
                <name\>MarketingTeamQueue</name\>
                <type\>queue</type\>
            </approver\>
            <approver\>
                <name\>LastModifiedBy</name\>
                <type\>relatedUserField</type\>
            </approver\>
            <approver\>
                <name\>awheeler@example.com</name\>
                <type\>user</type\>
            </approver\>
            <whenMultipleApprovers\>FirstResponse</whenMultipleApprovers\>
        </assignedApprover\>
        <entryCriteria\>
            <formula\>CONTAINS( MyLeadCustomField\_\_c , 'Salesforce')</formula\>
        </entryCriteria\>
        <label\>Step3</label\>
        <name\>Step3</name\>
        <rejectBehavior\>
            <type\>BackToPrevious</type\>
        </rejectBehavior\>
    </approvalStep\>
    <emailTemplate\>MyFolder/LeadsNewassignmentnotification</emailTemplate\>
    <enableMobileDeviceAccess\>false</enableMobileDeviceAccess\>
    <entryCriteria\>
        <criteriaItems\>
            <field\>Lead.AnnualRevenue</field\>
            <operation\>greaterThan</operation\>
            <value\>10500</value\>
        </criteriaItems\>
        <criteriaItems\>
            <field\>Lead.MyLeadCustomField\_\_c</field\>
            <operation\>equals</operation\>
            <value\>Salesforce</value\>
        </criteriaItems\>
    </entryCriteria\>
    <finalApprovalActions\>
        <action\>
            <name\>LeadEmailContacted</name\>
            <type\>Alert</type\>
        </action\>
    </finalApprovalActions\>
    <finalApprovalRecordLock\>true</finalApprovalRecordLock\>
    <finalRejectionActions\>
        <action\>
            <name\>ProcessRejectedMessageAction</name\>
            <type\>OutboundMessage</type\>
        </action\>
    </finalRejectionActions\>
    <finalRejectionRecordLock\>false</finalRejectionRecordLock\>
    <initialSubmissionActions\>
        <action\>
            <name\>LeadFieldUpdate</name\>
            <type\>FieldUpdate</type\>
        </action\>
        <action\>
            <name\>NewLeadEmail</name\>
            <type\>Alert</type\>
        </action\>
    </initialSubmissionActions\>
    <label\>SampleProcess</label\>
    <nextAutomatedApprover\>
        <useApproverFieldOfRecordOwner\>false</useApproverFieldOfRecordOwner\>
        <userHierarchyField\>customlookupuserfield\_\_c</userHierarchyField\>
    </nextAutomatedApprover\>
    <postTemplate\>MyPostTemplate</postTemplate\>
    <recallActions\>
        <action\>
            <name\>ProcessRecalledMessageAction</name\>
            <type\>OutboundMessage</type\>
        </action\>
    </recallActions\>
    <recordEditability\>AdminOnly</recordEditability\>
    <showApprovalHistory\>false</showApprovalHistory\>
</ApprovalProcess\>

## Wildcard Support in the Manifest File

Use the wildcard character \* (asterisk) in the package.xml manifest file to retrieve all approval processes for all objects. You can’t use it to retrieve a subset of approval processes. Syntax such as Lead.\* isn’t supported. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=1a1c4fd5f97324fdc3079895dec61020d9e476a9cc447e12d17bd474f4a1e508 url=/legacydeveloper/current/en-us/api_meta/meta_articletype.md -->

# ArticleType

Represents the metadata associated with an article type.

All articles in Salesforce Knowledge are assigned to an article type. An article's type determines the type of content it contains, its appearance, and which users can access it. For example, a simple FAQ article type can have two custom fields, Question and Answer, where article managers enter data when creating or updating FAQ articles. A more complex article type can have dozens of fields organized into several sections. Using layouts and templates, administrators can structure the article type in the most effective way for its particular content. User access to article types is controlled by permissions. For each article type, an administrator can grant “Create,” “Read,” “Edit,” or “Delete” permissions to users. For example, the article manager can allow internal users to read, create, and edit FAQ article types, but let partner users only read FAQs. See “[Knowledge Article Types](https://help.salesforce.com/s/articleView?id=service.knowledge_article_types_manage.htm&type=5&language=en_US)” in the Salesforce online help and [Knowledge](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_guidelines_knowledge.htm) in the SOAP API Developer Guide.

## Declarative Metadata File Suffix and Directory Location

An ArticleType is defined as a custom object and is stored in the objects folder. ArticleTypes have a suffix \_\_kav (instead of \_\_c for custom objects). ArticleType field names have a suffix of \_\_c like other custom objects, and must be dot-qualified with the name of the article type to which they belong. This is shown in the following sample package.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>articlefilemetadata</fullName\>
    <apiAccessLevel\>Unrestricted</apiAccessLevel\>
    <types\>
        <members\>newarticle\_\_kav.description\_\_c</members\>
        <name\>CustomField</name\>
    </types\>
    <types\>
        <members\>newarticle\_\_kav</members\>
        <name\>CustomObject</name\>
    </types\>
</Package\>

## Version

ArticleTypes are available in API version 19.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d149018e125">Field Name</th>

              <th class="featureTableHeader  " id="d149018e128">Field Type</th>

              <th class="featureTableHeader  " id="d149018e131">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d149018e125" data-title="Field Name"><span class="keyword parmname">articleTypeChannel​Display</span></td>

              <td class="entry" headers="d149018e128" data-title="Field Type">articleTypeChannelDisplay</td>

              <td class="entry" headers="d149018e131" data-title="Description">Represents the article-type templates used to display an article
                in the various channels. See “<a class="xref" href="https://help.salesforce.com/s/articleView?id=service.knowledge_article_templates_create.htm&amp;type=5&amp;language=en_US" target="_blank">Article Type
                  Templates</a>” in the Salesforce online help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d149018e125" data-title="Field Name"><span class="keyword parmname">deploymentStatus</span></td>

              <td class="entry" headers="d149018e128" data-title="Field Type">DeploymentStatus (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d149018e131" data-title="Description">
                <p class="p">A string which represents the deployment status of a custom
                  object or field. Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">InDevelopment</samp></li>

                  <li class="li"><samp class="codeph nolang">Deployed</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d149018e125" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d149018e128" data-title="Field Type">string</td>

              <td class="entry" headers="d149018e131" data-title="Description">A description of the article type. Maximum of 1000
                characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d149018e125" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d149018e128" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm" title="Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.">CustomField[]</a></td>

              <td class="entry" headers="d149018e131" data-title="Description">Represents one or more fields in the article type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d149018e125" data-title="Field Name"><span class="keyword parmname">gender</span></td>

              <td class="entry" headers="d149018e128" data-title="Field Type">Gender</td>

              <td class="entry" headers="d149018e131" data-title="Description">Indicates the gender of the noun that represents the object. This
                is used for languages where words need different treatment depending
                on their gender.</td>

            </tr>

            <tr>
              <td class="entry" headers="d149018e125" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d149018e128" data-title="Field Type">string</td>

              <td class="entry" headers="d149018e131" data-title="Description">Label that represents the object throughout the Salesforce user
                interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d149018e125" data-title="Field Name"><span class="keyword parmname">pluralLabel</span></td>

              <td class="entry" headers="d149018e128" data-title="Field Type">string</td>

              <td class="entry" headers="d149018e131" data-title="Description">Plural version of the <span class="keyword parmname">label</span> value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d149018e125" data-title="Field Name"><span class="keyword parmname">startsWith</span></td>

              <td class="entry" headers="d149018e128" data-title="Field Type">StartsWith (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d149018e131" data-title="Description"><span class="ph" id="startsWith_desc"><a name="startsWith_desc"><!-- --></a>Indicates whether the noun starts with a
                  vowel, consonant, or is a special character. This is used for
                  languages where words need different treatment depending on the
                  first character. Valid values are listed in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm#startsWith_ul">StartsWith</a>.</span></td>

            </tr>

          </tbody>

        </table>

## ArticleTypeChannelDisplay

Determines the article-type templates that are used to display an article in its channels. Unless otherwise noted, all fields are createable, filterable, and nillable.

| Field Name | Field Type | Description |
| --- | --- | --- |
| articleTypeTemplates | [ArticleTypeTemplate](#articleTypeTemplates)\[\] | Indicates which article-type template applies in the specified channel. |

## ArticleTypeTemplate

Sets the article-type template for a specific channel. If not specified, the default article-type template applies.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d149018e367">Field Name</th>

              <th class="featureTableHeader  " id="d149018e370">Field Type</th>

              <th class="featureTableHeader  " id="d149018e373">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d149018e367" data-title="Field Name"><span class="keyword parmname">channel</span></td>

              <td class="entry" headers="d149018e370" data-title="Field Type">string</td>

              <td class="entry" headers="d149018e373" data-title="Description">Specifies the channel where the article-type template applies:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AllChannels</samp>: all the
                    available channels.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">App</samp>: the Articles tab
                    in Salesforce Knowledge.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Pkb</samp>: the public
                    knowledge base.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Csp</samp>: the Customer
                    Portal.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Prm</samp>: the partner
                    portal.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d149018e367" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="page"><a name="page"><!-- --></a>page</span></span></td>

              <td class="entry" headers="d149018e370" data-title="Field Type">string</td>

              <td class="entry" headers="d149018e373" data-title="Description">Represents the name of the custom Visualforce page used as a
                custom article-type template. Use this field when you select template</td>

            </tr>

            <tr>
              <td class="entry" headers="d149018e367" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="template"><a name="template"><!-- --></a>template</span></span></td>

              <td class="entry" headers="d149018e370" data-title="Field Type">string</td>

              <td class="entry" headers="d149018e373" data-title="Description">Indicates the article-type template used for the specified channel:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang" id="template_page"><a name="template_page"><!-- --></a>Page</samp>: custom Visualforce page. When specifying
                    this value, you must also set the <samp class="codeph nolang">page</samp> field with the Visualforce page name.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Tab</samp>: display the
                    sections you defined in the layout as tabs.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Toc</samp>: display the
                    sections you defined in the layout as table of content.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definitions

A sample article type definition follows:

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <articleTypeChannelDisplay\>
        <articleTypeTemplates\>
            <channel\>App</channel\>
            <template\>Tab</template\>
        </articleTypeTemplates\>
        <articleTypeTemplates\>
            <channel\>Prm</channel\>
            <template\>Tab</template\>
        </articleTypeTemplates\>
        <articleTypeTemplates\>
            <channel\>Csp</channel\>
            <template\>Tab</template\>
        </articleTypeTemplates\>
        <articleTypeTemplates\>
            <channel\>Pkb</channel\>
            <template\>Toc</template\>
        </articleTypeTemplates\>
    </articleTypeChannelDisplay\>
    <deploymentStatus\>Deployed</deploymentStatus\>
    <description\>Article type with custom fields</description\>
    <fields\>
        <fullName\>description\_\_c</fullName\>
        <label\>Description</label\>
        <length\>48</length\>
        <type\>Text</type\>
    </fields\>
    <label\>newarticle</label\>
    <pluralLabel\>newarticles</pluralLabel\>
</CustomObject\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

- **[ArticleType Layout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype_layout.htm)**  
    Represents the metadata associated with an article type page layout. Article type layouts determine which fields users can view and edit when entering data for an article. Article type layouts also determine which sections appear when users view articles.
- **[ChannelLayout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype_channellayout.htm)**  
    Represents the metadata associated with a communication channel layout. Communication channel layouts let admins share article content inline into communication channels (for example, in email publishers, Experience Builder sites, or social media publishers). Admins can create a list of fields for an article type or record type that they want to share for each communication channel. You can customize the order of the fields.
- **[ArticleType CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype_customfield.htm)**  
    Represents the metadata associated with an article type custom field. Use this metadata type to create, update, or delete article type custom field definitions.

#### See Also

- [ArticleType Layout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype_layout.htm "Represents the metadata associated with an article type page layout. Article type layouts determine which fields users can view and edit when entering data for an article. Article type layouts also determine which sections appear when users view articles.")
- [ArticleType CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype_customfield.htm "Represents the metadata associated with an article type custom field. Use this metadata type to create, update, or delete article type custom field definitions.")

<!-- document id=0390d9e88d3b4aec8067967c6b0de89b9ed84429686701f30530f4c631ed16a9 url=/legacydeveloper/current/en-us/api_meta/meta_articletype_customfield.md -->

# ArticleType CustomField

Represents the metadata associated with an article type custom field. Use this metadata type to create, update, or delete article type custom field definitions.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

Always specify the full name whenever you create or update a custom field. For example, a custom field on a custom object:

MyArticleType\_\_kav.MyCustomField\_\_c
      

## Declarative Metadata File Suffix and Directory Location

Custom fields are defined as part of the article type. ArticleType field names have a suffix of \_\_c like other custom objects, and must be dot-qualified with the name of the article type to which they belong. See [ArticleType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype.htm "Represents the metadata associated with an article type.") for more information.

## Retrieving Custom Fields on Custom or Standard Objects

When you retrieve a custom or standard object, you return everything associated with the object. However, you can also retrieve only the custom fields for an object by explicitly naming the object and fields in package.xml. The following definition in package.xml retrieves the files objects/MyCustomObject\_\_c.object, objects/Account.object\_\_c.object, and objects/MyArticleType\_\_kav.object, each containing one custom field definition.

<types\>
    <members\>MyCustomObject\_\_c.MyCustomField\_\_c</members\>
    <members\>Account.MyCustomAccountField\_\_c</members\>
    <members\>MyArticleType\_\_kav.MyOtherCustomField\_\_c</members\>
    <name\>CustomField</name\>
</types\>
      

## Version

ArticleTypes custom fields are available in API version 19.0 and later.

## Fields for ArticleType

Unless otherwise noted, all fields are createable, filterable, and nillable.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If you create a knowledge validation rule, the errors always display at the top of the page, even if you add it beside the field. Therefore, write the errors descriptively so authors know how to satisfy the validation rule. For example, identify which field is causing the error. The Salesforce Classic user interface does not support field level error messages for articles.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d151139e141">Field Name</th>

              <th class="featureTableHeader  " id="d151139e144">Field Type</th>

              <th class="featureTableHeader  " id="d151139e147">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">defaultValue</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">string</td>

              <td class="entry" headers="d151139e147" data-title="Description">If specified, represents the default value of the field. This field was
                deprecated in API version 48.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">deleteConstraint</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm" title="These field types extend the field types described in the Salesforce Object Reference.">Metadata Field Types</a> (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d151139e147" data-title="Description">Provides deletion options for lookup relationships. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Cascade</samp>—Deletes the lookup record
                    as well as associated lookup fields.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Restrict</samp>—Prevents the record from
                    being deleted if it's in a lookup relationship.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SetNull</samp>—This is the default. If
                    the lookup record is deleted, the lookup field is cleared.
                  </li>

                </ul>
                <p class="p">For more information on lookup relationships, see "Object Relationships" in
                  Salesforce Help.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">string</td>

              <td class="entry" headers="d151139e147" data-title="Description">Description of the field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">formula</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">string</td>

              <td class="entry" headers="d151139e147" data-title="Description">If specified, represents a formula on the field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">formulaTreatBlankAs</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm" title="These field types extend the field types described in the Salesforce Object Reference.">Metadata Field Types</a> (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d151139e147" data-title="Description">Indicates how to treat blanks in a formula. Valid values are: <samp class="codeph nolang">BlankAsBlank</samp> and <samp class="codeph nolang">BlankAsZero</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">string</td>

              <td class="entry" headers="d151139e147" data-title="Description">Inherited from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>,
                this field is defined in the WSDL for this metadata type. It must be specified when
                creating, updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a> to see an example of this
                field specified for a call.<p class="p" id="no_null_para"><a name="no_null_para"><!-- --></a>This value cannot be <samp class="codeph java">null</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">inlineHelpText</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">string</td>

              <td class="entry" headers="d151139e147" data-title="Description">Represents the content of field-level help. For more information, see "Define
                Field-Level Help" in Salesforce Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">string</td>

              <td class="entry" headers="d151139e147" data-title="Description">Label for the field. You cannot update the label for standard fields in Article
                Type such as Title, UrlName, Summary, etc.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">length</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">int</td>

              <td class="entry" headers="d151139e147" data-title="Description">Length of the field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">picklist</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm" title="Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.">Picklist (Including
                  Dependent Picklist)</a></td>

              <td class="entry" headers="d151139e147" data-title="Description">(<strong class="ph b">Deprecated.</strong> Use this field in API version 37.0 and earlier only. In
                later versions, use <span class="keyword parmname">valueSet</span> instead.) If specified, the field
                is a picklist, and this field enumerates the picklist values and labels.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">referenceTo</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">string</td>

              <td class="entry" headers="d151139e147" data-title="Description">If specified, indicates a reference this field has to another object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">relationshipLabel</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">string</td>

              <td class="entry" headers="d151139e147" data-title="Description">Label for the relationship.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">relationshipName</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">string</td>

              <td class="entry" headers="d151139e147" data-title="Description">If specified, indicates the value for one-to-many relationships. For example,
                in the object MyObject that had a relationship to YourObject, the relationship name
                might be YourObjects.</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">required</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">boolean</td>

              <td class="entry" headers="d151139e147" data-title="Description">Indicates whether the field requires a value on creation (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">FieldType</td>

              <td class="entry" headers="d151139e147" data-title="Description">Required. Indicates the field type for the field. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Checkbox</samp> available in version 30.0 and
                    later
                  </li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">ArticleCurrency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Email</samp></li>

                  <li class="li"><samp class="codeph nolang">File</samp></li>

                  <li class="li"><samp class="codeph nolang">Formula</samp></li>

                  <li class="li"><samp class="codeph nolang">Html</samp></li>

                  <li class="li"><samp class="codeph nolang">Lookup</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">Percent</samp></li>

                  <li class="li"><samp class="codeph nolang">Phone</samp></li>

                  <li class="li"><samp class="codeph nolang">Picklist</samp></li>

                  <li class="li"><samp class="codeph nolang">DependentPicklist</samp></li>

                  <li class="li"><samp class="codeph nolang">MultiselectPicklist</samp></li>

                  <li class="li"><samp class="codeph nolang">Text</samp></li>

                  <li class="li"><samp class="codeph nolang">TextArea</samp></li>

                  <li class="li"><samp class="codeph nolang">LongTextArea</samp></li>

                  <li class="li"><samp class="codeph nolang">URL</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d151139e141" data-title="Field Name"><span class="keyword parmname">visibleLines</span></td>

              <td class="entry" headers="d151139e144" data-title="Field Type">int</td>

              <td class="entry" headers="d151139e147" data-title="Description">Indicates the number of lines displayed for the field.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <fields>
        <fullName>Comments\_\_c</fullName>
        <description>add your comments about this object here</description>
        <label>Comments</label>
        <length>32000</length>
        <type>LongTextArea</type>
        <visibleLines>30</visibleLines>
    </fields>
</CustomObject>

#### See Also

- [ArticleType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype.htm "Represents the metadata associated with an article type.")
- [ArticleType Layout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype_layout.htm "Represents the metadata associated with an article type page layout. Article type layouts determine which fields users can view and edit when entering data for an article. Article type layouts also determine which sections appear when users view articles.")

<!-- document id=2645659f363a32346a8a41419f22dfd18d73a32886e9f78751d617fc026c1793 url=/legacydeveloper/current/en-us/api_meta/meta_articletype_layout.md -->

# ArticleType Layout

Represents the metadata associated with an article type page layout. Article type layouts determine which fields users can view and edit when entering data for an article. Article type layouts also determine which sections appear when users view articles.

The format of the article, for example whether layout sections display as subtabs or as a single page with links, is defined by the [article-type template](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype.htm#articleTypeTemplates). Each article type has only one layout, but you can choose a different template for each of the article type's four channels. See [Knowledge](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_guidelines_knowledge.htm) in SOAP API Developer Guide.

## File Suffix and Directory Location

ArticleType layouts are stored in the layouts directory of the corresponding package directory. The prefix must match with the article type API name. The extension is .layout.

## Version

ArticleType layouts are available in API version 19.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| layoutSections | [LayoutSection](#LayoutSection)\[\] | The main sections of the layout containing the article fields. The order here determines the layout order. |

## LayoutSection

LayoutSection represents a section of an ArticleType layout.

| Field Name | Field Type | Description |
| --- | --- | --- |
| customLabel | boolean | Indicates if this section's label is custom or standard (built-in). Custom labels can be any text, but must be translated. Standard labels have a predefined set of valid values, for example 'System Information', which are automatically translated. |
| label | string | The label; either standard or custom, based on the customLabel flag. |
| layoutColumns | [LayoutColumn](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_layouts.htm#LayoutColumn)\[\] | The columns of the layout, depending on the style. Salesforce Knowledge only supports one column in article type layouts. |
| style | LayoutSectionStyle ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | The style of the layout. Salesforce Knowledge only supports the value OneColumn, which displays a one-column page. |

## LayoutColumn

LayoutColumn represents the items in a column within a layout section.

| Field Name | Field Type | Description |
| --- | --- | --- |
| layoutItems | [LayoutItem](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_layouts.htm#LayoutItem)\[\] | The individual items within a column (ordered from top to bottom). |

## LayoutItem

LayoutItem represents the valid values that define a layout item.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | The field name reference, for example MyField\_\_c. |

## Declarative Metadata Sample Definition

The following is the definition of an ArticleType page layout:

<?xml version="1.0" encoding="UTF-8"?>
<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
    <layoutSections\>
        <customLabel\>true</customLabel\>
        <label\>Description</label\>
        <layoutColumns\>
            <layoutItems\>
                <field\>description\_\_c</field\>
            </layoutItems\>
            <layoutItems\>
                <field\>dateTime\_\_c</field\>
            </layoutItems\>
        </layoutColumns\>
        <style\>OneColumn</style\>
    </layoutSections\>
    <layoutSections\>
        <label\>Data Sheet</label\>
        <layoutColumns\>
            <layoutItems\>
                <field\>file\_\_c</field\>
            </layoutItems\>
        </layoutColumns\>
        <style\>OneColumn</style\>
    </layoutSections\>
</Layout\>

#### See Also

- [ArticleType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype.htm "Represents the metadata associated with an article type.")
- [ArticleType CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype_customfield.htm "Represents the metadata associated with an article type custom field. Use this metadata type to create, update, or delete article type custom field definitions.")

<!-- document id=ed2a0672bb417ca3c67c5db6bb9b57137f4ab07f96f90eb577bac05ff65273f1 url=/legacydeveloper/current/en-us/api_meta/meta_assessmentquestion.md -->

# AssessmentQuestion

Represents the container object that stores the questions required for an assessment.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AssessmentQuestion components have the suffix .AssessmentQuestion and are stored in the AssessmentQuestions folder.

## Version

AssessmentQuestion components are available in API version 55.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| assessmentQuestionVersion | 
Field Type

[AssessmentQuestionVersion](#AssesQVer)

Description

The object that stores the question versions for the assessment questions.



 |
| dataType | 

Field Type

string

Description

Required.

The data type of the assessment question.



 |
| developerName | 

Field Type

string

Description

Required.

The developer name of the assessment question. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| displayTextCategory | 

Field Type

string

Description

Specifies the category of the display text when the data type is Text Block.



 |
| formulaResponseDataType | 

Field Type

string

Description

Specifies the data type of the question response calculated by a formula.



 |
| name | 

Field Type

string

Description

Required.

The name of the record.



 |
| questionCategory | 

Field Type

string

Description

Required.

Stores the question category.



 |
| relatedQuestion | 

Field Type

string

Description

Specifies the related question. Used to define a question hierarchy.



 |

## AssessmentQuestionVersion​​

Stores the question versions for the assessment questions.

| Field Name | Description |
| --- | --- |
| additionalInformation | 
Field Type

string

Description

The additional details for a UI element, such as the disclosure text.



 |
| description | 

Field Type

string

Description

The description for the assessment question. This text isn’t rendered on the assessment.



 |
| guidanceInformation | 

Field Type

string

Description

The guidance for the assessment question.



 |
| helpText | 

Field Type

string

Description

The text that's added as an info bubble in the UI element related to the assessment question.



 |
| isActive | 

Field Type

boolean

Description

Required.

Indicates whether the current version of the assessment question is set to active (true) or not (false).

The default value is false.



 |
| name | 

Field Type

string

Description

Required.

Name of the assessment question version record.



 |
| optionSourceResponseValue | 

Field Type

boolean

Description

Indicates whether the response value source for an assessment question is configured as custom (true) or sObject in the OmniStudio designer (false).

The default value is false.



 |
| questionText | 

Field Type

string

Description

Required.

The assessment question text. Contains the label for the assessment question that appears on the assessment.



 |
| responseValues | 

Field Type

string

Description

Holds the values to be defined in the picklist, multiselect picklist, or radio buttons.



 |
| status | 

Field Type

string

Description

Required.

Status of the assessment question version. Possible values are Draft, Active, or Archived.



 |
| versionNumber | 

Field Type

int

Description

Required.

The assessment question version number.



 |

## Declarative Metadata Sample Definition

The following is an example of an AssessmentQuestion component.

<?xml version="1.0" encoding="UTF-8"?>
<AssessmentQuestion
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<assessmentQuestionVersion>
		<additionalInformation>ParentQuestionDevName AI</additionalInformation>
		<description>ParentQuestionDevName Desc</description>
		<helpText>ParentQuestionDevName HT</helpText>
		<isActive>true</isActive>
		<name>ParentQuestionDevName</name>
		<optionSourceResponseValue>true</optionSourceResponseValue>
		<questionText>ParentQuestionDevName Text</questionText>
		<status>Active</status>
		<versionNumber>1</versionNumber>
	</assessmentQuestionVersion>
	<dataType>DateTime</dataType>
	<developerName>ParentQuestionDevName</developerName>
	<name>ParentQuestionDevName</name>
	<questionCategory>Demographic</questionCategory>
</AssessmentQuestion>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>\*</members\>
		<name\>AssessmentQuestion</name\>
	</types\>
	<version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

## Usage

Before you retrieve assessment questions, we recommend that you review these considerations.

- When you retrieve an assessment question, you also get the related assessment question version with the status Active..
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    If an active assessment question version doesn’t exist for the assessment question, then the latest assessment question version with Status as Draft is retrieved.
- The value for the <status> tag in the XML definition must match the status of the related assessment question version.
- If an assessment question has a related assessment question (parent question), the XML definition must include the developer name of the related assessment question.
- If the fields of an assessment question contain values, the XML definition must contain tags with those values when retrieving it.

Before you deploy assessment questions, we recommend that you review these considerations.

- If the Related Question isn’t available in the target org, deploying the assessment question fails.
- If an assessment question with the same developer name exists in the target org, deploying the assessment question updates the values of the other fields in the target org.
- If the <versionNumber> tag is present in the XML definition of an assessment question, deploying creates a version for that question in the target org.
- If the Related Questions aren’t available in target org but available in the package, then deploying the questions inserts the Related Questions in the correct order.
- If the assessment questions are associated with flows of type Discovery Framework Data Capture Flow, then deploy the assessment questions first. After deploying the assessment questions, deploy the flows.

<!-- document id=8fa83929d375b8c331a72a30acb2c67e0c90b726ce88260bdd02f1dca099778a url=/legacydeveloper/current/en-us/api_meta/meta_assessmentquestionset.md -->

# AssessmentQuestionSet

Represents the container object for Assessment Questions.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

AssessmentQuestionSet components have the suffix .AssessmentQuestionSet and are stored in the AssessmentQuestionSets folder.

## Version

AssessmentQuestionSet components are available in API version 55.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| assessmentQuestionDeveloperNames | 
Field Type

string\[\]

Description

The developer names for the assessment question. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| developerName | 

Field Type

string

Description

Required.

The developer name for the assessment question set. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| name | 

Field Type

string

Description

Required.

The question set name.



 |

## Declarative Metadata Sample Definition

The following is an example of an AssessmentQuestionSet component.

<?xml version="1.0" encoding="UTF-8"?>
<AssessmentQuestionSet
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<developerName\>QuestionSetDevName</developerName\>
	<name\>QuestionSetName</name\>
	<assessmentQuestionDeveloperNames\>QuestionDevName</assessmentQuestionDeveloperNames\>
</AssessmentQuestionSet\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>\*</members\>
		<name\>AssessmentQuestion</name\>
	</types\>
	<types\>
		<members\>\*</members\>
		<name\>AssessmentQuestionSet</name\>
	</types\>
	<version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

## Usage

Before you retrieve assessment question sets, we recommend that you review these considerations.

- When retrieving an assessment question set, if its fields contain values, then the XML definition must contain tags with those values.
- When retrieving an assessment question set, if that set is associated with multiple questions, then the XML definition must contain developer names of all the associated questions.

Before you deploy assessment question sets, we recommend that you review these considerations.

- When deploying an assessment question set, if an assessment question set with the same developer name doesn't exist in the target org, deploying creates one with that name.
- If an assessment question set with the same developer name exists in the target org, then deploying the question set updates the values of the other fields in the target org.
- If the questions associated with the assessment question set don't exist in the target org, deploying the assessment question set fails.
- If the questions associated with the assessment question set don’t exist in the target org but are available in the package, then deploying the assessment question sets inserts the questions in the correct order.

<!-- document id=2283d327fe6b7eceb76bcbc2998d00390bbb6aa2ae9201b83cb80ee45c5cfc3b url=/legacydeveloper/current/en-us/api_meta/meta_assignmentrule.md -->

# AssignmentRules

Represents assignment rules that allow you to automatically route cases to the appropriate users or queues. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object.

The package.xml syntax for accessing all assignment rules for all objects is:

    <types>
        <members>\*</members>
        <name>AssignmentRules</name>
    </types>

All rules for a specific object use a similar syntax without the wildcard. For example, all assignment rules for the Case object would use this syntax:

    <types>
        <members>Case</members>
        <name>AssignmentRules</name>
    </types>

You can also access specific assignment rules for an object. The following example only accesses the “samplerule” and “newrule” assignment rules on the Case object. Notice that for this example the type name syntax is AssignmentRule and not AssignmentRules.

    <types>
        <members>Case.samplerule</members>
        <members>Case.newrule</members>
        <name>AssignmentRule</name>
    </types>

## File Suffix and Directory Location

Assignment rules for an object have the suffix .assignmentRules and are stored in the assignmentRules folder. For example, all Case assignment rules are stored in the Case.assignmentRules file.

## Version

AssignmentRules components are available in API version 27.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignmentRule | [AssignmentRule\[\]](#AssignmentRule_sub) | Represents the definitions of the named assignment rules. |

## AssignmentRule

Specifies whether the rule is active or not and its definition. Rules are processed in the order they appear within the AssignmentRules container.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d155746e162">Field Name</th>

              <th class="featureTableHeader  " id="d155746e165">Field Type</th>

              <th class="featureTableHeader  " id="d155746e168">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d155746e162" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d155746e165" data-title="Field Type">boolean</td>

              <td class="entry" headers="d155746e168" data-title="Description">Indicates whether the assignment rule is active (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e162" data-title="Field Name"><span class="keyword parmname">fullname</span></td>

              <td class="entry" headers="d155746e165" data-title="Field Type">string</td>

              <td class="entry" headers="d155746e168" data-title="Description">Inherited from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for this
                metadata type. It must be specified when creating, updating, or
                deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a>
                to see an example of this field specified for a call.<p class="p">This value
                  can't be <samp class="codeph java">null</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e162" data-title="Field Name"><span class="keyword parmname">ruleEntry</span></td>

              <td class="entry" headers="d155746e165" data-title="Field Type"><span class="keyword parmname"><a class="xref" href="#RuleEntry_title">RuleEntry[]</a></span></td>

              <td class="entry" headers="d155746e168" data-title="Description">Represents the type and description for the assignment rule.
              </td>

            </tr>

          </tbody>

        </table>

## RuleEntry

Represents the fields used by the rule.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d155746e272">Field Name</th>

              <th class="featureTableHeader  " id="d155746e275">Field Type</th>

              <th class="featureTableHeader  " id="d155746e278">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d155746e272" data-title="Field Name"><span class="keyword parmname">assignedTo</span></td>

              <td class="entry" headers="d155746e275" data-title="Field Type">string</td>

              <td class="entry" headers="d155746e278" data-title="Description">The name of the user or queue the item is assigned to. </td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e272" data-title="Field Name"><span class="keyword parmname">assignedToType</span></td>

              <td class="entry" headers="d155746e275" data-title="Field Type">
                <span class="keyword parmname">AssignToLookupValueType</span> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d155746e278" data-title="Description">Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">User</samp></li>

                  <li class="li"><samp class="codeph nolang">Queue</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e272" data-title="Field Name"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d155746e275" data-title="Field Type">string</td>

              <td class="entry" headers="d155746e278" data-title="Description">Advanced filter conditions that were specified for the rule.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e272" data-title="Field Name"><span class="keyword parmname">criteriaItems</span></td>

              <td class="entry" headers="d155746e275" data-title="Field Type"><span class="keyword parmname"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a>[]</span></td>

              <td class="entry" headers="d155746e278" data-title="Description">The items in the list that define the assignment criteria.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e272" data-title="Field Name"><span class="keyword parmname">formula</span></td>

              <td class="entry" headers="d155746e275" data-title="Field Type">string</td>

              <td class="entry" headers="d155746e278" data-title="Description">The validation formula.
                <p class="p">Specify either <span class="keyword parmname">formula</span> or
                  <span class="keyword parmname">criteriaItems</span>, but not both fields.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e272" data-title="Field Name"><span class="keyword parmname">notifyCcRecipients</span></td>

              <td class="entry" headers="d155746e275" data-title="Field Type">boolean</td>

              <td class="entry" headers="d155746e278" data-title="Description">Specifies whether email addresses included on the Cc line of an
                incoming Email-to-Case or Web-to-Lead message are included on the Cc
                line of the auto-response to that message (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 32.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e272" data-title="Field Name"><span class="keyword parmname">overrideExistingTeams</span></td>

              <td class="entry" headers="d155746e275" data-title="Field Type">boolean</td>

              <td class="entry" headers="d155746e278" data-title="Description">Specifies whether the case team resets when the assignment is
                done <samp class="codeph java">true</samp>) or if the current team
                is added to the case instead of replacing the previous team (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e272" data-title="Field Name"><span class="keyword parmname">team</span></td>

              <td class="entry" headers="d155746e275" data-title="Field Type">string[]</td>

              <td class="entry" headers="d155746e278" data-title="Description">The name of the case team. It can occur 0 or more times. </td>

            </tr>

            <tr>
              <td class="entry" headers="d155746e272" data-title="Field Name"><span class="keyword parmname">template</span></td>

              <td class="entry" headers="d155746e275" data-title="Field Type">string</td>

              <td class="entry" headers="d155746e278" data-title="Description">Specifies the template to use for the email that is automatically
                sent to the designated recipient. <p class="p">Lightning email templates
                  aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example file showing two assignment rules on the Case object:

<AssignmentRules xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <assignmentRule\>
        <fullName\>samplerule</fullName\>
        <active\>false</active\>
        <ruleEntry\>
            <assignedTo\>testUser@org.com</assignedTo\>
            <assignedToType\>User</assignedToType\>
            <criteriaItems\>
                <field\>Case.IsEscalated</field\>
                <operation\>equals</operation\>
                <value\>True</value\>
            </criteriaItems\>
            <template\>emailtemplate</template\>
        </ruleEntry\>
    </assignmentRule\>
    <assignmentRule\>
        <fullName\>Another samplerule</fullName\>
        <active\>false</active\>
        <ruleEntry\>
            <assignedTo\>otherUser@org.com</assignedTo\>
            <assignedToType\>User</assignedToType\>
            <criteriaItems\>
                <field\>Case.IsEscalated</field\>
                <operation\>equals</operation\>
                <value\>False</value\>
            </criteriaItems\>
            <template\>emailtemplate</template\>
        </ruleEntry\>
    </assignmentRule\>
</AssignmentRules\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=94607315a9022b99b6c24ba4fdf76814dfa7edb573143ace38dd52065c021a61 url=/legacydeveloper/current/en-us/api_meta/meta_associationenginesettings.md -->

# AssociationEngineSettings

Represents the record association builder 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details.

## File Suffix and Directory Location

AssociationEngineSettings values are stored in the AssociationEngine.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

AssociationEngineSettings components are available in API version 52.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| enableAssociationEngine | 
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 an AssociationEngineSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<AssociationEngineSettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <enableAssociationEngine>true</enableAssociationEngine>
</AssociationEngineSettings>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types>
    <members>AssociationEngine</members>
    <name>Settings</name>
  </types>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=260a8b37777ce4b6434d95fcef9f9c4b07460c744efccbee7d966164d8016f29 url=/legacydeveloper/current/en-us/api_meta/meta_asyncresult.md -->

# AsyncResult

Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.

## API Version 31.0 and Later

In API version 31.0, the process of retrieving metadata has been simplified and retrieval properties have been moved to [RetrieveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm "The retrieve() call returns an array of RetrieveResult objects."). Also, the asynchronous [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm#meta_create "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead."), [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm#meta_update "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead."), and [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm#meta_delete "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead.") calls have been removed. Therefore, only the id field in AsyncResult is used. The id field is the ID of a deployment or retrieval.

These asynchronous calls can return AsyncResult.

- [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.")
- [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.")

AsyncResult has this field that’s in use.

### id

- **Type**: ID
- **Description**: Required. The ID of the component that's being deployed or retrieved.

All fields in AsyncResult other than id are deprecated as of API version 31.0. These fields exist but are no longer in use.

- done
- message
- state
- statusCode

## API Versions 29.0 and 30.0

In API version 29.0, Salesforce moved several properties from the AsyncResult object to the [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") object and added several new ones, to improve the process for getting information about deployments. For more information about these changes, see [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.").

In API versions 29.0 and 30.0, AsyncResult is returned by the same asynchronous calls as in API version 28.0 and earlier, but it has different fields.

### done

- **Type**: boolean
- **Description**: Required. Indicates whether the call has been completed (true) or not (false).

### id

- **Type**: ID
- **Description**: Required. The ID of the component that's being created, updated, deleted, deployed, or retrieved.

### message

- **Type**: string
- **Description**: The message that corresponds to the returned [statusCode](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field, if any.

### state

- **Type**: AsyncRequestState ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: Required. The AsyncRequestState object has one of four possible values.
    - Queued: This call hasn’t started. It’s waiting in a queue.
    - InProgress: This call has started but hasn’t been completed.
    - Completed: This call has been completed.
    - Error: An error occurred. See the [statusCode](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") for more information.

### statusCode

- **Type**: StatusCode ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: If an error occurred during the [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead."), [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead."), or [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead.") call, a status code is returned, and the message that corresponds to the status code is returned in the [message](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field. For a description of each StatusCode value, see [StatusCode](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_concepts_core_data_objects.htm#statuscode_topic) in the [SOAP API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/ "HTML (New Window)").

## API Version 28.0 and Earlier

In API version 28.0 and earlier, these asynchronous calls can return AsyncResult.

- [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.")
- [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead.")
- [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.")
- [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.")
- [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead.")

Use the [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") call against each object to discover when the call is completed for that object. Salesforce updates each AsyncResult object as the call is completed or when errors occur.

Similarly, the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") and [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") calls use AsyncResult, though you must subsequently use [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy().") or [checkRetrieveStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkretrievestatus.htm "Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.") respectively to get more status information for the deployment or retrieval.

AsyncResult has the following fields.

### checkOnly

- **Type**: boolean
- **Description**: This field is available in API version 16.0 and later and is relevant only for the Indicates whether this deployment is used to check the validity of the deployed files without changing the organization (true) or not (false). A check-only deployment doesn’t deploy any components or change the organization in any way. [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### done

- **Type**: boolean
- **Description**: Required. Indicates whether the call has been completed (true) or not (false).

### id

- **Type**: ID
- **Description**: Required. The ID of the component that's being created, updated, deleted, deployed, or retrieved.

### message

- **Type**: string
- **Description**: The message that corresponds to the returned [statusCode](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field, if any.

### numberComponentErrors

- **Type**: int
- **Description**: This field is available in API version 16.0 and later and is relevant only for the The number of components that generated errors during this deployment. [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### numberComponentsDeployed

- **Type**: int
- **Description**: This field is available in API version 16.0 and later and is relevant only for the The number of components that have been deployed for this deployment. This field in conjunction with the [numberComponentsTotal](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field gives you an indication of the progress of the deployment. [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### numberComponentsTotal

- **Type**: int
- **Description**: This field is available in API version 16.0 and later and is relevant only for the The total number of components in the deployment. This field in conjunction with the [numberComponentsDeployed](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field gives you an indication of the progress of the deployment. [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### numberTestErrors

- **Type**: int
- **Description**: This field is available in API version 16.0 and later and is relevant only for the The number of Apex tests that generated errors during this deployment. [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### numberTestsCompleted

- **Type**: int
- **Description**: This field is available in API version 16.0 and later and is relevant only for the The number of Apex tests that have been completed for this deployment. This field in conjunction with the [numberTestsTotal](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field gives you an indication of the progress of tests for the deployment. [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### numberTestsTotal

- **Type**: int
- **Description**: This field is available in API version 16.0 and later and is relevant only for the The total number of Apex tests in the deployment. This field in conjunction with the [numberTestsCompleted](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field gives you an indication of the progress of tests for the deployment. The value in this field isn’t accurate until the deployment has started running tests for the components that are being deployed. [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### secondsToWait

- **Type**: int
- **Description**: This field is no longer supported for API version 13.0 and later and is provided only for backward compatibility. The field was removed in API version 17.0. Indicates the number of seconds before the call is likely to be completed. This number is an estimate only. A reasonable approach is to wait one second before calling to see if the operation is complete. Double your wait time for each successive iteration of calls until the operation is complete.

### state

- **Type**: AsyncRequestState ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: Required. The AsyncRequestState object has one of four possible values.
    - Queued: This call hasn’t started. It’s waiting in a queue.
    - InProgress: This call has started but hasn’t been completed.
    - Completed: This call has been completed.
    - Error: An error occurred. See the [statusCode](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") for more information.

### stateDetail

- **Type**: string
- **Description**: Indicates which component is being deployed or which Apex test class is running. This field is available in API version 16.0 and later and is relevant only for the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### stateDetailLastModifiedDate

- **Type**: dateTime
- **Description**: The date and time when the This field is available in API version 16.0 and later and is relevant only for the [stateDetail](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field was last modified. [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### statusCode

- **Type**: StatusCode ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: If an error occurred during the [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead."), [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead."), [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead."), or [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call, a status code is returned, and the message that corresponds to the status code is returned in the [message](#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field. For a description of each StatusCode value, see [StatusCode](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_concepts_core_data_objects.htm#statuscode_topic) in the [SOAP API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/ "HTML (New Window)").

<!-- document id=f07b88a9d98280d7c5eb575fb4f0e6afef85eeca3bcae596c5f2a0f300aa88ca url=/legacydeveloper/current/en-us/api_meta/meta_audience.md -->

# Audience

Represents the audience in an Experience Builder site. An audience consists of different types of criteria, where the audience can be assigned and used for targeting in a site. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

Audience components have the suffix .audience and are stored in the audience folder.

## Version

Audience components are available in API version 44.0 and later.

## Special Access Rules

Access to the Audience type requires the AudienceMetadata permission. This permission is on by default for orgs that have Networks enabled.

Access to permission criteria for the Audience type requires the AudiencePermissionCriteria permission. This permission is available in API version 45.0 and later and is on by default for orgs that have Networks enabled.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d157384e96">Field Name</th>

              <th class="featureTableHeader  " id="d157384e99">Field Type</th>

              <th class="featureTableHeader  " id="d157384e102">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d157384e96" data-title="Field Name"><span class="keyword parmname">audienceName</span></td>

              <td class="entry" headers="d157384e99" data-title="Field Type">string</td>

              <td class="entry" headers="d157384e102" data-title="Description">Required. The name of the audience.</td>

            </tr>

            <tr>
              <td class="entry" headers="d157384e96" data-title="Field Name"><span class="keyword parmname">container</span></td>

              <td class="entry" headers="d157384e99" data-title="Field Type">string</td>

              <td class="entry" headers="d157384e102" data-title="Description">Required. The name of the site or org that contains the audience.</td>

            </tr>

            <tr>
              <td class="entry" headers="d157384e96" data-title="Field Name"><span class="keyword parmname">criteria</span></td>

              <td class="entry" headers="d157384e99" data-title="Field Type"><a class="xref" href="#AudienceCriteria">AudienceCriteria</a></td>

              <td class="entry" headers="d157384e102" data-title="Description">Required. Criteria in an audience. This field is available in API version 47.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d157384e96" data-title="Field Name"><span class="keyword parmname">criterion</span></td>

              <td class="entry" headers="d157384e99" data-title="Field Type">
                <a class="xref" href="#AudienceCriterion">AudienceCriterion</a>[]
              </td>

              <td class="entry" headers="d157384e102" data-title="Description">Removed. List of criteria in an audience.
                <p class="p"> This field is available in API version 44.0–46.0. In API version 47.0 and later,
                  use <span class="keyword parmname">criteria</span> instead.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d157384e96" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d157384e99" data-title="Field Type">string</td>

              <td class="entry" headers="d157384e102" data-title="Description">The description of the audience.</td>

            </tr>

            <tr>
              <td class="entry" headers="d157384e96" data-title="Field Name"><span class="keyword parmname">formula</span></td>

              <td class="entry" headers="d157384e99" data-title="Field Type">string</td>

              <td class="entry" headers="d157384e102" data-title="Description">Formula used to determine the audience. This field is available in API version
                45.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d157384e96" data-title="Field Name"><span class="keyword parmname">formulaFilterType</span></td>

              <td class="entry" headers="d157384e99" data-title="Field Type">FormulaFilterType​(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d157384e102" data-title="Description">Indicates the audience’s formula type. Valid values are <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">AllCriteriaMatch</samp></li>

                  <li class="li"><samp class="codeph nolang">AnyCriterionMatches</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">CustomLogicMatches</samp> (available in API
                    version 45.0 and later)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d157384e96" data-title="Field Name"><span class="keyword parmname">isDefaultAudience</span></td>

              <td class="entry" headers="d157384e99" data-title="Field Type">boolean</td>

              <td class="entry" headers="d157384e102" data-title="Description">Indicates whether the audience is the default audience (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field is available and required in API version 48.0. In API
                version 49.0 and later, this field is optional.<p class="p">The default audience file name is
                  of format <samp class="codeph nolang">Default_<var class="keyword varname">Network
                      Name</var>.audience</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d157384e96" data-title="Field Name"><span class="keyword parmname">targets</span></td>

              <td class="entry" headers="d157384e99" data-title="Field Type"><a class="xref" href="#PersonalizationTargetInfos">PersonalizationTarget​Infos</a></td>

              <td class="entry" headers="d157384e102" data-title="Description">Targets for the audience. This field is available in API version 47.0 and
                later.</td>

            </tr>

          </tbody>

        </table>

## AudienceCriteria

Represents criteria for an audience. This subtype is available in API version 47.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| criterion | [AudienceCriterion](#AudienceCriterion)\[\] | List of criteria for an audience. An audience can have up to 100 criteria. |

## AudienceCriterion

Represents a criterion for an audience.

<table class="featureTable sort_table" summary="">



            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d157384e347">Field Name</th>

                <th class="featureTableHeader  " id="d157384e350">Field Type</th>

                <th class="featureTableHeader  " id="d157384e353">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d157384e347" data-title="Field Name"><span class="keyword parmname">criteriaNumber</span></td>

                <td class="entry" headers="d157384e350" data-title="Field Type">int</td>

                <td class="entry" headers="d157384e353" data-title="Description">The number associated with the criterion in a formula, for example (1 AND 2) OR
                  3. This field is available in API version 45.0 and later.</td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e347" data-title="Field Name"><span class="keyword parmname">criterionValue</span></td>

                <td class="entry" headers="d157384e350" data-title="Field Type"><a class="xref" href="#AudienceCriteriaValue">AudienceCriteriaValue</a></td>

                <td class="entry" headers="d157384e353" data-title="Description">The value of the criterion.</td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e347" data-title="Field Name"><span class="keyword parmname">operator</span></td>

                <td class="entry" headers="d157384e350" data-title="Field Type">AudienceCriterionOperator(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                  string)</td>

                <td class="entry" headers="d157384e353" data-title="Description">The operator associated with this criterion. Valid values are: <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">Equal</samp></li>

                    <li class="li"><samp class="codeph nolang">NotEqual</samp></li>

                    <li class="li"><samp class="codeph nolang">GreaterThan</samp></li>

                    <li class="li"><samp class="codeph nolang">GreaterThanOrEqual</samp></li>

                    <li class="li"><samp class="codeph nolang">LessThan</samp></li>

                    <li class="li"><samp class="codeph nolang">LessThanOrEqual</samp></li>

                    <li class="li"><samp class="codeph nolang">Contains</samp></li>

                    <li class="li"><samp class="codeph nolang">StartsWith</samp></li>

                    <li class="li">
                      <samp class="codeph nolang">Includes</samp> (available in API version 45.0
                      and later)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">NotIncludes</samp> (available in API version
                      45.0 and later)
                    </li>

                  </ul>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e347" data-title="Field Name"><span class="keyword parmname">type</span></td>

                <td class="entry" headers="d157384e350" data-title="Field Type">AudienceCriterion​Type(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

                <td class="entry" headers="d157384e353" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">GeoLocation</samp></li>

                    <li class="li"><samp class="codeph nolang">Domain</samp></li>

                    <li class="li"><samp class="codeph nolang">Profile</samp></li>

                    <li class="li"><samp class="codeph nolang">FieldBased</samp></li>

                    <li class="li">
                      <samp class="codeph nolang">Permission</samp> (available in API version 45.0
                      and later)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Default</samp> (available in API version 47.0
                      and later)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Audience</samp> (available in API version 53.0
                      and later)
                    </li>

                  </ul>
                  For a list of AudienceCriteriaValue fields that you can use with each
                  AudienceCriterion <span class="keyword parmname">type</span> field value, see <a class="xref" href="#AudCritTypeAudCritValueTable">this table</a>.</td>

              </tr>

            </tbody>

          </table>

## AudienceCriteriaValue

Represents the value of a criterion in an audience. For a list of AudienceCriteriaValue fields that you can use with each AudienceCriterion type field value, see [this table](#AudCritTypeAudCritValueTable).

| Field Name | Field Type | Description |
| --- | --- | --- |
| audienceDeveloperName | string | Developer name of the audience. This field is available in API version 53.0 and later. You can use this field only when the value of the AudienceCriterion type field is Audience. |
| city | string | City of a user. You can use this field only when the value of the AudienceCriterion type field is GeoLocation. |
| country | string | Country of a user. You can use this field only when the value of the AudienceCriterion type field is GeoLocation. |
| domain | string | Domain of a user. You can use this field only when the value of the AudienceCriterion type field is Domain. |
| entityField | string | Field of an object. You can use this field only when the value of the AudienceCriterion type field is FieldBased. |
| entityType | string | Type of object. You can use this field only when the value of the AudienceCriterion type field is FieldBased. |
| fieldValue | string | Value of a field. You can use this field only when the value of the AudienceCriterion type field is FieldBased. |
| isEnabled | string | Indicates whether the permission is enabled (true) or not (false) for a user. This field is available in API version 45.0 and later. You can use this field used only when the value of the AudienceCriterion type field is Permission. |
| permissionName | string | Valid API name of a standard user or custom permission. This field is available in API version 45.0 and later. You can use this field only when the value of the AudienceCriterion type field is Permission. |
| permissionType | string | Type of permission. Valid values are Standard and Custom. This field is available in API version 45.0 and later. You can use this field only when the value of the AudienceCriterion type field is Permission. |
| profile | string | Profile of a user. You can use this field only when the value of the AudienceCriterion type field is Profile. |
| subdivision | string | Subdivision of a user. You can use this field only when the value of the AudienceCriterion type field is GeoLocation. |

This table summarizes which AudienceCriteriaValue fields you can use with the different AudienceCriterion type field values.

<table class="featureTable sort_table" summary="">


            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d157384e812">AudienceCriterion Type</th>

                <th class="featureTableHeader  " id="d157384e815">AudienceCriteriaValue Fields</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d157384e812" data-title="AudienceCriterion Type"><samp class="codeph nolang">GeoLocation</samp></td>

                <td class="entry" headers="d157384e815" data-title="AudienceCriteriaValue Fields">
                  <span class="keyword parmname">city</span>
                  <p class="p"><span class="keyword parmname">country</span></p>
                  <p class="p"><span class="keyword parmname">subdivision</span></p>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e812" data-title="AudienceCriterion Type"><samp class="codeph nolang">Domain</samp></td>

                <td class="entry" headers="d157384e815" data-title="AudienceCriteriaValue Fields"><span class="keyword parmname">domain</span></td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e812" data-title="AudienceCriterion Type"><samp class="codeph nolang">Profile</samp></td>

                <td class="entry" headers="d157384e815" data-title="AudienceCriteriaValue Fields"><span class="keyword parmname">profile</span></td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e812" data-title="AudienceCriterion Type"><samp class="codeph nolang">FieldBased</samp></td>

                <td class="entry" headers="d157384e815" data-title="AudienceCriteriaValue Fields">
                  <span class="keyword parmname">entityField</span>
                  <p class="p"><span class="keyword parmname">entityType</span></p>
                  <p class="p"><span class="keyword parmname">fieldValue</span></p>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e812" data-title="AudienceCriterion Type"><samp class="codeph nolang">Permission</samp></td>

                <td class="entry" headers="d157384e815" data-title="AudienceCriteriaValue Fields">
                  <span class="keyword parmname">isEnabled</span>
                  <p class="p"><span class="keyword parmname">permissionName</span></p>
                  <p class="p"><span class="keyword parmname">permissionType</span></p>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e812" data-title="AudienceCriterion Type"><samp class="codeph nolang">Audience</samp></td>

                <td class="entry" headers="d157384e815" data-title="AudienceCriteriaValue Fields"><span class="keyword parmname">audienceDeveloperName</span></td>

              </tr>

            </tbody>

          </table>

## PersonalizationTargetInfos

Represents targets for an audience. This subtype is available in API version 47.0 and later.

When deploying an audience, you must include [ExperienceBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencebundle.htm "Represents a text-based code structure of the settings and site components, such as pages, branding sets, and themes that make up an Experience Builder site. Developers can quickly update and deploy Experience Builder sites programmatically using their preferred development tools. This type extends the Metadata metadata type and inherits its fullName field.") in your package to support experience variation targets.

| Field Name | Field Type | Description |
| --- | --- | --- |
| target | [PersonalizationTarget​Info](#PersonalizationTargetInfo)\[\] | List of targets for an audience. |

## PersonalizationTargetInfo

Represents a target for an audience. This subtype is available in API version 47.0 and later.

<table class="featureTable sort_table" summary="">



            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d157384e998">Field Name</th>

                <th class="featureTableHeader  " id="d157384e1001">Field Type</th>

                <th class="featureTableHeader  " id="d157384e1004">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d157384e998" data-title="Field Name"><span class="keyword parmname">groupName</span></td>

                <td class="entry" headers="d157384e1001" data-title="Field Type">string</td>

                <td class="entry" headers="d157384e1004" data-title="Description">Required. Group name of the target. Groups bundle related target and audience
                  pairs. You can have up to 2,000 groups and 500 targets per group.<p class="p">To determine the
                    target group name, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.communities_dev.meta/communities_dev/communities_dev_personalization_names.htm" target="_blank" title="HTML (New Window)">https://developer.salesforce.com/docs/atlas.en-us.communities_dev.meta/communities_dev/communities_dev_personalization_names.htm</a> in the <cite class="cite">Experience
                      Cloud Developer Guide</cite>.</p>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e998" data-title="Field Name"><span class="keyword parmname">priority</span></td>

                <td class="entry" headers="d157384e1001" data-title="Field Type">int</td>

                <td class="entry" headers="d157384e1004" data-title="Description">Priority of the target. Within a group, priority determines which target is
                  returned when the user matches more than one audience.</td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e998" data-title="Field Name"><span class="keyword parmname">targetType</span></td>

                <td class="entry" headers="d157384e1001" data-title="Field Type">string</td>

                <td class="entry" headers="d157384e1004" data-title="Description">Required. Type of target, indicating the nature of the data being targeted.
                  Supported values include:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">ExperienceVariation</samp> (API version 47.0 and
                      later)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">NavigationLinkSet</samp> (API version 49.0 and
                      later)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Report</samp> (API version 49.0 and later)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Dashboard</samp> (API version 49.0 and
                      later)
                    </li>

                  </ul>
                  <p class="p">You can have up to 2,500 <samp class="codeph nolang">ExperienceVariation</samp> targets and 25,000 record targets.</p>
                  <p class="p">For more
                    information on the <samp class="codeph nolang">ExperienceVariation</samp> target
                    type, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencebundle.htm" title="Represents a text-based code structure of the settings and site components, such as pages, branding sets, and themes that make up an Experience Builder site. Developers can quickly update and deploy Experience Builder sites programmatically using their preferred development tools. This type extends the Metadata metadata type and inherits its fullName field.">ExperienceBundle</a>.</p>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d157384e998" data-title="Field Name"><span class="keyword parmname">targetValue</span></td>

                <td class="entry" headers="d157384e1001" data-title="Field Type">string</td>

                <td class="entry" headers="d157384e1004" data-title="Description">Required. Value of the target, which is the developer name of the experience
                  variation, such as <samp class="codeph nolang">ContactSupport_ContactSupportFor​California_Page</samp> for a page
                  variation.<p class="p">To determine the target developer name, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.communities_dev.meta/communities_dev/communities_dev_personalization_names.htm" target="_blank" title="HTML (New Window)">https://developer.salesforce.com/docs/atlas.en-us.communities_dev.meta/communities_dev/communities_dev_personalization_names.htm</a>
                    in the <cite class="cite">Experience Cloud Developer Guide</cite>.</p>
                </td>

              </tr>

            </tbody>

          </table>

## Declarative Metadata Sample Definition

The following is an example of an Audience component.

<?xml version="1.0" encoding="UTF-8"?>
<Audience xmlns="http://soap.sforce.com/2006/04/metadata">
    <audienceName\>Audience Metadata</audienceName\>
    <container\>Customer</container\>
    <criteria\>
        <criterion\>
            <criteriaNumber\>1</criteriaNumber\>
            <criterionValue\>
                <country\>United States</country\>
                <subdivision\>Nevada</subdivision\>
            </criterionValue\>
            <operator\>Equal</operator\>
            <type\>GeoLocation</type\>
        </criterion\>
        <criterion\>
            <criteriaNumber\>2</criteriaNumber\>
            <criterionValue\>
                <profile\>customer community user</profile\>
            </criterionValue\>
            <operator\>Equal</operator\>
            <type\>Profile</type\>
        </criterion\>
        <criterion\>
            <criteriaNumber\>3</criteriaNumber\>
            <criterionValue\>
                <domain\>sampledomain.example.com</domain\>
            </criterionValue\>
            <operator\>Equal</operator\>
            <type\>Domain</type\>
        </criterion\>
        <criterion\>
            <criteriaNumber\>4</criteriaNumber\>
            <criterionValue\>
                <entityField\>Manager.Profile.CreatedBy.Contact.MailingCountry</entityField\>
                <entityType\>User</entityType\>
                <fieldValue\>USA</fieldValue\>
            </criterionValue\>
            <operator\>StartsWith</operator\>
            <type\>FieldBased</type\>
        </criterion\>
        <criterion\>
            <criteriaNumber\>5</criteriaNumber\>
            <criterionValue\>
                <entityField\>RecordTypeId</entityField\>
                <entityType\>CollaborationGroup</entityType\>
                <fieldValue\>CollaborationGroup.Group\_RT2</fieldValue\>
            </criterionValue\>
            <operator\>Equal</operator\>
            <type\>FieldBased</type\>
        </criterion\>
        <criterion\>
            <criteriaNumber\>6</criteriaNumber\>
            <criterionValue\>
                <isEnabled\>true</isEnabled\>
                <permissionName\>ManageUsers</permissionName\>
                <permissionType\>Standard</permissionType\>
            </criterionValue\>
            <operator\>Equal</operator\>
            <type\>Permission</type\>
        </criterion\>
        <criterion\>
            <criteriaNumber\>7</criteriaNumber\>
            <criterionValue\>
                <isEnabled\>false</isEnabled\>
                <permissionName\>NamespaceXYZ\_\_CustomPermABC</permissionName\>
                <permissionType\>Custom</permissionType\>
            </criterionValue\>
            <operator\>Equal</operator\>
            <type\>Permission</type\>
        </criterion\>
        <criterion\>
            <criteriaNumber\>8</criteriaNumber\>
            <criterionValue\>
                <audienceDeveloperName\>Audience1</audienceDeveloperName\>
            </criterionValue\>
            <operator\>Equal</operator\>
            <type\>Audience</type\>
        </criterion\>
    </criteria\>
    <formula\>1 AND (2 OR 3 OR 4 OR 5 OR 6 OR 7) AND 8</formula\>
    <formulaFilterType\>CustomLogicMatches</formulaFilterType\>
    <isDefaultAudience\>false</isDefaultAudience\>
    <targets\>
        <target\>
            <groupName\>c194d79c-5c6b-4c6a-8d14-0e7042564355$#$Branding</groupName\>
            <priority\>1</priority\>
            <targetType\>ExperienceVariation</targetType\>
            <targetValue\>Customer\_Service\_testBrandingSet\_Branding</targetValue\>
        </target\>
    </targets\>
</Audience\>

## Usage

You can’t use Metadata API to delete an audience.

In API version 47.0 and later, you can’t create an audience without criteria.

The list of targets provided in the input for an audience is considered the state of target assignments that you want. For example, see the following information for deleting, creating, and updating targets.

If you don’t have a default audience, updating targets can result in the UI erroneously showing a target assigned to the default audience. The target assignment data in the API is correct. To work around the UI issue, temporarily assign another target to the default audience and then delete it.

Personalization using audience targeting varies what the user can see in the browser but doesn’t secure data in any way. To prevent users accessing sensitive data, use standard Salesforce security features, such as sharing rules and permission sets.

Delete targets

To delete a single target from an audience, deploy the entire list of targets for the audience minus the one that you want to delete.

To delete all the targets from an audience, deploy the audience with empty targets tags. For example:

<?xml version="1.0" encoding="UTF-8"?>
<Audience
    xmlns="http://soap.sforce.com/2006/04/metadata">
    <audienceName\>testAudience</audienceName\>
    <container\>testContainer</container\>
    <criteria\>
        <criterion\>
            <criteriaNumber\>1</criteriaNumber\>
            <criterionValue\>
                <country\>United States</country\>
                <subdivision\>Nevada</subdivision\>
            </criterionValue\>
            <operator\>Equal</operator\>
            <type\>GeoLocation</type\>
        </criterion\>
    </criteria\>
    <formulaFilterType\>AllCriteriaMatch</formulaFilterType\>
    <isDefaultAudience\>false</isDefaultAudience\>
    <targets\>
    </targets\>
</Audience\>

Update an audience without updating targets

To update an audience without updating targets, deploy the audience without targets tags. For example:

<?xml version="1.0" encoding="UTF-8"?>
<Audience
    xmlns="http://soap.sforce.com/2006/04/metadata">
    <audienceName\>testAudience</audienceName\>
    <container\>testContainer</container\>
    <criteria\>
        <criterion\>
            <criteriaNumber\>1</criteriaNumber\>
            <criterionValue\>
                <country\>United States</country\>
                <subdivision\>Nevada</subdivision\>
            </criterionValue\>
            <operator\>Equal</operator\>
            <type\>GeoLocation</type\>
        </criterion\>
    </criteria\>
    <formulaFilterType\>AllCriteriaMatch</formulaFilterType\>
    <isDefaultAudience\>false</isDefaultAudience\>
</Audience\>

Create targets

To create a target, deploy the entire list of targets for the audience plus the one that you want to create.

Update the priority of a target

To change the priority of a target within an audience, deploy the entire list of targets for the audience with the new priority values for the targets.

To change the priority of a target that affects priority in another audience, deploy both audiences with their entire list of targets with the new priority values for the targets.

Update the target assignment for an audience

To reassign a target to a new audience, deploy both audiences with their entire list of targets. Deploy one list with the target removed, and the other list with the target added.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=3dc7ff61f576bcacbf6942609bd3d2b902a2e7ccaacadaab1a268d530654e445 url=/legacydeveloper/current/en-us/api_meta/meta_auradefinitionbundle.md -->

# AuraDefinitionBundle

Represents an Aura definition bundle. A bundle contains an Aura definition, such as an Aura component, and its related resources, such as a JavaScript controller. The definition can be a component, application, event, interface, or a tokens collection.

## File Suffix and Directory Location

An AuraDefinitionBundle component is a folder that contains definition files. Unlike most other metadata components, an AuraDefinitionBundle component isn’t a single file, it’s a collection of files. Each file represents a resource in a bundle, such as markup, applications, code files (including controllers and helpers), events, documentation, and interfaces. For example, this directory structure shows the hierarchy of the folders and files for two bundles: bundle1 and bundle2.

aura
    bundle1
        bundle1.cmp
        bundle1Controller.js
    bundle2
        bundle2.app
        bundle2Controller.js
        bundle2.auradoc

Aura definition bundles must be under a top-level folder named aura. Each bundle must have its own subfolder under the aura folder. The name of each definition file must start with the bundle name.

A bundle doesn’t have a suffix. Definition files can have one of these suffixes:

| Suffix | Component Type |
| --- | --- |
| .app | Application |
| .cmp | Component |
| .design | Design |
| .evt | Event |
| .intf | Interface |
| .js | Controller, Helper, or Renderer |
| .svg | SVG image |
| .css | Style |
| .auradoc | Documentation |
| .tokens | Tokens collection |

Each bundle can have only one file each with a suffix of .app, .cmp, .design, .evt, .intf, or .tokens.

## Version

AuraDefinitionBundle components are available in API version 32.0 and later.

Design and SVG components are available in API version 33.0 and later.

In API version 45.0 and later, there are two types of Lightning component: Aura components and Lightning web components. This metadata type describes an Aura component.

## Special Access Rules

Definitions can be created only in organizations with defined namespaces.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d160819e261">Field Name</th>

              <th class="featureTableHeader  " id="d160819e264">Field Type</th>

              <th class="featureTableHeader  " id="d160819e267">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="ph" id="apiVersion"><a name="apiVersion"><!-- --></a><span class="keyword parmname">apiVersion</span></span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">double</td>

              <td class="entry" headers="d160819e267" data-title="Description">
                <span class="ph" id="apiVersionDesc"><a name="apiVersionDesc"><!-- --></a>The API version for this definition bundle. When you
                  create an Aura bundle, you can specify the API version to save it with.</span>
                Available in API version 35.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">auraDefinitions</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">AuraDefinitions</td>

              <td class="entry" headers="d160819e267" data-title="Description">Reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">controllerContent</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">The content of a JavaScript client-side controller.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="ph" id="description"><a name="description"><!-- --></a><span class="keyword parmname">description</span></span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">string</td>

              <td class="entry" headers="d160819e267" data-title="Description">
                <span class="ph" id="descDesc"><a name="descDesc"><!-- --></a>The specification of the Aura bundle.</span> Available in API
                version 35.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">designContent</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">The content of a design definition. Only valid inside a component
                bundle.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">documentationContent</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">The content of a documentation definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">helperContent</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">The content of a JavaScript helper.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="ph" id="markup"><a name="markup"><!-- --></a><span class="keyword parmname">markup</span></span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">The content of the markup for a definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">modelContent</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">Deprecated. Do not use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="ph" id="packageVersions"><a name="packageVersions"><!-- --></a><span class="keyword parmname">packageVersions</span></span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_classes.htm#PackageVersion">PackageVersion</a>[]
              </td>

              <td class="entry" headers="d160819e267" data-title="Description">
                <span class="ph" id="packageVersionDesc"><a name="packageVersionDesc"><!-- --></a>The list of installed managed package versions that
                  this Aura definition bundle references.</span> Available in API version 35.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">rendererContent</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">The content of a JavaScript client-side renderer.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">styleContent</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">The CSS for the definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">SVGContent</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">The SVG image for the definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="keyword parmname">testsuiteContent</span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d160819e267" data-title="Description">Reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d160819e261" data-title="Field Name"><span class="ph" id="type"><a name="type"><!-- --></a><span class="keyword parmname">type</span></span></td>

              <td class="entry" headers="d160819e264" data-title="Field Type">AuraBundleType (enumeration of type string)</td>

              <td class="entry" headers="d160819e267" data-title="Description">The definition type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Application</samp></li>

                  <li class="li"><samp class="codeph nolang">Component</samp></li>

                  <li class="li"><samp class="codeph nolang">Event</samp></li>

                  <li class="li"><samp class="codeph nolang">Interface</samp></li>

                  <li class="li"><samp class="codeph nolang">Tokens</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This example shows the directory structure of an AuraDefinitionBundle component.

aura
    sampleCmp
        sampleCmp.cmp
        sampleCmpController.js

The following samples show the contents of the metadata definition files that correspond to the sample aura directory.

Content of sampleCmp.cmp:

<aura:component\>
    <aura:attribute name="val1" type="String" default="Value"/>
    <aura:attribute name="val2" type="String" />
    <aura:handler name="init" value="{!this}" action="{!c.myAction}"/>
        <ui:outputText value='Hello world!'/>
        <ui:outputText value='{!v.val1}'/>
        <ui:outputText value='{!v.val2}'/>
</aura:component\>

Content of sampleCmpController.js:

({  
  myAction : function(component) {
    component.set('v.val1','Value1');
    component.set('v.val2','Value2');
  }
})

This package.xml references the definitions of all Lightning components that are present in the sampleCmp bundle.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>sampleCmp</members\>
        <name\>AuraDefinitionBundle</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=5b64aee65989e18a0f40bb09757ebbef971026f4102e7d348e84c62e71459334 url=/legacydeveloper/current/en-us/api_meta/meta_authproviders.md -->

# AuthProvider

Represents an authentication provider (auth provider). An auth provider lets users log in to Salesforce from an external service provider such as Facebook, Google, or GitHub. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

Authentication providers are stored in the authproviders directory. The file name matches the URL suffix, and the extension is .authprovider. For example, an auth provider with URL suffix FacebookProvider is stored in authproviders/FacebookProvider.authprovider.

## Version

Authentication providers are available in API version 27.0 and later.

## Special Access Rules

Only users with the Customize Application and Manage AuthProviders permissions can access this object.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d162582e100">Field Name</th>

              <th class="featureTableHeader  " id="d162582e103">Field Type</th>

              <th class="featureTableHeader  " id="d162582e106">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">appleTeam</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">Required when using Apple as a third-party authentication
                provider. A 10-character team ID, obtained from an Apple developer
                account. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">authorizeUrl</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">Required when creating an OpenID Connect authentication provider.
                <span class="ph" id="authorizeUrl_desc"><a name="authorizeUrl_desc"><!-- --></a>The OAuth authorization endpoint
                  URL.</span> Available in API version 29.0 and later. <p class="p">In API
                  version 33.0 and later, for Salesforce-managed auth providers,
                  leave the field blank to let Salesforce supply and manage the
                  value. For details, see “Usage.”</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">consumerKey</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">The app’s key that is registered at the third-party
                (external) authentication provider. <p class="p">In API version 33.0 and
                  later, for Salesforce-managed auth providers, leave the field
                  blank to let Salesforce supply and manage the value. For
                  details, see “Usage.”</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">consumerSecret</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">The consumer secret of the app that is registered at the
                third-party provider. After it’s set, you can’t change the value.
                When using <samp class="codeph nolang">create()</samp>, this field
                must be encrypted. To create an encrypted form of the consumer
                secret from plaintext: <ol class="ol enumList">
                  <li class="li">Create an authentication provider with the
                    <span class="keyword parmname">consumerSecret</span> plaintext
                    value.
                  </li>

                  <li class="li">Save the authentication provider.</li>

                  <li class="li">Create an outbound change set that includes the
                    authentication provider component.</li>

                </ol>
                The new change set .xml file has an entry in the form <samp class="codeph xml"><span class="tag">&lt;consumerSecret</span>&gt;++XYZ++<span class="tag">&lt;/consumerSecret</span>&gt;</samp> where
                ++XYZ++ is the encrypted secret. <p class="p">In API version 33.0 and later,
                  for Salesforce-managed auth providers, leave the field blank to
                  let Salesforce supply and manage the value. For details, see
                  Usage.</p>
                <p class="p">If a consumer secret is defined on an
                  authentication provider, the consumer secret is always exported
                  as a placeholder value, not as an encrypted secret.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">controlPlane</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">
                <samp class="codeph nolang">MuleSoftControlPlane</samp>
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)
              </td>

              <td class="entry" headers="d162582e106" data-title="Description">Required when using MuleSoft as a third-party authentication
                provider. Environment where the MuleSoft Anypoint Platform control
                plane is hosted. The control plane is the part of the Anypoint
                Platform architecture that includes Anypoint Exchange and determines
                the login URL. If you select User-Specified, you must enter the
                Consumer Key and Consumer Secret. Obtain the values from the
                MuleSoft connected app that you created to store the authentication
                details for your Salesforce org. Available in API version 57.0 and
                later. Valid values include:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">None</samp>—User-specified control plane. If you
                    select <samp class="codeph nolang">None</samp>, you must
                    enter the Consumer Key and Consumer Secret. Obtain the
                    values from the MuleSoft connected app that you created to
                    store the authentication details for your Salesforce
                    org.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">US</samp>—US control
                    plane
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EU</samp>—EU control
                    plane
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname" id="cmderecord_field"><a name="cmderecord_field"><!-- --></a>customMetadataTypeRecord</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">Required when creating a custom authentication provider plug-in. The API name of the
                custom authentication provider. Available in API version 36.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">defaultScopes</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">For OpenID Connect authentication providers, the scopes to send with the authorization
                request, if not specified when a flow starts.<span class="ph" id="defaultScopes_desc"><a name="defaultScopes_desc"><!-- --></a></span> Available in API version 29.0 and
                later. <p class="p">In API version 33.0 and later, for Salesforce-managed auth
                  providers, leave the field blank to let Salesforce supply and
                  manage the value. See “Usage.”</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">ecKey</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">Required when using Apple as a third-party authentication
                provider. A private key generated by Apple. Available in API version
                48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">errorUrl</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">A custom error URL for the authentication provider to use to
                report errors.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">executionUser</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">
                <p class="p">Required to specify a registration handler. The username of the
                  Salesforce admin or system user who runs the Apex handler or
                  flow. The execution user provides the context in which the
                  registration handler runs. For example, if the handler creates a
                  contact, the creation can be easily traced back to the
                  registration process. In production, use a system user. The user
                  must have the Manage Users permission. Available in API version
                  27.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">flow</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">A flow for the registration handler. The flow must be of the
                Identity User Registration Flow type.<p class="p">You can use either a flow or
                  an Apex class for the registration handler. To use an Apex class
                  instead, omit the <span class="keyword parmname">flow</span> field and specify an
                  Apex class in the <span class="keyword parmname">registrationHandler</span>
                  field.</p>
                <p class="p">Available in API version 64.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">flowDefaultAccount</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">For authentication providers that use a flow registration
                handler, the default account that new external users are assigned
                to. If you include this field, Salesforce automatically uses it for
                the <span class="keyword parmname">defaultAccountId</span> variable in the
                Authentication Provider User Registration standard flow.<p class="p">A default
                  account is required to use a flow registration handler to create
                  and update external users. You can specify a default account
                  here or in the flow itself. If you use both, the default account
                  that's configured in the flow takes precedent.</p>
                <p class="p">Available
                  in API version 64.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">flowDefaultProfile</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">For authentication providers that use a flow registration
                handler, the default profile that new users are assigned to. If you
                include this field, Salesforce automatically uses it for the
                <span class="keyword parmname">defaultProfileId</span> variable in the
                Authentication Provider User Registration standard flow.<p class="p">A default
                  profile is required to use a flow registration handler. You can
                  specify a default profile here or in the flow itself. If you use
                  both, the default profile that's configured in the flow takes
                  precedent.</p>
                <p class="p">Available in API version 64.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">friendlyName</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">Required. A user-friendly name for the authentication
                provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">iconUrl</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">The path to an icon to use as a button on the login page. Users click the button to
                log in with the associated authentication provider, such as Twitter
                or Facebook. Available in API version 32.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">idTokenIssuer</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">The source of the authentication token in <samp class="codeph html">https:</samp>
                URI format. This field is available when configuring an OpenID
                Connect or Microsoft authentication provider. If provided,
                Salesforce validates the returned <samp class="codeph nolang">id_token</samp> value. OpenID Connect requires returning an
                <samp class="codeph nolang">id_token</samp> value with the
                <samp class="codeph nolang">access_token</samp> value.
                Available in API version 30.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">includeOrgIdInIdentifier</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d162582e106" data-title="Description">Used to differentiate between users with the same user ID from two sources (such as
                two sandboxes). If enabled (<samp class="codeph nolang">true</samp>), Salesforce stores the org ID of the third-party
                identity in addition to the user ID. After you enable this setting,
                you can’t disable it. Applies only to a Salesforce-managed auth
                provider. Available in API version 32.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">isPkceEnabled</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d162582e106" data-title="Description">Indicates whether the OAuth 2.0 Proof Key for Code Exchange
                (PKCE) security extension is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). You can enable PKCE for these
                <span class="keyword parmname">providerType</span> values.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Custom</samp></li>

                  <li class="li"><samp class="codeph nolang">Facebook</samp></li>

                  <li class="li"><samp class="codeph nolang">Google</samp></li>

                  <li class="li"><samp class="codeph nolang">Microsoft</samp></li>

                  <li class="li"><samp class="codeph nolang">OpenIdConnect</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Salesforce</samp>.
                  </li>

                </ul>
                <p class="p">This field is available in API version 59.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">linkKickoffUrl</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">The URL for linking existing Salesforce users to a third-party
                account. This field is read-only. Available in API version 43.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">logoutUrl</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">
                <span class="ph" id="logoutUrl_desc"><a name="logoutUrl_desc"><!-- --></a>The destination for users after they log
                  out if they authenticated using single sign-on. The URL must be
                  fully qualified with an http or https prefix, such as
                  <span class="ph filepath">https://acme.my.salesforce.com</span>.</span>
                Available in API version 33.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">oauthKickoffUrl</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">The URL for obtaining OAuth access tokens for a third party. This
                field is read-only. Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">paramForwardAllowlist</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">AuthProvParamFwdAllowlist[]</td>

              <td class="entry" headers="d162582e106" data-title="Description">An allowlisted URL parameter that can be forwarded from the
                authentication provider's client configuration URLs to the
                authorization URL. Available in API version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname" id="plugin"><a name="plugin"><!-- --></a>plugin</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">An existing Apex class that extends the <samp class="codeph nolang">Auth.AuthProviderPluginClass</samp> abstract class. Available
                in API version 36.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">portal</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">This field is used only with portals, which are deprecated.
                Salesforce doesn’t support creating portals, but existing portals
                are supported. </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">providerType</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">
                <samp class="codeph nolang">AuthProviderType</samp>
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)
              </td>

              <td class="entry" headers="d162582e106" data-title="Description">Required. The third-party authentication provider to use. Valid
                values include:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Apple</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Bitbucket</samp>—Provides authentication for a
                    <samp class="codeph nolang">Bitbucket</samp> provider.
                    Enables you to connect to Bitbucket from a Lightning
                    Platform application. When logged in to Bitbucket, the app
                    can makes calls to Bitbucket APIs. The <samp class="codeph nolang">Bitbucket</samp> provider isn’t
                    available as an SSO provider, so users can’t log in to a
                    Salesforce org using their Bitbucket login credentials.
                    Available in API version 61.0 and higher.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Custom</samp>—A
                    provider configured with a custom authentication provider
                    plug-in. Available in API version 36.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Facebook</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">GitHub</samp>—Provides authentication for a
                    <samp class="codeph nolang">GitHub</samp> provider.
                    Used to log in users of your Lightning Platform app to
                    GitHub using OAuth. When logged in to GitHub, your app can
                    make calls to GitHub APIs. The <samp class="codeph nolang">GitHub</samp> provider isn’t available as an SSO
                    provider, so users can’t log in to your Salesforce org using
                    their GitHub login credentials. Available in API version
                    35.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Google</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Janrain</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LinkedIn</samp>. Available in
                    API version 32.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Microsoft</samp>—Provides authentication for all
                    services that can be accessed via Microsoft Azure Active
                    Directory. Available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MicrosoftACS</samp>—Microsoft Access Control
                    Service typically provides authentication for a Microsoft
                    Office 365 service, like SharePoint Online. The <samp class="codeph nolang">MicrosoftACS</samp> provider
                    doesn't support SSO. Available in API version 31.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MuleSoft</samp>. Available in
                    API version 57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpenIdConnect</samp>.
                    Available in API version 29.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Salesforce</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Slack</samp>. Available in API
                    version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Twitter</samp>. Available in
                    API version 32.0 and later.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">registrationHandler</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">An existing Apex class that implements the <samp class="codeph nolang">Auth.RegistrationHandler</samp>
                interface.<p class="p">You can use either an Apex class or a flow for the
                  registration handler. To use a flow instead, omit the
                  <span class="keyword parmname">registrationHandler</span> field and specify a
                  flow in the <span class="keyword parmname">flow</span> field.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">requireMfa</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d162582e106" data-title="Description">Requires multi-factor authentication (MFA) for single sign-on
                with this auth provider based on the MFA status of each user. For
                this setting to trigger MFA, you must apply MFA directly to users
                via one of two methods. 1) Enable the org setting Require
                multi-factor authentication (MFA) for all direct UI logins to your
                Salesforce org. 2) Assign the user permission multi-factor
                authentication for User Interface Logins. </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">sendAccessTokenInHeader</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d162582e106" data-title="Description"> If enabled (<samp class="codeph nolang">true</samp>), the access token is sent to
                the <span class="keyword parmname">UserInfoUrl</span> in a header instead of a query
                string. Available in API version 30.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">sendClientCredentialsInHeader</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d162582e106" data-title="Description">Required when creating an OpenID Connect authentication provider. If enabled (<samp class="codeph nolang">true</samp>), the client credentials are
                sent in a header to the <span class="keyword parmname">tokenUrl</span> instead of a
                query string. The credentials are in the standard OpenID Connect
                Basic Credentials header format, which is <samp class="codeph nolang">Basic &lt;token&gt;</samp>, where <samp class="codeph nolang">&lt;token&gt;</samp> is the base64-encoded
                string <samp class="codeph nolang">"clientkey:clientsecret"</samp>. Available in API version 30.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">sendSecretInApis</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d162582e106" data-title="Description">
                <div class="p">Determines whether the encrypted consumer secret appears in API
                  responses. If enabled (default), the secret appears in the
                  response. If disabled (<samp class="codeph nolang">false</samp>), responses don’t include the consumer
                  secret. For security, you can disable the setting. However, keep
                  in mind that: <ul class="ul bulletList">
                    <li class="li">By disabling this setting, the consumer secret is
                      excluded from API responses in all API versions.</li>

                    <li class="li">Change sets and other metadata deployments break because
                      both the consumer key and secret are expected. To fix
                      this problem, insert the consumer key manually during
                      deployment.</li>

                  </ul>
                  Available in API version 47.0 and later.</div>

                <p class="p">The consumer secret is always included in the response as a
                  placeholder value, regardless of the value provided for <samp class="codeph nolang">sendSecretInApis</samp>. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">ssoKickoffUrl</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description">The URL for performing single sign-on into Salesforce from a
                third party by using its third-party credentials. This field is
                read-only. Available in API version 43 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">tokenUrl</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description"> The OAuth token endpoint URL of an OpenID Connect authentication provider. Available
                in API version 29.0 and later. <p class="p">In API version 33.0 and later, for
                  Salesforce-managed auth providers, leave the field blank to let
                  Salesforce supply and manage the value. For details, see
                  “Usage.”</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d162582e100" data-title="Field Name"><span class="keyword parmname">userInfoUrl</span></td>

              <td class="entry" headers="d162582e103" data-title="Field Type">string</td>

              <td class="entry" headers="d162582e106" data-title="Description"> The OpenID Connect endpoint URL of the OpenID Connect authentication provider.
                Available in API version 29.0 and later. <p class="p">In API version 33.0 and
                  later, for Salesforce-managed auth providers, leave the field
                  blank to let Salesforce supply and manage the value. For
                  details, see “Usage.”</p>
              </td>

            </tr>

          </tbody>

        </table>

## AuthProvParamFwdAllowlist

Represents an allowlisted URL parameter that can be forwarded from authentication provider client configuration URLs to the authorization URL. Use this type to add custom functionality to authentication providers. For example, allowlist a ui\_locales parameter and use it to send a user's language preference from Salesforce to the third-party provider's login page. You can allowlist up to 10 parameters.

| Filed Name | Field type | Description |
| --- | --- | --- |
| description | string | A description for the allowlisted URL parameter. |
| param | string | The name of the parameter, such as ui\_locales or login\_hint. |

## Declarative Metadata Sample Definition

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Starting in November 2022, enter the consumerSecret value as plaintext, for example, <consumerSecret>yourplaintextconsumersecret</consumerSecret>. Existing consumer secrets that were entered as encrypted values can be deployed throughout the Winter ‘23 release.

<?xml version="1.0" encoding="UTF-8"?>
<AuthProvider xmlns="http://soap.sforce.com/2006/04/metadata">
    <consumerKey\>yourappkey</consumerKey\>
    <consumerSecret>PwdVxXjzu3NCZ3MD4He+wA=\=</consumerSecret\>
    <executionUser\>admin@your.org</executionUser\>
    <friendlyName\>FacebookAuthProvider</friendlyName\>
    <providerType\>Facebook</providerType\>
    <registrationHandler\>RegistrationHandler</registrationHandler\>
    <sendSecretInApis\>true</sendSecretInApis\>     
</AuthProvider\>

This example package manifest references the previous AuthProvider definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>FacebookAuthProvider</members\>
        <name\>AuthProvider</name\>
    </types\>
    <version\>28.0</version\>
</Package\>

## Usage

Salesforce provides default authentication providers, called Salesforce-managed auth providers, to simplify setting up these service providers for authentication.

- Apple
- Bitbucket
- Facebook
- GitHub
- Google
- Janrain
- LinkedIn
- Microsoft
- Microsoft Access Control Service
- MuleSoft
- Salesforce
- Slack

To use a Salesforce-managed auth provider, leave these fields blank when creating your auth provider from the Auth. Provider Setup page.

- authorizeUrl
- consumerKey
- consumerSecret
- defaultScopes
- tokenURL
- userInfoUrl

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If you provide a value for one of these fields, you must also provide a value for consumerKey and consumerSecret.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=71f56c5d15ad7e4eda1277036222eb7043b4a9bce2d09ca8ce0608f7106a2509 url=/legacydeveloper/current/en-us/api_meta/meta_automatedcontactssettings.md -->

# AutomatedContactsSettings

Represents an org’s Einstein Automated Contacts settings. These settings let you find new contacts and opportunity contact roles. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

AutomatedContactsSettings values are stored in the AutomatedContacts.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

AutomatedContactsSettings is available in API versions 48.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d165736e102">Field Name</th>

              <th class="featureTableHeader  " id="d165736e105">Field Type</th>

              <th class="featureTableHeader  " id="d165736e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d165736e102" data-title="Field Name"><span class="keyword parmname">enableAddContactAutomatically</span></td>

              <td class="entry" headers="d165736e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d165736e108" data-title="Description">Indicates whether new contacts are automatically added from external email accounts
                (such as Microsoft and Google) to Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>.
                <p class="p"><span class="keyword parmname">enableAddContactWithSuggestion</span> must
                  be <samp class="codeph nolang">true</samp> to use this
                  setting.</p>
                <div class="p">
                  <div class="box message info">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p> When this feature is enabled, users do not see new
                              contacts as suggestions. The contacts are added
                              automatically.</p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>

                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d165736e102" data-title="Field Name"><span class="keyword parmname">enableAddContactRoleAutomatically</span></td>

              <td class="entry" headers="d165736e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d165736e108" data-title="Description">Indicates whether opportunity contact roles from external accounts are automatically
                added to Salesforce (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). The default value
                is <samp class="codeph nolang">false</samp>. <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p> When this
                            feature is enabled, users do not see new contact roles as
                            suggestions. The contact roles are added
                            automatically.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d165736e102" data-title="Field Name"><span class="keyword parmname">enableAddContactRoleWithSuggestion</span></td>

              <td class="entry" headers="d165736e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d165736e108" data-title="Description">Indicates whether opportunity contact roles from external accounts are suggested as
                new Salesforce opportunity contact roles (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d165736e102" data-title="Field Name"><span class="keyword parmname">enableAddContactWithSuggestion</span></td>

              <td class="entry" headers="d165736e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d165736e108" data-title="Description">Indicates whether new contacts from external accounts (such as Microsoft and Google)
                are suggested as new Salesforce contacts (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">true</samp>.
                <p class="p"><span class="keyword parmname">enableAddContactRoleWithSuggestion</span>
                  must be <samp class="codeph nolang">true</samp> to use this
                  setting.</p>
              </td>

            </tr>


          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the AutomatedContactsSettings.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<AutomatedContactsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableAddContactAutomatically\>true</enableAddContactAutomatically\>
	<enableAddContactRoleAutomatically\>true</enableAddContactRoleAutomatically\>
	<enableAddContactRoleWithSuggestion\>true</enableAddContactRoleWithSuggestion\>
	<enableAddContactWithSuggestion\>true</enableAddContactWithSuggestion\>

</AutomatedContactsSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the AutomatedContacts settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>AutomatedContactsSettings</members\>
		<name\>Settings</name\>
	</types\>
	<version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=14ff890f2afe782762a7e1a1609419f616775b71503c6f67509c068455debac6 url=/legacydeveloper/current/en-us/api_meta/meta_autoresponserules.md -->

# AutoResponseRules

Represents an auto-response rule that sets conditions for sending automatic email responses to lead or case submissions based on the attributes of the submitted record. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object.

The package.xml syntax for accessing all auto-response rules for all objects is:

    <types>
        <members>\*</members>
        <name>AutoResponseRules</name>
    </types>

All rules for a specific object use a similar syntax without the wildcard. For example, all auto-response rules for the Case object would use this syntax:

    <types>
        <members>Case</members>
        <name>AutoResponseRules</name>
    </types>

You can also access specific auto-response rules for an object. The following example only accesses the “samplerule” and “newrule” auto-response rules on the Case object. Notice that for this example the type name syntax is AutoResponseRule and not AutoResponseRules.

    <types>
        <members>Case.samplerule</members>
        <members>Case.newrule</members>
        <name>AutoResponseRule</name>
    </types>

## File Suffix and Directory Location

AutoResponseRules for an object have the suffix .autoResponseRules and are stored in the autoResponseRules folder. For example, all Case auto-response rules are stored in the Case.autoResponseRules file.

## Version

AutoResponseRules components are available in API version 27.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| autoresponseRule | [AutoResponseRule\[\]](#autoresponserule_sub) | Represents the definitions of the named auto-response rules. |

## AutoResponseRule

Represents whether a rule is active or not and the order in which the entry is processed in the rule.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d166349e162">Field Name</th>

              <th class="featureTableHeader  " id="d166349e165">Field Type</th>

              <th class="featureTableHeader  " id="d166349e168">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d166349e162" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d166349e165" data-title="Field Type">boolean</td>

              <td class="entry" headers="d166349e168" data-title="Description">Indicates whether the autoresponse rule is active (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d166349e162" data-title="Field Name"><span class="keyword parmname">fullname</span></td>

              <td class="entry" headers="d166349e165" data-title="Field Type">string</td>

              <td class="entry" headers="d166349e168" data-title="Description">Inherited from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for this
                metadata type. It must be specified when creating, updating, or
                deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a>
                to see an example of this field specified for a call.<p class="p">This value
                  can't be <samp class="codeph java">null</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d166349e162" data-title="Field Name"><span class="keyword parmname">ruleEntry</span></td>

              <td class="entry" headers="d166349e165" data-title="Field Type"><a class="xref" href="#RuleEntry">RuleEntry[]</a></td>

              <td class="entry" headers="d166349e168" data-title="Description">Represents the type and description for the auto-response rule.
              </td>

            </tr>

          </tbody>

        </table>

## RuleEntry

Represents the fields used by the rule.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d166349e271">Field Name</th>

              <th class="featureTableHeader  " id="d166349e274">Field Type</th>

              <th class="featureTableHeader  " id="d166349e277">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d166349e271" data-title="Field Name"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d166349e274" data-title="Field Type">string</td>

              <td class="entry" headers="d166349e277" data-title="Description">Advanced filter conditions that were specified for the rule.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d166349e271" data-title="Field Name"><span class="keyword parmname">criteriaItems</span></td>

              <td class="entry" headers="d166349e274" data-title="Field Type"><span class="keyword parmname"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a>[]</span></td>

              <td class="entry" headers="d166349e277" data-title="Description">The items in the list that define the assignment criteria.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d166349e271" data-title="Field Name"><span class="keyword parmname">formula</span></td>

              <td class="entry" headers="d166349e274" data-title="Field Type">string</td>

              <td class="entry" headers="d166349e277" data-title="Description">The validation formula.<p class="p">Specify either
                  <span class="keyword parmname">formula</span> or
                  <span class="keyword parmname">criteriaItems</span>, but not both fields.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d166349e271" data-title="Field Name"><span class="keyword parmname">replyToEmail</span></td>

              <td class="entry" headers="d166349e274" data-title="Field Type">string</td>

              <td class="entry" headers="d166349e277" data-title="Description">The email address that appears in the reply-to header. </td>

            </tr>

            <tr>
              <td class="entry" headers="d166349e271" data-title="Field Name"><span class="keyword parmname">senderEmail</span></td>

              <td class="entry" headers="d166349e274" data-title="Field Type">string</td>

              <td class="entry" headers="d166349e277" data-title="Description">The email address of the person or queue sending the email
                notification. </td>

            </tr>

            <tr>
              <td class="entry" headers="d166349e271" data-title="Field Name"><span class="keyword parmname">senderName</span></td>

              <td class="entry" headers="d166349e274" data-title="Field Type">string</td>

              <td class="entry" headers="d166349e277" data-title="Description">The name of the person or queue sending the email notification.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d166349e271" data-title="Field Name"><span class="keyword parmname">template</span></td>

              <td class="entry" headers="d166349e274" data-title="Field Type">string</td>

              <td class="entry" headers="d166349e277" data-title="Description">Specifies the template to use for the email that is automatically
                sent to the designated recipient. <p class="p">Lightning email templates
                  aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example AutoResponseRules component:

<AutoResponseRules xmlns="http://soap.sforce.com/2006/04/metadata">
    <autoResponseRule\>
        <fullName\>ajbdeploytest2</fullName\>
        <active\>false</active\>
        <ruleEntry\>
            <criteriaItems\>
                <field\>Case.Description</field\>
                <operation\>contains</operation\>
                <value\>testing</value\>
            </criteriaItems\>
            <senderEmail\>test@test.org</senderEmail\>
            <senderName\>tester name j</senderName\>
            <replyToEmail\>test@@test.org</replyToEmail\>
            <template\>emailtemplate</template\>
        </ruleEntry\>
    </autoResponseRule\>
</AutoResponseRules\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=2b43ab8664fa72d421f597605da6ee4ce3c819ea7995d8726e627db111a30f3a url=/legacydeveloper/current/en-us/api_meta/meta_basesharingrule.md -->

# BaseSharingRule

This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingBaseRule instead. Represents the base container for criteria-based and owner-based sharing rules.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can’t create a BaseSharingRule component directly. Use the components under the [CriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm#meta_cbsrules "This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingRules instead. Represents a criteria-based sharing rule. CriteriaBasedSharingRule enables you to share records based on specific criteria.") or [OwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#meta_ownersharingrule "Represents an ownership-based sharing rule. OwnerSharingRule enables you to share records owned by a set of users with another set, using rules that specify the access level of the target user group. This component is removed as of API version 33.0 and is available in earlier versions only.") metadata types instead.

## Version

[BaseSharingRule](#meta_basesharingrule "This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingBaseRule instead. Represents the base container for criteria-based and owner-based sharing rules.") components are available in API version 24.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| sharedTo | [SharedTo](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.") | Required. Specifies who the record is shared with. |
| fullName | string | The unique identifier for API access.The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") component. |

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm "CriteriaBasedSharingRule")

<!-- document id=c0e0a58d722a63c903bc134e440aed5f551dd97f924c11f8efbe9aeada24f0c8 url=/legacydeveloper/current/en-us/api_meta/meta_batchcalcjobdefinition.md -->

# BatchCalcJobDefinition

Represents a Data Processing Engine definition.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

BatchCalcJobDefinition components have the suffix .batchCalcJobDefinition and are stored in the batchCalcJobDefinitions folder.

## Version

BatchCalcJobDefinition components are available in API version 51.0 and later.

## Special Access Rules

To know the products and user permissions needed to access this type, See [product availability](https://help.salesforce.com/s/articleView?id=ind.dpe_editions.htm&language=en_US) and [user permissions](https://help.salesforce.com/s/articleView?id=ind.dpe_setup.htm&language=en_US) for Data Processing Engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e116">Field Name</th>

              <th class="featureTableHeader  " id="d167858e119">Field Type</th>

              <th class="featureTableHeader  " id="d167858e122">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">activities</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjactivityID">BatchCalcJobActivity</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of reusable activities, such as a data stream run or an activation
                trigger, that can be referenced across steps in a data processing engine
                definition.<p class="p">Available in API version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">aggregates</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjaggregateID">BatchCalcJob​​​Aggregate</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of aggregate nodes in a data processing engine.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">apiVersion</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e122" data-title="Description">API version in which the data processing engine definition is created. For
                example, 68.0.<p class="p">Available in API version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">appends</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjunionID">BatchCalcJobUnion</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of append nodes in a data processing engine.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">atomicWritebacks</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#BatchCalcJobAtomicWriteback">BatchCalcJobAtomicWriteBack</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of composite writeback nodes in a data processing engine definition.
                Available in API version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">customNodes</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjcustomnodeID">BatchCalcJobCustomNode</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of custom nodes in a data processing engine. Available in API
                version 57.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">currencyConversion</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e122" data-title="Description">Specifies the currency conversion type for the data processing engine
                definition.<p class="p">Available in API version 67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">dataSpaceApiName</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e122" data-title="Description">Stores the Data Space API Name from <span class="ph">Data 360</span>. Available in
                API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">datasources</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjdatasourceID">BatchCalcJob​Datasource</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of data source nodes in a data processing engine.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">definitionRunMode</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">BatchCalcJobDefRunMode(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e122" data-title="Description">Specifies the execution mode in a data processing engine. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Batch</samp></li>

                  <li class="li"><samp class="codeph nolang">OnDemand</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">definitionType</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">BatchCalcJobDefType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e122" data-title="Description">Type of data processing engine definition.<p class="p">Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Calcservice</samp></li>

                  <li class="li"><samp class="codeph nolang">DataStudio</samp></li>

                </ul>
                <p class="p">Available in API version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e122" data-title="Description">Description of a data processing engine definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">doesGenAllFailedRecords</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e122" data-title="Description">Indicates whether the error file includes a complete list of all failed
                writeback records (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>, and only the first instance of a failure is
                recorded in the error file. If set to <samp class="codeph nolang">true</samp>, all
                failed records are recorded in the error file for the writeback node.<p class="p">Available in
                  API version 65.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">executionPlatformObjectType</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">ExecutionPlatformObjectType(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e122" data-title="Description">The execution platform object type that's used during the read, transform, and
                writeback process for the Data Processing Engine definition. Possible values are:<a name="ul_n2d_tym_rgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_n2d_tym_rgc">
                  <li class="li"><samp class="codeph nolang">CalculatedInsightsObject</samp></li>

                  <li class="li"><samp class="codeph nolang">DataLakeObject</samp></li>

                  <li class="li"><samp class="codeph nolang">DataModelObject</samp></li>

                  <li class="li"><samp class="codeph nolang">None</samp></li>

                </ul>
                <p class="p">Available in API version 65.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">executionPlatformType</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">ExecutionPlatformType(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e122" data-title="Description">The platform that's used to run the Data Processing Engine definition. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CRMA</samp></li>

                  <li class="li"><samp class="codeph nolang">CDP</samp></li>

                  <li class="li"><samp class="codeph nolang">CORE</samp></li>

                </ul>
                <p class="p">Available in API version 59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjfilterID">BatchCalcJobFilter</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of filter nodes in a data processing engine. definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">forecasts</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjforecastID">BatchCalcJobForecast</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of forecast nodes in a data processing engine.
                definition.<p class="p">Available in API version 58.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">hierarchyPaths</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjhierarchypathID">BatchCalcJobHierarchyPath</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of hierarchy path nodes in a data processing engine
                definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">isTemplate</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e122" data-title="Description">Indicates whether it’s a template data processing engine definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">joins</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjsourcejoinID">BatchCalcJobSource​Join</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of join nodes in a data processing engine.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e122" data-title="Description">The label of a data processing engine definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">parameters</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjparameterID">BatchCalcJobParameter</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of input variables in a data processing engine.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">processType</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">BatchCalcProcessType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e122" data-title="Description">The process type of a data processing engine. These process types may be
                available to you depending on your industry solution and permission sets. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">AccountingPeriodClosure</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">AccountingSubledger</samp>—This value is
                    reserved for internal use.
                  </li>

                  <li class="li"><samp class="codeph nolang">AccrualsAndPayoutEngine</samp></li>

                  <li class="li"><samp class="codeph nolang">ActionableList</samp></li>

                  <li class="li"><samp class="codeph nolang">AdvancedAccountForecast</samp></li>

                  <li class="li"><samp class="codeph nolang">AutomotiveFoundation</samp></li>

                  <li class="li"><samp class="codeph nolang">BenefitManagement</samp></li>

                  <li class="li"><samp class="codeph nolang">BillingSchedulesforInvoiceGeneration</samp></li>

                  <li class="li"><samp class="codeph nolang">CDPEnrichment</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ChannelInventoryManagement</samp>—Available in API version 63.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CollectionPlan</samp>—Available in API
                    version 65.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ContextService</samp>—Available in API
                    version 67.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">CriteriaBsdSearchAndFilter</samp></li>

                  <li class="li"><samp class="codeph nolang">DataProcessingEngine</samp></li>

                  <li class="li"><samp class="codeph nolang">DecisionMatrixDataUpload</samp></li>

                  <li class="li"><samp class="codeph nolang">Decisiontable</samp></li>

                  <li class="li"><samp class="codeph nolang">Education</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">EmployeeService</samp>—Available in API
                    version 63.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">EnergyUtilitiesSales</samp></li>

                  <li class="li"><samp class="codeph nolang">FinancialSummaryRollup</samp></li>

                  <li class="li"><samp class="codeph nolang">FlexibleHierarchy</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ForeignExchangeGainLossCalculations</samp>—Available in API version
                    65.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">FSCHierarchyRollUp</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Fundraising</samp>—Available in API
                    version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FundraisingRollups</samp>—Available in
                    API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">GeneralLedgerAccountBalancesSummary</samp>—Available in API version
                    65.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">InventoryBatchSearch</samp>—Available in
                    API version 65.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">InventorySearch</samp>—Available in API
                    version 65.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">InvoiceGeneration</samp></li>

                  <li class="li"><samp class="codeph nolang">Loyalty</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">LegalEntityAccountingPeriodClosureAdvanced</samp>—Available in API
                    version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LifeSciencesCommercialTerritoryAlignment</samp>—Available in API
                    version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LifeSciencesCustomerEngagement</samp>—Available in API version 64.0
                    and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">LoyaltyPartnerManagement</samp></li>

                  <li class="li"><samp class="codeph nolang">LoyaltyPointsAggregation</samp></li>

                  <li class="li"><samp class="codeph nolang">MediaAdSales</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">NextGenForecasting</samp>—Available in
                    API version 64.0 and earlier.
                  </li>

                  <li class="li"><samp class="codeph nolang">NetZero</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">PatientServicesProgram</samp>—Available
                    in API version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PennyPerfectPricing</samp>—Available in
                    API version 68.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">PlanningAndForecasting</samp></li>

                  <li class="li"><samp class="codeph nolang">PnmRosterFileUpload</samp></li>

                  <li class="li"><samp class="codeph nolang">PriceProtection</samp></li>

                  <li class="li"><samp class="codeph nolang">ProductCatalogManagement</samp></li>

                  <li class="li"><samp class="codeph nolang">ProgramBasedBusiness</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ProviderSearch</samp>—This value is
                    reserved for internal use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PublicSector</samp>—Available in API
                    version 68.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Rebates</samp></li>

                  <li class="li"><samp class="codeph nolang">RebateAndAccrualManagementAdvanced</samp></li>

                  <li class="li"><samp class="codeph nolang">Recruitment</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">RevenueTransactionManagement</samp>—Available in API version 63.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SalesAgreement</samp>—Available in API
                    version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TestAtomicWritebackScale</samp>—Available
                    in API version 64.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">TestProcessType</samp></li>

                  <li class="li"><samp class="codeph nolang">UsageManagement</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">BatchJobDefinition​Status (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e122" data-title="Description">Status of a data processing engine definition. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Active</samp></li>

                  <li class="li"><samp class="codeph nolang">Inactive</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">steps</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjstepID">BatchCalcJobStep</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of steps that group related activities in a data processing engine
                definition.<p class="p">Available in API version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">targetCurrencyIsoCode</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e122" data-title="Description">ISO code of the target currency for currency conversion in the data processing
                engine definition.<p class="p">Available in API version 67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">transforms</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjtransformID">BatchCalcJobTransform</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of data transformation nodes in a data processing engine.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e116" data-title="Field Name"><span class="keyword parmname">writebacks</span></td>

              <td class="entry" headers="d167858e119" data-title="Field Type">
                <a class="xref" href="#bcjwritebackobjectID">BatchCalcJobWriteback​Object</a>[]
              </td>

              <td class="entry" headers="d167858e122" data-title="Description">Collection of writeback objects in which the results of the data processing
                engine are written back.</td>

            </tr>

          </tbody>

        </table>

## BatchCalcJob​Activity

Represents a reusable activity, such as a data stream run or an activation trigger, that can be referenced across steps in a data processing engine definition.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e952">Field Name</th>

              <th class="featureTableHeader  " id="d167858e955">Field Type</th>

              <th class="featureTableHeader  " id="d167858e958">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e952" data-title="Field Name"><span class="keyword parmname">activityName</span></td>

              <td class="entry" headers="d167858e955" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e958" data-title="Description">Required. Unique name that identifies the activity in a step.<p class="p">Available in
                  API version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e952" data-title="Field Name"><span class="keyword parmname">activityType</span></td>

              <td class="entry" headers="d167858e955" data-title="Field Type">BatchCalcJobActivityType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e958" data-title="Description">Required. Type of activity performed in a step. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">RefreshDataGraphActivity</samp></li>

                  <li class="li"><samp class="codeph nolang">RefreshSegmentActivity</samp></li>

                  <li class="li"><samp class="codeph nolang">RunCalculatedInsightsActivity</samp></li>

                  <li class="li"><samp class="codeph nolang">RunDataStreamActivity</samp></li>

                  <li class="li"><samp class="codeph nolang">RunDataTransformActivity</samp></li>

                  <li class="li"><samp class="codeph nolang">RunIdentityResolutionActivity</samp></li>

                  <li class="li"><samp class="codeph nolang">TriggerActivationActivity</samp></li>

                </ul>
                <p class="p">Available in API version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e952" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e955" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e958" data-title="Description">User-defined name for the activity.<p class="p">Available in API version 68.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e952" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e955" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e958" data-title="Description">Required. Unique API name of the activity.<p class="p">Available in API version 68.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJob​Step

Represents a stage in a data processing engine definition. A step groups related activities that must be completed before the definition advances to the next step.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e1096">Field Name</th>

              <th class="featureTableHeader  " id="d167858e1099">Field Type</th>

              <th class="featureTableHeader  " id="d167858e1102">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e1096" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e1099" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e1102" data-title="Description">User-defined name for the step.<p class="p">Available in API version 68.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e1096" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e1099" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e1102" data-title="Description">Unique API name that identifies the step.<p class="p">Available in API version 68.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e1096" data-title="Field Name"><span class="keyword parmname">processNodes</span></td>

              <td class="entry" headers="d167858e1099" data-title="Field Type">
                <a class="xref" href="#bcjstepprocnodeID">BatchCalcJobStepProcNode</a>[]
              </td>

              <td class="entry" headers="d167858e1102" data-title="Description">Collection of process nodes that associate activities with the
                step.<p class="p">Available in API version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e1096" data-title="Field Name"><span class="keyword parmname">sources</span></td>

              <td class="entry" headers="d167858e1099" data-title="Field Type">string[]</td>

              <td class="entry" headers="d167858e1102" data-title="Description">Collection of source node names associated with the step.<p class="p">Available in API
                  version 68.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobStepProcNode

Represents the association between a step and an activity that runs in that step. The sequence number defines the execution order of activities in a step.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e1209">Field Name</th>

              <th class="featureTableHeader  " id="d167858e1212">Field Type</th>

              <th class="featureTableHeader  " id="d167858e1215">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e1209" data-title="Field Name"><span class="keyword parmname">processNodeReferenceRecord</span></td>

              <td class="entry" headers="d167858e1212" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e1215" data-title="Description">Required. Action that represents the activity in the step.<p class="p">Available in API
                  version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e1209" data-title="Field Name"><span class="keyword parmname">sequenceNumber</span></td>

              <td class="entry" headers="d167858e1212" data-title="Field Type">integer</td>

              <td class="entry" headers="d167858e1215" data-title="Description">Execution order of the activity in the step.<p class="p">Available in API version 68.0
                  and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJob​​​Aggregate

Represents a collection of fields relating to an aggregate node in a data processing engine.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Description of an aggregate node. |
| fields | [BatchCalcJob​AggregateField](#bcjaggregatefieldID)\[\] | Required. Collection of aggregation fields. |
| groupBy | string\[\] | Required. Collections of fields used to group data in an aggregate node. |
| label | string | Required. Label of an aggregate node. |
| name | string | Required. Name of an aggregate node. |
| sourceName | string | Required. Name of the source node. |

## BatchCalcJob​AggregateField

Represents a collection of fields relating to an aggregation field in an aggregate node of a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e1420">Field Name</th>

              <th class="featureTableHeader  " id="d167858e1423">Field Type</th>

              <th class="featureTableHeader  " id="d167858e1426">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e1420" data-title="Field Name"><span class="keyword parmname">aggregateFunction</span></td>

              <td class="entry" headers="d167858e1423" data-title="Field Type">BatchCalcJobAggregateFunction (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e1426" data-title="Description">Required. Function used for aggregation. <p class="p">Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Unique</samp>—A count of unique values.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Sum</samp>—The sum of all values.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Max</samp>—The largest value.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Min</samp>—The smallest value.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Avg</samp>—The average value, calculated as the
                    mean.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Std</samp>—The standard deviation.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Stdp</samp>—A standard deviation with population
                    variance.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Var</samp>—The variance.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">VarP</samp>—The variance with population.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Count</samp>—The total count of values.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e1420" data-title="Field Name"><span class="keyword parmname">alias</span></td>

              <td class="entry" headers="d167858e1423" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e1426" data-title="Description">Required. Name that subsequent nodes within the data processing engine use to
                refer to the aggregate field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e1420" data-title="Field Name"><span class="keyword parmname">sourceFieldName</span></td>

              <td class="entry" headers="d167858e1423" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e1426" data-title="Description">Required. Source node field on which the aggregate is calculated.</td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobAtomicWriteback

Represents a node in a DPE definition that stores the details about the relationship between the writeback nodes and the composite writeback operations between the nodes.

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Description of the composite writeback object. |
| label | string | Required. Name of the composite writeback object. |
| name | string | Required. API name of the composite writeback object. |
| writebackObject​Relationships | [BatchCalcJobAtomicWritebackRelationship](#BatchCalcJobAtomicWritebackRelationship)\[\] | Specifies the relationship between the writeback objects that are involved in the writeback operation. |
| writebackSequence | int | Sequence in which the data processing engine executes the composite write back node. |

## BatchCalcJobAtomicWritebackRelationship

Represents the relationships between the writeback objects that are involved in a composite writeback operation. It captures the relationships between these objects and the sequence in which they should be processed.

| Field Name | Field Type | Description |
| --- | --- | --- |
| childWriteback​ObjectField | string | Field name that's associated with the child writeback object in a composite writeback relationship. Available in API version 63.0 and later. |
| childWriteback​ObjectName | string | Name of the child writeback object that's associated with the writeback relationship. |
| parentWriteback​ObjectField | string | Field name that's associated with the parent writeback object in a composite writeback relationship. Available in API version 63.0 and later. |
| parentWriteback​ObjectName | string | Required. Name of the parent writeback object that's associated with the writeback relationship. |
| relationshipName | string | Describes the relationship between the child and parent writeback objects in a composite writeback node. Available in API version 64.0 and later. |
| sequenceNumber | int | Sequence number of the writeback node that's associated with its parent node in the relationship. |

## BatchCalcJob​​​CustomNode

Represents a collection of custom nodes in a data processing engine. Use a custom node to add a custom action.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Description of a custom node. |
| extensionName | string | Required. Name of an extension node. |
| extensionNamespace | string | Required. Namespace of an extension node. |
| label | string | Required. Label of a custom node. |
| name | string | Required. Name of a custom node. |
| parameters | [BatchCalcJob​​​CustomNodeParameter](#bcjcustomnodeparameterID)\[\] | The field mappings of an extension node. |
| sources | string\[\] | Sources of an extension node. |

## BatchCalcJob​​​CustomNodeParameter

Represents the field mappings of an extension node.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Name of a parameter. |
| value | string | Required. Value of a parameter. |

## BatchCalcJob​Datasource

Represents a collection of fields relating to a data source node in a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e2014">Field Name</th>

              <th class="featureTableHeader  " id="d167858e2017">Field Type</th>

              <th class="featureTableHeader  " id="d167858e2020">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">CSVDelimiter</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">​BatchCalcJobCSVDelimiter (enumeration of type string)</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Specifies the field separator to read fields from a CSV file record.
                <p class="p">Possible values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">COMMA</samp></li>

                  <li class="li"><samp class="codeph nolang">BACKQUOTE</samp></li>

                  <li class="li"><samp class="codeph nolang">CARET</samp></li>

                  <li class="li"><samp class="codeph nolang">PIPE</samp></li>

                  <li class="li"><samp class="codeph nolang">SEMICOLON</samp></li>

                  <li class="li"><samp class="codeph nolang">TAB</samp></li>

                </ul>
                <p class="p">The default value is <samp class="codeph nolang">COMMA</samp>.</p>
                <p class="p">The
                  same delimiter value used for the CSV file can’t be used within any of the column
                  values in the file. If you mistakenly use the same delimiter value in column
                  values, it can cause data parsing issues.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Description of a data source node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">
                <a class="xref" href="#bcjdatasourcefieldID">BatchCalcJob​DatasourceField</a>[]
              </td>

              <td class="entry" headers="d167858e2020" data-title="Description">Required. Collection of data source fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">fileIdentifier</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Specifies the source of the file or file storage system.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">filePath</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2020" data-title="Description">The file path for the specified file.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">fileSource</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">BatchCalcJobFileSource (enumeration of type string)</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Specifies the source of the file or file storage system.<p class="p">Possible value
                  is:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ContentManagement</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Required. Label of a data source node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Required. Name of a data source node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">parentDataSource</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Name of the parent data source node.<p class="p">Available in API version 67.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">sourceName</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Required. Name of a standard or custom object from which the data source node
                extracts data.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">subtype</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">BatchCalcJobSubtype (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Specifies the subtype of the data source. Use this field to identify data
                source nodes that reference context nodes or similar structures. <p class="p">Valid value
                  is:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ContextNode</samp></li>

                </ul>

                <p class="p">Available in API version 67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2014" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d167858e2017" data-title="Field Type">BatchCalcJobDataSource​Type (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e2020" data-title="Description">Required. Type of object for the source object field. Supported values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Analytics</samp></li>

                  <li class="li"><samp class="codeph nolang">CalculatedInsightsObject</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Context</samp>—Available in API version 67.0 and
                    later.
                  </li>

                  <li class="li"><samp class="codeph nolang">CRMObject</samp></li>

                  <li class="li"><samp class="codeph nolang">CSV</samp></li>

                  <li class="li"><samp class="codeph nolang">DataLakeObject</samp></li>

                  <li class="li"><samp class="codeph nolang">DataModelObject</samp></li>

                  <li class="li"><samp class="codeph nolang">StandardObject</samp></li>

                </ul>
                .</td>

            </tr>

          </tbody>

        </table>

## BatchCalcJob​DatasourceField

Represents a collection of fields relating to a source object field that are selected in the data source node of a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e2327">Field Name</th>

              <th class="featureTableHeader  " id="d167858e2330">Field Type</th>

              <th class="featureTableHeader  " id="d167858e2333">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e2327" data-title="Field Name"><span class="keyword parmname">alias</span></td>

              <td class="entry" headers="d167858e2330" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2333" data-title="Description">Name that subsequent nodes within the data processing engine use to refer to
                the data source field. Required when the field name is lookup.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2327" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d167858e2330" data-title="Field Type">BatchCalcJobDataType (enumeration of type string)</td>

              <td class="entry" headers="d167858e2333" data-title="Description">Specifies the data type of the input field when using a CSV file as a data
                source.<p class="p">Possible values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Boolean</samp>—Available in API version
                    65.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">MultiValue</samp></li>

                  <li class="li"><samp class="codeph nolang">Numeric</samp></li>

                  <li class="li"><samp class="codeph nolang">Text</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2327" data-title="Field Name"><span class="keyword parmname">isPrimaryKey</span></td>

              <td class="entry" headers="d167858e2330" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e2333" data-title="Description">Indicates whether a column name is the primary key (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) for the Data
                Cloud CSV file.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2327" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e2330" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2333" data-title="Description">Required. Name of the field. Can be either of the following:<ul class="ul bulletList">
                  <li class="li">Name of the source field selected in the associated data source object.</li>

                  <li class="li">Name from a nested lookup object with three child levels.</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobFilter

Represents a collection of fields relating to a filter node in a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e2473">Field Name</th>

              <th class="featureTableHeader  " id="d167858e2476">Field Type</th>

              <th class="featureTableHeader  " id="d167858e2479">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e2473" data-title="Field Name"><span class="keyword parmname">criteria</span></td>

              <td class="entry" headers="d167858e2476" data-title="Field Type">
                <a class="xref" href="#bcjfiltercriteriaID">BatchCalcJobFilter​Criteria</a>[]
              </td>

              <td class="entry" headers="d167858e2479" data-title="Description">Collection of filter criteria in a filter node. <p class="p">The field is required when
                  <samp class="codeph nolang">isDynamicFilter</samp> is set to <samp class="codeph nolang">False</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2473" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d167858e2476" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2479" data-title="Description">Description of the batch calculation job filter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2473" data-title="Field Name"><span class="keyword parmname">filterCondition</span></td>

              <td class="entry" headers="d167858e2476" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2479" data-title="Description">Logic that is specified to apply the filter conditions. <p class="p">The field is
                  required when <samp class="codeph nolang">isDynamicFilter</samp> is set to
                  <samp class="codeph nolang">False</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2473" data-title="Field Name"><span class="keyword parmname">filterParameterName</span></td>

              <td class="entry" headers="d167858e2476" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2479" data-title="Description">Name of the parameter of type filter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2473" data-title="Field Name"><span class="keyword parmname">isDynamicFilter</span></td>

              <td class="entry" headers="d167858e2476" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e2479" data-title="Description">Indicates whether the filter criteria is dynamic. If value is set to <samp class="codeph nolang">True</samp>, filter criteria is passed in runtime with
                <samp class="codeph nolang">filterParameterName</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2473" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e2476" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2479" data-title="Description">Required. Label of the filter node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2473" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e2476" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2479" data-title="Description">Required. Name of the filter node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2473" data-title="Field Name"><span class="keyword parmname">sourceName</span></td>

              <td class="entry" headers="d167858e2476" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2479" data-title="Description">Required. Name of the source node.</td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobForecast

Represents a collection of fields relating to a forecast node in a data processing engine. Available in API version 58.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e2653">Field Name</th>

              <th class="featureTableHeader  " id="d167858e2656">Field Type</th>

              <th class="featureTableHeader  " id="d167858e2659">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">accuracyPercent</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">BatchCalcJobFrcstAccuracy (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e2659" data-title="Description">
                <p class="p">The interval percentage to account for errors in forecasts.</p>

                <p class="p">Possible values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Eighty</samp></li>

                  <li class="li"><samp class="codeph nolang">NinetyFive</samp></li>

                  <li class="li"><samp class="codeph nolang">None</samp></li>

                </ul>

                <p class="p">The default value is <samp class="codeph nolang">None</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">aggregationFields</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type"><a class="xref" href="#BtchCalcJobFrcstAggrFld">BtchCalcJobFrcstAggrFld[]</a></td>

              <td class="entry" headers="d167858e2659" data-title="Description">The list of fields to forecast.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">dateFieldName</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2659" data-title="Description">Required.<p class="p">The date field from the source node used to forecast values for the
                  specified forecast length.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2659" data-title="Description">The description of the forecast node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">forecastModelType</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">BatchCalcJobFrcstModel (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e2659" data-title="Description">The model used to forecast data.<p class="p">Possible values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Additive</samp></li>

                  <li class="li"><samp class="codeph nolang">Auto</samp></li>

                  <li class="li"><samp class="codeph nolang">Multiplicative</samp></li>

                </ul>
                <p class="p">The default value is <samp class="codeph nolang">Auto</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">forecastPeriodCount</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">int</td>

              <td class="entry" headers="d167858e2659" data-title="Description">The number of time periods to generate forecast data. For example, if you
                select Year-Month as the forecast period type, and 4 as the forecast period count,
                the forecast results are generated for the next 4 months. <p class="p">The minimum and the
                  default count is 1, and the maximum is 100.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">forecastPeriodType</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">BatchCalcJobFrcstPeriodType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e2659" data-title="Description">Required.<p class="p">The type of forecast period to group date field values in the
                  forecast results.</p>
                <p class="p">Possible values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FiscalYear</samp></li>

                  <li class="li"><samp class="codeph nolang">FiscalYearMonth</samp></li>

                  <li class="li"><samp class="codeph nolang">FiscalYearQuarter</samp></li>

                  <li class="li"><samp class="codeph nolang">FiscalYearWeek</samp></li>

                  <li class="li"><samp class="codeph nolang">Year</samp></li>

                  <li class="li"><samp class="codeph nolang">YearMonth</samp></li>

                  <li class="li"><samp class="codeph nolang">YearMonthDay</samp></li>

                  <li class="li"><samp class="codeph nolang">YearQuarter</samp></li>

                  <li class="li"><samp class="codeph nolang">YearWeek</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">groupFields</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type"><a class="xref" href="#BatchCalcJobFrcstGrpFld">BatchCalcJobFrcstGrpFld[]</a></td>

              <td class="entry" headers="d167858e2659" data-title="Description">The source fields for grouping the data to be processed by the forecast
                node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2659" data-title="Description">Required.<p class="p">The name of the forecast node in the UI.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2659" data-title="Description">Required. <p class="p">A unique name for the forecast node.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">periodStartDateName</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2659" data-title="Description">Required.<p class="p">The start date of the forecast period.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">seasonality</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">BatchCalcJobFrcstSeasonality (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e2659" data-title="Description">
                <p class="p">Represents the periodic fluctuations that occur around the same time every
                  year.</p>

                <p class="p">Possible values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Two</samp></li>

                  <li class="li"><samp class="codeph nolang">Three</samp></li>

                  <li class="li"><samp class="codeph nolang">Four</samp></li>

                  <li class="li"><samp class="codeph nolang">Five</samp></li>

                  <li class="li"><samp class="codeph nolang">Six</samp></li>

                  <li class="li"><samp class="codeph nolang">Seven</samp></li>

                  <li class="li"><samp class="codeph nolang">Eight</samp></li>

                  <li class="li"><samp class="codeph nolang">Nine</samp></li>

                  <li class="li"><samp class="codeph nolang">Ten</samp></li>

                  <li class="li"><samp class="codeph nolang">Eleven</samp></li>

                  <li class="li"><samp class="codeph nolang">Twelve</samp></li>

                  <li class="li"><samp class="codeph nolang">Thirteen</samp></li>

                  <li class="li"><samp class="codeph nolang">Fourteen</samp></li>

                  <li class="li"><samp class="codeph nolang">Fifteen</samp></li>

                  <li class="li"><samp class="codeph nolang">Sixteen</samp></li>

                  <li class="li"><samp class="codeph nolang">Seventeen</samp></li>

                  <li class="li"><samp class="codeph nolang">Eighteen</samp></li>

                  <li class="li"><samp class="codeph nolang">Nineteen</samp></li>

                  <li class="li"><samp class="codeph nolang">Twenty</samp></li>

                  <li class="li"><samp class="codeph nolang">TwentyOne</samp></li>

                  <li class="li"><samp class="codeph nolang">TwentyTwo</samp></li>

                  <li class="li"><samp class="codeph nolang">TwentyThree</samp></li>

                  <li class="li"><samp class="codeph nolang">TwentyFour</samp></li>

                  <li class="li"><samp class="codeph nolang">Auto</samp></li>

                  <li class="li"><samp class="codeph nolang">None</samp></li>

                </ul>

                <p class="p">The default value is <samp class="codeph nolang">None</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">shouldExcludeLastPeriod</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e2659" data-title="Description">Indicates whether to ignore the last period in the source node when it has
                incomplete data (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e2653" data-title="Field Name"><span class="keyword parmname">sourceName</span></td>

              <td class="entry" headers="d167858e2656" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e2659" data-title="Description">Required. <p class="p">The name of the source node.</p>

                <p class="p">A source can be any node other than the datasink and register node.</p>
              </td>

            </tr>

          </tbody>

        </table>

## BtchCalcJobFrcstAggrFld

Represents a list of fields to forecast in a forecast node.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e3132">Field Name</th>

              <th class="featureTableHeader  " id="d167858e3135">Field Type</th>

              <th class="featureTableHeader  " id="d167858e3138">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e3132" data-title="Field Name"><span class="keyword parmname">aggregateFunction</span></td>

              <td class="entry" headers="d167858e3135" data-title="Field Type">BatchCalcJobAggregateFunction (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e3138" data-title="Description">Required.<p class="p">The function of the aggregate field.</p>
                <p class="p">Possible values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Avg</samp></li>

                  <li class="li"><samp class="codeph nolang">Count</samp></li>

                  <li class="li"><samp class="codeph nolang">Max</samp></li>

                  <li class="li"><samp class="codeph nolang">Min</samp></li>

                  <li class="li"><samp class="codeph nolang">Std</samp></li>

                  <li class="li"><samp class="codeph nolang">StdP</samp></li>

                  <li class="li"><samp class="codeph nolang">Sum</samp></li>

                  <li class="li"><samp class="codeph nolang">Unique</samp></li>

                  <li class="li"><samp class="codeph nolang">Var</samp></li>

                  <li class="li"><samp class="codeph nolang">VarP</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3132" data-title="Field Name"><span class="keyword parmname">aggregationResultLabel</span></td>

              <td class="entry" headers="d167858e3135" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3138" data-title="Description">Required.<p class="p">The name of the aggregation result generated from the aggregation
                  function that’s applied to the source node field.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3132" data-title="Field Name"><span class="keyword parmname">fieldName</span></td>

              <td class="entry" headers="d167858e3135" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3138" data-title="Description">Required.<p class="p">The name of the source field.</p>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobFrcstGrpFld

Represents source fields for grouping the data to be processed by the forecast node.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e3266">Field Name</th>

              <th class="featureTableHeader  " id="d167858e3269">Field Type</th>

              <th class="featureTableHeader  " id="d167858e3272">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e3266" data-title="Field Name"><span class="keyword parmname">fieldName</span></td>

              <td class="entry" headers="d167858e3269" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3272" data-title="Description">Required.<p class="p">The name of the source field to group the data to be processed by
                  the forecast node.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3266" data-title="Field Name"><span class="keyword parmname">groupBy</span></td>

              <td class="entry" headers="d167858e3269" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3272" data-title="Description">A comma-separated list of values to group data by. <p class="p">Required when the source
                  field type is Date or DateTime.</p>

                <p class="p">Possible values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Second</samp></li>

                  <li class="li"><samp class="codeph nolang">Second Epoch</samp></li>

                  <li class="li"><samp class="codeph nolang">Minute</samp></li>

                  <li class="li"><samp class="codeph nolang">Hour</samp></li>

                  <li class="li"><samp class="codeph nolang">Day</samp></li>

                  <li class="li"><samp class="codeph nolang">Day Epoch</samp></li>

                  <li class="li"><samp class="codeph nolang">Week</samp></li>

                  <li class="li">

                  </li><li class="li"><samp class="codeph nolang">Month</samp></li>

                  <li class="li"><samp class="codeph nolang">Quarter</samp></li>

                  <li class="li"><samp class="codeph nolang">Year</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobHierarchyPath

Represents a collection of hierarchy path nodes in a data processing engine definition.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e3394">Field Name</th>

              <th class="featureTableHeader  " id="d167858e3397">Field Type</th>

              <th class="featureTableHeader  " id="d167858e3400">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">aggregateFields</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">
                <a class="xref" href="#bcjhierarchypathaggfieldID">BatchCalcJobHierarchyPath​AggregateField</a>[]
              </td>

              <td class="entry" headers="d167858e3400" data-title="Description">Collection of aggregate fields for the hierarchy path node.<p class="p">Available in API
                  version 67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Description of the hierarchy path node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">hierarchyFieldName</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Required. Field name that contains the hierarchy path.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">isAggregationRequired</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Indicates whether aggregation is required for the hierarchy path node (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">Available in API version 67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">isSelfFieldValueIncluded</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Indicates whether the self value is included in the calculated hierarchy path
                (<samp class="codeph nolang">True</samp>) or not (<samp class="codeph nolang">False</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Required. Label of the hierarchy path node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Required. Name of the hierarchy path node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">parentFieldName</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Required. Parent field name to calculate hierarchy path.</td>

            </tr>


            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">rollupMultiplicationFactor</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">double</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Multiplication factor used for the rollup calculation in the hierarchy path
                node.<p class="p">Available in API version 264.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">rollupPercentageFieldName</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Field name used for rollup percentage calculation in the hierarchy
                path.<p class="p">Available in API version 67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">selfFieldName</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Required. Self field name to calculate hierarchy path.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3394" data-title="Field Name"><span class="keyword parmname">sourceName</span></td>

              <td class="entry" headers="d167858e3397" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3400" data-title="Description">Required. Name of the source node.</td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobHierarchyPath​AggregateField

Represents a collection of fields relating to an aggregation field in a hierarchy path node of a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e3625">Field Name</th>

              <th class="featureTableHeader  " id="d167858e3628">Field Type</th>

              <th class="featureTableHeader  " id="d167858e3631">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e3625" data-title="Field Name"><span class="keyword parmname">aggregateFunction</span></td>

              <td class="entry" headers="d167858e3628" data-title="Field Type">BatchCalcJobHierPathAggrFunc (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e3631" data-title="Description">Required. Function used to aggregate values across the hierarchy path. <p class="p">Valid
                  values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Count</samp></li>

                  <li class="li"><samp class="codeph nolang">Sum</samp></li>

                </ul>
                <p class="p">Available in API version 67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3625" data-title="Field Name"><span class="keyword parmname">shouldExcludeParentValue</span></td>

              <td class="entry" headers="d167858e3628" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e3631" data-title="Description">Indicates whether to exclude the parent record's value from the hierarchical
                aggregation (<samp class="codeph nolang">true</samp>) or include it (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. This field is supported only when
                <span class="keyword parmname">definitionRunMode</span> is <samp class="codeph nolang">OnDemand</samp>.<p class="p">Available in API version 68.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobFilter​Criteria

Represents a collection of fields relating to a filter condition in a filter node in a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e3737">Field Name</th>

              <th class="featureTableHeader  " id="d167858e3740">Field Type</th>

              <th class="featureTableHeader  " id="d167858e3743">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e3737" data-title="Field Name"><span class="keyword parmname">inputVariable</span></td>

              <td class="entry" headers="d167858e3740" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3743" data-title="Description">Name of the input variable used as a filter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3737" data-title="Field Name"><span class="keyword parmname">operator</span></td>

              <td class="entry" headers="d167858e3740" data-title="Field Type">BatchCalcJobFilter​Operator (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e3743" data-title="Description">Required. Operator that is specified in the filter condition. <p class="p">Valid values
                  are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Equals</samp></li>

                  <li class="li"><samp class="codeph nolang">NotEquals</samp></li>

                  <li class="li"><samp class="codeph nolang">GreaterThan</samp></li>

                  <li class="li"><samp class="codeph nolang">GreaterThanOrEqual</samp></li>

                  <li class="li"><samp class="codeph nolang">LessThan</samp></li>

                  <li class="li"><samp class="codeph nolang">LessThanOrEqual</samp></li>

                  <li class="li"><samp class="codeph nolang">StartsWith</samp></li>

                  <li class="li"><samp class="codeph nolang">EndsWith</samp></li>

                  <li class="li"><samp class="codeph nolang">Contains</samp></li>

                  <li class="li"><samp class="codeph nolang">DoesNotContain</samp></li>

                  <li class="li"><samp class="codeph nolang">IsNull</samp></li>

                  <li class="li"><samp class="codeph nolang">IsNotNull</samp></li>

                  <li class="li"><samp class="codeph nolang">In</samp></li>

                  <li class="li"><samp class="codeph nolang">NotIn</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3737" data-title="Field Name"><span class="keyword parmname">sequence</span></td>

              <td class="entry" headers="d167858e3740" data-title="Field Type">integer</td>

              <td class="entry" headers="d167858e3743" data-title="Description">Required. Sequence number used to refer the criteria in a filter node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3737" data-title="Field Name"><span class="keyword parmname">sourceFieldName</span></td>

              <td class="entry" headers="d167858e3740" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3743" data-title="Description">Required. Name of the field from the source node to apply the filter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3737" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d167858e3740" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3743" data-title="Description">Value used to filter data from the source node.</td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobParameter

Represents a collection of fields relating to an input variable in a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e3919">Field Name</th>

              <th class="featureTableHeader  " id="d167858e3922">Field Type</th>

              <th class="featureTableHeader  " id="d167858e3925">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e3919" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d167858e3922" data-title="Field Type">BatchCalcJobParameter​DataType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e3925" data-title="Description">Required. Data type of the parameter. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Expression</samp></li>

                  <li class="li"><samp class="codeph nolang">FileIdentifier</samp></li>

                  <li class="li"><samp class="codeph nolang">Filter</samp></li>

                  <li class="li"><samp class="codeph nolang">Numeric</samp></li>

                  <li class="li"><samp class="codeph nolang">Text</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3919" data-title="Field Name"><span class="keyword parmname">defaultValue</span></td>

              <td class="entry" headers="d167858e3922" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3925" data-title="Description">Default value of the parameter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3919" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d167858e3922" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3925" data-title="Description">Description of the batch calculation job parameter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3919" data-title="Field Name"><span class="keyword parmname">isMultiValue</span></td>

              <td class="entry" headers="d167858e3922" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e3925" data-title="Description">Indicates whether the parameter has different values (<samp class="codeph nolang">True</samp>) or not (<samp class="codeph nolang">False</samp>). This field is supported only for the <samp class="codeph nolang">Text</samp> data type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3919" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e3922" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3925" data-title="Description">Required. Label of the batch calculation job parameter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e3919" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e3922" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e3925" data-title="Description">Required. Name of the batch calculation job parameter.</td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobSource​Join

Represents a collection of fields relating to a join node in a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e4091">Field Name</th>

              <th class="featureTableHeader  " id="d167858e4094">Field Type</th>

              <th class="featureTableHeader  " id="d167858e4097">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e4091" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d167858e4094" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4097" data-title="Description">Description of the join node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4091" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d167858e4094" data-title="Field Type">
                <a class="xref" href="#bcjjoinresultfieldID">BatchCalcJobJoin​ResultField</a>[]
              </td>

              <td class="entry" headers="d167858e4097" data-title="Description">Collection of fields in a join node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4091" data-title="Field Name"><span class="keyword parmname">hasLookUpMultipleValues</span></td>

              <td class="entry" headers="d167858e4094" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e4097" data-title="Description">Indicates whether the lookup join returns multiple values (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">Available in API version 67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4091" data-title="Field Name"><span class="keyword parmname">joinKeys</span></td>

              <td class="entry" headers="d167858e4094" data-title="Field Type">
                <a class="xref" href="#bcjjoinkeyID">BatchCalcJobJoin​Key</a>[]
              </td>

              <td class="entry" headers="d167858e4097" data-title="Description">Collection of mapping of fields from the primary source node and the second
                source node in a join node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4091" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e4094" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4097" data-title="Description">Required. Label of the join node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4091" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e4094" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4097" data-title="Description">Required. Name of the join node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4091" data-title="Field Name"><span class="keyword parmname">primarySourceName</span></td>

              <td class="entry" headers="d167858e4094" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4097" data-title="Description">Required. Name associated with the node as the primary source node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4091" data-title="Field Name"><span class="keyword parmname">secondarySourceName</span></td>

              <td class="entry" headers="d167858e4094" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4097" data-title="Description">Required. Name associated with the node as the secondary source node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4091" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d167858e4094" data-title="Field Type">BatchCalcJobSource​JoinType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e4097" data-title="Description">Required. Type of join specified between the primary source node and secondary
                source node. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">LeftOuter</samp></li>

                  <li class="li"><samp class="codeph nolang">RightOuter</samp></li>

                  <li class="li"><samp class="codeph nolang">Inner</samp></li>

                  <li class="li"><samp class="codeph nolang">Outer</samp></li>

                  <li class="li"><samp class="codeph nolang">Lookup</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobJoin​Key

Represents a collection of fields relating to a mapping of fields from the first source node and second source node in a join node of a data processing engine.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| primarySourceFieldName | string | Required. Mapped field name of the primary source node. |
| secondarySourceFieldName | string | Required. Mapped field name of the secondary source node. |

## BatchCalcJobJoin​ResultField

Represents a collection of fields relating to a set of resultant fields in a join node of a data processing engine.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| alias | string | Required. Name that subsequent nodes within the data processing engine definition use to refer to the resultant field. |
| sourceFieldName | string | Required. Name of field from the primary or secondary data source. |
| sourceName | string | Required. Source node of the primary or secondary data source. |

## BatchCalcJobTransform

Represents a collection of fields relating to a data transformation in a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e4463">Field Name</th>

              <th class="featureTableHeader  " id="d167858e4466">Field Type</th>

              <th class="featureTableHeader  " id="d167858e4469">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e4463" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d167858e4466" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4469" data-title="Description">The description of the batch calculation job transform.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4463" data-title="Field Name"><span class="keyword parmname">droppedFields</span></td>

              <td class="entry" headers="d167858e4466" data-title="Field Type">
                <a class="xref" href="#bcjtransformdroppedfieldID">BatchCalcJobTransform​DroppedField</a>[]
              </td>

              <td class="entry" headers="d167858e4469" data-title="Description">The collection of dropped fields in a data transformation. Available when the
                transformation type is <samp class="codeph nolang">Slice</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4463" data-title="Field Name"><span class="keyword parmname">expressionFields</span></td>

              <td class="entry" headers="d167858e4466" data-title="Field Type">
                <a class="xref" href="#bcjtransformaddedfieldID">BatchCalcJobTransform​AddedField</a>[]
              </td>

              <td class="entry" headers="d167858e4469" data-title="Description">The collection of formula fields in a data transformation. Available when the
                transformation type is <samp class="codeph nolang">Expression</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4463" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e4466" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4469" data-title="Description">Required. The label of the batch calculation job transform.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4463" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e4466" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4469" data-title="Description">Required. The name of the batch calculation job transform.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4463" data-title="Field Name"><span class="keyword parmname">orderBy</span></td>

              <td class="entry" headers="d167858e4466" data-title="Field Type">
                <a class="xref" href="#bcjorderbyfieldID">BatchCalcJobOrderByField</a>[]
              </td>

              <td class="entry" headers="d167858e4469" data-title="Description">A collection of fields that’s used to sort the records within each partition
                group.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4463" data-title="Field Name"><span class="keyword parmname">partitionBy</span></td>

              <td class="entry" headers="d167858e4466" data-title="Field Type">string[]</td>

              <td class="entry" headers="d167858e4469" data-title="Description">A group of fields that’s used to partition the source data into partition
                groups.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4463" data-title="Field Name"><span class="keyword parmname">sourceName</span></td>

              <td class="entry" headers="d167858e4466" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4469" data-title="Description">Required. Name of the source node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4463" data-title="Field Name"><span class="keyword parmname">transformType</span></td>

              <td class="entry" headers="d167858e4466" data-title="Field Type">BatchCalcJobTransform​Type (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e4469" data-title="Description">Required. The type of transformation. <p class="p">Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ComputeRelative—</samp>This transformation
                    calculates values based on values of the same partition group.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Expression</samp>—This transformation calculates
                    values based on existing values of fields in the same record.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Slice</samp>—This transformation removes fields
                    from the source node.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobTransform​DroppedField

Represents a collection of fields relating to a dropped field in a data transformation of a data processing engine.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| sourceFieldName | string | Required. Name of the field that is dropped. |

## BatchCalcJobTransform​AddedField

Represents a collection of fields relating to a formula in a data transformation of a data processing engine.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e4732">Field Name</th>

              <th class="featureTableHeader  " id="d167858e4735">Field Type</th>

              <th class="featureTableHeader  " id="d167858e4738">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e4732" data-title="Field Name"><span class="keyword parmname">alias</span></td>

              <td class="entry" headers="d167858e4735" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4738" data-title="Description">Required. Name that subsequent nodes within the data processing engine use to
                the transform node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4732" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d167858e4735" data-title="Field Type">BatchCalcJobDataType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e4738" data-title="Description">Required. Data type of the formula. <p class="p">Valid values are:</p>

                <a name="ul_u3x_bsm_rgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_u3x_bsm_rgc">
                  <li class="li">
                    <samp class="codeph nolang">Boolean</samp>—Available in API version
                    65.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">MultiValue</samp></li>

                  <li class="li"><samp class="codeph nolang">Numeric</samp></li>

                  <li class="li"><samp class="codeph nolang">Text</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4732" data-title="Field Name"><span class="keyword parmname">decimalPlaces</span></td>

              <td class="entry" headers="d167858e4735" data-title="Field Type">integer</td>

              <td class="entry" headers="d167858e4738" data-title="Description">Number of digits to the right of a decimal point in the value. Required for the
                <samp class="codeph nolang">Numeric</samp> data type.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4732" data-title="Field Name"><span class="keyword parmname">displayOrder</span></td>

              <td class="entry" headers="d167858e4735" data-title="Field Type">integer</td>

              <td class="entry" headers="d167858e4738" data-title="Description">The order in which this expression is evaluated in its parent formula node.
                Values start at 1 and must be continuous. This field can be null for legacy
                formulas.<p class="p">Available in API version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4732" data-title="Field Name"><span class="keyword parmname">expression</span></td>

              <td class="entry" headers="d167858e4735" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4738" data-title="Description">Required. Formula defined by the user.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4732" data-title="Field Name"><span class="keyword parmname">length</span></td>

              <td class="entry" headers="d167858e4735" data-title="Field Type">integer</td>

              <td class="entry" headers="d167858e4738" data-title="Description">Total length of the value including the decimal places. Required for data
                types: <samp class="codeph nolang">Text</samp> and <samp class="codeph nolang">Numeric</samp>.</td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobOrderByField

Represents a collection of fields that are used to sort the partitioned data.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e4906">Field Name</th>

              <th class="featureTableHeader  " id="d167858e4909">Field Type</th>

              <th class="featureTableHeader  " id="d167858e4912">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e4906" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e4909" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e4912" data-title="Description">Required. Name of the field that is used to sort data.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e4906" data-title="Field Name"><span class="keyword parmname">orderType</span></td>

              <td class="entry" headers="d167858e4909" data-title="Field Type">BatchCalcJobOrderType(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e4912" data-title="Description">Order in which the data is sorted. <p class="p">Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">Ascending</li>

                  <li class="li">Descending</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobUnion

Represents a collection of fields relating to the union of data from two nodes in a data processing engine.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Description of the batch calculation job union. |
| isDisjointedSchema | boolean | Indicates whether the union is of two disjointed datasets (true) or not (false). Set to True to allow joining of two datasets having no common fields. |
| label | string | Required. Label of the batch calculation job union. |
| name | string | Required. Name of the batch calculation job union. |
| sources | string\[\] | Names of the source nodes. |

## BatchCalcJobWriteback​Object

Represents a collection of fields relating to the object in which the results of the data processing engine are written back.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e5120">Field Name</th>

              <th class="featureTableHeader  " id="d167858e5123">Field Type</th>

              <th class="featureTableHeader  " id="d167858e5126">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">canWrtbckToNonEditableFields</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Indicates whether the non-editable fields are included in field mapping when
                the action type is upsert. The default value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version 64.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Descriptions of the batch calculation job writeback object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">externalId​FieldName</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Unique external field ID for the target object name. <p class="p">Available in API
                  version 60.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">
                <a class="xref" href="#bcjwritebackmappingID">BatchCalcJobWriteback​Mapping</a>[]
              </td>

              <td class="entry" headers="d167858e5126" data-title="Description">Collection of the writeback fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">filterCondition</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">The condition that filters the records from a writeback dataset for a user.
                Examples of a filter condition include a user ID, stage name, and a security policy
                that returns only the records that a user owns.<p class="p">Available in API version 57.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">folderName</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">The folder where the writeback dataset is saved. Available in API version 57.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">groupBy</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Reserved
                for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">isChangedRow</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Indicates whether a row in the write back object is changed. Set to <samp class="codeph nolang">True</samp> to write back the changed rows.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">isExistingDataset</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Indicates whether a CRM Application (CRMA) dataset or a <span class="ph">Data 360</span> Data Lake object is present (<samp class="codeph nolang">true</samp>) or will be created (<samp class="codeph nolang">false</samp>).
                Available in API version 62.0 and later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">jsonStructureType</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">JSON structure type for the writeback object.<p class="p">Available in API version 67.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Required. Name of the write back object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Required. Name of the batch calculation job write back object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">operationType</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">BatchCalcJobWriteback​Opn (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Type of operation specified. <p class="p">Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Delete</samp>—This value is available in API
                    version 56.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Insert</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Overwrite</samp>—Available only when
                    <span class="keyword parmname">storageType</span> is <samp class="codeph nolang">DataLakeObject</samp>. This value is available in API version 60.0 and
                    later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Update</samp></li>

                  <li class="li"><samp class="codeph nolang">Upsert</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">sharingInheritanceObjectName</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">The name of the source object from which the row-level sharing inheritance
                settings are applied. Available in API version 57.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">shouldCreateTargetObject</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Indicates whether target Data Lake Object or Salesforce Object is created in
                Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 65.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">shouldMngRow​LockFor​GroupedRec</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">sourceName</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Required. Name of the source node associated with the write back
                object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">storageType</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">BatchCalcJobWriteback​Type (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Specifies where you want to use the data stored in the source node. Available
                in API version 57.0 and later.<p class="p">Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Analytics</samp></li>
                  <li class="li"><samp class="codeph nolang">DataLakeObject</samp></li>
                  <li class="li"><samp class="codeph nolang">sObject</samp></li>

                </ul>

                <p class="p">The default value is <samp class="codeph nolang">sObject</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">targetObjectName</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Required. Object that is inserted or upserted by the data processing
                engine.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">targetObjectCategory</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Category of the target object for the writeback operation.<p class="p">Available in API
                  version 67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">writebackSequence</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">integer</td>

              <td class="entry" headers="d167858e5126" data-title="Description">Sequence in which the target object is updated by the data processing
                engine.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5120" data-title="Field Name"><span class="keyword parmname">writebackUser</span></td>

              <td class="entry" headers="d167858e5123" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5126" data-title="Description">ID of the user whose permissions decide which objects and fields of the target
                object can be updated.</td>

            </tr>

          </tbody>

        </table>

## BatchCalcJobWriteback​Mapping

Represents a collection of fields relating to the mapping between results and the fields in the target object.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d167858e5557">Field Name</th>

              <th class="featureTableHeader  " id="d167858e5560">Field Type</th>

              <th class="featureTableHeader  " id="d167858e5563">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d167858e5557" data-title="Field Name"><span class="keyword parmname">fieldType</span></td>

              <td class="entry" headers="d167858e5560" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5563" data-title="Description">Target field type on the writeback object. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">EventTimeField</samp>—Available in API version
                    67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ParentRecordIdentifierField</samp>—Available in
                    API version 67.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">PrimaryKey</samp></li>

                  <li class="li"><samp class="codeph nolang">QualifierKey</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">RecordIdentifierField</samp>—Available in API
                    version 67.0 and later.
                  </li>

                </ul>
                <p class="p">Available in API version 64.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5557" data-title="Field Name">isAutogenerated</td>

              <td class="entry" headers="d167858e5560" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e5563" data-title="Description">Indicates whether the target field value on the writeback object is
                autogenerated (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">Available in API version 64.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5557" data-title="Field Name"><span class="keyword parmname">parentName</span></td>

              <td class="entry" headers="d167858e5560" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5563" data-title="Description">Name of the lookup object. Required only when the <samp class="codeph nolang">relationshipName</samp> field is defined.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5557" data-title="Field Name"><span class="keyword parmname">relationshipName</span></td>

              <td class="entry" headers="d167858e5560" data-title="Field Type">string </td>

              <td class="entry" headers="d167858e5563" data-title="Description">Name of the lookup relationship.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5557" data-title="Field Name"><span class="keyword parmname">runtimeParameter</span></td>

              <td class="entry" headers="d167858e5560" data-title="Field Type">boolean</td>

              <td class="entry" headers="d167858e5563" data-title="Description">Indicates whether the source field from runtime parameter is <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>.
                The default value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API
                  version 59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5557" data-title="Field Name"><span class="keyword parmname">sourceFieldName</span></td>

              <td class="entry" headers="d167858e5560" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5563" data-title="Description">Required. Name of the field in the source node that is written back.</td>

            </tr>

            <tr>
              <td class="entry" headers="d167858e5557" data-title="Field Name"><span class="keyword parmname">targetFieldName</span></td>

              <td class="entry" headers="d167858e5560" data-title="Field Type">string</td>

              <td class="entry" headers="d167858e5563" data-title="Description">Name of the sObject field to which the results are written back.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a BatchCalcJobDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<BatchCalcJobDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <aggregates\>
        <description\>Aggregate Description</description\>
        <fields\>
            <aggregateFunction\>Count</aggregateFunction\>
            <alias\>NameCount</alias\>
            <sourceFieldName\>Name</sourceFieldName\>
        </fields\>
        <groupBy\>ContactId</groupBy\>
        <groupBy\>Name</groupBy\>
        <label\>AggregateOpportunities</label\>
        <name\>AggregateOpportunities</name\>
        <sourceName\>Opportunity</sourceName\>
    </aggregates\>
    <forecasts\>
        <description\>ForecastNode Description</description\>
        <label\>ContactForecast</label\>
        <name\>ContactForecast</name\>
        <sourceName\>Contact</sourceName\>
        <dateFieldName\>CreatedDate</dateFieldName\>
        <forecastPeriodType\>YearMonth</forecastPeriodType\>
        <shouldExcludeLastPeriod\>false</shouldExcludeLastPeriod\>
        <forecastPeriodCount\>12</forecastPeriodCount\>
        <periodStartDateName\>CreatedDateYM</periodStartDateName\>
        <forecastModelType\>Auto</forecastModelType\>
        <seasonality\>None</seasonality\>
        <accuracyPercent\>None</accuracyPercent\>
        <aggregationFields\>
            <aggregateFunction\>Count</aggregateFunction\>
            <aggregationResultLabel\>CountOfLastName</aggregationResultLabel\>
            <fieldName\>LastName</fieldName\>
        </aggregationFields\>
        <groupFields\>
            <fieldName\>LastModifiedDate</fieldName\>
            <groupBy\>Week</groupBy\>
        </groupFields\>
    </forecasts\>
    <appends\>
        <description\>Append desc</description\>
        <isDisjointedSchema\>true</isDisjointedSchema\>
        <label\>AppendAllAccounts</label\>
        <name\>AppendAllAccounts</name\>
        <sources\>AccountsOfManufacturingIndustry</sources\>
        <sources\>ComputeRelativeManufacturingIndustry</sources\>
    </appends\>
    <datasources\>
        <description\>Desc Contact</description\>
        <fields\>
            <alias\>Id</alias\>
            <name\>Id</name\>
            <isPrimaryKey\>false</isPrimaryKey\>
            <dataType\>Text</dataType\>
        </fields\>
        <fields\>
            <alias\>LastName</alias\>
            <name\>LastName</name\>
            <isPrimaryKey\>false</isPrimaryKey\>
            <dataType\>Text</dataType\>
        </fields\>
        <fields\>
            <alias\>CreatedDate</alias\>
            <name\>CreatedDate</name\>
            <isPrimaryKey\>false</isPrimaryKey\>
            <dataType\>Date</dataType\>
        </fields\>
        <fields\>
            <alias\>LastModifiedDate</alias\>
            <name\>LastModifiedDate</name\>
            <isPrimaryKey\>false</isPrimaryKey\>
            <dataType\>Date</dataType\>
        </fields\>
        <label\>Contact</label\>
        <name\>Contact</name\>
        <sourceName\>Contact</sourceName\>
        <type\>StandardObject</type\>
        <fileSource\>ContentManagement</fileSource\>
        <fileIdentifier\>069xx0000004CAeAAM</fileIdentifier\>
        <CSVDelimiter\>COMMA</CSVDelimiter\>
        <filePath\>parentFolder/childFolder</filePath\>
    </datasources\>
    <datasources\>
        <fields\>
            <alias\>Name</alias\>
            <name\>Name</name\>
            <isPrimaryKey\>false</isPrimaryKey\>
            <dataType\>Text</dataType\>
        </fields\>
        <fields\>
            <alias\>ContactId</alias\>
            <name\>ContactId</name\>
            <isPrimaryKey\>false</isPrimaryKey\>
            <dataType\>Text</dataType\>
        </fields\>
        <label\>Opportunity</label\>
        <name\>Opportunity</name\>
        <sourceName\>Opportunity</sourceName\>
        <type\>StandardObject</type\>
        <fileSource\>ContentManagement</fileSource\>
        <fileIdentifier\>069xx0000004CAeAAM</fileIdentifier\>
        <CSVDelimiter\>COMMA</CSVDelimiter\>
        <filePath\>parentFolder/childFolder</filePath\>
    </datasources\>
    <description\>Calculates and creates transaction journal records based on the orders placed by the loyalty program members. The transaction journals are used to accrue points to the member.</description\>
    <filters\>
        <criteria\>
            <operator\>Equals</operator\>
            <sequence\>1</sequence\>
            <sourceFieldName\>LastName</sourceFieldName\>
            <value\>Salesforce</value\>
        </criteria\>
        <description\>Filter Desc</description\>
        <filterCondition\>1</filterCondition\>
        <isDynamicFilter\>false</isDynamicFilter\>
        <label\>AccountsOfManufacturingIndustry</label\>
        <name\>AccountsOfManufacturingIndustry</name\>
        <sourceName\>AccountOpportunities</sourceName\>
    </filters\>
    <hierarchyPaths\>
        <description\>Hierarchy Path Node</description\>
        <hierarchyFieldName\>Hierarchy\_Path</hierarchyFieldName\>
        <isAggregationRequired\>true</isAggregationRequired\>
        <isSelfFieldValueIncluded\>true</isSelfFieldValueIncluded\>
        <label\>Get Hierarchy</label\>
        <name\>Get\_Hierarchy</name\>
        <parentFieldName\>ContactId</parentFieldName\>
        <selfFieldName\>LastName</selfFieldName\>
        <sourceName\>AppendAllAccounts</sourceName\>
        <aggregateFields\>
            <aggregateFunction\>Count</aggregateFunction\>
            <aggregationFieldName\>\*</aggregationFieldName\>
            <aggregateFieldAliasName\>CountOfLastName</aggregateFieldAliasName\>
        </aggregateFields\>
    </hierarchyPaths\>
    <isTemplate\>false</isTemplate\>
    <executionPlatformObjectType\>None</executionPlatformObjectType\>
    <joins\>
        <description\>Left Outer Join</description\>
        <fields\>
            <alias\>ContactId</alias\>
            <sourceFieldName\>Id</sourceFieldName\>
            <sourceName\>Contact</sourceName\>
        </fields\>
        <fields\>
            <alias\>LastName</alias\>
            <sourceFieldName\>LastName</sourceFieldName\>
            <sourceName\>Contact</sourceName\>
        </fields\>
        <fields\>
            <alias\>NameCount</alias\>
            <sourceFieldName\>NameCount</sourceFieldName\>
            <sourceName\>AggregateOpportunities</sourceName\>
        </fields\>
        <fields\>
            <alias\>OpportunityName</alias\>
            <sourceFieldName\>Name</sourceFieldName\>
            <sourceName\>AggregateOpportunities</sourceName\>
        </fields\>
        <joinKeys\>
            <primarySourceFieldName\>Id</primarySourceFieldName\>
            <secondarySourceFieldName\>ContactId</secondarySourceFieldName\>
        </joinKeys\>
        <label\>AccountOpportunities</label\>
        <name\>AccountOpportunities</name\>
        <primarySourceName\>Contact</primarySourceName\>
        <secondarySourceName\>AggregateOpportunities</secondarySourceName\>
        <type\>LeftOuter</type\>
    </joins\>
    <label\>Create Transaction Journals Based on Orders</label\>
    <parameters\>
        <dataType\>Date</dataType\>
        <defaultValue\>2020-01-01</defaultValue\>
        <description\>Desc TextParameter</description\>
        <isMultiValue\>false</isMultiValue\>
        <label\>DateParameter</label\>
        <name\>DateParameter</name\>
    </parameters\>
    <parameters\>
        <dataType\>Filter</dataType\>
        <defaultValue\>{&quot;filterCondition&quot;: &quot;1 AND 2&quot;, &quot;criteria&quot;: \[{&quot;sourceFieldName&quot;: &quot;NameCount&quot;,&quot;operator&quot;: &quot;GreaterThan&quot;,&quot;value&quot;: &quot;20&quot;,&quot;sequence&quot;: &quot;1&quot;}, {&quot;sourceFieldName&quot;: &quot;Name&quot;,&quot;operator&quot;: &quot;Equals&quot;,&quot;value&quot;: &quot;Salesforce&quot;,&quot;sequence&quot;: &quot;2&quot;}\]}</defaultValue\>
        <isMultiValue\>false</isMultiValue\>
        <label\>FilterParameter</label\>
        <name\>FilterParameter</name\>
    </parameters\>
    <parameters\>
        <dataType\>Numeric</dataType\>
        <defaultValue\>5000</defaultValue\>
        <description\>Desc TextParameter</description\>
        <isMultiValue\>false</isMultiValue\>
        <label\>NumericParameter</label\>
        <name\>NumericParameter</name\>
    </parameters\>
    <parameters\>
        <dataType\>Text</dataType\>
        <defaultValue\>@salesforce.com</defaultValue\>
        <description\>Desc TextParameter</description\>
        <isMultiValue\>false</isMultiValue\>
        <label\>TextParameter</label\>
        <name\>TextParameter</name\>
    </parameters\>
    <processType\>Rebates</processType\>
    <definitionRunMode\>Batch</definitionRunMode\>
    <status\>Inactive</status\>
    <transforms\>
        <description\>transforms Desc</description\>
        <expressionFields\>
            <alias\>NewLastName</alias\>
            <dataType\>Text</dataType\>
            <expression\>TODAY()</expression\>
            <length\>80</length\>
        </expressionFields\>
        <label\>ManufacturingIndustry</label\>
        <name\>ManufacturingIndustry</name\>
        <sourceName\>AccountsOfManufacturingIndustry</sourceName\>
        <transformationType\>Expression</transformationType\>
    </transforms\>
    <transforms\>
        <droppedFields\>
            <sourceFieldName\>NewLastName</sourceFieldName\>
        </droppedFields\>
        <label\>MediaIndustry</label\>
        <name\>MediaIndustry</name\>
        <sourceName\>ManufacturingIndustry</sourceName\>
        <transformationType\>Slice</transformationType\>
    </transforms\>
    <transforms\>
        <description\>compute relative transforms Desc</description\>
        <expressionFields\>
            <alias\>NewLastName</alias\>
            <dataType\>Text</dataType\>
            <expression\>rank()</expression\>
            <length\>80</length\>
        </expressionFields\>
        <label\>ComputeRelativeManufacturingIndustry</label\>
        <name\>ComputeRelativeManufacturingIndustry</name\>
        <orderBy\>
            <name\>LastName</name\>
            <orderType\>Ascending</orderType\>
        </orderBy\>
        <partitionBy\>LastName</partitionBy\>
        <sourceName\>MediaIndustry</sourceName\>
        <transformationType\>ComputeRelative</transformationType\>
    </transforms\>
    <customNodes\>
        <name\>RebatesCustomNode</name\>
        <label\>Rebates Custom Node</label\>
        <description\>customNodes Desc</description\>
        <sources\>Get\_Hierarchy</sources\>
        <extensionName\>RebatesExpression</extensionName\>
        <extensionNamespace\>industries\_mfg</extensionNamespace\>
        <parameters\>
            <name\>inputColumn</name\>
            <value\>LastName</value\>
        </parameters\>
        <parameters\>
            <name\>isFilterCriteria</name\>
            <value\>true</value\>
        </parameters\>
        <parameters\>
            <name\>outputColumn</name\>
            <value\>GenName</value\>
        </parameters\>
    </customNodes\>
    <writebacks\>
        <fields\>
            <sourceFieldName\>GenName</sourceFieldName\>
            <targetFieldName\>LastName</targetFieldName\>
        </fields\>
        <isChangedRow\>false</isChangedRow\>
        <label\>exportToContact</label\>
        <name\>exportToContact</name\>
        <description\>Export To Contact</description\>
        <operationType\>Insert</operationType\>
        <sourceName\>RebatesCustomNode</sourceName\>
        <targetObjectName\>Contact</targetObjectName\>
        <writebackSequence\>1</writebackSequence\>
        <canWrtbckToNonEditableFields\>false</canWrtbckToNonEditableFields\>
    </writebacks\>
    <writebacks\>
        <fields\>
            <sourceFieldName\>CreatedDateYM</sourceFieldName\>
            <targetFieldName\>CreatedDate</targetFieldName\>
        </fields\>
        <isChangedRow\>false</isChangedRow\>
        <isExistingDataset\>false</isExistingDataset\>
        <label\>exportToContactFC</label\>
        <name\>exportToContactFC</name\>
        <description\>Export To Contact</description\>
        <operationType\>Insert</operationType\>
        <sourceName\>ContactForecast</sourceName\>
        <targetObjectName\>Contact</targetObjectName\>
        <writebackSequence\>2</writebackSequence\>
        <canWrtbckToNonEditableFields\>false</canWrtbckToNonEditableFields\>
    </writebacks\>
</BatchCalcJobDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   ~ Copyright 2020 Salesforce, Inc.
   ~ All Rights Reserved
   ~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>BatchCalcJobDefinition</name\>
   </types\>
   <version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=d3855241c68d19b8cd268efef6283e39e915d2f586f2f0f17fffcc7925f8ac79 url=/legacydeveloper/current/en-us/api_meta/meta_batchprocessjobdefinition.md -->

# BatchProcessJobDefinition

Represents the details of a Batch Management job definition.

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

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

BatchProcessJobDefinition components have the suffix .batchProcessJobDefinition and are stored in the batchProcessJobDefinitions folder.

## Version

BatchProcessJobDefinition components are available in API version 51.0 and later.

## Special Access Rules

To know the products and user permissions needed to access this type, See [Supported Editions and Permissions for Batch Management](https://help.salesforce.com/s/articleView?id=ind.concept_batch_management_editions.htm&language=en_US).

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d185638e105">Field Name</th>

              <th class="featureTableHeader  " id="d185638e108">Field Type</th>

              <th class="featureTableHeader  " id="d185638e111">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">batchSize</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">integer</td>

              <td class="entry" headers="d185638e111" data-title="Description">Required. Number of records that each Batch Management job can process. Flow
                type Batch Management jobs can process up to 2000 records and Loyalty Program
                Process type Batch Management jobs can process up to 250 records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">dataSource</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">
                <a class="xref" href="#batchdatasourceID">BatchDataSource</a>[]
              </td>

              <td class="entry" headers="d185638e111" data-title="Description">Required. Source of information whose records must be processed by the Batch
                Management job.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e111" data-title="Description">Description of the Batch Management job, up to 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">executionProcessApiName</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e111" data-title="Description">API name of process that must be executed by the Batch Management job. This
                field is available in API version 55.0 and later.<ul class="ul bulletList">
                  <li class="li">If the batch job’s type is Flow, enter the API name of an active flow that the
                    batch job must execute.</li>

                  <li class="li">If the batch job’s type is Loyalty Program Process, enter:<ul class="ul bulletList">
                      <li class="li">Transaction_Journals if you want the batch job to process Transaction
                        Journal records by applying the applicable active loyalty program process of
                        the type TransactionJournal.</li>

                      <li class="li">API name of an active loyalty process of the type TierProcessing if you
                        want the batch job to run the loyalty program process to assess the tier of
                        eligible members. The API name consists of the name of the process, the
                        process type, and the name of the loyalty program separated by two
                        consecutive underscores. For example, the process API name is <samp class="codeph nolang">Update Member Tier__TierProcessing__Inner
                          Circle</samp> if the process name is Update Member Tier, the process
                        type is TierProcessing, and the loyalty program name is Inner Circle.</li>

                    </ul>
                  </li>

                </ul>
                <p class="p">You can use database-based APEX classes that let you use&nbsp;flex queues&nbsp;in the
                  Batch Management job, allowing to place more than 5 jobs in a queue. This
                  functionality is applicable to all Industry Clouds that use managed packages. See
                  <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.code_apex_flex_queue.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Apex
                    Flex Queue</a>.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">flowApiName</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e111" data-title="Description">API name of an active flow process that must be executed by the Batch
                Management job.<p class="p">You can either specify the flow API name in the <samp class="codeph nolang">executionProcessApiName</samp> field or in the <samp class="codeph nolang">flowApiName</samp> field.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">flowInputVariable</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e111" data-title="Description">Input variable of associated flow that is used by the batch job to uniquely
                identify records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e111" data-title="Description">Required. Name of the Batch Management job, up to 80 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">processGroup</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e111" data-title="Description">Required. Name of the group for which the Batch Management job processes
                records. </td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">retryCount</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">integer</td>

              <td class="entry" headers="d185638e111" data-title="Description">Required. Number of times this Batch Management job must be rerun in case it
                fails. The maximum retry count is 3. Valid values are 1–3.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">retryInterval</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">integer</td>

              <td class="entry" headers="d185638e111" data-title="Description">Required. Number of milliseconds after which the Batch Management job must be
                rerun in case it fails. Valid values are 1,000–10,000. </td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e111" data-title="Description">Indicates the status of the Batch Management job. Valid values are <samp class="codeph nolang">Active</samp> and <samp class="codeph nolang">Inactive</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e105" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d185638e108" data-title="Field Type">string (enumeration of type string)</td>

              <td class="entry" headers="d185638e111" data-title="Description">The type of process that the Batch Management job must execute. This field is
                available in API version 55.0 and later. Valid values are:<a name="ul_xv4_wfr_y3c"><!-- --></a>
                <ul class="ul bulletList" id="ul_xv4_wfr_y3c">
                  <li class="li"><samp class="codeph nolang">BulkUpdate</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Calc</samp>—Data Processing Engine
                  </li>

                  <li class="li"><samp class="codeph nolang">ConsumptionOveragesCalculation</samp></li>

                  <li class="li"><samp class="codeph nolang">DecisionTableRefresh</samp></li>

                  <li class="li"><samp class="codeph nolang">DeepCloneSalesAgreement</samp></li>

                  <li class="li"><samp class="codeph nolang">FlattenAccountIOUHierarchyBatchJob</samp></li>

                  <li class="li"><samp class="codeph nolang">Flow</samp></li>

                  <li class="li"><samp class="codeph nolang">EnergyUseRecordCreationBatchJob</samp></li>

                  <li class="li"><samp class="codeph nolang">EntitlementCreationBatchJob</samp></li>

                  <li class="li"><samp class="codeph nolang">HighScaleBreProcess</samp></li>

                  <li class="li"><samp class="codeph nolang">IndustriesLSCommercial</samp></li>

                  <li class="li"><samp class="codeph nolang">InvoiceDTPRunBatchJob</samp></li>

                  <li class="li"><samp class="codeph nolang">InvoiceRecoveryRunBatchJob</samp></li>

                  <li class="li"><samp class="codeph nolang">InvoiceRunBatchJob</samp></li>

                  <li class="li"><samp class="codeph nolang">LifeSciProviderActivityGoalSharingBatchJob</samp></li>

                  <li class="li"><samp class="codeph nolang">LoyaltyProgramProcess</samp></li>

                  <li class="li"><samp class="codeph nolang">NetUnitRateCalculation</samp></li>

                  <li class="li"><samp class="codeph nolang">NextGenCommitmentBatchProcessingJob</samp></li>

                  <li class="li"><samp class="codeph nolang">ManagerProvisioning</samp></li>

                  <li class="li"><samp class="codeph nolang">PbbToOptyConversion</samp></li>

                  <li class="li"><samp class="codeph nolang">ProductCatalogCacheRefresh</samp></li>

                  <li class="li"><samp class="codeph nolang">PromotionChannelPropagationBatchJob</samp></li>

                  <li class="li"><samp class="codeph nolang">RatableSummaryCreation</samp></li>

                  <li class="li"><samp class="codeph nolang">ServiceProcess</samp></li>

                  <li class="li"><samp class="codeph nolang">StoreAssortmentPropagationBatchJob</samp></li>

                  <li class="li"><samp class="codeph nolang">SummaryCreation</samp></li>

                  <li class="li"><samp class="codeph nolang">WorkDotComToHRManagerProvisioning</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## BatchDataSource

Represents the source of information whose records must be processed by the Batch Management job.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d185638e470">Field Name</th>

              <th class="featureTableHeader  " id="d185638e473">Field Type</th>

              <th class="featureTableHeader  " id="d185638e476">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d185638e470" data-title="Field Name"><span class="keyword parmname">condition</span></td>

              <td class="entry" headers="d185638e473" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e476" data-title="Description">Required. Criteria defined to filter the records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e470" data-title="Field Name"><span class="keyword parmname">criteria</span></td>

              <td class="entry" headers="d185638e473" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e476" data-title="Description">Type of filter criteria that’s used to filter records for processing.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e470" data-title="Field Name"><span class="keyword parmname">dataSourceType</span></td>

              <td class="entry" headers="d185638e473" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e476" data-title="Description">Type of data source that's used to create the batch job definition. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">SingleSobject</li>

                  <li class="li">MultiSobject</li>

                  <li class="li">File—Available in API version 67.0 and later.</li>

                </ul>
                <p class="p">Available in API version 64.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e470" data-title="Field Name"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d185638e473" data-title="Field Type">
                <a class="xref" href="#batchdatasrcfiltercriteriaID">BatchDataSrcFilterCriteria</a>[]
              </td>

              <td class="entry" headers="d185638e476" data-title="Description">Filter criterion that decides which records must be processed by the Batch
                Management job.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e470" data-title="Field Name">orderFields</td>

              <td class="entry" headers="d185638e473" data-title="Field Type"><a class="xref" href="#BatchDataSourceOrderField">BatchDataSourceOrderField</a></td>

              <td class="entry" headers="d185638e476" data-title="Description">Fields that are used to order the records before the records are added to a
                batch in a job.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e470" data-title="Field Name"><span class="keyword parmname">sourceObject</span></td>

              <td class="entry" headers="d185638e473" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e476" data-title="Description">Required. API name of an object whose records must be processed by the batch
                job. <p class="p">If the batch job type is Loyalty Program Process, the source object must
                  be:</p>
                <ul class="ul bulletList">
                  <li class="li">TransactionJournal if the batch job is used to process transaction journals by
                    applying the applicable loyalty program process.</li>

                  <li class="li">An object that stores the details of loyalty program members whose tier must
                    be assessed by the loyalty program process specified in the
                    executionProcessApiName field.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e470" data-title="Field Name"><span class="keyword parmname">sourceObjectField</span></td>

              <td class="entry" headers="d185638e473" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e476" data-title="Description">API name of the source object field that uniquely identifies records for which
                the batch job is executed. This field is available in API version 57.0 and
                later.<p class="p">This field is only applicable when the batch job’s type is Loyalty
                  Program Process and a TierProcess type active loyalty program process is specified
                  in the <span class="keyword parmname">executionProcessApiName</span> field. Specify the API name of
                  a field that is a lookup to the LoyaltyProgramMember object and uniquely
                  identifies the members whose tier must be assessed.</p>
              </td>

            </tr>

          </tbody>

        </table>

## BatchDataSrcFilterCriteria

Represents the filter conditions that decide which records must be processed by the Batch Management job.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d185638e643">Field Name</th>

              <th class="featureTableHeader  " id="d185638e646">Field Type</th>

              <th class="featureTableHeader  " id="d185638e649">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d185638e643" data-title="Field Name">domainObjectName</td>

              <td class="entry" headers="d185638e646" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e649" data-title="Description">Name of the object the field is associated with. Available in API version 64.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e643" data-title="Field Name"><span class="keyword parmname">dynamicValueType</span></td>

              <td class="entry" headers="d185638e646" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e649" data-title="Description">Data type of the input variable used as a filter. </td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e643" data-title="Field Name"><span class="keyword parmname">fieldName</span></td>

              <td class="entry" headers="d185638e646" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e649" data-title="Description">Required. Name of the field that must be used to filter records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e643" data-title="Field Name"><span class="keyword parmname">fieldPath</span></td>

              <td class="entry" headers="d185638e646" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e649" data-title="Description">Stores the path to a field in the object. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e643" data-title="Field Name"><span class="keyword parmname">fieldValue</span></td>

              <td class="entry" headers="d185638e646" data-title="Field Type">string</td>

              <td class="entry" headers="d185638e649" data-title="Description">Required. Value of the field that must be filtered. Specify the field if
                <samp class="codeph nolang">dynamicValue</samp> is set to <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e643" data-title="Field Name"><span class="keyword parmname">dynamicValue</span></td>

              <td class="entry" headers="d185638e646" data-title="Field Type">boolean</td>

              <td class="entry" headers="d185638e649" data-title="Description">Required. Indicates whether the filter criteria is dynamic.</td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e643" data-title="Field Name"><span class="keyword parmname">operator</span></td>

              <td class="entry" headers="d185638e646" data-title="Field Type">string <span class="ph" id="enum_link_component"><a name="enum_link_component"><!-- --></a>(enumeration of type string)</span>
              </td>

              <td class="entry" headers="d185638e649" data-title="Description">Required. Operator that is specified in the filter criteria. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">equals</samp></li>

                  <li class="li"><samp class="codeph nolang">excludes</samp></li>

                  <li class="li"><samp class="codeph nolang">greaterThan</samp></li>

                  <li class="li"><samp class="codeph nolang">greaterThanOrEqualTo</samp></li>

                  <li class="li"><samp class="codeph nolang">in</samp></li>

                  <li class="li"><samp class="codeph nolang">includes</samp></li>

                  <li class="li"><samp class="codeph nolang">lessThan</samp></li>

                  <li class="li"><samp class="codeph nolang">LessThanOrEqualTo</samp></li>

                  <li class="li"><samp class="codeph nolang">GreaterOrEqual</samp></li>

                  <li class="li"><samp class="codeph nolang">like</samp></li>

                  <li class="li"><samp class="codeph nolang">notEquals</samp></li>

                  <li class="li"><samp class="codeph nolang">notIn</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d185638e643" data-title="Field Name"><span class="keyword parmname">sequenceNo</span></td>

              <td class="entry" headers="d185638e646" data-title="Field Type">integer</td>

              <td class="entry" headers="d185638e649" data-title="Description">Required. Sequence number used to refer the criteria in a filter.</td>

            </tr>

          </tbody>

        </table>

## BatchDataSourceOrderField

Represents the fields that are used to group data.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| domainObjectName | string | Required. Name of the object the field is associated with. Available in API version 64.0 and later. |
| fieldName | string | Required. Name of the field that must be used to filter records. Available in API version 64.0 and later. |
| fieldPath | string | Required. Stores the path to a field in the object. Available in API version 64.0 and later. |

## Declarative Metadata Sample Definition

The following is an example of a BatchProcessJobDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<BatchProcessJobDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
   <batchSize\>10</batchSize\>
   <dataSource\>
      <condition\>1</condition\>
      <criteria\>all</criteria\>
      <filters\>
         <dynamicValue\>false</dynamicValue\>
         <dynamicValueType\>string</dynamicValueType\>
         <fieldName\>Name</fieldName\>
         <fieldValue\>abcd</fieldValue\>
         <operator\>equals</operator\>
         <sequenceNo\>1</sequenceNo\>
      </filters\>
      <sourceObject\>Account</sourceObject\>
   </dataSource\>
   <flowApiName\>Flow1</flowApiName\>
   <flowInputVariable\>recordId</flowInputVariable\>
   <masterLabel\>BatchJob1</masterLabel\>
   <processGroup\>Loyalty</processGroup\>
   <retryCount\>2</retryCount\>
   <retryInterval\>1000</retryInterval\>
   <status\>Inactive</status\>
   <description\>test</description\>
   <type\>Flow</type\>
   <executionProcessApiName\>testFlow</executionProcessApiName\>
</BatchProcessJobDefinition\>

The following is an example of a Flow object used in Metadata API.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   ~ Copyright 2020 Salesforce, Inc.
   ~ All Rights Reserved
   ~ Company Confidential
-->
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
   <apiVersion\>51.0</apiVersion\>
   <interviewLabel\>Flow1 {!$Flow.CurrentDateTime}</interviewLabel\>
   <label\>Flow1</label\>
   <processMetadataValues\>
      <name\>BuilderType</name\>
      <value\>
         <stringValue\>LightningFlowBuilder</stringValue\>
      </value\>
   </processMetadataValues\>
   <processMetadataValues\>
      <name\>OriginBuilderType</name\>
      <value\>
         <stringValue\>LightningFlowBuilder</stringValue\>
      </value\>
   </processMetadataValues\>
   <processType\>AutoLaunchedFlow</processType\>
   <recordLookups\>
      <name\>getAcc</name\>
      <label\>getAcc</label\>
      <locationX\>614</locationX\>
      <locationY\>465</locationY\>
      <assignNullValuesIfNoRecordsFound\>false</assignNullValuesIfNoRecordsFound\>
      <filterLogic\>and</filterLogic\>
      <filters\>
         <field\>Id</field\>
         <operator\>EqualTo</operator\>
         <value\>
            <elementReference\>recordId</elementReference\>
         </value\>
      </filters\>
      <getFirstRecordOnly\>true</getFirstRecordOnly\>
      <object\>Account</object\>
      <storeOutputAutomatically\>true</storeOutputAutomatically\>
   </recordLookups\>
   <start\>
      <locationX\>73</locationX\>
      <locationY\>213</locationY\>
      <connector\>
         <targetReference\>getAcc</targetReference\>
      </connector\>
   </start\>
   <status\>Draft</status\>
   <variables\>
      <name\>recordId</name\>
      <dataType\>String</dataType\>
      <isCollection\>false</isCollection\>
      <isInput\>true</isInput\>
      <isOutput\>false</isOutput\>
   </variables\>
</Flow\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>BatchProcessJobDefinition</name\>
   </types\>
   <types\>
      <members\>Flow1</members\>
      <name\>Flow</name\>
   </types\>
   <version\>51.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=02b35a7d7caab84050752a6cbccb418104a67e277fba48b3e5175cc75621f67f url=/legacydeveloper/current/en-us/api_meta/meta_billingsettings.md -->

# BillingSettings

Represents the settings for Salesforce Billing.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details.

## File Suffix and Directory Location

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

## Version

BillingSettings components are available in API version 62.0 and later.

## Special Access Rules

These settings are available when Billing is enabled.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| acctRecGlAccount | string | General ledger account to record the credit amount for unrealized or realized losses and the debit amount for unrealized or realized gains in transaction journals. Available in API version 64.0 and later. |
| billingContextDefinition | string | Name of the context definition that the [Create Billing Schedules for Orders API](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/connect_resources_create_billing_schedules.htm "HTML (New Window)") uses to understand your order data. Available in API version 64.0 and later. |
| billingContextSourceMapping | string | Name of the context mapping that links Order fields to billing transaction context nodes. Available in API version 64.0 and later. |
| billingIntraCtxtSrcMapping | string | Name of the custom context mapping that maps your custom or standard Order fields to billing transaction context nodes. Available in API version 64.0 and later. |
| defaultAPClosureDPEDefnName | string | Org-wide default value to specify the Data Processing Engine (DPE) definition to close legal entity accounting periods. Available in API version 64.0 and later. |
| defaultApplyCreditMemoFlow | string | Default flow that’s used to apply the credit memo to invoices. Available in API version 64.0 and later. |
| defaultBillingTreatment | string | Org-wide default value to specify the name of the billing treatment. Available in API version 64.0 and later. |
| defaultEmailTemplate | string | Default email template to send the generated invoice PDFs. Available in API version 64.0 and later. |
| defaultInvPreviewTemplate | string | Default template to generate PDFs of invoice previews. Available in API version 64.0 and later. |
| defaultInvoiceDocTemplate | string | Default template to generate PDFs of invoices. Available in API version 64.0 and later. |
| defaultLegalEntity | string | Org-wide default value to specify the name of the legal entity. Available in API version 64.0 and later. |
| defaultTaxTreatment | string | Org-wide default value to specify the name of the tax treatment. Available in API version 64.0 and later. |
| enableBillingDisputeManagement | boolean | Indicates whether to enable Dispute Management (true) or not (false). The default value is false. Available in API version 66.0 and later. |
| enableBillingForecast | boolean | Indicates whether to enable billing forecasts (true) or not (false). The default value is false. Available in API version 68.0 and later. |
| enableBillingSetup | boolean | Indicates whether to enable Billing setting (true) or not (false). The default value is false. |
| enableCreditMemoSequenceService | boolean | Indicates whether to mandate the application of sequence policy for credit memos (true) or not (false). The default value is false. Available in API version 66.0 and later with Revenue Cloud Billing. |
| enableCrMemoApplicationToPostedInvoices | boolean | Indicates whether to enable Apply Credits to Posted Invoices setting (true) or not (false). The default value is false. This setting automates settlement of invoices through application of credits to posted invoices. The credit application level determines whether credits are automatically applied to invoices or invoice lines. |
| enableFailedPaymentsRetry | boolean | Indicates whether to retry failed payment schedule items automatically based on the defined payment retry rules (true) or not (false). The default value is false. Available in API version 66.0 and later. |
| enableForeignExchangeTrxnJrnlCreation | boolean | Indicates whether to create Transaction Journal records for invoices that hold balance amounts (partially settled and not fully settled posted invoices) to record foreign exchange unrealized gains or losses during the closure activity of a legal entity accounting period. The default value is false. Available in API version 65.0 and later with Revenue Cloud Billing. |
| enableInvoiceEmailDelivery | boolean | Indicates whether to enable Configure Email Delivery Settings (true) or not (false). The default value is false. Available in API version 63.0 and later with Revenue Cloud Billing. |
| enableInvoicePdfGeneration | boolean | Indicates whether to enable Document Generation setting (true) or not (false). The default value is false. Available in API version 63.0 and later with Revenue Cloud Billing. |
| enableInvoiceSequenceService | boolean | Indicates whether to mandate the application of sequence policy for posted invoices (true) or not (false). The default value is false. If enabled, each posted invoice is assigned an invoice number. Available in API version 65.0 and later with Revenue Cloud Billing. |
| enableNegInvoiceLnConversionToCrMemoLn | boolean | Indicates whether to enable Convert Negative Invoice Lines to Credit Memo Lines setting (true) or not (false). The default value is false. |
| enablePaymentSchedulesAndItemsCreation | boolean | Indicates whether to create a default payment schedule policy and payment schedule treatment (true) or not (false). The default value is false. If enabled, payment schedules and payment schedule items are created during financial transactions such as posting of invoices. Available in API version 64.0 and later with Revenue Cloud Billing. |
| enableRefundIssuingAndBalanceSettlement | boolean | Indicates whether to issue refunds and settle balances (true) or not (false). The default value is false. If enabled, refunds are issued and credit memos are applied to any remaining invoice balance when customers amend or cancel an order. Available in API version 67.0 and later. |
| enableTransactionJournalCreation | boolean | Indicates whether to create Transaction Journal records based on the defined general ledger account assignment rules for the billing entities when billing transaction records are created or updated ( true ) or not ( false ). The default value is false. Available in API version 63.0 and later with Revenue Cloud Billing. Billing transaction records include these transaction types. |
| enableTransactionsApplicationToInvoices | boolean | Indicates whether to enable Credit Application Level setting (true) or not (false). The default value is false. **Revenue Cloud Advanced:** This setting applies balances of credit memos to invoices or balances of credit memo lines to invoice lines. For the latter, amounts and balances on the invoices are rolled-up from the related invoice lines. **Revenue Cloud Billing:** This setting applies balances of credit memos and payments to invoices or balances of credit memo lines and payments lines to invoice lines. For the latter, amounts and balances on the invoices are rolled-up from the related invoice lines. |
| enableTrxnAmountsStorageInCorpCurrency | boolean | Indicates whether to allow conversion of amounts of the Invoice, Invoice Line, Credit Memo, and Credit Memo Line records to your corporate currency (true) or not (false). The default value is false. Available in API version 63.0 and later. Store the converted amounts in corporate currency-specific amount fields. |
| realisedGainGlAccount | string | Name of the general ledger account to record realized gains in transaction journals. Available in API version 64.0 and later. |
| realisedLossGlAccount | string | Name of the general ledger account to record realized losses in transaction journals. Available in API version 64.0 and later. |
| ruleBasedCrAndPymtAppln | string | Automates the settlement of the posted invoices by applying payments and credits that meet the specified application rules. The rules application level determines whether payments or credits are applied first to the invoices. The ruleset displays a list of selectable rules. Available in API version 66.0 and later. |
| unrealisedGainGlAccount | string | Name of the general ledger account to record unrealized gains in transaction journals. Available in API version 64.0 and later. |
| unrealisedLossGlAccount | string | Name of the general ledger account to record unrealized losses in transaction journals. Available in API version 64.0 and later. |

enableTransactionJournalCreation values:

- Invoice
- Invoice Line
- Invoice Line Tax
- Credit Memo
- Credit Memo Line
- Credit Memo Line Tax
- Payment
- Refund
- Payment Line Invoice
- Payment Line Invoice Line
- Credit Memo Inv Application
- Credit Memo Line Invoice Line

## Declarative Metadata Sample Definition

The following is an example of a BillingSettings component.

<BillingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableBillingForecast\>true</enableBillingForecast\>
    <enableBillingSetup\>true</enableBillingSetup\>
    <enableForeignExchangeTrxnJrnlCreation\>true</enableForeignExchangeTrxnJrnlCreation\>
    <enableInvoicePdfGeneration\>true</enableInvoicePdfGeneration\>
    <enableTransactionsApplicationToInvoices\>true</enableTransactionsApplicationToInvoices\>
    <enableCrMemoApplicationToPostedInvoices\>true</enableCrMemoApplicationToPostedInvoices\>
    <enableInvoiceEmailDelivery\>true</enableInvoiceEmailDelivery\>
    <enableInvoiceSequenceService\>true</enableInvoiceSequenceService\>
    <enableTransactionJournalCreation\>true</enableTransactionJournalCreation\>
    <enableTrxnAmountsStorageInCorpCurrency\>true</enableTrxnAmountsStorageInCorpCurrency\>
    <enablePaymentSchedulesAndItemsCreation\>true</enablePaymentSchedulesAndItemsCreation\>
</BillingSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Billing</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)"). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=37e3449b093a501ea5dafaa2832db386b94d2801df429b12f90981fd504901ad url=/legacydeveloper/current/en-us/api_meta/meta_blacklistedconsumer.md -->

# BlacklistedConsumer

Represents a connected app that is inaccessible to your Salesforce org’s users. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

BlacklistedConsumer components have the suffix .blacklistedConsumer and are stored in the blacklistedConsumers folder.

## Version

BlacklistedConsumer components are available in API version 49.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d188444e94">Field Name</th>

              <th class="featureTableHeader  " id="d188444e97">Field Type</th>

              <th class="featureTableHeader  " id="d188444e100">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d188444e94" data-title="Field Name"><span class="keyword parmname">blockedByApiWhitelisting</span></td>

              <td class="entry" headers="d188444e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d188444e100" data-title="Description">Set to <samp class="codeph nolang">true</samp> to apply the Permitted Users
                policy, <span class="keyword parmname">Admin approved users are pre-authorized</span> to all
                connected apps in the org. This policy limits access to only users with the
                associated profile or permission set assigned to the app. Set to <samp class="codeph nolang">false</samp> to allow access to the connected
                app. False is
                the default value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188444e94" data-title="Field Name"><span class="keyword parmname">consumerKey</span></td>

              <td class="entry" headers="d188444e97" data-title="Field Type">string</td>

              <td class="entry" headers="d188444e100" data-title="Description">Required. A value used by the consumer for identification of the connected app
                to Salesforce. Referred to as <samp class="codeph nolang">client_id</samp> in
                OAuth 2.0.<p class="p">After you define and save the value, it can’t be edited. The value must
                  be alphanumeric, can’t contain special characters or spaces, and must be between
                  8–256 characters. Consumer keys must be globally unique.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d188444e94" data-title="Field Name"><span class="keyword parmname">consumerName</span></td>
              <td class="entry" headers="d188444e97" data-title="Field Type">string</td>
              <td class="entry" headers="d188444e100" data-title="Description">Required. The name of the connected app being blocked.</td>
            </tr>

            <tr>
              <td class="entry" headers="d188444e94" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d188444e97" data-title="Field Type">string</td>

              <td class="entry" headers="d188444e100" data-title="Description">Required. The primary label for the connected app record.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a component.

<BlacklistedConsumer xmlns="http://soap.sforce.com/2006/04/metadata">
    <consumerKey\>testConsumerKey</consumerKey\>
    <consumerName\>testName</consumerName\>
    <blockedByApiWhitelisting\>false</blockedByApiWhitelisting\>
    <masterLabel\>myTest</masterLabel\>
</BlacklistedConsumer\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>BlacklistedConsumer</name>
    </types>
    <version>49.0</version>
</Package>

## Usage

Use this type judiciously for connected apps that you want to make inaccessible to your org’s users. Blocking an app ends all current user sessions and prevents future sessions. To block malicious attempts to access your org’s data, we recommend using API Access Control instead. This feature restricts users from accessing your Salesforce APIs unless they are pre-authorized through an approved connected app.

<!-- document id=fb207c595a90ad6d459222053cedac9600a0e27462ad6443da2f22f631fd6276 url=/legacydeveloper/current/en-us/api_meta/meta_bot.md -->

# Bot

Represents a definition of an Einstein Bot configuration that can have one or more versions. Only one version can be active.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

Bot components have the suffix .bot and are stored in the bots folder.

## Version

Bot components are available in API version 43.0 and later.

## Special Access Rules

Bot is available only if Chat and Einstein Bots are enabled in your org.

Bot metadata deployment and retrieval are not supported for Lead Nurturing and Sales Coach Agents.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d188907e106">Field Name</th>

              <th class="featureTableHeader  " id="d188907e109">Field Type</th>

              <th class="featureTableHeader  " id="d188907e112">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">agentDSLEnabled</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">boolean</td>

              <td class="entry" headers="d188907e112" data-title="Description">Reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">agentTemplate</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e112" data-title="Description"> If this Bot represents an agent, this field represents the name of the agent template used to create it. Available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">agentType</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">GenAiAgentType (enumeration of type string)</td>

              <td class="entry" headers="d188907e112" data-title="Description">Specifies the agent type for this agent. For example, <samp class="codeph nolang">AgentforceServiceAgent</samp>. Available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">botMlDomain</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type"><a class="xref" href="#LocalMlDomain">LocalMlDomain</a></td>

              <td class="entry" headers="d188907e112" data-title="Description">Represents the Einstein intent set that groups intents, entities,
                and variables associated with a bot. All Einstein Bot versions under
                the same bot now share an intent set. Available in API version 44.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">botUser</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e112" data-title="Description">Specifies the username of the user account, not the first and
                last name or the user ID. Available in API version 46.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">botVersions</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_botversion.htm" title="Represents the configuration details for a specific Einstein Bot version, including dialogs and variables.">BotVersion</a></td>

              <td class="entry" headers="d188907e112" data-title="Description">Represents the configuration details for a specific Einstein Bots
                version, including dialogs, intents, entities, and
                variables.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">contextVariables</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type"><a class="xref" href="#ConversationContextVariable">ConversationContextVariable</a></td>

              <td class="entry" headers="d188907e112" data-title="Description">Represents the context variables that enable your bot to gather
                customer information regardless of channel. Available in API 45.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">conversationChannelProviders</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type"><a class="xref" href="#ConversationDefinitionChannelProvider">ConversationDefinitionChannelProvider []</a></td>

              <td class="entry" headers="d188907e112" data-title="Description">Represents a list of the conversation channels linked to the bot.
                Available in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">defaultOutboundFlow</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e112" data-title="Description">Specifies a fallback escalation behavior if the primary agent escalation
                behavior is not available. For example, Agentforce Service Agents
                can route conversations to human service reps. Available in API
                version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e112" data-title="Description">A description of the bot.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e112" data-title="Description">Label that identifies the bot throughout the Salesforce user
                interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">logPrivateConversationData</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">boolean</td>

              <td class="entry" headers="d188907e112" data-title="Description">Specifies whether to log customer inputs as part of conversation
                data (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version
                48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">pageContextVariables</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">
                <a class="xref" href="#PageContextVariable">PageContextVariable</a>[]
              </td>

              <td class="entry" headers="d188907e112" data-title="Description">Provides page-level context variables for the bot. Available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name">sessionTimeout</td>

              <td class="entry" headers="d188907e109" data-title="Field Type">int</td>

              <td class="entry" headers="d188907e112" data-title="Description">Represents the maximum amount of minutes that a bot session can
                be idle. Available in API version 58.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e106" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d188907e109" data-title="Field Type">BotType (enumeration of type string)</td>

              <td class="entry" headers="d188907e112" data-title="Description"> Required. The default value is <samp class="codeph nolang">Bot</samp>. This field represents the configuration type of
                the bot. Valid values are:<a name="ul_arl_x31_n2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_arl_x31_n2c">
                  <li class="li">
                    <samp class="codeph nolang">Bot</samp>— Default
                    Einstein Bot configuration.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ExternalCopilot</samp>—
                    An external-facing agent. For example, an Agentforce Service
                    agent.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">InternalCopilot</samp>—
                    An internal-facing agent. For example, an Agentforce
                    Employee agent.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## LocalMlDomain

An Einstein Intent Set local to the current bot version.

| Field Name | Field Type | Description |
| --- | --- | --- |
| label | string | Label that represents an Einstein Intent Set local to the current bot version throughout the Salesforce user interface. |
| mlIntents | [MlIntent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mldomain.htm#MlIntent)\[\] | List of intents associated with this local intent set. |
| mlSlotClasses | [MlSlotClass](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mldomain.htm#MlSlotClass)\[\] | List of entities associated with this local intent set. |
| name | string | Required. This unique name prevents conflicts with other local Einstein Intent Sets. This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. |

## ConversationContextVariable

A context variable local to the current bot version. Available in API version 45.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d188907e483">Field Name</th>

              <th class="featureTableHeader  " id="d188907e486">Field Type</th>

              <th class="featureTableHeader  " id="d188907e489">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d188907e483" data-title="Field Name"><span class="keyword parmname">contextVariableMappings</span></td>

              <td class="entry" headers="d188907e486" data-title="Field Type"><a class="xref" href="#ConversationContextVariableMapping">ConversationContextVariableMapping</a></td>

              <td class="entry" headers="d188907e489" data-title="Description">Represents the mapping between a context variable, channel type,
                and sObject field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e483" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d188907e486" data-title="Field Type">ConversationDataType (enumeration of type string)</td>

              <td class="entry" headers="d188907e489" data-title="Description">Required. Represents the data type of the context variable. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Text</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Object</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Id</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e483" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d188907e486" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e489" data-title="Description">A description of this variable. This value may be used by the
                Agentforce planner service. Available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e483" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d188907e486" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e489" data-title="Description">Required. Represents the name of the context variable. Can
                contain only underscores and alphanumeric characters and must be
                unique in your org. It must begin with a letter, not include spaces,
                not end with an underscore, and not contain two consecutive
                underscores.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e483" data-title="Field Name"><span class="keyword parmname">includeInPrompt</span></td>

              <td class="entry" headers="d188907e486" data-title="Field Type">boolean</td>

              <td class="entry" headers="d188907e489" data-title="Description">Indicates whether the variable is injected into the prompt sent
                to the Agentforce model. If <samp class="codeph nolang">true</samp>, the variable appears in the <strong class="ph uicontrol">Included
                  Fields</strong> section of the UI. <div class="box message info" id="note_nzc_tsr_qhc">
                  <a name="note_nzc_tsr_qhc"><!-- --></a>
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p> The default variables <samp class="codeph nolang">Id</samp>, <samp class="codeph nolang">EndUserId</samp>, and <samp class="codeph nolang">EndUserLanguage</samp> always appear in the
                            <strong class="ph uicontrol">Included Fields</strong> section of the UI,
                            regardless of their value of <samp class="codeph nolang">includeInPrompt</samp>. We recommend that you don't
                            change the value of <samp class="codeph nolang">includeInPrompt</samp> for these default variables, as
                            changing the value can prevent your agent from accessing
                            important session data.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
                Available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e483" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d188907e486" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e489" data-title="Description">Required. A label that identifies the context variable throughout
                the Salesforce user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e483" data-title="Field Name"><span class="keyword parmname">SObjectType</span></td>

              <td class="entry" headers="d188907e486" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e489" data-title="Description">Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">BotDefinition</samp></li>

                  <li class="li"><samp class="codeph nolang">Queue</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ConversationContextVariableMapping

Represents the mapping between a context variable, channel type, and sObject field.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d188907e686">Field Name</th>

              <th class="featureTableHeader  " id="d188907e689">Field Type</th>

              <th class="featureTableHeader  " id="d188907e692">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d188907e686" data-title="Field Name"><span class="keyword parmname">fieldName</span></td>

              <td class="entry" headers="d188907e689" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e692" data-title="Description">Required. The API name of an SObject field to be used as part of
                the mapping.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e686" data-title="Field Name"><span class="keyword parmname">messageType</span></td>

              <td class="entry" headers="d188907e689" data-title="Field Type">MessageType (enumeration of type string)</td>

              <td class="entry" headers="d188907e692" data-title="Description">Required. Represents the message channel. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Alexa</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">AppleBusinessChat</samp>—Messages sent in enhanced Apple
                    Messages for Business channels.
                  </li>

                  <li class="li"><samp class="codeph nolang">Email</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">EmbeddedMessaging</samp>—Messages sent in Messaging for
                    In-App and Web channels. Available in API version 50.0 and
                    later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Facebook</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">GoogleChat</samp>—Available in
                    API version 68.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">GoogleHome</samp></li>

                  <li class="li"><samp class="codeph nolang">InternalCopilot</samp></li>

                  <li class="li"><samp class="codeph nolang">Line</samp></li>

                  <li class="li"><samp class="codeph nolang">MsCopilot</samp></li>

                  <li class="li"><samp class="codeph nolang">Omega</samp></li>

                  <li class="li"><samp class="codeph nolang">Phone</samp></li>

                  <li class="li"><samp class="codeph nolang">PstnVoice</samp></li>

                  <li class="li"><samp class="codeph nolang">Rcs</samp></li>

                  <li class="li"><samp class="codeph nolang">SipVoice</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Slack</samp>—Available in API
                    version 68.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Text</samp></li>

                  <li class="li"><samp class="codeph nolang">VoiceIntegrationPilot</samp></li>

                  <li class="li"><samp class="codeph nolang">WeChat</samp></li>

                  <li class="li"><samp class="codeph nolang">WebChat</samp></li>

                  <li class="li"><samp class="codeph nolang">WhatsApp</samp></li>

                  <li class="li"><samp class="codeph nolang">WhatsAppVoice</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e686" data-title="Field Name"><span class="keyword parmname">SObjectType</span></td>

              <td class="entry" headers="d188907e689" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e692" data-title="Description">Required. SObject type for the field property defined as part of
                the mapping. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">LiveChatTranscript</samp></li>

                  <li class="li"><samp class="codeph nolang">MessagingEndUser</samp></li>

                  <li class="li"><samp class="codeph nolang">MessagingSession</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ConversationDefinitionChannelProvider

The developer name of a conversation channel linked to the bot. Available in API version 51.0 and later.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

To add, edit, or remove a messaging channel, you must use the UI. If you deploy a bot with messaging channel providers, those providers aren’t visible in Metadata API.

| Field Name | Field Type | Description |
| --- | --- | --- |
| agentRequired | boolean | Specifies whether an agent must be online for the bot to be active (true) or not (false) The default is false. |
| chatButtonName | string | Required. The developer name of a LiveChatButton metadata component. |

## PageContextVariable

A page-level context variable used by the bot. Available in API version 64.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d188907e951">Field Name</th>

              <th class="featureTableHeader  " id="d188907e954">Field Type</th>

              <th class="featureTableHeader  " id="d188907e957">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d188907e951" data-title="Field Name"><span class="keyword parmname">SObjectType</span></td>

              <td class="entry" headers="d188907e954" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e957" data-title="Description">Specifies the sObject type associated with this page context variable.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e951" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d188907e954" data-title="Field Type">ConversationDataType (enumeration of type string)</td>

              <td class="entry" headers="d188907e957" data-title="Description">Required. Represents the data type of the page context variable. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Text</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Object</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Id</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e951" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d188907e954" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e957" data-title="Description">A description of the page context variable.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e951" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d188907e954" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e957" data-title="Description">Required. Represents the unique API name of the page context variable. Can
                contain only underscores and alphanumeric characters and must be unique in your
                org. It must begin with a letter, not include spaces, not end with an underscore,
                and not contain two consecutive underscores.</td>

            </tr>

            <tr>
              <td class="entry" headers="d188907e951" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d188907e954" data-title="Field Type">string</td>

              <td class="entry" headers="d188907e957" data-title="Description">Required. A label that identifies the page context variable throughout the Salesforce
                user interface.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a Bot. This example has been trimmed to make it easier to read.

<?xml version="1.0" encoding="UTF-8"?>
<Bot xmlns="http://soap.sforce.com/2006/04/metadata">
    <botMlDomain\>
        <label\>Astros Pizza</label\>
        <mlIntents\>
            <developerName\>New\_Order</developerName\>
            <label\>New Order</label\>
            <mlIntentUtterances\>
                <utterance\>Today is pie day so I want pie</utterance\>
            </mlIntentUtterances\>
        </mlIntents\>
        <mlSlotClasses\>
            <developerName\>Size</developerName\>
            <extractionType\>Value</extractionType\>
            <label\>Size</label\>
            <mlSlotClassValues\>
                <synonymGroup\>
                    <languages\>en\_US</languages\>
                    <terms\>Big</terms\>
                    <terms\>Extra Large</terms\>
                    <terms\>X-Large</terms\>
                    <terms\>Grande</terms\>
                    <terms\>Huge</terms\>
                </synonymGroup\>
                <value\>Large</value\>
            </mlSlotClassValues\>
        </mlSlotClasses\>
        <name\>Astros\_Pizza\_ld1</name\>
    </botMlDomain\>
    <botVersions\>
        <fullName\>v1</fullName\>
        <botDialogGroups\>
            <developerName\>Order\_Management</developerName\>
            <label\>Order Management</label\>
        </botDialogGroups\>
        <botDialogs\>
            <botDialogGroup\>Order\_Management</botDialogGroup\>
            <botSteps\>
                <botMessages\>
                    <message\>🍕🍕🍕Pizza Time! 🍕🍕🍕</message\>
                </botMessages\>
                <type\>Message</type\>
            </botSteps\>
            <botSteps\>
                <botStepConditions\>
                    <leftOperandName\>Verified\_User</leftOperandName\>
                    <leftOperandType\>ConversationVariable</leftOperandType\>
                    <operatorType\>Equals</operatorType\>
                    <rightOperandValue\>false</rightOperandValue\>
                </botStepConditions\>
                <botSteps\>
                    <botNavigation\>
                        <botNavigationLinks\>
                            <targetBotDialog\>Customer\_Verification</targetBotDialog\>
                        </botNavigationLinks\>
                        <type\>Call</type\>
                    </botNavigation\>
                    <type\>Navigation</type\>
                </botSteps\>
                <type\>Group</type\>
            </botSteps\>
            <botSteps\>
                <botStepConditions\>
                    <leftOperandName\>Location</leftOperandName\>
                    <leftOperandType\>ConversationVariable</leftOperandType\>
                    <operatorType\>IsNotSet</operatorType\>
                </botStepConditions\>
                <botSteps\>
                    <botNavigation\>
                        <botNavigationLinks\>
                            <targetBotDialog\>Select\_Location</targetBotDialog\>
                        </botNavigationLinks\>
                        <type\>Call</type\>
                    </botNavigation\>
                    <type\>Navigation</type\>
                </botSteps\>
                <type\>Group</type\>
            </botSteps\>
            <botSteps\>
                <botVariableOperation\>
                    <botInvocation\>
                        <invocationActionName\>CreateOrderService</invocationActionName\>
                        <invocationActionType\>apex</invocationActionType\>
                        <invocationMappings\>
                            <parameterName\>customer</parameterName\>
                            <type\>Input</type\>
                            <variableName\>Contact</variableName\>
                            <variableType\>ConversationVariable</variableType\>
                        </invocationMappings\>
                        <invocationMappings\>
                            <parameterName\>location</parameterName\>
                            <type\>Input</type\>
                            <variableName\>Location</variableName\>
                            <variableType\>ConversationVariable</variableType\>
                        </invocationMappings\>
                        <invocationMappings\>
                            <parameterName\>output</parameterName\>
                            <type\>Output</type\>
                            <variableName\>Pizza\_Order</variableName\>
                            <variableType\>ConversationVariable</variableType\>
                        </invocationMappings\>
                    </botInvocation\>
                    <type\>Set</type\>
                </botVariableOperation\>
                <type\>VariableOperation</type\>
            </botSteps\>
            <botSteps\>
                <botMessages\>
                    <message\>Perfect, let&apos;s work on your order from our {!Location.Name} location</message\>
                </botMessages\>
                <type\>Message</type\>
            </botSteps\>
            <botSteps\>
                <botNavigation\>
                    <botNavigationLinks\>
                        <targetBotDialog\>Add\_Items\_to\_Order</targetBotDialog\>
                    </botNavigationLinks\>
                    <type\>Redirect</type\>
                </botNavigation\>
                <type\>Navigation</type\>
            </botSteps\>
            <developerName\>New\_Order</developerName\>
            <label\>New Order</label\>
            <mlIntent\>New\_Order</mlIntent\>
            <showInFooterMenu\>false</showInFooterMenu\>
        </botDialogs\>
        <conversationVariables\>
            <dataType\>Object</dataType\>
            <developerName\>Contact</developerName\>
            <label\>Contact</label\>
        </conversationVariables\>
        <conversationVariables\>
            <dataType\>Text</dataType\>
            <developerName\>Delivery\_Address</developerName\>
            <label\>Delivery Address</label\>
        </conversationVariables\>
        <conversationVariables\>
            <dataType\>Object</dataType\>
            <developerName\>Pizza\_Order</developerName\>
            <label\>Pizza Order</label\>
        </conversationVariables\>
        <entryDialog\>Welcome</entryDialog\>
        <mainMenuDialog\>Main\_Menu</mainMenuDialog\>
    </botVersions\>
    <contextVariables\>
        <contextVariableMappings\>
            <SObjectType\>LiveChatTranscript</SObjectType\>
            <fieldName\>LiveChatTranscript.ChatKey</fieldName\>
            <messageType\>WebChat</messageType\>
        </contextVariableMappings\>
        <dataType\>Text</dataType\>
        <developerName\>ChatKey</developerName\>
        <label\>Chat Key</label\>
    </contextVariables\>
    <contextVariables\>
        <contextVariableMappings\>
            <SObjectType\>LiveChatTranscript</SObjectType\>
            <fieldName\>LiveChatTranscript.ContactId</fieldName\>
            <messageType\>WebChat</messageType\>
        </contextVariableMappings\>
        <dataType\>Id</dataType\>
        <developerName\>ContactId</developerName\>
        <label\>Contact Id</label\>
    </contextVariables\>
    <contextVariables\>
        <contextVariableMappings\>
            <SObjectType\>LiveChatTranscript</SObjectType\>
            <fieldName\>LiveChatTranscript.LiveChatVisitorId</fieldName\>
            <messageType\>WebChat</messageType\>
        </contextVariableMappings\>
        <dataType\>Id</dataType\>
        <developerName\>EndUserId</developerName\>
        <label\>End User Id</label\>
    </contextVariables\>
    <contextVariables\>
        <contextVariableMappings\>
            <SObjectType\>LiveChatTranscript</SObjectType\>
            <fieldName\>LiveChatTranscript.Id</fieldName\>
            <messageType\>WebChat</messageType\>
        </contextVariableMappings\>
        <dataType\>Id</dataType\>
        <developerName\>RoutableId</developerName\>
        <label\>Routable Id</label\>
    </contextVariables\>
....<conversationChannelProviders\>
        <agentRequired\>false</agentRequired\>
        <chatButtonName\>Chat\_Button\_For\_Bot</chatButtonName\>
    </conversationChannelProviders\>
    <label\>Astro&apos;s Pizza</label\>
</Bot\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Pizza\_Bot</members\>
        <name\>Bot</name\>
    </types\>
    <version\>45.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ff8052795b2b0cfbf4415fbe35ae6d42db90bb22adabcc37c0b3dad1e2bdb2c6 url=/legacydeveloper/current/en-us/api_meta/meta_botblock.md -->

# BotBlock

Represents the configuration details for a specific Einstein Bot block, including dialogs and variables.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

BotBlock components have the suffix .botBlock and are stored in the botBlocks folder.

## Version

BotBlock components are available in API version 58.0 and later.

## Special Access Rules

BotBlock is available only if Chat and Einstein Bots are enabled in your org.

Bot metadata deployment and retrieval are not supported for Lead Nurturing and Sales Coach Agents.

## Fields

| Field Name | Description |
| --- | --- |
| botBlockVersions | 
Field Type

[BotBlockVersion\[\]](#BotBlockVersion)

Description

The configuration details for specific Einstein Bot block versions, including dialogs and variables.



 |
| description | 

Field Type

string

Description

A description of the bot block.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly label for BotBlock, which is defined when the block is created.





 |
| richContentEnabled | 

Field Type

boolean

Description

Indicates whether the block is available for enhanced bots (true) or for only standard bots (false). The default is false.



 |

## BotBlockVersion

Represents the configuration details for an Einstein Bot block version, including dialogs and variables.

| Field Name | Description |
| --- | --- |
| botDialogs | 
Field Type

[BotDialog\[\]](meta_botversion.htm#BotDialog)

Description

The list of dialogs in this bot block.



 |
| conversationGoals | 

Field Type

[ConversationDefinitionGoal\[\]](meta_botversion.htm#ConversationDefinitionGoal)

Description

The list of goals in this bot block. Available in API version 57.0 and later.



 |
| conversationLanguages | 

Field Type

string

Description

Required.

Specifies the language of the bot block.



 |
| conversationVariables | 

Field Type

[ConversationVariable\[\]](meta_botversion.htm#ConversationVariable)

Description

A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs. Available in API version 44.0 and later.



 |
| description | 

Field Type

string

Description

A description of the bot block.



 |
| mlDomain | 

Field Type

[LocalMlDomain](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_bot.htm#LocalMlDomain)

Description

Required.

The Einstein Intent Set that groups intents, entities, and variables associated with a block.



 |
| permissionSet | 

Field Type

string

Description

The permission set associated with the bot block. Available in API version 59.0 and later.



 |
| status | 

Field Type

ConvDefBlockVersionStatus (enumeration of type string)

Description

Required.

Indicates whether a block is published or is a draft.

Values are:

- Published





 |

## Declarative Metadata Sample Definition

The following is an example of a BotBlock component.

<?xml version="1.0" encoding="UTF-8"?>
<BotBlock xmlns="http://soap.sforce.com/2006/04/metadata">
    <access xsi:nil="true"/>
    <botBlockVersions\>
        <fullName\>Published</fullName\>
        <botDialogs\>
            <developerName\>Test\_Dialog\_1646070168572</developerName\>
            <label\>Test\_Dialog\_1646070168572</label\>
            <showInFooterMenu\>false</showInFooterMenu\>
        </botDialogs\>
        <botDialogs\>
            <developerName\>Test\_Dialog\_1646070168926</developerName\>
            <label\>Test\_Dialog\_1646070168926</label\>
            <showInFooterMenu\>false</showInFooterMenu\>
        </botDialogs\>
        <botDialogs\>
            <botSteps\>
                <stepIdentifier\>s4</stepIdentifier\>
                <type\>Wait</type\>
            </botSteps\>
            <developerName\>Main\_Menu</developerName\>
            <label\>Main Menu</label\>
            <mlIntent\>Main\_Menu</mlIntent\>
            <showInFooterMenu\>false</showInFooterMenu\>
        </botDialogs\>
        <botDialogs\>
            <botSteps\>
                <botMessages\>
                    <message\>Goodbye! Click the &quot;End Chat&quot; button to end this chat</message\>
                    <messageIdentifier\>m2</messageIdentifier\>
                </botMessages\>
                <stepIdentifier\>s6</stepIdentifier\>
                <type\>Message</type\>
            </botSteps\>
            <botSteps\>
                <stepIdentifier\>s7</stepIdentifier\>
                <type\>Wait</type\>
            </botSteps\>
            <developerName\>End\_Chat</developerName\>
            <label\>End Chat</label\>
            <mlIntent\>End\_Chat</mlIntent\>
            <showInFooterMenu\>false</showInFooterMenu\>
        </botDialogs\>
        <botDialogs\>
            <botSteps\>
                <botMessages\>
                    <message\>Unfortunately, there are no agents available at the moment</message\>
                    <messageIdentifier\>m3</messageIdentifier\>
                </botMessages\>
                <stepIdentifier\>s8</stepIdentifier\>
                <type\>Message</type\>
            </botSteps\>
            <botSteps\>
                <stepIdentifier\>s9</stepIdentifier\>
                <type\>Wait</type\>
            </botSteps\>
            <developerName\>No\_Agent\_Available</developerName\>
            <label\>No Agent</label\>
            <showInFooterMenu\>false</showInFooterMenu\>
        </botDialogs\>
        <botDialogs\>
            <botSteps\>
                <botMessages\>
                    <message\>Hi! I&apos;m your helpful bot.</message\>
                    <messageIdentifier\>m1</messageIdentifier\>
                </botMessages\>
                <stepIdentifier\>s1</stepIdentifier\>
                <type\>Message</type\>
            </botSteps\>
            <botSteps\>
                <conversationRecordLookup\>
                    <SObjectType\>Account</SObjectType\>
                    <conditions\>
                        <leftOperand\>Account.Phone</leftOperand\>
                        <operatorType\>Equal</operatorType\>
                        <rightOperandValue\>Value</rightOperandValue\>
                        <sortOrder\>0</sortOrder\>
                    </conditions\>
                    <lookupFields\>
                        <fieldName\>Account.Phone</fieldName\>
                    </lookupFields\>
                    <lookupFields\>
                        <fieldName\>Account.OwnerId</fieldName\>
                    </lookupFields\>
                    <maxLookupResults\>1</maxLookupResults\>
                    <sourceVariableName\>\_LastCustomerInput</sourceVariableName\>
                    <sourceVariableType\>ConversationVariable</sourceVariableType\>
                    <targetVariableName\>MyCustomVariable</targetVariableName\>
                </conversationRecordLookup\>
                <stepIdentifier\>s2</stepIdentifier\>
                <type\>RecordLookup</type\>
            </botSteps\>
            <botSteps\>
                <botNavigation\>
                    <botNavigationLinks\>
                        <targetBotDialog\>Main\_Menu</targetBotDialog\>
                        <targetVariable xsi:nil="true"/>
                        <targetVariableType xsi:nil="true"/>
                    </botNavigationLinks\>
                    <type\>Redirect</type\>
                </botNavigation\>
                <stepIdentifier\>s3</stepIdentifier\>
                <type\>Navigation</type\>
            </botSteps\>
            <developerName\>Welcome</developerName\>
            <label\>Welcome</label\>
            <mlIntent\>Welcome</mlIntent\>
            <showInFooterMenu\>false</showInFooterMenu\>
        </botDialogs\>
        <conversationLanguages\>en\_US</conversationLanguages\>
        <conversationVariables\>
            <dataType\>Text</dataType\>
            <developerName\>TestVariableABC</developerName\>
            <label\>TestVariableABC</label\>
        </conversationVariables\>
        <conversationVariables\>
            <dataType\>Text</dataType\>
            <developerName\>TestVariableXYZ</developerName\>
            <label\>TestVariableXYZ</label\>
        </conversationVariables\>
        <conversationVariables\>
            <collectionType\>List</collectionType\>
            <dataType\>Object</dataType\>
            <developerName\>MyCustomVariable</developerName\>
            <label\>MyCustomVariable</label\>
        </conversationVariables\>
        <description\>Created for testing.</description\>
        <mlDomain\>
            <label\>vPub</label\>
            <mlIntents\>
                <developerName\>End\_Chat</developerName\>
                <label\>End Chat</label\>
                <mlIntentUtterances\>
                    <language\>es</language\>
                    <utterance\>Utterance1</utterance\>
                </mlIntentUtterances\>
                <mlIntentUtterances\>
                    <language\>es</language\>
                    <utterance\>Utterance2</utterance\>
                </mlIntentUtterances\>
                <mlIntentUtterances\>
                    <language\>es</language\>
                    <utterance\>Utterance3</utterance\>
                </mlIntentUtterances\>
            </mlIntents\>
            <mlIntents\>
                <description\>Main Menu Intent</description\>
                <developerName\>Main\_Menu</developerName\>
                <label\>Main Menu</label\>
            </mlIntents\>
            <mlIntents\>
                <description\>Welcome Intent</description\>
                <developerName\>Welcome</developerName\>
                <label\>Welcome</label\>
            </mlIntents\>
            <name\>blockDevName0001\_vPub</name\>
        </mlDomain\>
        <status\>Published</status\>
    </botBlockVersions\>
    <description\>Collects the user&apos;s first name, last name, email address, phone number, and company name.</description\>
    <masterLabel\>User Info Collection Block</masterLabel\>
    <richContentEnabled\>true</richContentEnabled\>
</BotBlock\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>AgentTransfer</members\>
        <name\>BotBlock</name\>
    </types\>
    <version\>58.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=92618f383138977e46e7f9a83bbe8ea182e847759d758a449623de9577d8d6e4 url=/legacydeveloper/current/en-us/api_meta/meta_botsettings.md -->

# BotSettings

Represents an organization’s Einstein Bot settings, such as whether or not Einstein Bots is enabled. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

Bot components have the suffix .bot and are stored in the bot folder.

## Version

Bot components are available in API version 46.0 and later.

## Special Access Rules

Bot metadata deployment and retrieval are not supported for Lead Nurturing and Sales Coach Agents.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableBots | boolean | Indicates whether Einstein Bots is enabled (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example of a BotSetting. This example has been trimmed to make it easier to read.

<?xml version="1.0" encoding="UTF-8"?>
<BotSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableBots\>true</enableBots\>
</BotSettings\>

The following is an example package.xml manifest that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Bot</members\>
        <name\>Settings</name\>
    </types\>
    <version\>46.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=894a369d755642fd0af3b74b619881522fc8d4738cf714b3de505d1b7ecbea8d url=/legacydeveloper/current/en-us/api_meta/meta_bottemplate.md -->

# BotTemplate

Represents the configuration details for a specific Einstein Bot template, including dialogs and variables.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

BotTemplate components have the suffix .botTemplate and are stored in the botTemplates folder.

## Version

BotTemplate components are available in API version 55.0 and later.

## Special Access Rules

BotTemplate is available only if Chat and Einstein Bots are enabled in your org.

Bot metadata deployment and retrieval are not supported for Lead Nurturing and Sales Coach Agents.

## Fields

| Field Name | Description |
| --- | --- |
| botDialogGroups | 
Field Type

[BotDialogGroup\[\]](meta_botversion.htm#BotDialogGroup)

Description

The list of dialog groups in this bot template.



 |
| botDialogs | 

Field Type

[BotDialog\[\]](meta_botversion.htm#BotDialog)

Description

The list of dialogs in this bot template.



 |
| conversationLanguages | 

Field Type

string

Description

Required.

Specifies the language of the bot template.



 |
| contextVariables | 

Field Type

[ConversationContextVariable\[\]](meta_bot.htm#ConversationContextVariable)

Description

Represents the context variables that enable your bot to gather customer information regardless of channel.



 |
| conversationGoals | 

Field Type

[ConversationDefinitionGoal\[\]](meta_botversion.htm#ConversationDefinitionGoal)

Description

The list of goals in this bot template. Available in API version 57.0 and later.



 |
| conversationSystemDialogs | 

Field Type

[ConversationSystemDialog\[\]](meta_botversion.htm#ConversationSystemDialog)

Description

A system function assigned to a dialog.



 |
| conversationVariables | 

Field Type

[ConversationVariable\[\]](meta_botversion.htm#ConversationVariable)

Description

A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs.



 |
| description | 

Field Type

string

Description

A description of the bot template.



 |
| entryDialog | 

Field Type

string

Description

A reference to the first dialog that the bot presents to your customer. For example, Welcome.



 |
| icon | 

Field Type

string

Description

The icon used to identify the template.



 |
| mainMenuDialog | 

Field Type

string

Description

A reference to the dialog identified as the main menu dialog. For example, Main Menu.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly label for BotTemplate, which is defined when the BotTemplate is created.



 |
| mlDomain | 

Field Type

[LocalMlDomain](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_bot.htm#LocalMlDomain)

Description

Required.

Represents the Einstein Intent Set that groups intents, entities, and variables associated with a template.



 |
| permissionSet | 

Field Type

string

Description

The permission set associated with the bot template. Available in API version 59.0 and later.



 |
| richContentEnabled | 

Field Type

boolean

Description

Indicates whether the template is available for enhanced bots (true) or for standard bots (false). The default is false.



 |
| type | 

Field Type

BotType (enumeration of type string)

Description

This field represents the configuration type of the bot. The default value is Bot.

Valid values are:

- Bot—Default Einstein Bot configuration.
- ExternalCopilot— An external-facing agent. For example, an Agentforce Service agent.
- InternalCopilot— An internal-facing agent. For example, an Agentforce Employee agent.





 |

## Declarative Metadata Sample Definition

The following is an example of a BotTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<BotTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <botDialogGroups\>
        <developerName\>dialog\_group1</developerName\>
        <label\>dialog group1</label\>
    </botDialogGroups\>
    <botDialogs\>
        <developerName\>Test\_Dialog\_1</developerName\>
        <label\>Test\_Dialog\_1</label\>
        <showInFooterMenu\>false</showInFooterMenu\>
    </botDialogs\>
    <botDialogs\>
        <developerName\>Test\_Dialog\_2</developerName\>
        <label\>Test\_Dialog\_2</label\>
        <showInFooterMenu\>false</showInFooterMenu\>
    </botDialogs\>
    <botDialogs\>
        <botSteps\>
            <botMessages\>
                <message\>Hi! I&apos;m your helpful bot.</message\>
                <messageIdentifier\>m1</messageIdentifier\>
            </botMessages\>
            <stepIdentifier\>s1</stepIdentifier\>
            <type\>Message</type\>
        </botSteps\>
        <botSteps\>
           <conversationRecordLookup\>
               <SObjectType\>Account</SObjectType\>
               <conditions\>
                   <leftOperand\>Account.Phone</leftOperand\>
                   <operatorType\>Equal</operatorType\>
                   <rightOperandValue\>Value</rightOperandValue\>
                   <sortOrder\>0</sortOrder\>
               </conditions\>
               <lookupFields\>
                   <fieldName\>Account.Phone</fieldName\>
               </lookupFields\>
               <lookupFields\>
                   <fieldName\>Account.OwnerId</fieldName\>
               </lookupFields\>
               <maxLookupResults\>1</maxLookupResults\>
               <sourceVariableName\>\_LastCustomerInput</sourceVariableName\>
               <sourceVariableType\>ConversationVariable</sourceVariableType\>
               <targetVariableName\>MyCustomVariable</targetVariableName\>
           </conversationRecordLookup\>
           <stepIdentifier\>s2</stepIdentifier\>
           <type\>RecordLookup</type\>
        </botSteps\>
        <botSteps\>
            <botNavigation\>
                <botNavigationLinks\>
                    <targetBotDialog\>Main\_Menu</targetBotDialog\>
                </botNavigationLinks\>
                <type\>Redirect</type\>
            </botNavigation\>
            <stepIdentifier\>s3</stepIdentifier\>
            <type\>Navigation</type\>
        </botSteps\>
        <developerName\>Welcome</developerName\>
        <label\>Welcome</label\>
        <mlIntent\>Welcome</mlIntent\>
        <showInFooterMenu\>false</showInFooterMenu\>
    </botDialogs\>
    <botDialogs\>
        <botSteps\>
            <stepIdentifier\>s4</stepIdentifier\>
            <type\>Wait</type\>
        </botSteps\>
        <developerName\>Main\_Menu</developerName\>
        <label\>Main Menu</label\>
        <mlIntent\>Main\_Menu</mlIntent\>
        <showInFooterMenu\>false</showInFooterMenu\>
    </botDialogs\>
    <botDialogs\>
        <botSteps\>
            <botMessages\>
                <message\>Goodbye! Click the &quot;End Chat&quot; button to end this chat</message\>
                <messageIdentifier\>m2</messageIdentifier\>
            </botMessages\>
            <stepIdentifier\>s6</stepIdentifier\>
            <type\>Message</type\>
        </botSteps\>
        <botSteps\>
            <stepIdentifier\>s7</stepIdentifier\>
            <type\>Wait</type\>
        </botSteps\>
        <developerName\>End\_Chat</developerName\>
        <label\>End Chat</label\>
        <mlIntent\>End\_Chat</mlIntent\>
        <showInFooterMenu\>false</showInFooterMenu\>
    </botDialogs\>
    <botDialogs\>
        <botSteps\>
            <botMessages\>
                <message\>Unfortunately, there are no agents available at the moment</message\>
                <messageIdentifier\>m3</messageIdentifier\>
            </botMessages\>
            <stepIdentifier\>s8</stepIdentifier\>
            <type\>Message</type\>
        </botSteps\>
        <botSteps\>
            <stepIdentifier\>s9</stepIdentifier\>
            <type\>Wait</type\>
        </botSteps\>
        <developerName\>No\_Agent\_Available</developerName\>
        <label\>No Agent</label\>
        <showInFooterMenu\>false</showInFooterMenu\>
    </botDialogs\>
    <contextVariables\>
        <contextVariableMappings\>
            <SObjectType\>LiveChatTranscript</SObjectType\>
            <fieldName\>LiveChatTranscript.ChatKey</fieldName\>
            <messageType\>WebChat</messageType\>
        </contextVariableMappings\>
        <dataType\>Text</dataType\>
        <developerName\>ChatKey</developerName\>
        <label\>Chat Key</label\>
    </contextVariables\>
    <conversationLanguages\>en\_US</conversationLanguages\>
    <conversationSystemDialogs\>
        <dialog\>No\_Agent\_Available</dialog\>
        <type\>TransferFailed</type\>
    </conversationSystemDialogs\>
    <conversationSystemDialogs\>
        <dialog\>Test\_Dialog\_1</dialog\>
        <type\>ErrorHandling</type\>
    </conversationSystemDialogs\>
    <conversationVariables\>
        <dataType\>Text</dataType\>
        <developerName\>TestVariableXYZ</developerName\>
        <label\>TestVariableXYZ</label\>
    </conversationVariables\>
    <conversationVariables\>
        <collectionType\>List</collectionType\>
        <dataType\>Object</dataType\>
        <developerName\>MyCustomVariable</developerName\>
        <label\>MyCustomVariable</label\>
    </conversationVariables\>
    <description\>Description of BotTemplate</description\>
    <entryDialog\>Test\_Dialog\_1</entryDialog\>
    <icon\>AA8qwqXXXXX</icon\>
    <mainMenuDialog\>Test\_Dialog\_2</mainMenuDialog\>
    <masterLabel\>Astro Bot</masterLabel\>
    <mlDomain\>
        <label\>Astro Bot</label\>
        <mlIntents\>
            <developerName\>End\_Chat</developerName\>
            <label\>End Chat</label\>
            <mlIntentUtterances\>
                <utterance\>Utterance1</utterance\>
                <language\>es</language\>
            </mlIntentUtterances\>
            <mlIntentUtterances\>
                <utterance\>Utterance2</utterance\>
                <language\>es</language\>
            </mlIntentUtterances\>
            <mlIntentUtterances\>
                <utterance\>Utterance3</utterance\>
                <language\>es</language\>
            </mlIntentUtterances\>
        </mlIntents\>
        <mlIntents\>
            <developerName\>Main\_Menu</developerName\>
            <label\>Main Menu</label\>
            <description\>Main Menu Intent</description\>
        </mlIntents\>
        <mlIntents\>
            <developerName\>Welcome</developerName\>
            <label\>Welcome</label\>
            <description\>Welcome Intent</description\>
        </mlIntents\>
        <name\>Astro\_Bot\_ld1</name\>
    </mlDomain\>
    <richContentEnabled\>true</richContentEnabled\>
</BotTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>BotTemplate</name\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=933a62863663c5bf28664852ef49056d560ce9a4367e8ef8f5a5335024ceb5f2 url=/legacydeveloper/current/en-us/api_meta/meta_botversion.md -->

# BotVersion

Represents the configuration details for a specific Einstein Bot version, including dialogs and variables.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

BotVersion components have the suffix .bot and are stored in the bot folder. BotVersion is a top-level child of Bot and shares its suffix and file directory.

## Version

BotVersion components are available in API version 43.0 and later.

## Special Access Rules

BotVersion is available only if Chat and Einstein Bots are enabled in your org.

Bot metadata deployment and retrieval are not supported for Lead Nurturing and Sales Coach Agents.

## Fields

| Field Name | Description |
| --- | --- |
| botDialogGroups | 
Field Type

[BotDialogGroup\[\]](#BotDialogGroup)

Description

The list of dialog groups in this bot version.



 |
| botDialogs | 

Field Type

[BotDialog\[\]](#BotDialog)

Description

The list of dialogs in this bot version.



 |
| company | 

Field Type

string

Description

Reserved for internal use.



 |
| conversationGoals | 

Field Type

[ConversationDefinitionGoal\[\]](#ConversationDefinitionGoal)

Description

The list of goals in this bot verion. Available in API version 57.0 and later.



 |
| conversationDefinitionPlanners | 

Field Type

[ConversationDefinitionPlanner\[\]](#ConversationDefinitionPlanner)

Description

Represents the API name of the Agent planner service [GenAiPlanner](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplanner.htm "Represents a planner for an agent. It’s a container for all the topics and actions used to interact with a large language model (LLM).").

Available in API version 60.0 and later.



 |
| conversationSystemDialogs | 

Field Type

[ConversationSystemDialog\[\]](#ConversationSystemDialog)

Description

A system function assigned to a dialog. Available in API version 48.0 and later.



 |
| conversationVariables | 

Field Type

[ConversationVariable\[\]](#ConversationVariable)

Description

A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs. Available in API version 44.0 and later.



 |
| copilotPrimaryLanguage | 

Field Type

Language (enumeration of type string)

Description

Represents the primary language of a Copilot or Agent.



 |
| copilotSecondaryLanguages | 

Field Type

string

Description

Reserved for internal use.



 |
| entryDialog | 

Field Type

string

Description

Required.

A reference to the first dialog that the bot presents to your customer. For example, Welcome.



 |
| initialIntentDetectionEnabled | 

Field Type

boolean

Description

Reserved for internal use.



 |
| intentDisambiguationEnabled | 

Field Type

boolean

Description

Reserved for internal use.



 |
| intentThreshold | 

Field Type

double

Description

Specifies how strictly a user message must match with a bot intent.

Valid values are between 1 and 5, where 1 is the least strict and 5 is the most strict.

To turn on this feature, contact Salesforce Customer Support. This field is available in API version 63.0 and later.





 |
| intentV3Enabled | 

Field Type

boolean

Description

Reserved for internal use.



 |
| knowledgeActionEnabled | 

Field Type

boolean

Description

Indicates whether a knowledge action is enabled. The default value is false.



 |
| knowledgeFallbackEnabled | 

Field Type

boolean

Description

Reserved for internal use.



 |
| mainMenuDialog | 

Field Type

string

Description

A reference to the dialog identified as the main menu dialog. For example, Main Menu.



 |
| nlpProviders | 

Field Type

[ConversationDefinitionNlpProvider\[\]](#ConversationDefinitionNlpProvider)

Description

Defines the language provider which is used for a particular language. Available in API version 49.0 and later.



 |
| responseDelayMilliseconds | 

Field Type

int

Description

An optional default or custom delay after every bot response to simulate typing.



 |
| role | 

Field Type

string

Description

Reserved for internal use.



 |
| surfacesEnabled | 

Field Type

boolean

Description

Reserved for internal use.



 |
| toneType | 

Field Type

GenAiBotToneType (enumeration of type string)

Description

The tone of the bot. Valid values are:

- Casual
- Formal
- Neutral





 |

## BotDialogGroup

The list of dialog groups in this bot version.

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

A description of the bot dialog group.



 |
| developerName | 

Field Type

string

Description

Required.

This unique name prevents conflicts with other dialog groups associated with the same bot version. This name can contain only underscores and alphanumeric characters. The name must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.















 |
| label | 

Field Type

string

Description

Required.

A label that identifies the dialog group throughout the Salesforce user interface.



 |

## BotDialog

The list of dialogs in this bot version.

| Field Name | Description |
| --- | --- |
| botDialogGroup | 
Field Type

string

Description

The bot dialog group that contains this bot dialog.



 |
| botSteps | 

Field Type

[BotStep\[\]](#BotStep)

Description

A list of steps that are executed as part of the dialog.



 |
| description | 

Field Type

string

Description

A description of the bot dialog.



 |
| developerName | 

Field Type

string

Description

Required.

This unique name prevents conflicts with other dialogs associated with the same bot version. This name can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.















 |
| isPlaceholderDialog | 

Field Type

boolean

Description

In a bot block, indicates whether a dialog is a placeholder (true) or not (false). In a bot template or bot version not associated with a bot block, this field is read-only and the value is false. Available in API version 58.0 and later.



 |
| label | 

Field Type

string

Description

Required.

A label that identifies the dialog throughout the Salesforce user interface.



 |
| mlIntent | 

Field Type

string

Description

Required.

A label that identifies the dialog throughout the Salesforce user interface. The name of the intent associated with a dialog.



 |
| mlIntentTrainingEnabled | 

Field Type

boolean

Description

Indicates whether Einstein is turned on to train an intent model for the dialog intent (true) or turned off for the exact match option (false). The default value is false. Available in API version 46.0 and later.



 |
| showInFooterMenu | 

Field Type

boolean

Description

Indicates whether to show this dialog in the Bot Options menu. The default value is false.



 |

## BotStep

A step that is executed as part of the dialog.

| Field Name | Description |
| --- | --- |
| booleanFilter | 
Field Type

string

Description

This field is reserved for future use.



 |
| botInvocation | 

Field Type

[BotInvocation](#BotInvocation)

Description

Bot Invocation used by a BotStep of type Invocation.



 |
| botMessages | 

Field Type

[BotMessage\[\]](#BotMessage)

Description

List of bot messages used by a BotStep of type Message.



 |
| botNavigation | 

Field Type

[BotNavigation](#BotNavigation)

Description

Bot Navigation used by a BotStep of type Navigation.



 |
| botStepConditions | 

Field Type

[BotStepCondition\[\]](#BotStepCondition)

Description

List of BotStep conditions associated with a BotStep of type Group.



 |
| botSteps | 

Field Type

[BotStep\[\]](#BotStep)

Description

List of BotSteps associated to a Bot Step of type Group.



 |
| botVariableOperation | 

Field Type

[BotVariableOperation\[\]](#BotVariableOperation)

Description

Bot Variable Operation used by a BotStep of type VariableOperation.



 |
| conditionLogicType | 

Field Type

ConversationDefinitionLogicalOperatorType (enumeration of type string)

Description

Represents the type of conditional logic used by a BotStep. Values are:

- And
- Or

Available in API version 58.0 and later.



 |
| conversationRecordLookup | 

Field Type

[ConversationRecordLookup\[\]](#ConversationRecordLookup)

Description

A lookup action to the Conversation record. Available in API version 46.0 and later.



 |
| conversationStepGoalMappings | 

Field Type

[ConversationDefinitionStepGoalMapping\[\]](#ConversationDefinitionStepGoalMapping)

Description

The API name of a goal used by a BotStep of type GoalStep. Available in API version 57.0 and later.



 |
| conversationSystemMessage | 

Field Type

[ConversationSystemMessage\[\]](#ConversationSystemMessage)

Description

System messages that represent an action for a BotStep, such as transferring to an agent or ending a chat. Available in API version 46.0 and later.



 |
| messageDefinition | 

Field Type

[ConversationDefinitionRichMessage\[\]](#ConversationDefinitionRichMessage)

Description

List of configuration details used by a BotStep that references a messaging component. Available in API version 54.0 and later.



 |
| stepIdentifier | 

Field Type

string

Description

A unique key that identifies a step within a dialog. It is used to link translated labels to labels within the step. This field is recommended for all step records and is required for translated step labels. Available in API version 53.0 and later.

If a step is created via the UI, the stepIdentifier is automatically generated. If a step is created via API, the stepIdentifier must be provided. The stepIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.





 |
| type | 

Field Type

BotStepType (enumeration of type string)

Description

Required.

Values are:

- GoalStep (Available in API version 57.0 and later.)
- Group
- Invocation
- Message
- Navigation
- RecordLookup (Available in API version 48.0 and later.)
- RichMessage (Available in API version 54.0 and later.)
- SystemMessage
- VariableOperation
- Wait





 |

## BotInvocation

Bot Invocation used by a BotStep of type Invocation.

| Field Name | Description |
| --- | --- |
| invocationActionName | 
Field Type

string

Description

The name of the invocable action used by a Bot Invocation.



 |
| invocationActionType | 

Field Type

ConversationInvocableTargetType (enumeration of type string)

Description

Available dialog action types are:

Values are:

- apex
- externalService (Available in API version 53.0 and later.)
- flow
- logFeedback (Available in API version 51.0 and later.)
- logGoalAchieved (Deprecated in API version 57.0 and later.)
- standardInvocableAction





 |
| invocationMappings | 

Field Type

[BotInvocationMapping\[\]](#BotInvocationMapping)

Description

List of Bot Invocation Mappings for a Bot Invocation.



 |

## BotInvocationMapping

List of Bot Invocation Mappings for a Bot Invocation.

| Field Name | Description |
| --- | --- |
| parameterName | 
Field Type

string

Description

Required.

Name of an Input/Output parameter of the parent Bot Invocation target.



 |
| recordName | 

Field Type

string

Description

Name of the record that is used as part of an Invocation mapping. Available in API version 54.0 and later.



 |
| type | 

Field Type

BotInvocationMappingType (enumeration of type string)

Description

Required.

Values are:

- Input
- Output





 |
| value | 

Field Type

string

Description

Literal value to be assigned to the specified parameter.



 |
| variableName | 

Field Type

string

Description

Name of the Bot Variable that is used as part of an Invocation mapping.



 |
| variableType | 

Field Type

ConversationVariableType (enumeration of type string)

Description

This field relates to the type of variable used in this invocation mapping.

Values are:

- ContextVariable
- ConversationVariable
- PageContextVariable





 |

## BotMessage

A bot message used by a BotStep of type Message.

| Field Name | Description |
| --- | --- |
| message | 
Field Type

string

Description

Required.

Message to display as part of an outgoing message from the bot to the customer.



 |
| messageIdentifier | 

Field Type

string

Description

A unique key that identifies a message within a dialog. It is used to link translated labels to labels within the message. This field is recommended for all message records and is required for translated message labels. Available in API version 53.0 and later.

If a message is created via the UI, the messageIdentifier is automatically generated. If a message is created via API, the messageIdentifier must be provided. messageIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.





 |

## BotNavigation

Bot navigation used by a BotStep of type Navigation.

| Field Name | Description |
| --- | --- |
| botNavigationLinks | 
Field Type

[BotNavigationLink\[\]](#BotNavigationLink)

Description

List of Bot Navigation links associated with a Bot Navigation of type Call or Redirect.



 |
| type | 

Field Type

BotNavigationType (enumeration of type string)

Description

Required.

Values are:

- Call
- Redirect
- TransferToAgent





 |

## BotNavigationLink

List of Bot Navigation links associated with a Bot Navigation of type Call or Redirect.

| Field Name | Description |
| --- | --- |
| label | 
Field Type

string

Description

Label displayed when more than one Bot Navigation Link is available under a Bot Navigation of type Redirect. The target dialog label is used when no label is provided.



 |
| targetBotDialog | 

Field Type

string

Description

Name of the target dialog to be called as part of this Bot Navigation Link.



 |
| targetVariable | 

Field Type

string

Description

In the Redirect to Dialog Rule Action, the ID of the target object variable to be called as part of this Bot Navigation link. Available in API version 57.0 and later.



 |
| targetVariableType | 

Field Type

ConversationVariableType (enumeration of type string)

Description

In the Redirect to Dialog Rule Action, the type of variable referred to in targetVariable. Available in API version 57.0 and later.

Values are:

- ContextVariable
- ConversationVariable
- PageContextVariable





 |

## BotStepCondition

List of BotStep conditions associated with a BotStep of type Group.

| Field Name | Description |
| --- | --- |
| leftOperandName | 
Field Type

string

Description

Required.

Name of the variable used as the left side of the condition operation.



 |
| leftOperandType | 

Field Type

ConversationVariableType (enumeration of type string)

Description

Required.

Type of the variable used as the left side of the condition operation.

Values are:

- ContextVariable
- ConversationVariable
- PageContextVariable





 |
| operatorType | 

Field Type

BotStepConditionOperatorType (enumeration of type string)

Description

Required.

Values are:

- Equals
- GreaterThan (Available in API version 47.0 and later.)
- GreaterThanOrEqualTo (Available in API version 47.0 and later.)
- IsNotSet
- IsSet
- LessThan (Available in API version 47.0 and later.)
- LessThanOrEqualTo (Available in API version 47.0 and later.)
- NotEquals





 |
| rightOperandValue | 

Field Type

string

Description

Value that is used as the right side of the condition operation. This value is ignored when using IsSet and IsNotSet operators.



 |

## BotVariableOperation

Bot variable operation used by a BotStep of type VariableOperation.

| Field Name | Description |
| --- | --- |
| askCollectIfSet | 
Field Type

boolean

Description

If true, the bot runs a Bot Variable Operation of type Collect regardless of whether the variable already has a value. When a value exists for a variable, the bot asks the user for the relevant information, and the bot overwrites the existing value with the user-provided value. If false, the bot skips variables with an existing value and maintains the existing value. The default is false. Available in API version 51.0 and later.



 |
| autoSelectIfSingleChoice | 

Field Type

boolean

Description

If true, the bot automatically selects the answer in the conversation flow when only one button choice is available in a Bot Variable Operation of type Collect and a quickReplyType value of Dynamic. If false, the bot presents the single button choice and waits for the user’s response. The default is false. Available in API version 51.0 and later.



 |
| botInvocation | 

Field Type

[BotInvocation](#BotInvocation)

Description

Bot Invocation used to provide Dynamic choices by a Bot Variable Operation of type Collect and quickReplyType of Dynamic.



 |
| botMessages | 

Field Type

[BotMessage\[\]](#BotMessage)

Description

List of Bot Messages used as prompt messages by a Bot Variable Operation of type Collect.



 |
| botQuickReplyOptions | 

Field Type

[BotQuickReplyOption\[\]](#BotQuickReplyOption)

Description

List of static choice options used by a Bot Variable Operation of type Collect and quickReplyType of Static.



 |
| botVariableOperands | 

Field Type

[BotVariableOperand\[\]](#BotVariableOperand)

Description

List of Bot Variable Operands associated with a Bot Variable of type Set or Unset.



 |
| ignoreIntentRecognition | 

Field Type

boolean

Description

If true the bot requires a response to a Question dialog step. The bot doesn't perform intent recognition for any user messages that do not fit the entity requirements. The bot repeats the question until the customer's response fits the entity requirements. Available in API version 63.0 and later.



 |
| invalidInputBotNavigation | 

Field Type

[BotNavigation](#BotNavigation)

Description

Bot Navigation used by a Bot Variable Operation of type Collect. This navigation is executed when the associated Bot Invocation doesn’t return any options.



 |
| messageDefinition | 

Field Type

[ConversationDefinitionRichMessage](#ConversationDefinitionRichMessage)

Description

Configuration details that reference a messaging component. Outputs are used by a Bot Variable Operation of type Set. Available in API version 58.0 and later.



 |
| optionalCollect | 

Field Type

boolean

Description

If true, the bot asks the repair attempts once and then moves on to the next dialog step. The default value is false. Available in API version 48.0 and later.



 |
| quickReplyOptionTemplate | 

Field Type

string

Description

Formula template used to resolve a label for Dynamic choice options of type Object.



 |
| quickReplyType | 

Field Type

BotQuickReplyType (enumeration of type string)

Description

Values are:

- Dynamic
- Static





 |
| quickReplyWidgetType | 

Field Type

BotWidgetType (enumeration of type string)

Description

Values are:

- Buttons
- Menu





 |
| retryMessages | 

Field Type

[BotMessage\[\]](#BotMessage)

Description

In [Conversation Repair](https://help.salesforce.com/articleView?id=bots_service_setup_dialog_question_text.htm&language=en_US "HTML (New Window)"), the messages assigned to repair attempts. Available in API version 48.0 and later.



 |
| sourceVariableName | 

Field Type

string

Description

Name of the source VariableName used in the variable operation. Available in API version 47.0 and later.



 |
| sourceVariableType | 

Field Type

ConversationVariableType (enumeration of type string)

Description

This name defines the data type of VariableName used in the variable operation.

Values are:

- ContextVariable
- ConversationVariable
- PageContextVariable





 |
| successMessages | 

Field Type

[BotMessage\[\]](#BotMessage)

Description

In a File dialog step, the message displayed to the customer as part of type CollectAttachment to confirm a successful file upload. Available in API version 57.0 and later.



 |
| type | 

Field Type

BotVariableOperationType (enumeration of type string)

Description

Required.

Values are:

- Collect
- CollectAttachment (Available in API version 57.0 and later.)
- Set
- SetConversationLanguage (Available in API version 53.0 and later.)
- Unset





 |
| variableOperationIdentifier | 

Field Type

string

Description

A unique key that identifies a variable operation within a dialog. It is used to link translated labels to labels within the variable operation. This field is recommended for all variable operation records and is required for translated variable operation labels. Available in API version 53.0 and later.

If a variable operation is created via the UI, the variableOperationIdentifier is automatically generated. If a variable operation is created via API, the variableOperationIdentifier must be provided. variableOperationIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.





 |

## BotQuickReplyOption

List of static choice options used by a bot variable operation of type Collect and quickReplyType of Static.

| Field Name | Description |
| --- | --- |
| literalValue | 
Field Type

string

Description

Required.

Value to be displayed as a menu or button choice to your customer.



 |
| quickReplyOptionIdentifier | 

Field Type

string

Description

A unique key that identifies a quick reply option within a dialog. It is used to link translated labels to labels within the quick reply option. This field is recommended for all quick reply option records and is required for translated quick reply option labels. Available in API version 53.0 and later.

If a quick reply option is created via the UI, the quickReplyOptionIdentifier is automatically generated. If a message is created via API, the quickReplyOptionIdentifier must be provided. quickReplyOptionIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.





 |

## BotVariableOperand

List of bot variable operands associated with a bot variable of type Set or Unset.

| Field Name | Description |
| --- | --- |
| disableAutoFill | 
Field Type

boolean

Description

Disables auto-fill behavior for a bot variable under a bot variable operation of type Collect.



 |
| sourceName | 

Field Type

string

Description

Name of the source CustomField or MlSlotClass used in the variable operation.



 |
| sourceType | 

Field Type

ConversationVariableOperandSourceType (enumeration of type string)

Description

Values are:

- BotDefinition (Available in API version 46.0 and later.)
- ContextVariable (Available in API version 45.0 and later.)
- ConversationVariable
- FlowDefinition (Available in API version 52.0 and later.)
- MlSlotClass
- Queue (Available in API version 46.0 and later.)
- StandardConversationVariable
- StandardMlSlotClass
- Value





 |
| sourceValue | 

Field Type

string

Description

Literal value used as the source for this variable operation.



 |
| targetName | 

Field Type

string

Description

Required.

Name of the target variable used in the variable operation.



 |
| targetType | 

Field Type

ConversationVariableType (enumeration of type string)

Description

Required.

Type of the target used in the variable operation.

Values are:

- ContextVariable
- ConversationVariable
- PageContextVariable





 |

## ConversationRecordLookup

Information related to the linked conversation. Currently only works on Lightning Knowledge. Available in API version 46.0 and later.

| Field Name | Description |
| --- | --- |
| SObjectType | 
Field Type

string

Description

Required.

Specifies the SObjectType of the ID stored in a bot variable.



 |
| conditions | 

Field Type

[ConversationRecordLookupCondition\[\]](#ConversationRecordLookupCondition)

Description

The conditions associated with this lookup. Available in API version 51.0 and later.



 |
| filterLogic | 

Field Type

string

Description

The logical operator that connects the conditions.

Values are:

- And
- Or

Available in API version 51.0 and later.



 |
| lookupFields | 

Field Type

[ConversationRecordLookupField\[\]](#ConversationRecordLookupField)

Description

Definition of the fields that are used for this lookup.



 |
| maxLookupResults | 

Field Type

int

Description

Required.

The maximum number of records to return (1-3).



 |
| sortFieldName | 

Field Type

string

Description

The name of the field used to sort the lookup results. Available in API version 51.0 and later.



 |
| sortOrder | 

Field Type

SortOrder (enumeration of type string)

Description

The display order of the lookup results.

Values are:

- Asc
- Desc

Available in API version 51.0 and later.



 |
| sourceVariableName | 

Field Type

string

Description

The input for this lookup operation.



 |
| sourceVariableType | 

Field Type

ConversationVariableType (enumeration of type string)

Description

Type of the target used in the variable operation.

Values are:

- ContextVariable
- ConversationVariable
- PageContextVariable





 |
| targetVariableName | 

Field Type

string

Description

Required.

The variable that holds the results of this lookup.



 |

## ConversationRecordLookupCondition

List of conditions associated with a ConversationRecordLookup. Available in API version 51.0 and later.

| Field Name | Description |
| --- | --- |
| leftOperand | 
Field Type

string

Description

Required.

Field on which the condition operation takes place.



 |
| operatorType | 

Field Type

string

Description

Required.

The operator applied to the leftOperand.

Values are:

- Equals
- NotEquals
- IsSet
- IsNotSet
- GreaterThan
- LessThan
- GreaterThanOrEqualTo
- LessThanOrEqualTo





 |
| rightOperandName | 

Field Type

string

Description

The name of the variable to compare against.



 |
| rightOperandType | 

Field Type

ConversationVariableType (enumeration of type string)

Description

The type of the variable to compare against.

Values are:

- ContextVariable
- ConversationVariable
- PageContextVariable





 |
| rightOperandValue | 

Field Type

string

Description

The custom value to compare against. This value is ignored when using IsSet and IsNotSet operators.



 |
| sortOrder | 

Field Type

int

Description

Required.

Order in which the conditions are applied.



 |

## ConversationRecordLookupField

The fields used in a conversation record lookup. Available in API version 46.0 and later.

| Field Name | Description |
| --- | --- |
| fieldName | 
Field Type

string

Description

Required.

Defines the field names used in the Conversation Lookup function.



 |

## ConversationDefinitionStepGoalMapping

Represents the association between a goal and a BotStep. A goal can be associated with only one BotStep and one dialog at a time. Available in API version 57.0 and later.

| Field Name | Description |
| --- | --- |
| goalName | 
Field Type

string

Description

The API name of the goal.



 |

## ConversationSystemMessage

System messages that represent an action for a Bot Step, such as transferring to an agent or ending a chat. Available in API version 46.0 and later.

| Field Name | Description |
| --- | --- |
| systemMessageMappings | 
Field Type

[ConversationSystemMessageMapping](#ConversationSystemMessageMapping)

Description

Defines the type of system message to be sent.



 |
| type | 

Field Type

ConversationSystemMessageType (enumeration of type string)

Description

Required.

This field defines the values available for a system message.

Values are:

- EndChat
- Transfer





 |

## ConversationSystemMessageMapping

List of mappings that indicate additional information provided for the system message. Available in API version 46.0 and later.

| Field Name | Description |
| --- | --- |
| mappingType | 
Field Type

ConversationMappingType (enumeration of type string)

Description

Required.

Defines the type of mapping used in the record.

Values are:

- Input
- Output





 |
| parameterType | 

Field Type

ConversationSystemMessageParamType (enumeration of type string)

Description

Required.

Defines the type of parameter the value is mapped to.

Values are:

- Transfer





 |
| variableName | 

Field Type

string

Description

Required.

Name of the variable that contains the value passed to the system message.



 |

## ConversationDefinitionRichMessage

Represents the configuration details for referencing a messaging component, such as an enhanced link. Available in API version 54.0 and later.

| Field Name | Description |
| --- | --- |
| messageDefinitionMappings | 
Field Type

[BotInvocationMapping\[\]](#BotInvocationMapping)

Description

List of mappings for referencing a messaging component. Includes any input parameters and their values. Optionally, specifies the conversation variable for storing any outputs.

Input parameter values can be either static values or references to conversation or context variables.





 |
| messageDefinitionName | 

Field Type

string

Description

Required.

The API name of the messaging component referenced by the bot.



 |

## ConversationDefinitionGoal

A goal included in the bot version. Available in API version 57.0 and later.

| Field Name | Description |
| --- | --- |
| developerName | 
Field Type

string

Description

Required.

A unique name that prevents conflicts with other goals associated with the same bot version. This name can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| label | 

Field Type

string

Description

Required.

A label that identifies the goal throughout the Salesforce user interface. This label can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |

## ConversationDefinitionPlanner

Represents the API name for the Agent planner service. Available in API version 60.0 and later.

| Field Name | Description |
| --- | --- |
| genAiPlannerName | 
Field Type

string

Description

The name of an agent planner service that uses a large language model (LLM) and a reasoning strategy to decompose a given task into smaller subtasks, identify the most suitable actions for each subtask, and invoke them.



 |

## ConversationSystemDialog

A system function assigned to a dialog. Available in API version 48.0 and later.

| Field Name | Description |
| --- | --- |
| dialog | 
Field Type

string

Description

The dialog name triggered when this system event fires.



 |
| type | 

Field Type

ConversationSystemDialogType (enumeration of type string)

Description

The type of system event. Required. Valid values are:

- Disambiguation (Reserved for Future Use)
- DisambiguationFailed (Reserved for Future Use)
- ErrorHandling
- KnowledgeAction (Available in API version 60.0.)
- KnowledgeFallback (Available in API version 51.0.)
- TransferFailed





 |

## ConversationVariable

A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs. Available in API version 44.0 and later.

| Field Name | Description |
| --- | --- |
| collectionType | 
Field Type

ConversationVariableCollectionType (enumeration of type string)

Description

This field defines whether a variable is designated as a List Variable. Valid value is List.



 |
| dataType | 

Field Type

ConversationVariableCollectionType (enumeration of type string)

Description

Required.

Valid values are:

- Boolean
- Currency
- Date
- DateTime
- Id (available in API 45.0 and later.)
- Object
- Number
- Text





 |
| description | 

Field Type

string

Description

A description of this variable. This value may be used by the Agentforce planner service. Available in API version 63.0 and later.





 |
| developerName | 

Field Type

string

Description

Required.

This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.



 |
| includeInPrompt | 

Field Type

boolean

Description

Indicates whether the variable is injected into the prompt sent to the Agentforce model. If true, the variable appears in the **Included Fields** section of the UI.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The default variables Id, EndUserId, and EndUserLanguage always appear in the **Included Fields** section of the UI, regardless of their value of includeInPrompt. We recommend that you don't change the value of includeInPrompt for these default variables, as changing the value can prevent your agent from accessing important session data.

Available in API version 63.0 and later.



 |
| label | 

Field Type

string

Description

Required.

Label that identifies a variable throughout the Salesforce user interface.



 |
| SObjectType | 

Field Type

string

Description

Specifies the SObjectType of the ID stored in a bot variable. Valid values are:

- BotDefinition
- Queue





 |
| visibility | 

Field Type

ConversationVariableVisibilityType (enumeration of type string)

Description

Required. Determines which components can set this variable. If the visibility is internal, the variable can only be set by action outputs. If the visibility is external, the variable can also be set by the API.

Valid values are:

- internal
- external





 |

## ConversationDefinitionNlpProvider

Defines the natural language service that is used for the language assigned to a bot version. Available in API version 49.0 and later.

| Field Name | Description |
| --- | --- |
| language | 
Field Type

Language

Description

Required.

The language assigned to a bot version.



 |
| nlpProviderName | 

Field Type

string

Description

If nlpProviderType is EinsteinAI, this field is blank. If Apex, this field holds the Apex class name of the service.



 |
| nlpProviderType | 

Field Type

ConversationDefinitionNlpProviderType (enumeration of type string)

Description

Required.

Default value is EinsteinAi. Valid values are:

- EinsteinAi
- Apex





 |

## Declarative Metadata Sample Definition

The following is an example of a BotVersion.

<?xml version="1.0" encoding="UTF-8"?>
<Bot xmlns="http://soap.sforce.com/2006/04/metadata">
    <botMlDomain\>
        <label\>Astros Pizza</label\>
        <mlIntents\>
            <developerName\>New\_Order</developerName\>
            <label\>New Order</label\>
            <mlIntentUtterances\>
                <utterance\>Today is pie day so I want pie</utterance\>
            </mlIntentUtterances\>
        </mlIntents\>
        <mlSlotClasses\>
            <developerName\>Size</developerName\>
            <extractionType\>Value</extractionType\>
            <label\>Size</label\>
            <mlSlotClassValues\>
                <synonymGroup\>
                    <languages\>en\_US</languages\>
                    <terms\>Big</terms\>
                    <terms\>Extra Large</terms\>
                    <terms\>X-Large</terms\>
                    <terms\>Grande</terms\>
                    <terms\>Huge</terms\>
                </synonymGroup\>
                <value\>Large</value\>
            </mlSlotClassValues\>
        </mlSlotClasses\>
        <name\>Astros\_Pizza\_ld1</name\>
    </botMlDomain\>
    <botVersions\>
        <fullName\>v1</fullName\>
        <botDialogGroups\>
            <developerName\>Order\_Management</developerName\>
            <label\>Order Management</label\>
        </botDialogGroups\>
        <botDialogs\>
            <botDialogGroup\>Order\_Management</botDialogGroup\>
            <botSteps\>
                <botMessages\>
                    <message\>🍕🍕🍕Pizza Time! 🍕🍕🍕</message\>
                    <messageIdentifier\>Greeting\_Message</messageIdentifier\>
                </botMessages\>
                <stepIdentifier\>Greeting</stepIdentifier\>
                <type\>Message</type\>
            </botSteps\>
            <botSteps\>
                <botStepConditions\>
                    <leftOperandName\>Verified\_User</leftOperandName\>
                    <leftOperandType\>ConversationVariable</leftOperandType\>
                    <operatorType\>Equals</operatorType\>
                    <rightOperandValue\>false</rightOperandValue\>
                </botStepConditions\>
                <botSteps\>
                    <botNavigation\>
                        <botNavigationLinks\>
                            <targetBotDialog\>Customer\_Verification</targetBotDialog\>
                        </botNavigationLinks\>
                        <type\>Call</type\>
                    </botNavigation\>
                    <stepIdentifier\>Call\_Customer\_Verification</stepIdentifier\>
                    <type\>Navigation</type\>
                </botSteps\>
                <stepIdentifier\>Verify\_User</stepIdentifier\>
                <type\>Group</type\>
            </botSteps\>
            <botSteps\>
                <botStepConditions\>
                    <leftOperandName\>Location</leftOperandName\>
                    <leftOperandType\>ConversationVariable</leftOperandType\>
                    <operatorType\>IsNotSet</operatorType\>
                </botStepConditions\>
                <botSteps\>
                    <botNavigation\>
                        <botNavigationLinks\>
                            <targetBotDialog\>Select\_Location</targetBotDialog\>
                        </botNavigationLinks\>
                        <type\>Call</type\>
                    </botNavigation\>
                    <stepIdentifier\>Call\_Select\_Location</stepIdentifier\>
                    <type\>Navigation</type\>
                </botSteps\>
                <stepIdentifier\>Set\_Location</stepIdentifier\>
                <type\>Group</type\>
            </botSteps\>
            <botSteps\>
                <botVariableOperation\>
                    <botInvocation\>
                        <invocationActionName\>CreateOrderService</invocationActionName\>
                        <invocationActionType\>apex</invocationActionType\>
                        <invocationMappings\>
                            <parameterName\>customer</parameterName\>
                            <type\>Input</type\>
                            <variableName\>Contact</variableName\>
                            <variableType\>ConversationVariable</variableType\>
                        </invocationMappings\>
                        <invocationMappings\>
                            <parameterName\>location</parameterName\>
                            <type\>Input</type\>
                            <variableName\>Location</variableName\>
                            <variableType\>ConversationVariable</variableType\>
                        </invocationMappings\>
                        <invocationMappings\>
                            <parameterName\>output</parameterName\>
                            <type\>Output</type\>
                            <variableName\>Pizza\_Order</variableName\>
                            <variableType\>ConversationVariable</variableType\>
                        </invocationMappings\>
                    </botInvocation\>
                    <type\>Set</type\>
                    <variableOperationIdentifier\>Set\_Order</variableOperationIdentifier\>
                </botVariableOperation\>
                <stepIdentifier\>Create\_Order</stepIdentifier\>
                <type\>VariableOperation</type\>
            </botSteps\>
            <botSteps\>
                <botMessages\>
                    <message\>Perfect, let&apos;s work on your order from our {!Location.Name} location</message\>
                    <messageIdentifier\>Start\_Order\_Message</messageIdentifier\>
                </botMessages\>
                <stepIdentifier\>Start\_Order</stepIdentifier\>
                <type\>Message</type\>
            </botSteps\>
            <botSteps\>
                <messageDefinition\>
                    <messageDefinitionName\>Astros\_Pizza\_Menu</messageDefinitionName\>
                </messageDefinition\>
                <stepIdentifier\>36e5a7cb-50c4-4279-aa06-1217eba1bf62</stepIdentifier\>
                <type\>RichMessage</type\>
            </botSteps\>
            <botSteps\>
                <botNavigation\>
                    <botNavigationLinks\>
                        <targetBotDialog\>Add\_Items\_to\_Order</targetBotDialog\>
                    </botNavigationLinks\>
                    <type\>Redirect</type\>
                </botNavigation\>
                <stepIdentifier\>Proceed\_To\_Add\_Items</stepIdentifier\>
                <type\>Navigation</type\>
            </botSteps\>
            <developerName\>New\_Order</developerName\>
            <label\>New Order</label\>
            <mlIntent\>New\_Order</mlIntent\>
            <showInFooterMenu\>false</showInFooterMenu\>
        </botDialogs\>
        <conversationVariables\>
            <dataType\>Object</dataType\>
            <developerName\>Contact</developerName\>
            <label\>Contact</label\>
        </conversationVariables\>
        <conversationVariables\>
            <dataType\>Text</dataType\>
            <developerName\>Delivery\_Address</developerName\>
            <label\>Delivery Address</label\>
        </conversationVariables\>
        <conversationVariables\>
            <dataType\>Object</dataType\>
            <developerName\>Pizza\_Order</developerName\>
            <label\>Pizza Order</label\>
        </conversationVariables\>
        <entryDialog\>Welcome</entryDialog\>
        <mainMenuDialog\>Main\_Menu</mainMenuDialog\>
    </botVersions\>
    <label\>Astro&apos;s Pizza</label\>
</Bot\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Astros Pizza\_Bot.v1</members\>
        <name\>BotVersion</name\>
    </types\>
    <version\>45.0</version\>
</Package\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=66d2c59e4a919774a5a693b56c28ed6ae4c46a46db92eedbaf21903d85af8c0b url=/legacydeveloper/current/en-us/api_meta/meta_branchmanagementsettings.md -->

# 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) 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.

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

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>BranchManagement</members>
        <name>Settings</name>
    </types>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=119a0fd8d67e448f3295e4f8d4c9447b717ca8cc6924f9b6f5cc50788883ba07 url=/legacydeveloper/current/en-us/api_meta/meta_brandingset.md -->

# BrandingSet

Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

BrandingSet components have the suffix brandingSet and are stored in the brandingSets folder.

## Version

BrandingSet components are available in API version 40.0 and later.

## Special Access Rules

The BrandingSet type is available when at least one of the following is enabled in your org: Digital Experiences, Surveys, or Lightning Experience. All users, including unauthenticated guest users, can access this type.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| brandingSetProperty | [BrandingSetProperty](#BrandingSetProperty)\[\] | An array containing the name and value of each branding property, such as TextColor:#333. |
| description | string | A description of the set of branding properties. |
| masterLabel | string | Required. The user interface name of the set of branding properties. |
| type | string | The assigned branding set definition for this BrandingSet. |

## BrandingSetProperty

Represents the definition of a branding property in the Theme panel in Experience Builder or in the Edit Theme page in Setup.

| Field Name | Field Type | Description |
| --- | --- | --- |
| propertyName | string | Required. The name of the branding property, such as TextColor. |
| propertyValue | string | The value of the branding property, such as #333. |

## Branding Properties for Lightning Experience Themes

Use these properties to describe Lightning Experience themes. Each propertyName is case-sensitive and must use all capital letters. Some properties only apply to either Salesforce Lightning Design System (SLDS) 1 themes or SLDS 2 themes.

| Property | Description |
| --- | --- |
| ACCENT\_COLOR\_1 | 
Field Type

string

Description

The primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 64.0 and later.



 |
| ACCENT\_COLOR\_1\_DARK\_MODE | 

Field Type

string

Description

The primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states when a user views Salesforce in dark mode. Must be a valid hex string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| ACCENT\_COLOR\_2 | 

Field Type

string

Description

A variant of the primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 64.0 and later.



 |
| ACCENT\_COLOR\_2\_DARK\_MODE | 

Field Type

string

Description

A variant of the primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states when a user views Salesforce in dark mode. Must be a valid hex string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| ACCENT\_COLOR\_3 | 

Field Type

string

Description

A variant of the primary accent color used to highlight active states of the user interface, like navigation, tabs, and hover states. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 64.0 and later.



 |
| ACCENT\_COLOR\_3\_DARK\_MODE | 

Field Type

string

Description

A variant of the primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states when a user views Salesforce in dark mode. Must be a valid hex string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| ACCENT\_CONTAINER\_CONTENT\_COLOR\_1 | 

Field Type

string

Description

The primary color used for the icons and text within accent containers. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| ACCENT\_CONTAINER\_CONTENT\_COLOR\_1\_DARK\_MODE | 

Field Type

string

Description

The primary color used for the icons and text within accent containers when a user views Salesforce with dark mode enabled. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| ACCENT\_CONTAINER\_CONTENT\_COLOR\_2 | 

Field Type

string

Description

A variant of the primary color used for the icons and text within accent containers. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| ACCENT\_CONTAINER\_CONTENT\_COLOR\_2\_DARK\_MODE | 

Field Type

string

Description

A variant of the primary color used for the icons and text within accent containers when a user views Salesforce with dark mode enabled. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| ACCENT\_CONTAINER\_CONTENT\_COLOR\_3 | 

Field Type

string

Description

A variant of the primary color used for the icons and text within accent containers. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| ACCENT\_CONTAINER\_CONTENT\_COLOR\_3\_DARK\_MODE | 

Field Type

string

Description

A variant of the primary color used for the icons and text within accent containers when a user views Salesforce with dark mode enabled. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| BANNER\_IMAGE | 

Field Type

string

Description

The path to the image to display in the background of your org's pages. Use a JPG, PNG, or GIF that's 1800x360 pixels and smaller than 5 MB. Must refer to an [asset file](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org.

Available only for SLDS 1 themes.



 |
| BRAND\_COLOR | 

Field Type

string

Description

The color to display on your nav bar and other important areas of Salesforce. Must be a valid hex color string in the format #54C254.



 |
| BRAND\_IMAGE | 

Field Type

string

Description

The path to the image to display as your logo. Use a JPG, PNG, or GIF that’s 600x120 pixels and smaller than 5 MB. Must refer to an [asset file](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org.



 |
| BRAND\_IMAGE\_DARK\_MODE | 

Field Type

string

Description

The path to the image to display as your logo when a user views Salesforce in dark mode. Use a JPG, PNG, or GIF that’s 600x120 pixels and smaller than 5 MB. Must refer to an [asset file](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| CONTAINER\_ACCENT\_COLOR\_1 | 

Field Type

string

Description

The primary color used for the background of branded component containers like the brand button. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 64.0 and later.



 |
| CONTAINER\_ACCENT\_COLOR\_1\_DARK\_MODE | 

Field Type

string

Description

The primary color used for the background of branded component containers like the brand button when a user views Salesforce in dark mode. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| CONTAINER\_ACCENT\_COLOR\_2 | 

Field Type

string

Description

A variant of the primary color used for the background of branded component containers. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 64.0 and later.



 |
| CONTAINER\_ACCENT\_COLOR\_2\_DARK\_MODE | 

Field Type

string

Description

A variant of the primary color used for the background of branded component containers when a user views Salesforce in dark mode. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| CONTAINER\_ACCENT\_COLOR\_3 | 

Field Type

string

Description

A variant of the primary color used for the background of branded component containers. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 64.0 and later.



 |
| CONTAINER\_ACCENT\_COLOR\_3\_DARK\_MODE | 

Field Type

string

Description

A variant of the primary color used for the background of branded component containers when a user views Salesforce in dark mode. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254.

Available only for SLDS 2 themes. Available in API version 65.0 and later.



 |
| GROUP\_IMAGE | 

Field Type

string

Description

The default group avatar image. Use a JPG, PNG, or GIF that's 200x200 pixels and smaller than 5 MB. Group owners can change their avatar image. Must refer to an [asset file](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org.



 |
| GROUPS\_BANNER\_IMAGE | 

Field Type

string

Description

The default banner image for group pages. Use a JPG, PNG, or GIF that’s 1800x360 pixels and smaller than 5 MB. Group owners can change their banner image. Must refer to an [asset file](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org.



 |
| HEADER\_BACKGROUND\_COLOR | 

Field Type

string

Description

The color to display at the top of your org pages. Your logo, global search, and global actions appear on top of the global header background. Must be a valid hex color string in the format #54C254.

Available only for SLDS 1 themes.



 |
| LINK\_AS\_BACKGROUND | 

Field Type

boolean

Description

Indicates whether you want links in your org to use your selected brand color (true) or not (false). The default value is true.

Available only for SLDS 1 themes.



 |
| OVERRIDE\_A11Y\_COLOR | 

Field Type

string

Description

When you select a value for BRAND\_COLOR, a color palette that complements your brand color and is WCAG 2.0 compliant is automatically generated. In places where your selected brand color isn’t accessible, an accessible color is used instead. If you provide a value for OVERRIDE\_A11Y\_COLOR, your value is used in the instances described in place of an automatically generated color.

Overriding the accessible brand color only updates the first tile in your brand-based color palette, which affects colors like links and buttons. Overriding the accessibility brand color can make text harder to read.

Must be a valid hex color string in the format #54C254.

Available only for SLDS 1 themes.



 |
| OVERRIDE\_LOADING\_PAGE | 

Field Type

boolean

Description

Indicates whether your provided brand logo displays while a Lighting Experience page loads or refreshes (true) or not (false). The default value is false.



 |
| PAGE\_BACKGROUND\_COLOR | 

Field Type

string

Description

The color used for page backgrounds. Must be a valid hex color string in the format #54C254.

Available only for SLDS 1 themes.



 |
| PROFILE\_BANNER\_IMAGE | 

Field Type

string

Description

The default banner image for user profiles. Use a JPG, PNG, or GIF that's 1800x360 pixels and smaller than 5 MB. Users can change their profile banner image. Must refer to an [asset file](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org.



 |
| USER\_IMAGE | 

Field Type

string

Description

The default avatar image for user profiles. Use a JPG, PNG, or GIF that's 200x200 pixels and smaller than 5 MB. Users can change their profile avatar image. Must refer to an [asset file](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org.



 |

## Declarative Metadata Sample Definition

The following is an example of a BrandingSet component.

<?xml version="1.0" encoding="UTF-8"?>
<BrandingSet xmlns="http://soap.sforce.com/2006/04/metadata">
    <brandingSetProperty\>
        <propertyName\>TextTransformStyle</propertyName\>
        <propertyValue\>uppercase</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>DetailTextColor</propertyName\>
        <propertyValue\>#696969</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>BorderColor</propertyName\>
        <propertyValue\>#D4D4D4</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>HeaderImage</propertyName\>
        <propertyValue\></propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>HeaderFonts</propertyName\>
        <propertyValue\>Montserrat</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>CardBackgroundColor</propertyName\>
        <propertyValue\>rgba(255, 255, 255, 0)</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>LoginBackgroundColor</propertyName\>
        <propertyValue\>#F4F4F4</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>ActionColor</propertyName\>
        <propertyValue\>#2574A9</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>\_ActionColorTrans</propertyName\>
        <propertyValue\>rgba(25, 124, 190, 0.9)</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>CompanyLogo</propertyName\>
        <propertyValue\></propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>LoginBackgroundImage</propertyName\>
        <propertyValue\>../../../../sfsites/picasso/core/external/
            salesforceIdentity/images/background.jpg?v=1</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>\_LinkColorDarker</propertyName\>
        <propertyValue\>#135F90</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>\_ActionColorDarker</propertyName\>
        <propertyValue\>#135F90</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>\_HoverColor</propertyName\>
        <propertyValue\>rgba(25, 124, 190, 0.1)</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>ErrorFontColor</propertyName\>
        <propertyValue\>#ff9e9e</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>TextColor</propertyName\>
        <propertyValue\>#333</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>OverlayTextColor</propertyName\>
        <propertyValue\>#FFFFFF</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>PrimaryFont</propertyName\>
        <propertyValue\>Lato</propertyValue\>
    </brandingSetProperty\>
    <brandingSetProperty\>
        <propertyName\>LinkColor</propertyName\>
        <propertyValue\>#2574A9</propertyValue\>
    </brandingSetProperty\>
    <masterLabel\>ex</masterLabel\>
    <type\>napili:branding-napili-merged</type\>
</BrandingSet\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyBrandingSet</members\>
        <name\>BrandingSet</name\>
    </types\>
    <version\>40.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=c2fddab393b41ebe385990196e977ed4f5020b2b188fd9312c106d62e8dd0670 url=/legacydeveloper/current/en-us/api_meta/meta_briefcasedefinition.md -->

# BriefcaseDefinition

Represents a briefcase definition. A briefcase makes selected records available for specific users and groups to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

BriefcaseDefinition components have the suffix .briefcaseDefinition and are stored in the briefcaseDefinitions folder.

## Version

BriefcaseDefinition components are available in API version 50.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d210363e91">Field Name</th>

              <th class="featureTableHeader  " id="d210363e94">Field Type</th>

              <th class="featureTableHeader  " id="d210363e97">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d210363e91" data-title="Field Name"><span class="keyword parmname">briefcaseRules</span></td>

              <td class="entry" headers="d210363e94" data-title="Field Type">BriefcaseRule[]</td>

              <td class="entry" headers="d210363e97" data-title="Description">A list of rules that specify which records are included in the
                briefcase.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e91" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d210363e94" data-title="Field Type">string</td>

              <td class="entry" headers="d210363e97" data-title="Description">Description of the briefcase.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e91" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d210363e94" data-title="Field Type">boolean</td>

              <td class="entry" headers="d210363e97" data-title="Description">Required. Indicates whether the briefcase is active by default (<samp class="codeph nolang">true</samp>) or inactive (<samp class="codeph nolang">false</samp>). Activate a briefcase to make the selected records available to
                assignees.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e91" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d210363e94" data-title="Field Type">string</td>

              <td class="entry" headers="d210363e97" data-title="Description">Required. Label for the briefcase name that appears in the Salesforce user
                interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e91" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d210363e94" data-title="Field Type">
                <samp class="codeph nolang">BriefcaseType</samp> (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d210363e97" data-title="Description">Applies if multiple briefcase types are available in your org. Valid values
                include: <a name="ul_l3j_tmr_jgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_l3j_tmr_jgc">
                  <li class="li">
                    <samp class="codeph nolang">Standard</samp>: Standard briefcase that can be
                    used with priming APIs.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HighVolume</samp>: Increased capacity briefcase
                    that’s used with performance priming in the Salesforce Field Service mobile app.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MobileAppSync</samp>: Automatically generated
                    briefcase that’s used for performance priming in the Salesforce Field Service
                    mobile app.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## BriefcaseRule

Represents a rule that specifies records to be included in the BriefcaseDefinition.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d210363e225">Field Name</th>

              <th class="featureTableHeader  " id="d210363e228">Field Type</th>

              <th class="featureTableHeader  " id="d210363e231">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">briefcaseRuleFilters</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">
                <a class="xref" href="#BriefcaseRuleFilter">BriefcaseRuleFilter</a>[]
              </td>

              <td class="entry" headers="d210363e231" data-title="Description">A list of filters on a rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">filterLogic</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">string</td>

              <td class="entry" headers="d210363e231" data-title="Description">The filter logic for record selection, for example, <samp class="codeph nolang">1 AND 2</samp> where 1 and 2 correspond to filter 1 and filter 2. Filter logic
                operators include <samp class="codeph nolang">AND</samp> and <samp class="codeph nolang">OR</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">isAscendingOrder</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">boolean</td>

              <td class="entry" headers="d210363e231" data-title="Description">Indicates whether the records should be sorted in ascending order (<samp class="codeph nolang">true</samp>) or descending order (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">isRelatedFilesRule</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">boolean</td>

              <td class="entry" headers="d210363e231" data-title="Description">Indicates whether the briefcase rule is part of a hierarchical set of rules
                that configure the offline priming of file attachments. Available only for the
                Offline App (Salesforce Mobile App Plus).<p class="p">To configure the offline priming of file
                  attachments, create a set of four hierarchical briefcase rules:</p>
                <ul class="ul bulletList">
                  <li class="li">A rule with <span class="keyword parmname">targetEntity</span> set to the object with the file
                    attachments at the first level</li>

                  <li class="li">A rule with <span class="keyword parmname">targetEntity</span> set to <samp class="codeph nolang">ContentDocumentLink</samp> at the second level</li>

                  <li class="li">A rule with <span class="keyword parmname">targetEntity</span> set to <samp class="codeph nolang">ContentDocument</samp> at the third level</li>

                  <li class="li">A rule with <span class="keyword parmname">targetEntity</span> set to <samp class="codeph nolang">ContentVersion</samp> at the fourth level</li>

                </ul>

                <p class="p">See the Declarative Metadata Sample Definition section for an example briefcase
                  definition that configures the offline priming of file attachments.</p>

                <p class="p">The <samp class="codeph nolang">ContentDocumentLink</samp>, <samp class="codeph nolang">ContentDocument</samp>, and <samp class="codeph nolang">ContentVersion</samp> rules must all have
                  <span class="keyword parmname">isRelatedFilesRule</span> set to <samp class="codeph nolang">true</samp>. To delete a briefcase configuration for file attachments, you
                  must delete the <samp class="codeph nolang">ContentDocumentLink</samp> rule and
                  all of its nested rules. You can’t delete a single rule within the hierarchy of
                  <samp class="codeph nolang">ContentDocumentLink</samp>, <samp class="codeph nolang">ContentDocument</samp>, and <samp class="codeph nolang">ContentVersion</samp> rules.
                </p>
                <p class="p">When
                  <span class="keyword parmname">isRelatedFilesRule</span> is set to true, you must use the
                  <span class="keyword parmname">recordLimit</span> field to limit the number of file attachments
                  returned by a briefcase rule. Apply the same <span class="keyword parmname">recordLimit</span>
                  value across the <samp class="codeph nolang">ContentDocumentLink</samp>, <samp class="codeph nolang">ContentDocument</samp>, and <samp class="codeph nolang">ContentVersion</samp> rules. You can optionally filter file attachments by
                  file size and file type through Briefcase Builder in Setup.
                </p>
                After you set a
                value for <span class="keyword parmname">isRelatedFilesRule</span>, you can no longer modify the
                field. The value that you set persists for the life of the rule.<p class="p">Removed in API
                  version 63.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">orderBy</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">string</td>

              <td class="entry" headers="d210363e231" data-title="Description">The field to order the records by, which determines how the records can be
                sorted. For example, Account Name or Created By.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">queryScope</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">
                <samp class="codeph nolang">FilterScope</samp> (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d210363e231" data-title="Description">A group of records to restrict the scope of this rule. Valid values include:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Everything</samp></li>

                  <li class="li"><samp class="codeph nolang">AssignedToMe</samp></li>

                  <li class="li"><samp class="codeph nolang">Mine</samp></li>

                </ul>
                <p class="p">The <samp class="codeph nolang">AssignedToMe</samp> scope is supported for
                  the ServiceAppointment object only.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">recordLimit</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">int</td>

              <td class="entry" headers="d210363e231" data-title="Description">The maximum number of records for an object on the briefcase rule. The maximum
                is 50,000 records that meet the criteria. However, the records returned by one
                briefcase rule must fit within the maximum limit of 50,000 records across active
                briefcases. If there are more records that match the criteria than the record limit
                allows, the <span class="keyword parmname">orderBy</span> field determines which records are
                returned.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">relatedRules</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">BriefcaseRule[]</td>

              <td class="entry" headers="d210363e231" data-title="Description">A list of rules that are related to the current rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">relationshipField</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">string</td>

              <td class="entry" headers="d210363e231" data-title="Description">Required for <span class="keyword parmname">relatedRules</span>. Defines the Salesforce object
                field that relates the <span class="keyword parmname">relatedRules</span> field to another
                <span class="keyword parmname">relatedRules</span> field or the <span class="keyword parmname">briefcaseRules</span>
                field on the BriefcaseDefinition metadata type that it's nested in. For example, an
                Account object rule can be related to a Contact object rule using the Account ID
                object field. In this example, the value for the related rule's
                <span class="keyword parmname">relationshipField</span> is <samp class="codeph nolang">AccountID</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">relationshipType</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">
                <samp class="codeph nolang">BriefcaseRuleRelationshipType</samp> (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d210363e231" data-title="Description">Required for <span class="keyword parmname">relatedRules</span>. Defines the relationship
                between the <span class="keyword parmname">relatedRules</span> field and another
                <span class="keyword parmname">relatedRules</span> field or the <span class="keyword parmname">briefcaseRules</span>
                field on the BriefcaseDefinition metadata type that it's nested in. Valid values include:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ParentToChild</samp></li>

                  <li class="li"><samp class="codeph nolang">ChildToParent</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e225" data-title="Field Name"><span class="keyword parmname">targetEntity</span></td>

              <td class="entry" headers="d210363e228" data-title="Field Type">string</td>

              <td class="entry" headers="d210363e231" data-title="Description">Required. The API name of the standard object, custom object, or custom
                metadata type that the briefcase rule selects records from.<p class="p">If the
                  <span class="keyword parmname">targetEntity</span> is a custom metadata type, the briefcase rule
                  can’t include any other fields. You can add only one briefcase rule for the same
                  custom metadata type in a briefcase. Custom metadata types are supported as the
                  <span class="keyword parmname">targetEntity</span> for top-level rules only–you can’t create a
                  related rule with <span class="keyword parmname">targetEntity</span> as a custom metadata type.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## BriefcaseRuleFilter

Specifies filter criteria for a BriefcaseRule.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d210363e613">Field Name</th>

              <th class="featureTableHeader  " id="d210363e616">Field Type</th>

              <th class="featureTableHeader  " id="d210363e619">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d210363e613" data-title="Field Name"><span class="keyword parmname">filterOperator</span></td>

              <td class="entry" headers="d210363e616" data-title="Field Type">
                <samp class="codeph nolang">BriefcaseFilterOperator</samp> (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d210363e619" data-title="Description">Required. The comparison operator for this rule filter. Capitalization matters
                with date filter operators. Be sure to specify date literals in uppercase. Some
                valid date literals include TODAY, YESTERDAY and TOMORROW. <div class="p">Valid values include:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">d</samp>—Ends with
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">e</samp>—Equals
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">g</samp>—Greater than
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">h</samp>—Greater than or equal
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">l</samp>—Less than
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">m</samp>—Less than or equal
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">n</samp>—Not equals. This value is
                      applicable only when <span class="keyword parmname">filterValue</span> is empty.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">s</samp>—Starts with
                    </li>

                  </ul>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e613" data-title="Field Name"><span class="keyword parmname">filterSeqNumber</span></td>

              <td class="entry" headers="d210363e616" data-title="Field Type">int</td>

              <td class="entry" headers="d210363e619" data-title="Description">Required. The filter number. When you apply multiple filters, the filters are
                numbered sequentially, 1, 2, 3, and so on.</td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e613" data-title="Field Name"><span class="keyword parmname">filterValue</span></td>

              <td class="entry" headers="d210363e616" data-title="Field Type">string</td>

              <td class="entry" headers="d210363e619" data-title="Description">The value that the field and criteria evaluate. For example, <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>
                for a boolean field whose criteria or filter operator is Equals.<p class="p">Be sure to
                  specify date literals in uppercase. Some valid date literals include TODAY,
                  YESTERDAY and TOMORROW.</p>
                <p class="p">For <span class="keyword parmname">targetEntityField</span> values
                  that accept a user ID, such as <samp class="codeph nolang">OwnerId</samp> or
                  <samp class="codeph nolang">CreatedById</samp>, enter <samp class="codeph nolang">$User.Id</samp> to pass the ID of the user making the
                  request.
                </p>
                <p class="p">To evaluate <span class="keyword parmname">targetEntityField </span>by whether the
                  field is empty or not empty, leave <span class="keyword parmname">filterValue</span> blank and set
                  <span class="keyword parmname">filterOperator </span>to <samp class="codeph nolang">e</samp>
                  (equals) or <samp class="codeph nolang">n</samp> (not equals).
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d210363e613" data-title="Field Name"><span class="keyword parmname">targetEntityField</span></td>

              <td class="entry" headers="d210363e616" data-title="Field Type">string</td>

              <td class="entry" headers="d210363e619" data-title="Description">Required. The API name of the field to filter by. This field is from the
                <span class="keyword parmname">targetEntity</span> on BriefcaseRule. Compound fields aren't
                supported. Fields encrypted with deterministic encryption can be used in filters
                with equals and not equals operators.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a BriefcaseDefinition component for account records.

The following is an example definition of a briefcase definition. If you include a rule filter, you must include a filter logic.

<?xml version="1.0" encoding="UTF-8"?>
<BriefcaseDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <briefcaseRules\>
        <briefcaseRuleFilters\>
           <filterOperator\>g</filterOperator\>
           <filterSeqNumber\>1</filterSeqNumber\>
           <filterValue\>50000.00</filterValue\>
           <targetEntityField\>AnnualRevenue</targetEntityField\>
        </briefcaseRuleFilters\>
        <briefcaseRuleFilters\>
            <filterOperator\>l</filterOperator\>
            <filterSeqNumber\>2</filterSeqNumber\>
            <filterValue\>50</filterValue\>
            <targetEntityField\>NumberOfEmployees</targetEntityField\>
        </briefcaseRuleFilters\>
        <filterLogic\>1 AND 2</filterLogic\>
        <isAscendingOrder\>false</isAscendingOrder\>
        <orderBy\>NumberOfEmployees</orderBy\>
        <queryScope\>Everything</queryScope\>
        <recordLimit\>1000</recordLimit\>
        <targetEntity\>Account</targetEntity\>
    </briefcaseRules\>
    <description\>Account Briefcase</description\>
    <isActive\>true</isActive\>
    <masterLabel\>Account With Standard Fields</masterLabel\>
</BriefcaseDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>AccountWithCustomFields</members\>
        <name\>BriefcaseDefinition</name\>
    </types\>
    <version\>49.0</version\>
</Package\>

This example briefcase definition configures the offline priming of file attachments for the WorkOrder object. Files Priming is available only for the Offline App (Salesforce Mobile App Plus).

<?xml version="1.0" encoding="UTF-8"?>
<BriefcaseDefinition xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <briefcaseRules\>
       <isAscendingOrder\>false</isAscendingOrder\>
       <orderBy\>SystemModstamp</orderBy\>
       <queryScope\>Everything</queryScope\>
       <recordLimit\>25</recordLimit\>
       <targetEntity\>WorkOrder</targetEntity\>
       <relatedRules\>
           <targetEntity\>ContentDocumentLink</targetEntity\>
           <relationshipField\>LinkedEntityId</relationshipField\>
           <relationshipType\>ParentToChild</relationshipType\>
           <isAscendingOrder\>false</isAscendingOrder\>
           <isRelatedFilesRule\>true</isRelatedFilesRule\>
           <queryScope\>Everything</queryScope\>
           <recordLimit\>2</recordLimit\>
           <relatedRules\>
               <targetEntity\>ContentDocument</targetEntity\>
               <relationshipField\>ContentDocumentId</relationshipField\>
               <relationshipType\>ChildToParent</relationshipType\>
               <isAscendingOrder\>false</isAscendingOrder\>
               <isRelatedFilesRule\>true</isRelatedFilesRule\>
               <queryScope\>Everything</queryScope\>
               <recordLimit\>2</recordLimit\>
               <relatedRules\>
                   <targetEntity\>ContentVersion</targetEntity\>
                   <relationshipField\>ContentDocumentId</relationshipField\>
                   <relationshipType\>ParentToChild</relationshipType\>
                   <isAscendingOrder\>false</isAscendingOrder\>
                   <isRelatedFilesRule\>true</isRelatedFilesRule\>
                   <queryScope\>Everything</queryScope\>
                   <recordLimit\>2</recordLimit\>
               </relatedRules\>
           </relatedRules\>
       </relatedRules\>
   </briefcaseRules\>
   <description xsi:nil="true"/>
   <isActive\>true</isActive\>
   <masterLabel\>WorkOrder with Related Files</masterLabel\>
</BriefcaseDefinition\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

## Usage

Briefcase objects are available in orgs that have Briefcase Builder and Field Service enabled.

<!-- document id=46e63390a5f242c3a56ab1475ace1b732d10fdd8d28ab52ad7375e5cb4af33b0 url=/legacydeveloper/current/en-us/api_meta/meta_quickstart.md -->

# Build Client Applications for Metadata API

Use Metadata API to retrieve, deploy, create, update, or delete customizations for your org. The most common use is to migrate changes from a sandbox or testing org to your production environment. Metadata API is intended for managing customizations and for building tools that can manage the metadata model, not the data itself.

Salesforce CLI automates the underlying calls of Metadata API. However, you can use these calls directly with your own client application. This guide gives you all the information you require to start writing applications that directly use Metadata API to manage customizations for your organization. It shows you how to get started with File-Based Development. For an example of CRUD-Based Development, see [Java Sample for CRUD-Based Development with Synchronous Calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_calls_intro.htm "Use the CRUD-based metadata calls to create, update, or delete setup and configuration components for your organization or application. These configuration components include custom objects, custom fields, and other configuration metadata. The metadata calls mimic the behavior in the Salesforce user interface for creating, updating, or deleting components. Whatever rules apply there also apply to these calls.").

<!-- document id=d98b70ac1798e4dd0002af9392797cc2940aaeb90307613d6b350fe5a1b271dd url=/legacydeveloper/current/en-us/api_meta/meta_businesshourssettings.md -->

# BusinessHoursSettings

Represents the metadata used to manage settings for business hours and holidays in entitlements, entitlement templates, campaigns, and cases. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

Business hours and holidays settings are stored in a single file named businessHours.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

BusinessHoursSettings is available in API version 29.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| businessHours | [BusinessHoursEntry](#BusinessHoursEntry)\[\] | Represents the application of business hours to entitlements, entitlement templates, campaigns, and cases. |
| holidays | [Holidays](#Holidays)\[\] | Represents a holiday and its usage in businessHours. |

## BusinessHoursEntry

Represents the application of business hours to entitlements, entitlement templates, campaigns, and cases.

| Field Name | Field Type | Description |
| --- | --- | --- |
| timeZoneId | string | The time zone for the time that defines business hours. |
| name | string | Name of the business hours. This name should be unique. |
| active | string | Indicates whether the business hours are active. |
| default | string | Indicates whether the business hours are used as the default business hours. |
| mondayStartTime | string | Start time for the business hours on Monday. Uses the format HH:mm:ss.SSSZ. |
| mondayEndTime | string | End time for the business hours on Monday. Uses the format HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight on Monday. |
| tuesdayStartTime | string | Start time for the business hours on Tuesday. Uses the format HH:mm:ss.SSSZ. |
| tuesdayEndTime | string | End time for the business hours on Tuesday. Uses the format HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight on Tuesday. |
| wednesdayStartTime | string | Start time for the business hours on Wednesday. Uses the format HH:mm:ss.SSSZ. |
| wednesdayEndTime | string | End time for the business hours on Wednesday. Uses the format HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight on Wednesday. |
| thursdayStartTime | string | Start time for the business hours on Thursday. Uses the format HH:mm:ss.SSSZ. |
| thursdayEndTime | string | End time for the business hours on Thursday. Uses the format HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight on Thursday. |
| fridayStartTime | string | Start time for the business hours on Friday. Uses the format HH:mm:ss.SSSZ. |
| fridayEndTime | string | End time for the business hours on Friday. Uses the format HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight on Friday. |
| saturdayStartTime | string | Start time for the business hours on Saturday. Uses the format HH:mm:ss.SSSZ. |
| saturdayEndTime | string | End time for the business hours on Saturday. Uses the format HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight on Saturday. |
| sundayStartTime | string | Start time for the business hours on Sunday. Uses the format HH:mm:ss.SSSZ. |
| sundayEndTime | string | End time for the business hours on Sunday. Uses the format HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight on Sunday. |

## Holidays

Represents a holiday and its usage in businessHours.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Name of the holiday. This name does not have to be unique. |
| description | string | The description of the holiday. |
| isRecurring | string | Indicates whether the holiday is recurring. |
| activityDate | string | The date of the holiday. Use for non-recurring holidays. Uses the format HH:mm:ss.SSSZ. |
| recurrenceStartDate | string | The date the holiday starts recurring. Uses the format yyyy-mm-dd. |
| recurrenceEndDate | string | The date the holiday stops recurring. Uses the format yyyy-mm-dd. Optional. |
| startTime | string | The start time on the date of the holiday. Uses the format HH:mm:ss.SSSZ. startTime and endTime must be both null or both not null. If they are both null, indicates the whole day. |
| endTime | string | The end time on the date of the holiday. Uses the format HH:mm:ss.SSSZ. startTime and endTime must be both null or both not null. If they are both null, indicates the whole day. |
| recurrenceType | string | The recurrence type of the holiday. Valid values are: RecursDaily, RecursEveryWeekday, RecursMonthly, RecursMonthlyNth, RecursWeekly, RecursYearly, RecursYealyNth. |
| recurrenceInterval | string | The interval of weeks, months, or years the holiday recurs. |
| recurrenceDayOfWeek | string | The day of week the holiday recurs. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. |
| recurrenceDayOfMonth | string | The day of month the holiday recurs. Valid values: integers 1-31. |
| recurrenceInstance | string | Valid values: First, Second, Third, Fourth, Last. Only used for recurrenceType RecursMonthlyNth and RecursYearlyNth. For example, if the recurenceInstance value is First, the holiday recurs on the first Monday of the month every 3 months. |
| recurrenceMonthOfYear | string | Valid values: January, February, March, April, May, June, July, August, September, October, November, December. |
| businessHours | string | The name of the business hours setting that applies to this holiday. |

## Declarative Metadata Sample Definition

The following is an example businesshours.settings metadata file:

<?xml version="1.0" encoding="UTF-8"?>
<BusinessHoursSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <businessHours\>
        <active\>true</active\>
        <default\>true</default\>
        <fridayEndTime\>00:00:00.000Z</fridayEndTime\>
        <fridayStartTime\>00:00:00.000Z</fridayStartTime\>
        <mondayEndTime\>00:00:00.000Z</mondayEndTime\>
        <mondayStartTime\>00:00:00.000Z</mondayStartTime\>
        <name\>Default</name\>
        <saturdayEndTime\>00:00:00.000Z</saturdayEndTime\>
        <saturdayStartTime\>00:00:00.000Z</saturdayStartTime\>
        <sundayEndTime\>00:00:00.000Z</sundayEndTime\>
        <sundayStartTime\>00:00:00.000Z</sundayStartTime\>
        <thursdayEndTime\>00:00:00.000Z</thursdayEndTime\>
        <thursdayStartTime\>00:00:00.000Z</thursdayStartTime\>
        <timeZoneId\>America/Los\_Angeles</timeZoneId\>
        <tuesdayEndTime\>00:00:00.000Z</tuesdayEndTime\>
        <tuesdayStartTime\>00:00:00.000Z</tuesdayStartTime\>
        <wednesdayEndTime\>00:00:00.000Z</wednesdayEndTime\>
        <wednesdayStartTime\>00:00:00.000Z</wednesdayStartTime\>
    </businessHours\>
    <businessHours\>
        <active\>true</active\>
        <default\>false</default\>
        <fridayEndTime\>00:00:00.000Z</fridayEndTime\>
        <fridayStartTime\>00:00:00.000Z</fridayStartTime\>
        <mondayEndTime\>15:00:00.000Z</mondayEndTime\>
        <mondayStartTime\>09:00:00.000Z</mondayStartTime\>
        <name\>bh1</name\>
        <saturdayEndTime\>00:00:00.000Z</saturdayEndTime\>
        <saturdayStartTime\>00:00:00.000Z</saturdayStartTime\>
        <sundayEndTime\>00:00:00.000Z</sundayEndTime\>
        <sundayStartTime\>00:00:00.000Z</sundayStartTime\>
        <thursdayEndTime\>17:00:00.000Z</thursdayEndTime\>
        <thursdayStartTime\>10:50:00.000Z</thursdayStartTime\>
        <timeZoneId\>America/Los\_Angeles</timeZoneId\>
        <tuesdayEndTime\>13:00:00.000Z</tuesdayEndTime\>
        <tuesdayStartTime\>09:00:00.000Z</tuesdayStartTime\>
        <wednesdayEndTime\>15:00:00.000Z</wednesdayEndTime\>
        <wednesdayStartTime\>09:00:00.000Z</wednesdayStartTime\>
    </businessHours\>
    <holidays\>
        <activityDate\>2013-09-02</activityDate\>
        <businessHours\>Default</businessHours\>
        <businessHours\>bh1</businessHours\>
        <isRecurring\>false</isRecurring\>
        <name\>Labor Day</name\>
    </holidays\>
    <holidays\>
        <businessHours\>bh1</businessHours\>
        <isRecurring\>true</isRecurring\>
        <name\>Christmas</name\>
        <recurrenceDayOfMonth\>25</recurrenceDayOfMonth\>
        <recurrenceMonthOfYear\>December</recurrenceMonthOfYear\>
        <recurrenceStartDate\>2013-12-25</recurrenceStartDate\>
        <recurrenceType\>RecursYearly</recurrenceType\>
    </holidays\>
</BusinessHoursSettings\>

The following is an example package.xml manifest that references the BusinessHoursSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>BusinessHours</members\>
        <name\>Settings</name\>
    </types\>
    <version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=d80d218002822e1f8c0116f8cd4b9fefc4eebb52a36b7e986d99bf56dc132c22 url=/legacydeveloper/current/en-us/api_meta/meta_businessprocess.md -->

# BusinessProcess

The BusinessProcess metadata type enables you to display different picklist values for users based on their profile.

Multiple business processes allow you to track separate sales, support, and lead lifecycles. A sales, support, lead, or solution process is assigned to a record type. The record type determines the user profiles that are associated with the business process.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Don’t use business processes as an access control mechanism. Profile assignment governs create and edit access for business process but doesn’t govern read access. For example, a user assigned to a profile that isn't enabled for a particular business process can't create or edit it, but they can read the business process record.

Users with access to a business process can read all information it stores. Don’t store sensitive information in the business process description, name, or picklist values. Instead, store sensitive information in a separate object or fields to which you’ve applied appropriate access controls.

## Declarative Metadata File Suffix and Directory Location

Business processes are defined as part of the custom object or standard object definition. See [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.") for more information.

## Version

[BusinessProcess](#meta_businessprocess "The BusinessProcess metadata type enables you to display different picklist values for users based on their profile.") components are available in API version 17.0 and later.

## Special Access Rules

Access to this object requires the View Setup and Configuration permission.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | Description for the business process. |
| fullName | string | Required. The name used as a unique identifier for API access. This field is inherited from the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") component, but the string it contains is created differently than the fullName strings for other types. For a fullName string [BusinessProcess](#meta_businessprocess "The BusinessProcess metadata type enables you to display different picklist values for users based on their profile."), the fullName is created combining the Entity Name and Business Process Name. For example, for a business process called “Bulk Orders” for opportunities, the fullName would be Opportunity.Bulk Orders. Use the object-qualified form (Opportunity. Bulk Orders) for API addressing, such as in a package.xml member in metadata retrieve results. When creating a business process in a CustomObject definition, use the bare process name (Bulk Orders) for the nested <businessProcesses><fullName> value. The enclosing object already supplies the entity context. |
| isActive | boolean | Indicates if the business process is active (true) or not (false). |
| namespacePrefix | string | The namespace of the developer organization where the package was created. |
| values | [PicklistValue](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalpicklistvalue.htm#picklistvalue)\[\] | A list of picklist values associated with this business process. |

## Declarative Metadata Sample Definition

The following is a sample XML definition of a lead business process.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
....
    <businessProcesses\>
        <fullName\>HardwareLeadProcess</fullName\>
        <description\>Lead Process for hardware division</description\>
        <isActive\>true</isActive\>
        <values\>
            <fullName\>Closed - Converted</fullName\>
            <default\>false</default\>
        </values\>
        <values\>
            <fullName\>CustomLeadStep1</fullName\>
            <default\>false</default\>
        </values\>
        <values\>
            <fullName\>CustomLeadStep2</fullName\>
            <default\>false</default\>
        </values\>
        <values\>
            <fullName\>Open - Not Contacted</fullName\>
            <default\>false</default\>
        </values\>
        <values\>
            <fullName\>Working - Contacted</fullName\>
            <default\>true</default\>
        </values\>
    </businessProcesses\>
....
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file only when a [RecordType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordtype.htm#meta_recordtype "Represents the metadata associated with a record type. Record types let you offer different business processes, picklist values, and page layouts to different users. Use this metadata type to create, update, or delete record type definitions for a custom object.") is specified. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm "ActionOverride")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_compactlayout.htm "CompactLayout")

#### See Also

- [_Salesforce DX Developer Guide_: BusinessProcessGroup](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/packaging_packageable_components.htm#mdc_business_process_group)
- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")

<!-- document id=df426040dc11bfb5e95e79eb4dc481e49d277b7fea5779b64404b94160b1ddcd url=/legacydeveloper/current/en-us/api_meta/meta_businessprocessgroup.md -->

# BusinessProcessGroup

Represents the surveys used to track customers’ experiences across different stages in their lifecycle. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

BusinessProcessGroup components have the suffix .businessProcessGroup and are stored in the businessProcessGroups folder.

## Version

BusinessProcessGroup components are available in API version 49.0 and later.

## Special Access Rules

This metadata type is available in orgs with Surveys enabled with the Customer Lifecycle Designer license.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d215960e99">Field Name</th>

              <th class="featureTableHeader  " id="d215960e102">Field Type</th>

              <th class="featureTableHeader  " id="d215960e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d215960e99" data-title="Field Name"><span class="keyword parmname">businessProcessDefinitions</span></td>

              <td class="entry" headers="d215960e102" data-title="Field Type">
                <a class="xref" href="#BusinessProcessDefinition">BusinessProcessDefinition</a>[]
              </td>

              <td class="entry" headers="d215960e105" data-title="Description">A list that defines stages in a customer lifecycle map.</td>

            </tr>

            <tr>
              <td class="entry" headers="d215960e99" data-title="Field Name"><span class="keyword parmname">customerSatisfactionMetric</span></td>

              <td class="entry" headers="d215960e102" data-title="Field Type">SurveyQuestionType(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d215960e105" data-title="Description">Required. Types of questions that can be associated with stages in a customer
                lifecycle map. <p class="p">Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Attachment</samp></li>

                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">CSAT</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">FreeText</samp></li>

                  <li class="li"><samp class="codeph nolang">Image</samp></li>

                  <li class="li"><samp class="codeph nolang">NPS</samp></li>

                  <li class="li"><samp class="codeph nolang">Matrix</samp></li>

                  <li class="li"><samp class="codeph nolang">MultiChoice</samp></li>

                  <li class="li"><samp class="codeph nolang">MultiSelectPicklist</samp></li>

                  <li class="li"><samp class="codeph nolang">NPS</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">Picklist</samp></li>

                  <li class="li"><samp class="codeph nolang">Rating</samp></li>

                  <li class="li"><samp class="codeph nolang">ShortText</samp></li>

                  <li class="li"><samp class="codeph nolang">Slider</samp></li>

                  <li class="li"><samp class="codeph nolang">StackRank</samp></li>

                  <li class="li"><samp class="codeph nolang">Toggle</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d215960e99" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d215960e102" data-title="Field Type">string</td>

              <td class="entry" headers="d215960e105" data-title="Description">A description of the customer lifecycle map.</td>

            </tr>

            <tr>
              <td class="entry" headers="d215960e99" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d215960e102" data-title="Field Type">string</td>

              <td class="entry" headers="d215960e105" data-title="Description">Required. The name of the customer lifecycle map.</td>

            </tr>

          </tbody>

        </table>

## BusinessProcessDefinition

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d215960e284">Field Name</th>

              <th class="featureTableHeader  " id="d215960e287">Field Type</th>

              <th class="featureTableHeader  " id="d215960e290">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d215960e284" data-title="Field Name"><span class="keyword parmname">businessProcessFeedbacks</span></td>

              <td class="entry" headers="d215960e287" data-title="Field Type">
                <a class="xref" href="#BusinessProcessFeedback">BusinessProcessFeedback</a>[]
              </td>

              <td class="entry" headers="d215960e290" data-title="Description">A list of stages in a customer lifecycle map.</td>

            </tr>

            <tr>
              <td class="entry" headers="d215960e284" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d215960e287" data-title="Field Type">string</td>

              <td class="entry" headers="d215960e290" data-title="Description">A description of a stage in the customer lifecycle map.</td>

            </tr>

            <tr>
              <td class="entry" headers="d215960e284" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d215960e287" data-title="Field Type">string</td>

              <td class="entry" headers="d215960e290" data-title="Description">Required. The API name of a stage in the customer lifecycle map.
                <p class="p">Only users with View DeveloperName OR View Setup and Configuration
                  permission can view, group, sort, and filter this field.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d215960e284" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d215960e287" data-title="Field Type">string</td>

              <td class="entry" headers="d215960e290" data-title="Description">Required. The name of a stage in the customer lifecycle map.</td>

            </tr>

            <tr>
              <td class="entry" headers="d215960e284" data-title="Field Name"><span class="keyword parmname">sequenceNumber</span></td>

              <td class="entry" headers="d215960e287" data-title="Field Type">int</td>

              <td class="entry" headers="d215960e290" data-title="Description">Required. The position of a stage in the customer lifecycle map.</td>

            </tr>

          </tbody>

        </table>

## BusinessProcessFeedback

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d215960e391">Field Name</th>

              <th class="featureTableHeader  " id="d215960e394">Field Type</th>

              <th class="featureTableHeader  " id="d215960e397">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d215960e391" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d215960e394" data-title="Field Type">string</td>

              <td class="entry" headers="d215960e397" data-title="Description">Required. The name of the survey used to collect feedback </td>

            </tr>

            <tr>
              <td class="entry" headers="d215960e391" data-title="Field Name"><span class="keyword parmname">actionParam</span></td>

              <td class="entry" headers="d215960e394" data-title="Field Type">string</td>

              <td class="entry" headers="d215960e397" data-title="Description">Required. The name of the survey question used to collect feedback.</td>

            </tr>

            <tr>
              <td class="entry" headers="d215960e391" data-title="Field Name"><span class="keyword parmname">actionType</span></td>

              <td class="entry" headers="d215960e394" data-title="Field Type">ExpFeedbackCollType(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d215960e397" data-title="Description">Required. The mode of feedback collection. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">PHONE_CALL</samp></li>

                  <li class="li"><samp class="codeph nolang">SURVEY</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a BusinessProcessGroup component.

<?xml version="1.0" encoding="UTF-8"?>
<BusinessProcessGroup xmlns="http://soap.sforce.com/2006/04/metadata">
    <businessProcessDefinitions\>
        <developerName\>Customer\_Onboarding</developerName\>
        <masterLabel\>Customer Onboarding</masterLabel\>
        <description\>A stage in a customer's lifecycle.</description\>
        <sequenceNumber\>0</sequenceNumber\>
        <businessProcessFeedbacks\>
            <actionType\>Survey</actionType\>
            <actionName\>New Customer CSAT</actionName\>
            <actionParam\>How would you rate our service?</actionParam\>
        </businessProcessFeedbacks\>
    </businessProcessDefinitions\>
    <customerSatisfactionMetric\>NPS</customerSatisfactionMetric\>
    <masterLabel\>Customer Lifecycle</masterLabel\>
    <description\>This map tracks the feedback provided by customers' at different stages during their lifecycle.</description\>
</BusinessProcessGroup\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>policyholder</members\>
        <name\>BusinessProcessGroup</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=96f4357264db3479325de10c01788e476c532242b919454209668fafa678244e url=/legacydeveloper/current/en-us/api_meta/meta_callcenter.md -->

# CallCenter

Represents the Call Center definition used to integrate Salesforce with a third-party computer-telephony integration (CTI) system, a partner telephony system, or partner Contact Center as a Service (CCaaS) system.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CallCenter components have the suffix .callCenter and are stored in the callCenters folder.

## Version

CallCenter components are available in API version 27.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| adapterUrl | 
Field Type

string

Description

Optional field. A URL that points to an adapter.



 |
| contactCenterChannels | 

Field Type

[ContactCenterChannel\[\]](#ContactCenterChannel)

Description

Relates Bring Your Own Channel for Contact Center as a Service (CCaaS) messaging channels to a CallCenter and represents the routing details for a voicemail configuration.



 |
| displayName | 

Field Type

string

Description

Required.

The display name of this call center.



 |
| displayNameLabel | 

Field Type

string

Description

Required.

The label of the displayName field in Call Center setup page.



 |
| internalNameLabel | 

Field Type

string

Description

Required.

The label of the internalName field in Call Center setup page.



 |
| sections | 

Field Type

[CallCenterSection\[\]](#CallCenterSection)

Description

Custom setup items defined for this call center.



 |
| version | 

Field Type

string

Description

The version of this call center.



 |

## CallCenterSection

| Field Name | Description |
| --- | --- |
| items | 
Field Type

[CallCenterItem\[\]](#CallCenterItem)

Description

Contains the label, name, and value that describe the sections.



 |
| label | 

Field Type

string

Description

Required.

The label of the section.



 |
| name | 

Field Type

string

Description

Required.

The name of the section.



 |

## CallCenterItem

| Field Name | Description |
| --- | --- |
| label | 
Field Type

string

Description

Required.

The label of the custom setup item.



 |
| name | 

Field Type

string

Description

Required.

The name of the custom setup item.



 |
| value | 

Field Type

string

Description

Required.

The value of the custom setup item.



 |

## ContactCenterChannel

Represents a junction subtype that relates a Bring Your Own Channel for Contact Center as a Service (CCaaS) messaging channel to a CallCenter type for Bring Your Own Channel for CCaaS. This subtype also represents the routing details for a voicemail configuration and routing information for callback requests. This subtype is available in API version 56.0 and later.

| Field Name | Description |
| --- | --- |
| channel | 
Field Type

string

Description

Required.

For Bring Your Own Channel for CCaaS, this field represents the unique ID of the Bring Your Own Channel messaging channel (MessagingChannel) that’s associated with the contact center (CallCenterId). Available in API version 60.0 and later.



 |
| contactCenter | 

Field Type

string

Description

Required.

For Bring Your Own Channel for CCaaS, this field represents the unique ID of the contact center (CallCenterId) that’s associated with the Bring Your Own Channel messaging channel (MessagingChannel). Available in API version 60.0 and later.



 |
| omniCallbackFallbackQueue | 

Field Type

string

Description

If callbacks are configured for the contact center and the contact center uses Omni-Channel Unified Routing, this field represents the unique ID of the fallback queue to use if contact request routing through an Omni-Channel flow fails. Don't change the value in this field. Instead, configure contact request routing in Lightning Experience. Available in API version 65.0 and later.



 |
| omniCallbackHandler | 

Field Type

string

Description

If callbacks are configured for the contact center and the contact center uses Omni-Channel Unified Routing, this field represents the unique ID of the flow or queue used to route contact requests. Don't change the value in this field. Instead, configure contact request routing in Lightning Experience. Available in API version 65.0 and later.



 |
| voiceMailFallbackQueue | 

Field Type

string

Description

If voicemail routing is configured for the contact center, this field represents the unique ID of the fallback queue to use if voicemail routing fails. Don't change the value in this field. Instead, configure voicemail routing in Lightning Experience.



 |
| voiceMailHandler | 

Field Type

string

Description

If voicemail routing is configured for the contact center, this field represents the unique ID of the flow used to route voicemails. Don't change the value in this field. Instead, configure voicemail routing in Lightning Experience.



 |

## Declarative Metadata Sample Definition

The following is an example of a CallCenter component:

<?xml version="1.0" encoding="UTF-8"?>
<CallCenter xmlns="http://soap.sforce.com/2006/04/metadata">
    <adapterUrl\>http://localhost:11000</adapterUrl\>
    <displayName\>Demo Call Center Adapter</displayName\>
    <displayNameLabel\>Display Name</displayNameLabel\>
    <internalNameLabel\>Internal Name</internalNameLabel\>
    <sections\>
        <items\>
            <label\>Description</label\>
            <name\>reqDescription</name\>
            <value\>Demo Call Center Adapter</value\>
        </items\>
        <items\>
            <label\>CTI Connector ProgId</label\>
            <name\>reqProgId</name\>
            <value\>DemoAdapter.DemoAdapter.1</value\>
        </items\>
        <items\>
            <label\>Version</label\>
            <name\>reqVersion</name\>
            <value\>3.0</value\>
        </items\>
        <items\>
            <label\>CTI Adapter URL</label\>
            <name\>reqAdapterUrl</name\>
            <value\>http://localhost:11000</value\>
        </items\>
        <label\>General Information</label\>
        <name\>reqGeneralInfo</name\>
    </sections\>
    <sections\>
        <items\>
            <label\>Outside Prefix</label\>
            <name\>reqOutsidePrefix</name\>
            <value\>1</value\>
        </items\>
        <items\>
            <label\>Long Distance Prefix</label\>
            <name\>reqLongDistPrefix</name\>
            <value\>1</value\>
        </items\>
        <items\>
            <label\>International Prefix</label\>
            <name\>reqInternationalPrefix</name\>
            <value\>01</value\>
        </items\>
        <label\>Dialing Options</label\>
        <name\>reqDialingOptions</name\>
    </sections\>
    <version\>4</version\>
</CallCenter\>

For information about the CallCenter definition file, see [Call Center Definition Files](https://developer.salesforce.com/docs/atlas.en-us.210.0.api_cti.meta/api_cti/sforce_api_cti_call_def_file.htm).

<!-- document id=514e278f5eb0808587082744c3f9e851474371f40fa8e85fd226fa713bf33a3f url=/legacydeveloper/current/en-us/api_meta/meta_callcenterroutingmap.md -->

# CallCenterRoutingMap

Represents the mapping between a user or queue in a Salesforce org to a user or queue in an external system’s call center.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CallCenterRoutingMap components have the suffix .callCenterRoutingMap and are stored in the callCenterRoutingMaps folder.

## Version

CallCenterRoutingMap components are available in API version 52.0 and later.

## Special Access Rules

This type requires Contact Center Admin, Contact Center Admin (Partner Telephony), Contact Center Supervisor, or Manage Call Centers permission.

## Fields

| Field Name | Description |
| --- | --- |
| callCenter | 
Field Type

string

Description

Required.

Reference to a call center.



 |
| developerName | 

Field Type

string

Description

Required.

The developer name is a combination of the Salesforce user ID or queue name, and the callCenter value, with an underscore between these two values.

- \[SALESFORCE\_USER\_ID\]\_\[CALL\_CENTER\]
- \[SALESFORCE\_QUEUE\_NAME\]\_\[CALL\_CENTER\]





 |
| externalId | 

Field Type

string

Description

Required.

Unique identifier for the external system’s user or queue.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label of the CallCenterRoutingMap.



 |
| quickConnect | 

Field Type

string

Description

The Amazon Connect QuickConnectId ARN used to determine agent availability for Omni-Channel call transfers. Available in API version 56.0 and later.



 |
| referenceRecord | 

Field Type

string

Description

Required.

Lookup field to a Salesforce user or queue.



 |

## Declarative Metadata Sample Definition

The following is an example of a CallCenterRoutingMap component.

<?xml version="1.0" encoding="UTF-8"?>
<CallCenterRoutingMap xmlns="http://soap.sforce.com/2006/04/metadata">
    <callCenter\>ExampleCallCenter</callCenter\>
<developerName\>User\_001ABC00000FjYIIA0\_04vZ6000000Cagl</developerName\>
<externalId\>arn:aws:connect:ap-northeast-1:484907484500:instance/examplestring-9c18-4aa5-b5fe-cda6f34d99a0/agent/a69f7afe-5b04-4aa8-b5ee-108a84d0f504</externalId\>
    <masterLabel\>001ABC00000FjYIIA0</masterLabel\>
    <referenceRecord\>example.d2b87b8182fa@salesforce.com</referenceRecord\>
</CallCenterRoutingMap\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>User\_001ABC00000FjYIIA0\_04vZ6000000Cagl</members\>
        <name\>CallCenterRoutingMap</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=0f5dce2126b8c2ebe61126399edeac9ab22bafa72db8241a54a4003354273488 url=/legacydeveloper/current/en-us/api_meta/meta_callcoachingmediaprovider.md -->

# CallCoachingMediaProvider

Represents the CallCoachingMediaProvider configuration. Use CallCoachingMediaProvider to configure which providers of voice recordings that Einstein Conversation Insights can use. For example, Sales Dialer can provide voice recordings. Einstein Conversation Insights then stores and analyzes call recordings to surface insights and trends in customer conversations.This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

CallCoachingMediaProvider components have the suffix .callCoachingMediaProvider and are stored in the CallCoachingMediaProvider folder.

## Version

CallCoachingMediaProvider components are available in API version 49.0 and later.

## Special Access Rules

You must be a Sales Engagement customer to access this metadata type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d219528e93">Field Name</th>

              <th class="featureTableHeader  " id="d219528e96">Field Type</th>

              <th class="featureTableHeader  " id="d219528e99">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d219528e93" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d219528e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d219528e99" data-title="Description">Indicates whether the media provider can upload voice recordings (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">Default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d219528e93" data-title="Field Name"><span class="keyword parmname">providerDescription</span></td>

              <td class="entry" headers="d219528e96" data-title="Field Type">string</td>

              <td class="entry" headers="d219528e99" data-title="Description">Description of the media provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d219528e93" data-title="Field Name"><span class="keyword parmname">providerName</span></td>

              <td class="entry" headers="d219528e96" data-title="Field Type">string</td>

              <td class="entry" headers="d219528e99" data-title="Description">Name of the media provider.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a CallCoachingMediaProvider component.

<?xml version="1.0" encoding="UTF-8"?>
<CallCoachingMediaProvider xmlns="http://soap.sforce.com/2006/04/metadata">
    <isActive\>true</isActive\>
    <providerDescription\>Salesforce telephony provider</providerDescription\>
    <providerName\>Dialer</providerName\>
</CallCoachingMediaProvider\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>CallCoachingMediaProvider</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=368bfef75ab404bb3fec00f2f72a277e28f07e4288655858a0e7f4f4fd9492f6 url=/legacydeveloper/current/en-us/api_meta/meta_calloptions.md -->

# CallOptions

Specifies the API client identifier.

## Version

This call is available in all API versions.

## Supported Calls

All Metadata API calls.

## Fields

### client

- **Type**: string
- **Description**: A value that identifies an API client.

## Sample Code—Java

To change the API client ID, add the CallOptions header to the metadata connection before you perform a call as follows:

metadataConnection.setCallOptions("client ID");

<!-- document id=7067f1f531c2465ae0536ce046f4fa10bc546d1a270251899016433f3571e946 url=/legacydeveloper/current/en-us/api_meta/meta_campaigninfluencemodel.md -->

# CampaignInfluenceModel

Represents a campaign influence model used by Customizable Campaign Influence. You can’t configure Customizable Campaign Influence via the Metadata API, but you can add a campaign influence model.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This information applies only to Customizable Campaign Influence and not to [Campaign Influence 1.0](https://help.salesforce.com/s/articleView?id=sf.campaigns_influence_original.htm&language=en_US) .

## File Suffix and Directory Location

CampaignInfluenceModel values are stored in the campaignInfluenceModels directory of the corresponding package directory. The file name matches the model name, and the extension is .campaignInfluenceModel.

## Version

CampaignInfluenceModel components are available in API version 38.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d219955e104">Field Name</th>

              <th class="featureTableHeader  " id="d219955e107">Field Type</th>

              <th class="featureTableHeader  " id="d219955e110">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d219955e104" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d219955e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d219955e110" data-title="Description">Indicates whether the model is active. Active models can generate
                campaign influence records. Deactivating a model deletes its
                campaign influence records. Custom models are always active and this
                field is ignored. This field is available beginning with API version
                40.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d219955e104" data-title="Field Name"><span class="keyword parmname">isDefaultModel</span></td>

              <td class="entry" headers="d219955e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d219955e110" data-title="Description">Required. Indicates if the model is the default model or not.
                Only campaign influence records associated with the default model
                appear on campaigns and opportunities. You can only have one default
                model at a time. A model must be active to become the default
                model.<p class="p">Activating or deactivating custom models does not
                  automatically generate or delete campaign influence
                  records.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d219955e104" data-title="Field Name"><span class="keyword parmname">isModelLocked</span></td>

              <td class="entry" headers="d219955e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d219955e110" data-title="Description">Required. Indicates if the model is locked or not. Campaign
                Influence records for locked models can be manipulated only via the
                API.</td>

            </tr>

            <tr>
              <td class="entry" headers="d219955e104" data-title="Field Name"><span class="keyword parmname">modelDescription</span></td>

              <td class="entry" headers="d219955e107" data-title="Field Type">string</td>

              <td class="entry" headers="d219955e110" data-title="Description">A description of the influence model.</td>

            </tr>

            <tr>
              <td class="entry" headers="d219955e104" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d219955e107" data-title="Field Type">string</td>

              <td class="entry" headers="d219955e110" data-title="Description">Required. A unique name for the model.</td>

            </tr>

            <tr>
              <td class="entry" headers="d219955e104" data-title="Field Name"><span class="keyword parmname">recordPreference</span></td>

              <td class="entry" headers="d219955e107" data-title="Field Type">picklist</td>

              <td class="entry" headers="d219955e110" data-title="Description">The value of this field determines when to create campaign
                influence records.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AllRecords</samp>: Creates
                    records regardless of the revenue attribution
                    percentage.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RecordsWithAttribution</samp>:
                    Creates records only when the revenue attribution is greater
                    than 0%.
                  </li>

                </ul>
                <p class="p">This field is available In API version 41.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a CampaignInfluenceModel component that represents the default Salesforce campaign influence attribution model. The default isDefaultModel value of true can be changed if another model is created and set as the default model. The isModelLocked value of true means that Campaign Influence records for this model can be seen in the UI, but not created, updated, or deleted.

<?xml version="1.0" encoding="UTF-8"?>
<CampaignInfluenceModel xmlns="http://soap.sforce.com/2006/04/metadata">
    <isActive\>true</isActive\>
    <isDefaultModel\>true</isDefaultModel\>
    <isModelLocked\>true</isModelLocked\>    <recordPreference\>AllRecords</recordPreference\>   
    <modelDescription\>Primary Campaign gets 100% of the revenue share</modelDescription\>
    <name\>Salesforce Model</name\>
</CampaignInfluenceModel\>

The following is an example of a CampaignInfluenceModel component that creates an influence model called Last Touch, which will not be the default model.

<?xml version="1.0" encoding="UTF-8"?>
<CampaignInfluenceModel xmlns="http://soap.sforce.com/2006/04/metadata">
    <isActive\>true</isActive\>
    <isDefaultModel\>false</isDefaultModel\>
    <isModelLocked\>true</isModelLocked\>
    <modelDescription\>This model gives 100% influence attribution to the last campaign that touched the contact.</modelDescription\>
    <name\>Last Touch</name\>
    <recordPreference\>RecordsWithAttribution</recordPreference\>
</CampaignInfluenceModel\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=0c8dceafc0e533429bfa8a431fbe66c27f95c035adfb5900400dbce2607cc9cf url=/legacydeveloper/current/en-us/api_meta/meta_campaignsettings.md -->

# CampaignSettings

Represents an org’s Campaign Influence, Einstein Attribution, Einstein Key Accounts, and campaign member settings. These features help you understand how your campaigns and accounts are affecting your opportunity pipeline.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

CampaignSettings values are stored in the Campaign.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

CampaignSettings is available in API versions 48.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d220622e113">Field Name</th>

              <th class="featureTableHeader  " id="d220622e116">Field Type</th>

              <th class="featureTableHeader  " id="d220622e119">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">aiAttributionTimeframe</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">int</td>

              <td class="entry" headers="d220622e119" data-title="Description">Indicates the number of months between the opportunity creation
                date and an engagement activity, during which Einstein scans for
                influential campaigns. The value must be a multiple of three, up to
                24. Available in API version 49.0 and later.<p class="p">This field supports
                  Einstein Attribution.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableAIAttribution</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d220622e119" data-title="Description">Indicates whether the Einstein Attribution feature is enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>. Available in API
                version 49.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableAccountsAsCM</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d220622e119" data-title="Description">Indicates whether accounts can be used as campaign members
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>. Available in API
                version 51.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableAutoCampInfluenceDisabled</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d220622e119" data-title="Description">Indicates whether Salesforce creates Campaign Influence
                information (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>).
                <span class="keyword parmname">enableCampaignInfluence2</span> must be <samp class="codeph nolang">false</samp> to use this setting.<p class="p">The
                  default value is <samp class="codeph nolang">false</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableB2bmaCampaignInfluence2</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d220622e119" data-title="Description">Indicates whether your org can access campaign influence models
                from other systems, such as Pardot (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <span class="keyword parmname">enableCampaignInfluence2</span>
                must be <samp class="codeph nolang">true</samp> to use this
                setting.<p class="p">The default value is <samp class="codeph nolang">false</samp>. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableCampaignHistoryTrackEnabled</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d220622e119" data-title="Description">This read-only field is reserved for system use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableCampaignInfluence2</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d220622e119" data-title="Description">Indicates whether Customizable Campaign Influence is enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When <samp class="codeph nolang">true</samp>, Campaign Influence 1.0 is
                hidden from users and is no longer active. <p class="p">The default value is
                  <samp class="codeph nolang">true</samp>.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableCampaignMemberTWCF</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d220622e119" data-title="Description">This read-only field is reserved for system use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableEKAI</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d220622e119" data-title="Description">Indicates whether Einstein Key Accounts Identification is enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>. Available in API
                version 53.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableOpportunityInfluence</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type"></td>

              <td class="entry" headers="d220622e119" data-title="Description">Indicates whether Opportunity Influence campaign attribution is
                enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).

                When
                enabled, Opportunity Influence connects opportunity revenue to
                specific campaigns. The default value is <samp class="codeph nolang">false</samp>. Available with Marketing
                Cloud Growth and Advanced editions in API version 63.0 and
                higher.</td>

            </tr>

            <tr>
              <td class="entry" headers="d220622e113" data-title="Field Name"><span class="keyword parmname">enableSuppressNoValueCI2</span></td>

              <td class="entry" headers="d220622e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d220622e119" data-title="Description">This read-only field is reserved for system use.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the Campaign.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<CampaignSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCampaignInfluence2\>true</enableCampaignInfluence2\>
    <enableSuppressNoValueCI2\>true</enableSuppressNoValueCI2\>
    <enableCampaignHistoryTrackEnabled\>true</enableCampaignHistoryTrackEnabled\>
    <enableAutoCampInfluenceDisabled\>true</enableAutoCampInfluenceDisabled\>
    <enableCampaignMemberTWCF\>true</enableCampaignMemberTWCF\>
    <enableB2bmaCampaignInfluence2\>true</enableB2bmaCampaignInfluence2\>
    <enableAccountsAsCM\>true</enableAccountsAsCM\>
    <enableAIAttribution\>true</enableAIAttribution\>
    <aiAttributionTimeframe\>9</aiAttributionTimeframe\>
    <enableEKAI\>true</enableEKAI\>
</CampaignSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Campaign settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>Campaign</members\>
		<name\>Settings</name\>
	</types\>
	<version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6200f20077061e40613915b8473ed07b181a07c8b34e39291daf7e9b61db30b7 url=/legacydeveloper/current/en-us/api_meta/meta_rest_deploy_cancel.md -->

# Cancel a Deployment in Progress Using REST

You can request a cancellation of a deployment that's already in progress. Make the cancellation request by patching the status of an ongoing deployRequest. The cancellation is processed asynchronously. For API versions 65.0 and higher, deployments with a status of Finalizing Deploy, can't be cancelled. For API versions below 65.0, attempts to cancel a deployment may fail if the deployment has started committing data. Alternatively, it's possible that the cancellation will succeed, but data from the deployment is also committed.

**URI**

https://host/services/data/vXX.0/metadata/deployRequest/deployRequestId

**Formats**

JSON

**HTTP Method**

PATCH

**Authentication**

Authorization: Bearer token

## Request Body: Request Deployment Cancellation

The JSON request body for a deployment cancellation includes a PATCH to the status of the original deployRequest.

    { 
     "deployResult":
           {
           "status" : "Canceling"
           }
    }

## Response Body: Request Deployment Cancellation

Because the cancellation request is processed asynchronously, the status shown in the response body can be either Canceling or Canceled.

    { 
      	"id" : "0Afxx00000000lWCAQ"
      	"url" : “https://host/services/data/vXX.0/metadata/deployRequest/0Afxx00000000lWCAQ",
       "deployResult":    
             {
             "checkOnly" : "false",
             "ignoreWarnings" : "false",
             "rollbackOnError" : "false",             
             "status : "Canceling",  // or Canceled
             "numberComponentsDeployed" : "10",
             "numberComponentsTotal" : "1032",
             "numberComponentErrors" : "0",
             "numberTestsCompleted" : "45",
             "numberTestsTotal" : "135",
             "numberTestErrors" : "0",
             "details" :  { 
                "componentFailures" : \[\],
                "componentSuccesses" : \[\],
                      "retrieveResult" : null,
                      "runTestResults” : {
                         "numRun" : 0,
                         "successes" : \[ … \],
                         "failures" : \[\]
                 	   	}             
                },

                "createdDate" : "2017-10-10T08:22Z",
                "startDate" : "2017-10-10T08:22Z",
                "lastModifiedDate" : "2017-10-10T08:44Z",
                "completedDate" : "2017-10-10T08:44Z",
                "errorStatusCode" : null,
                "errorMessage" : null,
                "stateDetail" : "Processing Type: Apex Component",
                "createdBy" : "005xx0000001Sv1m",
                "createdByName" : "steve stevens",
                "canceledBy" : null, 
                "canceledByName" : null,
                "isRunTestsEnabled" : null
                }
       }
          

When an HTTP status code of 202 (Accepted) is returned, your cancellation request is in progress or successful.

<!-- document id=024494906a5346ee04feb452282080d3a9422eab3ed3217750c7b77724832969 url=/legacydeveloper/current/en-us/api_meta/meta_canceldeploy.md -->

# cancelDeploy()

Cancels a deployment that hasn’t completed yet.

## Syntax

CancelDeployResult = metadatabinding.cancelDeploy(string id)

## Usage

Use the cancelDeploy() operation to cancel a deployment in your org started by the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") operation, which includes deployments started by the Lightning Platform Migration Tool and the Lightning Platform IDE. The deployment can be in a queue waiting to get started, or can be in progress. For API versions 65.0 and higher, deployments with a status of Finalizing Deploy, can't be cancelled. For API versions below 65.0, attempts to cancel a deployment may fail if the deployment has started committing data. Alternatively, it's possible that the cancellation will succeed, but data from the deployment is also committed.

This operation takes the ID of the deployment you want to cancel and returns a [CancelDeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_canceldeployresult.htm "Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.") object. When the deployment is in the queue and hasn’t started yet, calling cancelDeploy() cancels the deployment immediately. When the deployment has started and is in progress, sometimes it doesn’t get canceled immediately, so call [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy().") to check the status of the cancellation.

Cancel a deployment using these steps.

1. Obtain the ID of the deployment you want to cancel. For example, you can obtain the ID from the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call in the AsyncResult object [id](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field. Alternatively, you can obtain the ID in the Salesforce user interface from Setup by entering Deployment Status in the Quick Find box, selecting **Deployment Status**, and then noting the ID of a deployment started by the API.
2. Issue a cancelDeploy() call to start the cancellation process. This call returns a CancelDeployResult object.
3. Check the value in the done field of the returned CancelDeployResult. If the done field value is true, the deployment has been canceled and you’re done. If the done field value is false, the cancellation is in progress. To check the cancellation status, follow these steps.
    1. Call [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy().") using the deployment ID you obtained earlier.
    2. In the returned [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") object, check the status field. If the status is Canceling, the cancellation is still in progress, and repeat steps a and b. Otherwise, if the status is Canceled, the deployment has been canceled and you’re done.

The deploy() operation throws these API faults.

INVALID\_ID\_FIELD with the message Invalid deploy ID

The specified ID argument doesn't correspond to a valid deployment.

INVALID\_ID\_FIELD with the message Deployment already completed

The specified deployment has already completed.

INVALID\_ID\_FIELD with the message You cannot cancel the deployment while finalizing is in progress

The specified deployment can't be canceled. Applies to API version 65.0 and later.

## Version

Available in API version 30.0 and later.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "checkDeployStatus()")

## Arguments

### id

- **Type**: [string](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/primitive_data_types.htm#i1435116)
- **Description**: The ID of the deployment to cancel.

## Response

[CancelDeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_canceldeployresult.htm "Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.")

## Sample Code—Java

This sample shows how to cancel a deployment. The sample calls cancelDeploy() by passing it a given deployment ID. Next, it checks whether the cancellation has completed, and if not, calls checkDeployStatus in a loop.

public void cancelDeploy(String asyncId) throws Exception {
    // Issue the deployment cancellation request  
    CancelDeployResult result = metadataConnection.cancelDeploy(asyncId);
    
    // If the deployment cancellation completed, write a message to the output.
    if (result.isDone()) {
        System.out.println("Your deployment was canceled successfully!");
    }
    else {
        // The deployment cancellation is still in progress, so get a new status 
        DeployResult deployResult = metadataConnection.checkDeployStatus(asyncId, false);
    
        // Check whether the deployment is done. If not done, this means 
        // that the cancellation is still in progress and the status is Canceling.        
        while (!deployResult.isDone()) {
            // Assert that the deployment status is Canceling
            assert deployResult.getStatus() == DeployStatus.Canceling;
            // Wait 2 seconds
            Thread.sleep(2000);
            // Get the deployment status again
            deployResult = metadataConnection.checkDeployStatus(asyncId, false);
        }
        
        // The deployment is done. Write the status to the output.
        // (When the deployment is done, the cancellation should have completed
        // and the status should be Canceled. However, in very rare cases,  
        // the deployment can complete before it is canceled.) 
        System.out.println("Final deploy status = >" + deployResult.getStatus());
    }
}

<!-- document id=b93426c84a8d8532a81083b4aeb43fcc8d5c07c73e597fc01826f1020f1036e0 url=/legacydeveloper/current/en-us/api_meta/meta_canceldeployresult.md -->

# CancelDeployResult

Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.

The asynchronous metadata call [cancelDeploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_canceldeploy.htm "Cancels a deployment that hasn’t completed yet.") returns a CancelDeployResult object.

## Version

Available in API version 30.0 and later.

CancelDeployResult has the following properties.

## done

- **Type**: boolean
- **Description**: Indicates whether the deployment cancellation, which is started through cancelDeploy(), has completed (true) or not (false).
    
    When a deployment hasn’t started yet and is still in the queue, the deployment is canceled immediately with the cancelDeploy() call and this field returns true. Otherwise, this field returns false when the cancellation is in progress.

## id

- **Type**: ID
- **Description**: ID of the deployment being canceled.

<!-- document id=aa40c399570f669c998e71359066fc500ead46680e5465923505c5d6859d4235 url=/legacydeveloper/current/en-us/api_meta/meta_carebenefitverifysettings.md -->

# CareBenefitVerifySettings

Represents the configuration settings for benefit verification requests.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CareBenefitVerifySettings components have the suffix .careBenefitVerifySettings and are stored in the careBenefitVerifySettings folder.

## Version

CareBenefitVerifySettings components are available in API version 52.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| codeSetType | 
Field Type

string

Description

Specifies the code set type for the benefits verification service type codes.



 |
| defaultNpi | 

Field Type

string

Description

Default National Provider Identifier to be used in the benefits verification request.



 |
| generalPlanServiceTypeCode | 

Field Type

string

Description

Service type code for the plan benefits as a whole.



 |
| isDefault | 

Field Type

boolean

Description

Indicates whether this record is the default verification service (true) or not (false).



 |
| masterLabel | 

Field Type

string

Description

Required.

Name of the benefits verification service.



 |
| organizationName | 

Field Type

string

Description

Specifies the organization name for the benefits verification request service.



 |
| serviceApexClass | 

Field Type

string

Description

Apex class used to access the benefits verification service.



 |
| serviceNamedCredential | 

Field Type

string

Description

Credential used to access the benefits verification service.



 |
| serviceTypeSourceSystem | 

Field Type

string

Description

Service type code for the plan benefits as a whole.



 |
| uriPath | 

Field Type

string

Description

Link to payer endpoint.



 |

## Declarative Metadata Sample Definition

This is an example of a CareBenefitVerifySettings component.

<?xml version="1.0" encoding="UTF-8"?>
<CareBenefitVerifySettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <generalPlanServiceTypeCode\>abc</generalPlanServiceTypeCode\>
    <isDefault\>true</isDefault\>
    <masterLabel\>test</masterLabel\>
    <serviceApexClass\>TestApexClass</serviceApexClass\>
    <serviceNamedCredential\>test</serviceNamedCredential\>
    <uriPath\>efgh</uriPath\>
    <serviceTypeSourceSystem\>Lorem ipsum dolor</serviceTypeSourceSystem\>
    <codeSetType\>Code set</codeSetType\>
    <defaultNpi\>Npi info</defaultNpi\>
    <organizationName\>Organization name</organizationName\>
</CareBenefitVerifySettings\>

This is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>CareBenefitVerifySettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ApexClass</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>NamedCredential</name\>
    </types\>
    <version\>52.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=dd67cb19dd069aaefe2032d1bbbca44a8c740030f33930a0cf2a1a4b5e9dc66e url=/legacydeveloper/current/en-us/api_meta/meta_carelimittype.md -->

# CareLimitType

Defines the characteristics of limits on benefit provision.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CareLimitType components have the suffix .careLimitType and are stored in the careLimitTypes folder.

## Version

CareLimitType components are available in API version 52.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| isProtected | 
Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type.



 |
| limitType | 

Field Type

string

Description

Source of limit on benefit provision, such as a co-insurance requirement.



 |
| masterLabel | 

Field Type

string

Description

Required.

Name of the limit type.



 |
| metricType | 

Field Type

CareLimitTypeMetricType (enumeration of type string)

Description

Metric to be used for calculating and displaying the benefit limit, such as number of visits, amount spent, or percentage of allowed expenditure.

Valid values are:

- Amount
- Money
- Percentage
- Text





 |

## Declarative Metadata Sample Definition

This is an example of a CareLimitType component.

<?xml version="1.0" encoding="UTF-8"?>
<CareLimitType xmlns="http://soap.sforce.com/2006/04/metadata">
    <limitType\>test</limitType\>
    <masterLabel\>test</masterLabel\>
    <metricType\>Money</metricType\>
    <isProtected\>false</isProtected\>
</CareLimitType\>

This is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>CareLimitType</name\>
    </types\>
    <version\>52.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=9bd97c2beafc0f47ddbb70a501512f2b3633fa0ec91ef625442eef0d8375423f url=/legacydeveloper/current/en-us/api_meta/meta_careprovidersearchconfig.md -->

# CareProviderSearchConfig

Represents the information about the fields that appear in care provider search results. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

CareProviderSearchConfig components have the suffix .careProviderSearchConfig and are stored in the careProviderSearchConfigs folder.

## Version

CareProviderSearchConfig components are available in API version 48.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d223117e91">Field Name</th>

              <th class="featureTableHeader  " id="d223117e94">Field Type</th>

              <th class="featureTableHeader  " id="d223117e97">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d223117e91" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d223117e94" data-title="Field Type">boolean</td>

              <td class="entry" headers="d223117e97" data-title="Description">Indicates whether this configuration is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d223117e91" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d223117e94" data-title="Field Type">boolean</td>

              <td class="entry" headers="d223117e97" data-title="Description">An auto-generated value that doesn’t currently impact the behavior of the
                metadata type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d223117e91" data-title="Field Name"><span class="keyword parmname">mappedObject</span></td>

              <td class="entry" headers="d223117e94" data-title="Field Type">ProviderSearch​ObjectMapping <span class="ph" id="enum_link_component"><a name="enum_link_component"><!-- --></a>(enumeration of type
                  string)</span>
              </td>

              <td class="entry" headers="d223117e97" data-title="Description">Required. Indicates mapped objects.<p class="p">Possible values are;</p>
                <ul class="ul bulletList">
                  <li class="li">HealthCarePractitionerFacility</li>

                  <li class="li">HealthCareProvider</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d223117e91" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d223117e94" data-title="Field Type">string</td>

              <td class="entry" headers="d223117e97" data-title="Description">Required. Name of the care provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d223117e91" data-title="Field Name"><span class="keyword parmname">sourceField</span></td>

              <td class="entry" headers="d223117e94" data-title="Field Type">string</td>

              <td class="entry" headers="d223117e97" data-title="Description">API name of the field that is copied to the target object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d223117e91" data-title="Field Name"><span class="keyword parmname">targetField</span></td>

              <td class="entry" headers="d223117e94" data-title="Field Type">string </td>

              <td class="entry" headers="d223117e97" data-title="Description">API name of the field to copy the data to.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a CareProviderSearchConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<CareProviderSearchConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <sourceField\>Test1\_\_c</sourceField\>
    <targetField\>Test1\_\_c</targetField\>
    <mappedObject\>HealthcareProvider</mappedObject\>
    <isProtected\>false</isProtected\>
    <isActive\>true</isActive\>
    <masterLabel\>testlabel</masterLabel\>
</CareProviderSearchConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>HealthcareProvider.Test1\_\_c</members\>
        <name\>CustomField</name\>
    </types\>
    <types\>
        <members\>CareProviderSearchableField.Test1\_\_c</members\>
        <name\>CustomField</name\>
    </types\>
    <types\>
        <members\>Test</members\>
        <name\>CareProviderSearchConfig</name\>
    </types\>
    <version\>48.0</version\>
</Package\>

<!-- document id=7a71d66e79c694867a90d0183aabd3ba2e3b78aaf421c98133441f0bec274e0c url=/legacydeveloper/current/en-us/api_meta/meta_carerequestconfiguration.md -->

# CareRequestConfiguration

Represents the details for a record type such as service request, drug request, or admission request. One or more record types can be associated with a care request.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CareRequestConfiguration components have the suffix .careRequestConfiguration and are stored in the careRequestConfigurations folder.

## Version

CareRequestConfiguration components are available in API version 44.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| careRequestRecordType | 
Field Type

string

Description

Required.

The record type for the care request.



 |
| careRequestRecords | 

Field Type

[CareRequestRecords\[\]](#CareRequestRecords)

Description

The list of objects you can select to configure the care request.



 |
| careRequestType | 

Field Type

string

Description

Required.

The type of care request. For example, an appeal, a service request, or an admission.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the care request is active (true) or not (false).



 |
|  | 

Field Type

boolean

Description

Indicates whether the record type of the care request is default (true) or not (false).



 |
|  | 

Field Type

string

Description

Required.

A user-friendly name for CareRequestConfiguration, which is defined when the CareRequestConfiguration is created.



 |

## CareRequestRecords

Displays a list of objects to customize the care request.

| Field Name | Description |
| --- | --- |
| careRequestRecord | 
Field Type

string

Description

Required.

The object selected to configure the care request.



 |

## Declarative Metadata Sample Definition

This is an example of a CareRequestConfiguration component.

<?xml version="1.0" encoding="UTF-8"?>
<CareRequestConfiguration xmlns="http://soap.sforce.com/2006/04/metadata">
    <careRequestRecordType\>DrugRequest</careRequestRecordType\>
    <careRequestRecords\>
        <careRequestRecord\>CareRequestItem</careRequestRecord\>
    </careRequestRecords\>
    <careRequestRecords\>
        <careRequestRecord\>CareRequestDrug</careRequestRecord\>
    </careRequestRecords\>
    <careRequestType\>Drug Request</careRequestType\>
    <isActive\>false</isActive\>
    <isDefaultRecordType\>false</isDefaultRecordType\>
    <masterLabel\>DrugRequest</masterLabel\>
</CareRequestConfiguration\>

This is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Case.DrugRequest</members\>
        <name\>BusinessProcess</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>CareRequestConfiguration</name\>
    </types\>
    <types\>
        <members\>CareRequest.DrugRequest</members\>
        <members\>CareRequestDrug.DrugRequest</members\>
        <members\>CareRequestItem.DrugRequest</members\>
        <members\>Case.DrugRequest</members\>
        <name\>RecordType</name\>
    </types\>
    <version\>44.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=46de00d61a70be3681ec62dabf11954e01c5f5474cb715aa063928532879d4c8 url=/legacydeveloper/current/en-us/api_meta/meta_caresystemfieldmapping.md -->

# CareSystemFieldMapping

Represents a mapping from source system fields to Salesforce objects and fields. This type extends the Metadata metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

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.

## File Suffix and Directory Location

CareSystemFieldMapping components have the suffix .careSystemFieldMapping and are stored in the careSystemFieldMappings folder.

## Version

CareSystemFieldMapping components are available in API version 49.0 and later.

## Special Access Rules

To use this metadata type, your Salesforce org must have the Health Cloud or Life Sciences Cloud license and the user must have the Health Cloud Foundation (for Health Cloud) or Health Cloud Starter (for Life Sciences Cloud) permission set.

## Fields

### externalIdField

- **Field Type**: string
- **Description**: The ID of the field in the external system.

### isActive

- **Field Type**: boolean
- **Description**: Indicates whether this field mapping is active (true) or not (false).
- **Default value**: False

### isProtected

- **Field Type**: boolean
- **Description**: An auto-generated value that doesn’t currently impact the behavior of the metadata type.

### masterLabel

- **Field Type**: string
- **Description**: Required. The name of the care system field mapping.

### role

- **Field Type**: SourceSystemFieldRole (enumeration of type string)
- **Description**: Required. The role the field represents.
- **Possible values**:
    - Patient—When the role field is set to Patient, the Enrollment API uses the value of externalIdField as the patient ID. This role can be used when targetObject is set to Account.
    - RemoteMonitoringDevice—Indicates which externalIdField on the Asset object maps to the Device field in the CareObservation object. This role can be used when targetObject is set to Asset.
    - RemoteMonitoringPatient—Indicates which externalIdField on the Account object maps to the ObservedSubject field in the Care Observation object. This role is used when targetObject is set to Account.
    - ServiceProvider—The Enrollment API uses the value of externalIdField as the provider ID. This role is used when targetObject is set to Account.
    - NotApplicable—This role is used when targetObject is set to CareProgram or Product, which means that there is no applicable role.

### sourceSystem

- **Field Type**: string
- **Description**: The system where the record originated.

### targetObject

- **Field Type**: string
- **Description**: The name of the Salesforce object to which the external system field is mapped.

## Declarative Metadata Sample Definition

The following is an example of a CareSystemFieldMapping component.

<?xml version="1.0" encoding="UTF-8"?>
<CareSystemFieldMapping xmlns="http://soap.sforce.com/2006/04/metadata">
    <externalIdField\>AccountNumber</externalIdField\>
    <isActive\>true</isActive\>
    <isProtected\>false</isProtected\>
    <masterLabel\>Map1</masterLabel\>
    <role\>Patient</role\>
    <sourceSystem\>Epic</sourceSystem\>
    <targetObject\>Account</targetObject\>
</CareSystemFieldMapping\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>patient</members\>
        <name\>CareSystemFieldMapping</name\>
    </types\>
    <version\>49.0</version\>
</Package\>

<!-- document id=c9f1de092f122a669cfe0b3a9f1b2091c3ce7416626c14715347ec2df7fb294f url=/legacydeveloper/current/en-us/api_meta/meta_casesettings.md -->

# CaseSettings

Represents an organization’s case settings, such as the default case owner, which case-related features are enabled, and which Classic email templates are used for various case activities. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

[CaseSettings](#meta_casesettings "Represents an organization’s case settings, such as the default case owner, which case-related features are enabled, and which Classic email templates are used for various case activities. This type extends the Metadata metadata type and inherits its fullName field.") values are stored in the Case.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

[CaseSettings](#meta_casesettings "Represents an organization’s case settings, such as the default case owner, which case-related features are enabled, and which Classic email templates are used for various case activities. This type extends the Metadata metadata type and inherits its fullName field.") is available in API version 27.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d224434e145">Field Name</th>

              <th class="featureTableHeader  " id="d224434e148">Field Type</th>

              <th class="featureTableHeader  " id="d224434e151">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">caseAssignNotificationTemplate</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies the email template used for case assignment
                notifications. <span class="ph" id="templateFieldFormatInfo"><a name="templateFieldFormatInfo"><!-- --></a>The format must be
                  <span class="keyword parmname">folderName</span>/<span class="keyword parmname">emailTemplateName</span>.</span>
                <p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">caseAutoProcUser</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether to create an automated
                response record after a customer’s initial email (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">caseCloseNotificationTemplate</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies the email template used for case close notifications.
                The format must be
                <span class="keyword parmname">folderName</span>/<span class="keyword parmname">emailTemplateName</span>. <p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">caseCommentNotificationTemplate</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies the email template used for case comment notifications.
                The format must be
                <span class="keyword parmname">folderName</span>/<span class="keyword parmname">emailTemplateName</span>. <p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">caseCreateNotificationTemplate</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies the email template used for case create notifications.
                The format must be
                <span class="keyword parmname">folderName</span>/<span class="keyword parmname">emailTemplateName</span>. <p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">caseFeedItemSettings</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">
                <a class="xref" href="#FeedItemSettings">FeedItemSettings</a>[]
              </td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies the settings for feed items in feed-based case page
                layouts. This field is available in API version 32.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">caseFeedReadUnreadLtng</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether unread feed items are shown in bold in
                Lightning Experience (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">caseMergeInLightning</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether Case Merge is enabled in
                Lightning Experience (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">closeCaseThroughStatusChange</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether <samp class="codeph nolang">Closed</samp> is
                included in the Case Status field on case edit pages (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">defaultCaseFeedLayoutOn</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the default Case Feed layout is used in the org
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">defaultCaseOwner</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies the default owner of a case when assignment rules fail
                to locate an owner.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">defaultCaseOwnerType</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies whether the default case owner is a user or a
                queue.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">defaultCaseUser</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies the user listed in the Case History related list for
                automated case changes from:<ul class="ul bulletList">
                  <li class="li">Assignment rules</li>

                  <li class="li">Escalation rules</li>

                  <li class="li">On-Demand Email-to-Case</li>

                  <li class="li">Cases logged in the Self-Service portal</li>

                </ul>
                <p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email template.</p>
                &nbsp;
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">emailActionDefaultsHandlerClass</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Use this Apex class name to provide default values for the email
                action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">emailToCase</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type"><a class="xref" href="#EmailToCaseSettings">EmailToCaseSettings</a></td>

              <td class="entry" headers="d224434e151" data-title="Description">The organization's Email-to-Case settings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableCaseFeed</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether Case Feed is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableCollapseEmailThread</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether earlier messages in an
                email thread are removed from email feed items (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 47.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableDraftEmails</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether draft emails are enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Enabling email drafts
                requires that Case Feed and Email-to-Case are also enabled. </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableEarlyEscalationRuleTriggers</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether early triggers on escalation rules are enabled
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableEmailActionDefaultsHandler</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the Email Action Default Handler setting is
                enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Use this setting to select an
                Apex class to load a default template or to specify the default
                target fields for the email action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableEmailContactOnCasePost</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">If <samp class="codeph java">true</samp>, the case contact is
                notified by email when someone makes an externally visible post on a
                case in an Experience Builder site.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableEscalateQfiToCaseInternal</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">If <samp class="codeph java">true</samp>, moderators can create
                cases from Question feed items in Chatter in your
                organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableEscalateQfiToCaseNetworks</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">If <samp class="codeph java">true</samp>, moderators can create
                cases from Question feed items in Chatter in all Experience Builder sites where Chatter Questions is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableExtNetworksCaseFeedEnabled</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">If <samp class="codeph java">true</samp>, site members can see
                case-related emails, comments, and updates in the case feed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableMultiLangSolnSrchCSS</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether multilingual searching for Solutions in
                self-service portals is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableMultiLangSolnSrchPKB</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether multilingual searching for public Solutions is
                enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableMultiLangSolution</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether multilingual Solutions are enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableNewEmailDefaultTemplate</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether default email templates are enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Default email templates are
                available only if draft emails are enabled.<p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableSolutionCategory</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether browsing for Solutions is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableSolutionInlineCategory</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether using inline Solutions category breadcrumbs is
                enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableSolutionShortSummary</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether Solutions summaries are enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableSuggestedArticlesApplication</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the Suggested Articles list appears on case
                pages. (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). <span class="ph" id="suggested_articles_enablement_limit"><a name="suggested_articles_enablement_limit"><!-- --></a>Is only valid if
                  <span class="keyword parmname">enableSuggestedSolutions</span>=<samp class="codeph java">false</samp></span>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableSuggestedArticlesCustomerPortal</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the Suggested Articles list appears on customer
                portal pages (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). Is only valid if
                <span class="keyword parmname">enableSuggestedSolutions</span>=<samp class="codeph java">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableSuggestedArticlesPartnerPortal</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the Suggested Articles list appears on partner
                portal pages (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). Is only valid if
                <span class="keyword parmname">enableSuggestedSolutions</span>=<samp class="codeph java">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">enableSuggestedSolutions</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the View Suggested Solutions or Find Articles
                button appears on case detail pages (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Is only valid if
                <span class="keyword parmname">enableSuggestedArticlesApplication</span>,
                <span class="keyword parmname">enableSuggestedArticlesCustomerPortal</span>, and
                <span class="keyword parmname">enableSuggestedArticlesPartnerPortal</span>=<samp class="codeph java">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">escalateCaseBefore</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether early triggers are enabled
                to escalate a case (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">genericMessageEnabled</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether generic messages are
                enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">keepCaseMergeRecords</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">If <samp class="codeph java">true</samp>, duplicate cases
                aren’t deleted after a case merge.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">keepRecordTypeOnAssignmentRule</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">When applying assignment rules to manually created records,
                indicates whether to keep the existing record type (<samp class="codeph java">true</samp>) or to override the existing
                record type with the assignee’s default record type (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">newEmailDefaultTemplateClass</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies the Apex class that defines the default email template
                for new email messages in Case Feed. This field appears only when
                <span class="keyword parmname">enableNewEmailDefaultTemplate</span><samp class="codeph java">=true</samp>.<p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">notifyContactOnCaseComment</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether contacts who aren’t members of your
                Self-Service portal can be notified when a new comment is added to a
                case (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">notifyDefaultCaseOwner</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the default case owner is notified when
                assigned a new case (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">notifyOwnerOnCaseComment</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the case owner is notified when a comment is
                added to a case (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">notifyOwnerOnCaseOwnerChange</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the <span class="keyword parmname">Send Notification
                  Email</span> checkbox on cases is automatically selected
                when users change a case owner to another user (<samp class="codeph java">true</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">predictiveSupportEnabled</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether predictive support is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">showEmailAttachmentsInCase​AttachmentsRL</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the case Attachments related list shows email
                attachments. If <samp class="codeph java">true</samp>, the page
                displays an email icon next to each attachment from an email in the
                Attachments related list for cases. The related list’s list view
                also includes a Source column that identifies the attachment’s
                origin. If <samp class="codeph java">false</samp>, email
                attachments aren’t displayed in the Attachments related list for
                cases.<p class="p">This field is available in API version 40.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">showFewerCloseActions</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the <strong class="ph uicontrol">Save &amp; Close</strong>
                button on case edit pages and the <strong class="ph uicontrol">Cls</strong> link on
                Cases related lists are hidden (<samp class="codeph java">true</samp>) or shown (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">systemUserEmail</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e151" data-title="Description">Specifies the email address used when the default case user is
                the system user.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">useSystemEmailAddress</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whom case comment, case attachment, and case assignment
                email notifications appear to be sent from. Use <samp class="codeph nolang">true</samp> to show notifications as sent
                from a system address. Use <samp class="codeph nolang">false</samp> to show notifications as sent from the user or
                contact who is updating the case.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">useSystemUserAsDefaultCaseUser</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Indicates whether the system user is used as the automated case
                user (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). If false, then you must
                specify a value for the <span class="keyword parmname">defaultCaseUser</span>
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">visibleInCssCheckbox</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e151" data-title="Description">Sets the default visibility of a case as indicated by the Visible
                in CSS option on the case edit page. If <samp class="codeph java">false</samp>, the case is visible in CSS by default. If
                <samp class="codeph java">true</samp>, CSS visibility is
                off.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e145" data-title="Field Name"><span class="keyword parmname">webToCase</span></td>

              <td class="entry" headers="d224434e148" data-title="Field Type"><a class="xref" href="#WebToCaseSettings">WebToCaseSettings</a></td>

              <td class="entry" headers="d224434e151" data-title="Description">The organization's Web-to-Case settings.</td>

            </tr>

          </tbody>

        </table>

## EmailToCaseSettings

Represents an organization's Email-to-Case settings.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d224434e1212">Field Name</th>

              <th class="featureTableHeader  " id="d224434e1215">Field Type</th>

              <th class="featureTableHeader  " id="d224434e1218">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableEmailToCase</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether Email-to-Case is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). <strong class="ph b">Note:</strong> After
                Email-to-Case is enabled, it can't be disabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableE2CAttachmentAsFile</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether to save attachments sent
                using Email-to-Case as Salesforce Files (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableE2CDeduplicateAttachments</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">&nbsp;When Email-to-Case receives an inbound email to thread to an
                existing case, attachments in the email that already exist on the
                case are not saved as new records and are instead linked to the new
                email (<samp class="codeph java">true</samp>). </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableE2CExternalServer</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether emails can be sent via an external service such
                as Gmail or Outlook, rather than the Salesforce email service
                (<samp class="codeph java">true</samp>). External outbound
                email services are available in Lightning Experience only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type"></td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableE2CSourceTracking</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether Set Case Source to Email is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). After you enable this
                setting, the <strong class="ph uicontrol">Case Source</strong> field is updated to
                <samp class="codeph nolang">Email</samp> for all cases that
                originate from Email-to-Case. Associated emails are marked as
                <samp class="codeph nolang">Read</samp> when the agent opens
                the case.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableHtmlEmail</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether HTML email is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). </td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableNewtoReadTriggers</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether the email status change invokes triggers when
                emails open in Case feeds or from Email Message records in Lightning
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableOnDemandEmailToCase</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether On-Demand Email-to-Case is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableThreadIDInBody</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether the Thread ID for a case is inserted in the
                body of an email (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>).
                This is applicable only to orgs that do not use Lightning
                Threading.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableThreadIDInSubject</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether the Thread ID for a case is inserted in the
                subject line of an email (<samp class="codeph java">true</samp>)
                or not (<samp class="codeph java">false</samp>).
                This is applicable only to orgs that do not use Lightning
                Threading.</td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableThreadTokenInBody</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether a threading token is appended in the email body
                when agents send an email from a Lightning email composer (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). This is applicable only to
                orgs using Lightning Threading.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">enableThreadTokenInSubject</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether a threading token is appended in the email
                subject when agents send an email from a Lightning email composer
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). This is applicable only to
                orgs using Lightning Threading.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type"></td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">notifyOwnerOnNewCaseEmail</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether the owner of a case receives a notification
                when a new email related to the case is received (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">overEmailLimitAction</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">EmailToCaseOnFailureActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Specifies what happens to email messages that are received after
                an organization exceeds its daily Email-to-Case limits. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang" id="bounce_action"><a name="bounce_action"><!-- --></a>Bounce</samp></li>

                  <li class="li"><samp class="codeph nolang" id="discard_action"><a name="discard_action"><!-- --></a>Discard</samp></li>

                  <li class="li"><samp class="codeph nolang" id="requeue_action"><a name="requeue_action"><!-- --></a>Requeue</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">preQuoteSignature</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether the user signature is inserted after the reply
                but before the email thread in an outbound email (<samp class="codeph java">true</samp>) or at the end of the email
                (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">routingAddresses</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">
                <a class="xref" href="#EmailToCaseRoutingAddress">EmailToCaseRoutingAddress</a>[]
              </td>

              <td class="entry" headers="d224434e1218" data-title="Description">The organization's Email-to-Case routing addresses and their
                attributes. Removing an address from this list deletes it from the
                target org.</td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">replyWithNewContentOnly</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description"> Indicates whether previous thread content in excluded from
                replies, to reduce the size of outgoing emails (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">showGeneratedEmailCheckbox</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether senders are required to confirm that they
                reviewed emails written by Einstein (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">unauthorizedSenderAction</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">EmailToCaseOnFailureActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Specifies what happens to email messages received from invalid
                senders. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Bounce</samp></li>

                  <li class="li"><samp class="codeph nolang">Discard</samp></li>

                </ul>
              </td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1212" data-title="Field Name"><span class="keyword parmname">useEmailHeadersForThreading</span></td>

              <td class="entry" headers="d224434e1215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1218" data-title="Description">Indicates whether metadata from incoming emails is used to match
                replies with cases if token-based threading doesn't produce a match
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>


          </tbody>

        </table>

## EmailToCaseRoutingAddress

Represents an organization's Email-to-Case routing address.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d224434e1681">Field Name</th>

              <th class="featureTableHeader  " id="d224434e1684">Field Type</th>

              <th class="featureTableHeader  " id="d224434e1687">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">addressType</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">EmailToCaseRoutingAddressType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies the type of Email-to-Case routing address. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">EmailToCase</samp>—A
                    routing address used with Email-to-Case or On-Demand
                    Email-to-Case.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Outlook</samp>—A
                    routing address used with Salesforce&nbsp;for&nbsp;Outlook
                    to create cases from Outlook. Requires that On-Demand
                    Email-to-Case is enabled.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">authorizedSenders</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies the email addresses or domains from which On-Demand
                Email-to-Case can receive email. Include multiple entries in a
                comma-separated list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">caseOrigin</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies the default case origin for cases created through this
                routing address.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">caseOwner</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">
                <p class="p">Specifies the default owner of cases created through this routing
                  address. The case owner can be either a user or a queue. Specify
                  the case owner using a Salesforce username.</p>

                <p class="p">Specifying a case owner here in the routing address sets a value
                  of <span class="keyword parmname">defaultCaseOwner</span> in CaseSettings. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">caseOwnerType</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies whether the default case owner is a user or a
                queue.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">casePriority</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies the default case priority for cases created through
                this routing address.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">createTask</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Indicates whether a task is automatically assigned to the case
                owner when a case is created through an email (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">emailAddress</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies the email address used to route email messages that are
                submitted as cases.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">emailServicesAddress</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies the Salesforce-generated routing address used for
                setting up Email-to-Case forwarding. This field value is read-only
                and can't be modified.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">fallbackQueue</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Defines which queue to use when emails can’t be routed with the
                specified Omni-Channel flow. This queue must use Case as the service
                channel object. <p class="p">Available in API version 56.0 and
                  later.</p>
              </td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">isPermsetControlled</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Indicates whether users’ access to the email routing address is
                controlled by a permission set. If <samp class="codeph java">true</samp>, only users with access via a permission set can
                use the routing address to send emails.<p class="p">Available in API version
                  61.0 and later.</p>
              </td>

            </tr>


            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">isVerified</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Indicates whether the customer has verified the routing address
                (typically by clicking a confirmation email). This field value is
                read-only and can't be modified.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">newEntityRecordType</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">
                <p class="p">Sets the Case Record Type used for new Cases that are created
                  from emails sent to that specific routing address.</p>
                <p class="p">If not
                  provided, Salesforce uses the org’s default Case Record Type for
                  the user/context handling Email-to-Case. Ensure the record type
                  exists and is active on Case.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">routingFlow</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies the name of an Omni-Channel flow that routes cases
                generated in Email-to-Case.<p class="p">Available in API version 56.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">routingName</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies the name of the Email-to-Case routing address.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">saveEmailHeaders</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Indicates whether email routing and envelope information are
                saved (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e1681" data-title="Field Name"><span class="keyword parmname">taskStatus</span></td>

              <td class="entry" headers="d224434e1684" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e1687" data-title="Description">Specifies the default status on tasks automatically assigned to
                the case owner when email is submitted as a case. Only applies if
                <span class="keyword parmname">createTask</span> is set to <samp class="codeph java">true</samp>.
              </td>

            </tr>

          </tbody>

        </table>

## FeedItemSettings

Represents an organization's feed item settings. Available in API version 32.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d224434e2007">Field Name</th>

              <th class="featureTableHeader vertical-align-top " id="d224434e2010">Field Type</th>

              <th class="featureTableHeader vertical-align-top " id="d224434e2013">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d224434e2007" data-title="Field Name"><span class="keyword parmname">characterLimit</span></td>

              <td class="entry" headers="d224434e2010" data-title="Field Type">int</td>

              <td class="entry" headers="d224434e2013" data-title="Description">Specifies the maximum number of characters displayed for each
                feed item.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e2007" data-title="Field Name"><span class="keyword parmname">collapseThread</span></td>

              <td class="entry" headers="d224434e2010" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e2013" data-title="Description">
                <p class="p">Removed. Indicates whether earlier messages
                  in an email thread are removed from email feed items (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</p>

                <p class="p">Available in API versions 27.0 to 46.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e2007" data-title="Field Name"><span class="keyword parmname">displayFormat</span></td>

              <td class="entry" headers="d224434e2010" data-title="Field Type">FeedItemDisplayFormat (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d224434e2013" data-title="Description">Indicates how email feed items are displayed. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <span class="keyword parmname">Default</span>—Blank lines in email
                    feed items are displayed.
                  </li>

                  <li class="li">
                    <span class="keyword parmname">HideBlankLines</span>—Blank lines in
                    email feed items aren’t displayed.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e2007" data-title="Field Name"><span class="keyword parmname">feedItemType</span></td>

              <td class="entry" headers="d224434e2010" data-title="Field Type">FeedItemType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d224434e2013" data-title="Description">The type of feed item to which the settings apply. For
                <span class="keyword parmname">FeedItemSettings</span>, the only valid
                <span class="keyword parmname">feedItemType</span> value is
                <span class="keyword parmname">EmailMessageEvent</span>.
              </td>

            </tr>

          </tbody>

        </table>

## WebToCaseSettings

Represents an organization's Web-to-Case settings.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d224434e2149">Field Name</th>

              <th class="featureTableHeader  " id="d224434e2152">Field Type</th>

              <th class="featureTableHeader  " id="d224434e2155">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d224434e2149" data-title="Field Name"><span class="keyword parmname">caseOrigin</span></td>

              <td class="entry" headers="d224434e2152" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e2155" data-title="Description">Specifies the default case origin for cases created through this
                web form. Applies only if <span class="keyword parmname">enableWebToCase</span> is
                set to <samp class="codeph java">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e2149" data-title="Field Name"><span class="keyword parmname">defaultResponseTemplate</span></td>

              <td class="entry" headers="d224434e2152" data-title="Field Type">string</td>

              <td class="entry" headers="d224434e2155" data-title="Description">Specifies the default template used for email responses to cases
                that are submitted through a Self-Service portal. Applies only if
                <span class="keyword parmname">enableWebToCase</span> is set to <samp class="codeph java">true</samp>.<p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d224434e2149" data-title="Field Name"><span class="keyword parmname">enableWebToCase</span></td>

              <td class="entry" headers="d224434e2152" data-title="Field Type">boolean</td>

              <td class="entry" headers="d224434e2155" data-title="Description">Indicates whether Web-to-Case is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This code sample is an example of a case settings file.

<?xml version="1.0" encoding="UTF-8"?>
<CaseSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <caseAssignNotificationTemplate\>
        unfiled$public/SupportCaseAssignmentNotification
    </caseAssignNotificationTemplate\>
    <caseCloseNotificationTemplate\>
        unfiled$public/SupportCaseCloseNotification
    </caseCloseNotificationTemplate\>
    <caseCommentNotificationTemplate\>
        unfiled$public/SupportCaseCommentNotification
    </caseCommentNotificationTemplate\>
    <caseCreateNotificationTemplate\>
        unfiled$public/SupportCaseCreateNotification
    </caseCreateNotificationTemplate\>
    <closeCaseThroughStatusChange\>true</closeCaseThroughStatusChange\>
    <defaultCaseOwner\>admin@acme.com</defaultCaseOwner\>
    <defaultCaseOwnerType\>User</defaultCaseOwnerType\>
    <defaultCaseUser\>admin@acme.com</defaultCaseUser\>
    <emailToCase\>
        <enableEmailToCase\>true</enableEmailToCase\>
        <enableHtmlEmail\>false</enableHtmlEmail\>
        <enableOnDemandEmailToCase\>true</enableOnDemandEmailToCase\>
        <enableThreadIDInBody\>true</enableThreadIDInBody\>
        <enableThreadIDInSubject\>true</enableThreadIDInSubject\>
        <notifyOwnerOnNewCaseEmail\>false</notifyOwnerOnNewCaseEmail\>
        <overEmailLimitAction\>Bounce</overEmailLimitAction\>
        <preQuoteSignature\>true</preQuoteSignature\>
        <routingAddresses\>
            <addressType\>EmailToCase</addressType\>
            <authorizedSenders\>user@acme.com</authorizedSenders\>
            <caseOrigin\>Email</caseOrigin\>
            <casePriority\>Medium</casePriority\>
            <createTask\>true</createTask\>
            <emailAddress\>support@acme.com</emailAddress\>
            <routingName\>EmailToCaseRoutingAddress1</routingName\>
            <saveEmailHeaders\>true</saveEmailHeaders\>
            <taskStatus\>Not Started</taskStatus\>
        </routingAddresses\>
        <routingAddresses\>
            <addressType\>Outlook</addressType\>
            <authorizedSenders\>user@acme.com</authorizedSenders\>
            <caseOrigin\>Email</caseOrigin\>
            <caseOwner\>admin@acme.com</caseOwner\>
            <caseOwnerType\>User</caseOwnerType\>
            <casePriority\>High</casePriority\>
            <routingName\>OutlookRoutingAddress1</routingName\>
        </routingAddresses\>
        <unauthorizedSenderAction\>Discard</unauthorizedSenderAction\>
    </emailToCase\>
    <enableCaseFeed\>true</enableCaseFeed\>
    <enableDraftEmails\>true</enableDraftEmails\>
    <enableEarlyEscalationRuleTriggers\>true</enableEarlyEscalationRuleTriggers\>
    <enableNewEmailDefaultTemplate\>true</enableNewEmailDefaultTemplate\>
    <enableSuggestedArticlesApplication\>true</enableSuggestedArticlesApplication\>
    <enableSuggestedArticlesCustomerPortal\>true</enableSuggestedArticlesCustomerPortal\>
    <enableSuggestedArticlesPartnerPortal\>false</enableSuggestedArticlesPartnerPortal\>
    <enableSuggestedSolutions\>false</enableSuggestedSolutions\>
    <keepRecordTypeOnAssignmentRule\>true</keepRecordTypeOnAssignmentRule\>
    <newEmailDefaultTemplateClass\>CaseTemplateController</newEmailDefaultTemplateClass\>
    <notifyContactOnCaseComment\>true</notifyContactOnCaseComment\>
    <notifyDefaultCaseOwner\>true</notifyDefaultCaseOwner\>
    <notifyOwnerOnCaseComment\>true</notifyOwnerOnCaseComment\>
    <notifyOwnerOnCaseOwnerChange\>false</notifyOwnerOnCaseOwnerChange\>
    <showFewerCloseActions\>false</showFewerCloseActions\>
    <useSystemEmailAddress\>true</useSystemEmailAddress\>
    <webToCase\>
        <caseOrigin\>Web</caseOrigin\>
        <defaultResponseTemplate\>unfiled$public/SupportCaseResponse</defaultResponseTemplate\>
        <enableWebToCase\>true</enableWebToCase\>
    </webToCase\>
</CaseSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Case</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=dc37d94b0b2550af6425200286179c4b32c16312b20363938f146595921d3b7e url=/legacydeveloper/current/en-us/api_meta/meta_casesubjectparticle.md -->

# CaseSubjectParticle

Represents the Social Business Rules custom format for the **Case Subject** field on cases created from inbound social posts.

## File Suffix and Directory Location

CaseSubjectParticle components have the suffix .CaseSubjectParticle and are stored in the CaseSubjectParticles folder.

## Version

CaseSubjectParticle is available in API version 41.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d232154e80">Field Name</th>

              <th class="featureTableHeader  " id="d232154e83">Field Type</th>

              <th class="featureTableHeader  " id="d232154e86">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d232154e80" data-title="Field Name"><span class="keyword parmname">index</span></td>

              <td class="entry" headers="d232154e83" data-title="Field Type">int</td>

              <td class="entry" headers="d232154e86" data-title="Description">Required. The order in which the custom <strong class="ph uicontrol">Case
                  Subject</strong> is generated, meaning if the social network
                is 0 and the social message is 1, then the subject generates as
                <samp class="ph systemoutput">Twitter | Tweet</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d232154e80" data-title="Field Name"><span class="keyword parmname">textField</span></td>

              <td class="entry" headers="d232154e83" data-title="Field Type">string</td>

              <td class="entry" headers="d232154e86" data-title="Description">Specifies inbound social content added to <strong class="ph uicontrol">Case
                  Subject</strong> in case records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d232154e80" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d232154e83" data-title="Field Type">CaseSubjectParticleType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d232154e86" data-title="Description">Required. Specifies the custom <strong class="ph uicontrol">Case
                  Subject</strong> format from which inbound social content
                appears in case records. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ProvidedString</samp></li>

                  <li class="li"><samp class="codeph nolang">Source</samp></li>

                  <li class="li"><samp class="codeph nolang">MessageType</samp></li>

                  <li class="li"><samp class="codeph nolang">SocialHandle</samp></li>

                  <li class="li"><samp class="codeph nolang">SocialNetwork</samp></li>

                  <li class="li"><samp class="codeph nolang">Sentiment</samp></li>

                  <li class="li"><samp class="codeph nolang">RealName</samp></li>

                  <li class="li"><samp class="codeph nolang">Content</samp></li>

                  <li class="li"><samp class="codeph nolang">PipeSeparator</samp></li>

                  <li class="li"><samp class="codeph nolang">ColonSeparator</samp></li>

                  <li class="li"><samp class="codeph nolang">HyphenSeparator</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This is a sample of a .CaseSubjectParticle file.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns=http://soap.sforce.com/2006/04/metadata"">
    <types\>
        <members\>\*</members\> 
        <name\>CaseSubjectParticle</name\>
    </types\>
    <version\>41.0</version\>
</Package\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a6dd7e3765d517734da3f61f705a023d2afd626c44e6ae02eab850f0dc407224 url=/legacydeveloper/current/en-us/api_meta/meta_catalogedapi.md -->

# CatalogedApi

Represents an API brought into API Catalog for Salesforce from an external source.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CatalogedApi components have the suffix .catalogedApi and are stored in the catalogedApis folder.

## Version

CatalogedApi components are available in API version 65.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d232674e98">Field Name</th>

              <th class="featureTableHeader  " id="d232674e101">Field Type</th>

              <th class="featureTableHeader  " id="d232674e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d232674e98" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d232674e101" data-title="Field Type">string</td>

              <td class="entry" headers="d232674e104" data-title="Description">The description defined when the API is cataloged.</td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e98" data-title="Field Name"><span class="keyword parmname">descriptor</span></td>

              <td class="entry" headers="d232674e101" data-title="Field Type">string</td>

              <td class="entry" headers="d232674e104" data-title="Description">The content of the API schema in JSON format.</td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e98" data-title="Field Name"><span class="keyword parmname">externalSourceIdentifier</span></td>

              <td class="entry" headers="d232674e101" data-title="Field Type">string</td>

              <td class="entry" headers="d232674e104" data-title="Description">The ID of the API in the external source that it's imported
                from.</td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e98" data-title="Field Name"><span class="keyword parmname">instances</span></td>

              <td class="entry" headers="d232674e101" data-title="Field Type">
                <a class="xref" href="#CatalogedApiInstance">CatalogedApiInstance</a>[]
              </td>

              <td class="entry" headers="d232674e104" data-title="Description">Reference to the cataloged API that this instance is specific to.</td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e98" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d232674e101" data-title="Field Type">string</td>

              <td class="entry" headers="d232674e104" data-title="Description">
                <p class="p">Required. The API name as it appears in API Catalog.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e98" data-title="Field Name"><span class="keyword parmname">providerType</span></td>

              <td class="entry" headers="d232674e101" data-title="Field Type">ExternalServiceRegistrationProviderType (enumeration of type
                string)</td>

              <td class="entry" headers="d232674e104" data-title="Description">Required. Indicates the source of the API specification registered with API
                Catalog.<p class="p">API Catalog supports the value <samp class="codeph nolang">Anypoint</samp> for deployment and
                  supports other values for enumeration. See information about the
                  values in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_externalserviceregistration.htm" target="_blank">the registrationProviderType
                    field</a>. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e98" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d232674e101" data-title="Field Type">APIType (enumeration of type string)</td>

              <td class="entry" headers="d232674e104" data-title="Description">
                <p class="p">Required. Specifies the API type. If not specified, the API type
                  is derived based on the descriptor content. Nillable.</p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">GraphQL</samp></li>

                  <li class="li"><samp class="codeph nolang">gRPC</samp></li>

                  <li class="li"><samp class="codeph nolang">REST</samp></li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## CatalogedApiInstance

Represents a MuleSoft API instance brought into API Catalog for Salesforce from Anypoint Platform.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d232674e266">Field Name</th>

              <th class="featureTableHeader  " id="d232674e269">Field Type</th>

              <th class="featureTableHeader  " id="d232674e272">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d232674e266" data-title="Field Name"><span class="keyword parmname">accessStatus</span></td>

              <td class="entry" headers="d232674e269" data-title="Field Type">APIInstanceAccessStatus (enumeration of type string)</td>

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The access status for the API instance.</p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Approved</samp></li>

                  <li class="li"><samp class="codeph nolang">Deleted</samp></li>

                  <li class="li"><samp class="codeph nolang">NoStatus</samp></li>

                  <li class="li"><samp class="codeph nolang">NotAccessible</samp></li>

                  <li class="li"><samp class="codeph nolang">Pending</samp></li>

                  <li class="li"><samp class="codeph nolang">Rejected</samp></li>

                  <li class="li"><samp class="codeph nolang">Revoked</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e266" data-title="Field Name"><span class="keyword parmname">apiInstanceDescriptor</span></td>

              <td class="entry" headers="d232674e269" data-title="Field Type">string</td>

              <td class="entry" headers="d232674e272" data-title="Description">The content of the API schema in JSON format.</td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e266" data-title="Field Name"><span class="keyword parmname">approvalType</span></td>

              <td class="entry" headers="d232674e269" data-title="Field Type">APIInstanceApprovalType (enumeration of type string)</td>

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The approval type for access in Anypoint Platform. </p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">AutoApproval</samp></li>

                  <li class="li"><samp class="codeph nolang">ManualApproval</samp></li>

                  <li class="li"><samp class="codeph nolang">NoApproval</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e266" data-title="Field Name"><span class="keyword parmname">endpointType</span></td>

              <td class="entry" headers="d232674e269" data-title="Field Type">APIInstanceEndpointType (enumeration of type string)</td>

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">The endpoint type to invoke the instance. Available in API version 66.0 and later. </p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Callout</samp></li>

                  <li class="li"><samp class="codeph nolang">Discovery</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e266" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d232674e269" data-title="Field Type">string</td>

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The instance name as it appears in API Catalog. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e266" data-title="Field Name"><span class="keyword parmname">serviceRegistration</span></td>

              <td class="entry" headers="d232674e269" data-title="Field Type">string</td>

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The service registration in external services related
                  to this API instance.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d232674e266" data-title="Field Name"><span class="keyword parmname">uri</span></td>

              <td class="entry" headers="d232674e269" data-title="Field Type">string</td>

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The uniform resource identifier (URI) for the
                  instance.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This XML is an example of a CatalogedApi component.

<?xml version="1.0" encoding="UTF-8"?>
<CatalogedApi xmlns="http://soap.sforce.com/2006/04/metadata">
    <externalSourceIdentifier\>urn:ms:03ff2c74-d0ea-4eba-a536-36dfd2d0fdbb:api-project::petstore-engineering</externalSourceIdentifier\>
    <instances\>
        <accessStatus\>NoStatus</accessStatus\>
        <apiInstanceDescriptor\>{&quot;@type&quot;:&quot;anypointAPIInstanceDescriptor&quot;,&quot;environmentType&quot;:&quot;SANDBOX&quot;,&quot;environmentName&quot;:&quot;Sandbox&quot;,&quot;environmentId&quot;:&quot;79305d19-1d89-413f-88ec-d7a8dbd1e29d&quot;,&quot;instanceId&quot;:&quot;4051358&quot;,&quot;authenticationMethod&quot;:&quot;NO\_AUTH&quot;,&quot;componentType&quot;:&quot;apiInstance&quot;,&quot;instanceOrigin&quot;:&quot;MANUAL&quot;}</apiInstanceDescriptor\>
        <approvalType\>NoApproval</approvalType\>
        <label\>petstore-engineering</label\>
        <serviceRegistration\>PetstoreEngineeringv109C60C7C</serviceRegistration\>
        <uri\>https://google.com</uri\>
    </instances\>
    <label\>petstore-engineering</label\>
    <providerType\>Anypoint</providerType\>
    <type\>REST</type\>
</CatalogedApi\>

<!-- document id=be8e6ad035fa0c64b2d1bae7a052778669ca14d88294c6d9d0d42775d1c9ca57 url=/legacydeveloper/current/en-us/api_meta/meta_catalogedapiartifactversioninfo.md -->

# CatalogedApiArtifactVersionInfo

Represents API version information in API Catalog that’s referenced by other entities.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CatalogedApiArtifactVersionInfo components have the suffix .catalogedApiArtifactVersionInfo and are stored in the catalogedApiArtifactVersionInfos folder.

## Version

CatalogedApiArtifactVersionInfo components are available in API version 65.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| releaseNotes | string | The API release notes. |
| revision | int | The API revision. |
| type | string | Required. The API type. |
| version | string | Required. The API version. |

## Declarative Metadata Sample Definition

This XML is an example of a CatalogedApiArtifactVersionInfo component.

<?xml version="1.0" encoding="UTF-8"?>
<CatalogedApiArtifactVersionInfo xmlns="http://soap.sforce.com/2006/04/metadata">
    <revision\>1</revision\>
    <type\>API</type\>
    <version\>v1</version\>
</CatalogedApiArtifactVersionInfo\>

<!-- document id=392e4833a4f43565719452a2a06325f1cf573d4ec280474d46292e2db1b7bac5 url=/legacydeveloper/current/en-us/api_meta/meta_catalogedapiversion.md -->

# CatalogedApiVersion

Represents a version of an API that is consumable in Salesforce using API Catalog.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CatalogedApiVersion components have the suffix .catalogedApiVersion and are stored in the catalogedApiVersions folder.

## Version

CatalogedApiVersion components are available in API version 65.0 and later.

## Special Access Rules

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234405e104">Field Name</th>

              <th class="featureTableHeader  " id="d234405e107">Field Type</th>

              <th class="featureTableHeader  " id="d234405e110">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234405e104" data-title="Field Name"><span class="keyword parmname">catalogedApi</span></td>

              <td class="entry" headers="d234405e107" data-title="Field Type">string</td>

              <td class="entry" headers="d234405e110" data-title="Description">Required. An API managed for consumption in Salesforce using API
                Catalog.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234405e104" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d234405e107" data-title="Field Type">string</td>

              <td class="entry" headers="d234405e110" data-title="Description">The description defined when the API is cataloged.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234405e104" data-title="Field Name"><span class="keyword parmname">externalSourceIdentifier</span></td>

              <td class="entry" headers="d234405e107" data-title="Field Type">string</td>

              <td class="entry" headers="d234405e110" data-title="Description">The ID of the API in the external source that it's imported
                from.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234405e104" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d234405e107" data-title="Field Type">string</td>

              <td class="entry" headers="d234405e110" data-title="Description">
                <p class="p">Required. The API name as it appears in API Catalog.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234405e104" data-title="Field Name"><span class="keyword parmname">version</span></td>

              <td class="entry" headers="d234405e107" data-title="Field Type">string</td>

              <td class="entry" headers="d234405e110" data-title="Description">Required. The ID of the API version information.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This XML is an example of a CatalogedApiVersion component.

<?xml version="1.0" encoding="UTF-8"?>
<CatalogedApiVersion xmlns="http://soap.sforce.com/2006/04/metadata">
    <catalogedApi\>PetstoreEngineeringv109C60C7C</catalogedApi\>
    <externalSourceIdentifier\>urn:ms:03ff2c74-d0ea-4eba-a536-36dfd2d0fdbb:api-project::petstore-engineering/v1</externalSourceIdentifier\>
    <label\>petstore-engineering</label\>
    <version\>v1lwWZmDFyJYIFValk</version\>
</CatalogedApiVersion\>

<!-- document id=1179526a8cb2a2bca4ead9a3640e1baeb482d1684acc8b8b51428572f68105f6 url=/legacydeveloper/current/en-us/api_meta/meta_certificate.md -->

# Certificate

Represents a certificate used for digital signatures that verify that requests are coming from your org. Certificates are used for either authenticated single sign-on with an external website, or when using your org as an identity provider. This type extends the Metadata With Content metadata type and inherits its content and fullName fields.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

Certificate components have the suffix .crt and are stored in the certs folder.

## Version

Certificate components are available in API version 36.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| caSigned | boolean | Required. Indicates whether this certificate is signed by the issuer (true) or not (false). |
| encryptedWithPlatformEncryption | boolean | Indicates whether this certificate is encrypted with Platform Encryption. |
| expirationDate | dateTime | The date that this certificate expires and is no longer usable. For self-signed certificates, if keySize is 2048 bits, the expiration date is automatically 1 year after you create the certificate. If keySize is 4096 bits, the expiration date is automatically 2 years after you create the certificate. For CA-signed certificates, expirationDate is automatically updated to the signed certificate’s expiration date when a signed certificate chain is uploaded. The date format is YYYY-MM-DD. |
| keySize | int | Certificate keys can be either 2048 bits or 4096 bits. A certificate with 4096-bit keys lasts 2 years, and a certificate with 2048-bit keys lasts 1 year. Certificates with 2048-bit keys are faster than certificates with 4096-bit keys. If keySize isn’t specified when you create a certificate, the key size defaults to 2048 bits. |
| masterLabel | string | Required. A user-friendly name for the certificate that appears in the Salesforce user interface, such as in Certificate and Key Management. Limit: 64 characters. |
| privateKeyExportable | boolean | Indicates whether this certificate’s private key is exportable. If privateKeyExportable isn’t specified when you create a certificate, its default value is true. |

## Usage

The Metadata API can be used to create a self-signed or a CA-signed certificate. The .crt file’s contents are the certificate chain, which can be updated when you renew or update the intermediate certificate chain of a CA-signed certificate. After creating a CA-signed certificate, the .crt file contains a certificate signing request (CSR). For details, see [About Salesforce Certificates and Keys](https://help.salesforce.com/apex/HTViewHelpDoc?id=security_keys_about.htm&language=en_US "HTML (New Window)") in Salesforce Help.

To copy an existing certificate’s X.509 parameter data to a new certificate, upload the existing certificate. You can also use this procedure to renew a certificate. A new private+public key pair is created with a new certificate. Salesforce doesn’t allow the import or export of the private key via the API.

Using the Metadata API, you can download a CSR. After it’s CA-signed, you can upload it back to Salesforce.

After the signed certificate chain is uploaded via the Metadata API, the CSR of that certificate can’t be downloaded via the API anymore. The content of the .crt file is the signed certificate chain. However, the CSR can still be downloaded via the UI.

- Downloading a CSR—The CSR is downloadable after a CA-signed cert is created. If a signed certificate hasn’t been uploaded to that certificate, the content of the downloaded .crt file is the CSR.
- Uploading a CA-Signed Certificate—To upload the signed certificate chain back to Salesforce, save the signed certificate chain as the content of the .crt file and update it via the Metadata API.

## Declarative Metadata Sample Definition

The following is an example of a Certificate component.

<?xml version="1.0" encoding="UTF-8"?>
<Certificate xmlns="http://soap.sforce.com/2006/04/metadata">
    <caSigned\>true</caSigned\>
    <encryptedWithPlatformEncryption\>true</encryptedWithPlatformEncryption\>
    <expirationDate\>2017-03-19</expirationDate\>
    <keySize\>4096</keySize\>
    <masterLabel\>My Certificate Name</masterLabel\>
    <privateKeyExportable\>true</privateKeyExportable\>
</Certificate\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=020e5a3211fef20af2727008beb6aea3211be2238809c78d462917b5158c8f02 url=/legacydeveloper/current/en-us/api_meta/meta_articletype_channellayout.md -->

# ChannelLayout

Represents the metadata associated with a communication channel layout. Communication channel layouts let admins share article content inline into communication channels (for example, in email publishers, Experience Builder sites, or social media publishers). Admins can create a list of fields for an article type or record type that they want to share for each communication channel. You can customize the order of the fields.

## File Suffix and Directory Location

Channel layout components have the suffix .channelLayout and are stored in the channelLayouts folder of the corresponding package directory. The prefix must match with the article type API name. In Lightning Knowledge, the prefix must match the API name for the knowledge object.

## Version

Channel layout components are available in API version 32.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| doesExcludeFieldLabels | boolean | Indicates whether field labels are excluded from the field contents in the communication channels where this layout applies (true) or not (false). The default is false, meaning field labels are inserted. Available when Lightning Knowledge is enabled in API version 48.0 and later. |
| doesExcludeFiles | boolean | Indicates whether related files are left off emails (true) or attached to emails (false). The default is false, meaning related files are attached. Available when Lightning Knowledge is enabled in API version 48.0 and later. |
| enabledChannels | string\[\] | The communication channels where this layout applies. In API version 32.0 to 46.0, the only valid value is Email. When Lightning Knowledge is enabled in API version 47.0 and later, Chat, Messaging, and Social are added valid values. |
| label | string | Required. The label for this configuration. |
| layoutItems | [ChannelLayoutItem](#layoutItemID)\[\] | The article fields contained in the layout. The order here determines the field order. |
| recordType | string | The name of the record type that the channel layout applies to. The default is the primary record type. Available in API version 41.0 and later. |

## ChannelLayoutItem

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Required. Name of the field. The format is ArticleTypeName.FieldName or, in Lightning Knowledge, KnowledgeBaseName.FieldName. |

## Declarative Metadata Sample Definition

The following is an example of a ChannelLayout component.

<?xml version="1.0" encoding="UTF-8"?>
<ChannelLayout xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>Layout for Email</label\>
    <layoutItems\>
        <field\>Knowledge.Question</field\>
    </layoutItems\>
    <layoutItems\>
        <field\>Knowledge.Answer</field\>
    </layoutItems\>
    <enabledChannels\>Email</enabledChannels\>
    <enabledChannels\>Social</enabledChannels\>
    <enabledChannels\>Chat</enabledChannels\>
    <doesExcludeFiles\>false</doesExcludeFiles\>
    <doesExcludeFieldLabels\>true</doesExcludeFieldLabels\>
</ChannelLayout\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ChannelLayout</name\>
    </types\>
    <version\>41.0</version\>
</Package\>

<!-- document id=6d4fbdd0c8f2a7e4bee633dff979a1859df86cc09d312f3de562d9c83c05b3c5 url=/legacydeveloper/current/en-us/api_meta/meta_chatteranswerssettings.md -->

# ChatterAnswersSettings

Represents the metadata used to manage settings for Chatter Answers.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

Chatter Answers settings are stored in a single file named ChatterAnswers.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ChatterAnswersSettings

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| emailFollowersOnBestAnswer | boolean | Indicates whether users are notified when a best answer is selected for a question that they’re following (true) or not (false). |
| emailFollowersOnReply | boolean | Indicates whether users are notified when other users reply to questions that they’re following (true) or not (false). |
| emailOwnerOnPrivateReply | boolean | Indicates whether users are notified when customer support responds to their questions privately (true) or not (false). |
| emailOwnerOnReply | boolean | Indicates whether users are notified when other users reply to their questions (true) or not (false). |
| enableAnswerViaEmail | boolean | Indicates whether users can post answers by replying to email notifications (true) or not (false). This field is available in API version 29.0 and later. |
| enableChatterAnswers | boolean | Indicates whether the Chatter Answers feature is enabled in the organization (true) or not (false). |
| enableFacebookSSO | boolean | Indicates whether users can sign in to your Chatter Answers forums with their Facebook logins (true) or not (false). To enable this feature, you must define and enable a Facebook authentication provider in your organization’s security controls and enable Auth Providers in your organization. |
| enableInlinePublisher | boolean | Indicates whether users can filter search results by articles or questions before they post a question to any of your Chatter Answers forums (true) or not (false). Also, adds Title and Body fields to questions for easier text input and scanning. This field is available in API version 29.0 and later. |
| enableReputation | boolean | Indicates whether user reputations appear as hover text on their profile pictures (true) or not (false).  Reputation is enabled across all zones. To enable the reputation setting, you must enable Reputation in your organization. |
| enableRichTextEditor | boolean | Indicates whether the rich text editor is enabled for users to format text and upload images when posting questions (true) or not (false). To enable rich text editor, you must enable Optimize Question Flow. |
| facebookAuthProvider | string | The name of an existing Facebook authentication provider. To implement Facebook Single Sign On for your Chatter Answers forums, you must choose a Facebook authentication provider. |
| showInPortals | boolean | Indicates whether Chatter Answers can be added as a tab to your Customer portal or partner portal (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example chatteranswers.settings metadata file:

<?xml version="1.0" encoding="UTF-8"?>
<ChatterAnswersSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <emailFollowersOnBestAnswer\>true</emailFollowersOnBestAnswer\>
    <emailFollowersOnReply\>true</emailFollowersOnReply\>
    <emailOwnerOnPrivateReply\>true</emailOwnerOnPrivateReply\>
    <emailOwnerOnReply\>true</emailOwnerOnReply\>
    <enableChatterAnswers\>true</enableChatterAnswers\>
    <enableFacebookSSO\>true</enableFacebookSSO\>
    <enableInlinePublisher\>true</enableInlinePublisher\>
    <enableReputation\>true</enableReputation\>
    <enableRichTextEditor\>true</enableRichTextEditor\>
    <facebookAuthProvider\>FacebookAuthProvider</facebookAuthProvider\>
    <showInPortals\>true</showInPortals\>
</ChatterAnswersSettings\>

The following is an example package.xml manifest that references the ChatterAnswersSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ChatterAnswers</members\>
        <name\>Settings</name\>
    </types\>
    <version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=0a4f0155600a6d1114f0b00d8539cddca2607aef8fa7cdb2054c36be3415910b url=/legacydeveloper/current/en-us/api_meta/meta_chatteremailmdsettings.md -->

# ChatterEmailsMDSettings

Represents an org’s settings for Chatter email when Chatter is enabled. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

The ChatterEmailsMDSettings component appears in the ChatterEmailsMD.settings file, and is stored 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

ChatterEmailsMDSettings components are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableChatterDigestEmailsApiOnly | boolean | Indicates whether Chatter digests can be sent via the API, rather than according to the regular schedule, for your org (true) or not (false). |
| enableChatterEmailAttachment | boolean | Indicates whether attachments can be included on posts to chatter feeds via email replies (true) or not (false). |
| enableCollaborationEmail | boolean | Indicates whether collaboration email notifications can be sent (true) or not (false). |
| enableDisplayAppDownloadBadges | boolean | Indicates whether iOS and Android app download badges display in Chatter notifications (true) or not (false). |
| enableEmailReplyToChatter | boolean | Indicates whether users can reply to chatter notifications through an email response (true) or not (false). |
| enableEmailToChatter | boolean | Indicates whether users can post to chatter feeds via email (true) or not (false). |
| noQnOwnNotifyOnCaseCmt | boolean | Indicates whether a user is notified when a question is posted on their case comment (false) or not (true). |
| noQnOwnNotifyOnRep | boolean | Indicates whether a user is notified when a reply is posted on their question (false) or not true. |
| noQnSubNotifyOnBestR | boolean | Indicates whether a user is notified when a best reply is selected on a question they follow (false) or not (true). |
| noQnSubNotifyOnRep | boolean | Indicates whether a user is notified when a reply is posted on a question they follow (false) or not (true). |

## Declarative Metadata Sample Definition

The following is an example of a chatteremailmd.settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>
<ChatterEmailsMDSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableChatterDigestEmailsApiOnly\>false</enableChatterDigestEmailsApiOnly\>
    <enableChatterEmailAttachment\>false</enableChatterEmailAttachment\>
    <enableCollaborationEmail\>true</enableCollaborationEmail\>
    <enableDisplayAppDownloadBadges\>true</enableDisplayAppDownloadBadges\>
    <enableEmailReplyToChatter\>false</enableEmailReplyToChatter\>
    <enableEmailToChatter\>true</enableEmailToChatter\>
    <noQnOwnNotifyOnCaseCmt\>false</noQnOwnNotifyOnCaseCmt\>
    <noQnOwnNotifyOnRep\>false</noQnOwnNotifyOnRep\>
    <noQnSubNotifyOnBestR\>false</noQnSubNotifyOnBestR\>
    <noQnSubNotifyOnRep\>false</noQnSubNotifyOnRep\>

</ChatterEmailsMDSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=14bc8ec40e7e1f2b05dcc6275955d26f819c146f2761d17eb7bba62723c5d506 url=/legacydeveloper/current/en-us/api_meta/meta_chatterextensions.md -->

# ChatterExtension

Represents the metadata used to describe a Rich Publisher App that’s integrated with the Chatter publisher.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Retrieving ChatterExtension

Using an API tool, you can get extension information from package.xml using this code.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
 <types\>
  <members\>xw1</members\>
  <name\>ChatterExtension</name\>
 </types\>
 <version\>41.0</version\>
</Package\>

Use the <members> tag to name a specific extension (in this example, xw1), or use the wildcard (\*) symbol to retrieve all your extensions.

Here’s an example of retrieved information.

<?xml version="1.0" encoding="UTF-8"?>
<ChatterExtension xmlns="http://soap.sforce.com/2006/04/metadata">
  <compositionComponent\>xwComp</compositionComponent\>
  <description\>des</description\>
  <extensionName\>xw1</extensionName\>
  <headerText\>h1</headerText\>
  <hoverText\>h2</hoverText\>
  <icon\>tiger</icon\>
  <masterLabel\>primary</masterLabel\>  
  <renderComponent\>xwRend</renderComponent\>
  <type\>Lightning</type\>
</ChatterExtension\>

## Version

ChatterExtension is a new feature in API version 41.0.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| compositionComponent | string | Required. The composition component of the Rich Publisher App that you provide. It’s comprised of the lightning:availableForChatterExtensionComposer interface. |
| description | string | Required. The description of your custom Rich Publisher App. |
| extensionName | string | Required. The name of your extension. That is, your Rich Publisher App. |
| headerText | string | The text to show in the header of your app composer. Header text is required for Lightning type extensions. This text can be localized. |
| hoverText | string | The text to show when a user mouses over your extension’s icon. Mouse-over text is required for Lightning type extensions. This text can be localized. |
| icon | string | Required. The icon to show in the Chatter publisher. Use an existing file asset id from your org. |
| isProtected | boolean | An auto-generated value. It currently has no impact. |
| masterLabel | string | Required. Label for the ChatterExtension object. |
| renderComponent | string | Required. The rendering component of the Rich Publisher App that you provide. It’s comprised of the lightning:availableForChatterExtensionRenderer interface. |
| type | ChatterExtensionType ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | Required. Describes the type of the extension. Currently, the only value supported is Lightning. Included to allow for other possible types in the future. |

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Integrate Your Custom Apps into the Chatter Publisher](https://developer.salesforce.com/docs/atlas.en-us.264.0.lightning.meta/lightning/components_integrate_customapps_to_publisher.htm "Integrate Your Custom Apps into the Chatter
    Publisher - HTML (New Window)")

<!-- document id=ad143588590d886b0b59ce07178f993896430c298962449c13e9abc072f03613 url=/legacydeveloper/current/en-us/api_meta/meta_chattersettings.md -->

# ChatterSettings

Represents an org’s settings for their Chatter instance when Chatter is enabled for the org. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

The ChatterSettings component appears in the Chatter.settings file, and is stored in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ChatterSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d242086e102">Field Name</th>

              <th class="featureTableHeader  " id="d242086e105">Field Type</th>

              <th class="featureTableHeader  " id="d242086e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">allowChatterGroupArchiving</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether manual and automatic group archiving are allowed on all
                Chatter groups (<samp class="codeph nolang">true</samp>) or aren’t allowed
                (<samp class="codeph nolang">false</samp>).<p class="p">In Setup,
                  <span class="keyword parmname">allowChatterGroupArchiving</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Group Archiving</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">allowRecordsInChatterGroup</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether records can be associated with groups (<samp class="codeph nolang">true</samp>), or not (<samp class="codeph nolang">false</samp>). If groups already have record data, setting this field to
                <samp class="codeph nolang">false</samp> doesn’t delete it.<p class="p">In Setup,
                  <span class="keyword parmname">allowRecordsInChatterGroup</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Records in Groups</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">allowSharingInChatterGroup</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Removed. The setting of this field has no effect on the org. Available in API
                version 47.0 only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableApprovalRequest</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether Approvals in Chatter are enabled for the org. When the value
                is <samp class="codeph nolang">true</samp>, users see approval requests as posts
                in Chatter feeds. Users can update their own Chatter feeds settings to opt out of
                receiving approval requests as Chatter posts. When the value is <samp class="codeph nolang">false</samp>, approval requests aren’t posted to Chatter.
                The default value is <samp class="codeph nolang">false</samp>.<p class="p">In Setup,
                  <span class="keyword parmname">enableApprovalRequest</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Approvals</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableCaseFeedRelativeTimestamps</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">In Case feeds, indicates whether to use relative (<samp class="codeph nolang">true</samp>) or absolute (<samp class="codeph nolang">false</samp>) date and
                time stamp formats on Case feed items. When the value is <samp class="codeph nolang">true</samp>, Case feed items show a relative timestamp (for example,
                <samp class="ph systemoutput">10m ago</samp>). When the value is <samp class="codeph nolang">true</samp>,
                users can hover over the relative timestamp to see the absolute. When the value is
                <samp class="codeph nolang">false</samp>, Case feed items show an absolute
                timestamp (for example, <samp class="ph systemoutput">January 7, 2020 at 12:15PM</samp>).
                When you change this setting, all timestamps in Case feeds reflect that change. The
                default value is <samp class="codeph nolang">true</samp>. This field is available
                in API version 48.0 and later.<p class="p">In Setup,
                  <span class="keyword parmname">enableCaseFeedRelativeTimestamps</span> equates to the Chatter
                  setting <strong class="ph uicontrol">Show relative timestamp</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableChatter</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether Chatter is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableChatterEmoticons</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether the automatic conversion of text characters, such as :), into
                a graphic emoticon is allowed in Chatter (<samp class="codeph nolang">true</samp>)
                or isn’t allowed (<samp class="codeph nolang">false</samp>).<p class="p">In Setup,
                  <span class="keyword parmname">enableChatter</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Emoticons</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableFeedEdit</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether qualified users can edit feed posts and comments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Qualified users include:<div class="p">
                  <ul class="ul bulletList">
                    <li class="li">The author of the post or comment</li>

                    <li class="li">The person who owns the record that was posted to or commented on</li>

                    <li class="li">The Chatter or site moderator</li>

                  </ul>

                </div>
                <p class="p">In Setup, <span class="keyword parmname">enableFeedEdit</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow users to edit posts and comments</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableFeedPinning</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to allow the pinning of posts in a feed
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to
                <samp class="codeph nolang">true</samp>:<div class="p">
                  <ul class="ul bulletList">
                    <li class="li">Authorized users can pin posts to the top of the feed.</li>

                    <li class="li">The feed supports up to three pinned posts.</li>

                    <li class="li">Pinned posts stay pinned until they’re unpinned.</li>

                  </ul>

                </div>
                <p class="p">After post pinning is enabled, authorized users include admins and group
                  owners and managers. Admins can also assign post pinning permission through
                  permission sets or user profiles.</p>
                <p class="p">In Setup,
                  <span class="keyword parmname">enableFeedPinning</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow post pinning</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableFeedsDraftPosts</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether draft posts are automatically saved every seven seconds
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to <samp class="codeph nolang">true</samp>:<div class="p">
                  <ul class="ul bulletList">
                    <li class="li">Adds the My Drafts feed to the Chatter tab</li>

                    <li class="li">Saves draft posts automatically every seven seconds</li>

                    <li class="li">Makes drafts available in the My Drafts feed</li>

                  </ul>

                </div>
                When the user posts the entry, the draft is automatically removed from the My
                Drafts feed.<p class="p">In Setup, <span class="keyword parmname">enableFeedsDraftPosts</span> equates to the
                  Chatter setting <strong class="ph uicontrol">Allow draft posts</strong>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableFeedsRichText</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to use the Rich Text Editor in the Chatter Publisher (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The rich text editor supports text formats, inline images,
                hyperlinks, and, when enabled for the org, code snippets.<p class="p">In Setup,
                  <span class="keyword parmname">enableFeedsRichText</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow users to compose rich text posts</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableInviteCsnUsers</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether a licensed user can invite customers to private groups that
                the licensed user owns or manages (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). When the value is set to
                <samp class="codeph nolang">true</samp>, licensed users can invite customers who are from outside
                org email domains. Invited customers can see information only in the groups that
                they're invited to. They can interact only with members of those groups.<p class="p">In Setup,
                  <span class="keyword parmname">enableInviteCsnUsers</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow customer invitations</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableOutOfOfficeEnabledPref</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to add an Out of Office setting to a user profile page
                (<samp class="codeph nolang">true</samp>), or to omit it (<samp class="codeph nolang">false</samp>). When the value is set to <samp class="codeph nolang">true</samp>, this option adds a control to user profile
                pages for setting a personal out-of-office message.<p class="p">In Setup,
                  <span class="keyword parmname">enableOutOfOfficeEnabledPref</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Users can set Out of Office message</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableRichLinkPreviewsInFeed</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to convert links in posts into embedded videos, images, and
                article previews (<samp class="codeph nolang">true</samp>) or not to convert the
                links (<samp class="codeph nolang">false</samp>). <p class="p">In Setup,
                  <span class="keyword parmname">enableRichLinkPreviewsInFeed</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Rich Link Previews</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableTodayRecsInFeed</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to allow the posting of recommendations for using the
                Salesforce Today app in users’ feeds (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). When set to <samp class="codeph nolang">true</samp>, automatically posts recommendations for using
                the Salesforce Today app in users’ feeds.<p class="p">In Setup,
                  <span class="keyword parmname">enableTodayRecsInFeed</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Today Recommendations</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">unlistedGroupsEnabled</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to allow the creation of unlisted groups (<samp class="codeph nolang">true</samp>) or to prevent their creation (<samp class="codeph nolang">false</samp>). When the value is set to <samp class="codeph nolang">true</samp>, users can create unlisted groups. Unlisted
                groups don’t appear on the Groups list page. Membership in unlisted groups is by
                invitation only.<p class="p">In Setup, <span class="keyword parmname">unlistedGroupsEnabled</span> equates to
                  the Chatter setting <strong class="ph uicontrol">Enable Unlisted Groups</strong>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a Chatter.settings file.

<?xml version="1.0" encoding="UTF-8"?>
 <ChatterSettings xmlns="http://soap.sforce.com/2006/04/metadata">
     <allowChatterGroupArchiving\>true</allowChatterGroupArchiving\>
     <allowRecordsInChatterGroup\>true</allowRecordsInChatterGroup\>
     <enableApprovalRequest\>true</enableApprovalRequest\>
     <enableChatter\>true</enableChatter\>
     <enableChatterEmoticons\>true</enableChatterEmoticons\>
     <enableFeedEdit\>true</enableFeedEdit\>
     <enableFeedsDraftPosts\>false</enableFeedsDraftPosts\>
     <enableFeedsRichText\>true</enableFeedsRichText\>
     <enableInviteCsnUsers\>true</enableInviteCsnUsers\>
     <enableOutOfOfficeEnabledPref\>false</enableOutOfOfficeEnabledPref\>
     <enableRichLinkPreviewsInFeed\>true</enableRichLinkPreviewsInFeed\>
     <enableTodayRecsInFeed\>true</enableTodayRecsInFeed\>
     <unlistedGroupsEnabled\>true</unlistedGroupsEnabled\>
 </ChatterSettings\>

The following is an example package.xml manifest that references the ChatterSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Chatter</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b7ef1bed74f3716528ae93ee975668e2d92e7634c979bae633ac0cf31363117f url=/legacydeveloper/current/en-us/api_meta/meta_rest_deploy_checkstatus.md -->

# Check the Status of Your Deployment Using REST Resources

Check the status of your deployment by using passing the deployment request ID in the URL The response body is similar to that returned by the original deployment request, but it includes information about the deployment in progress.

**URI**

https://host/services/data/vXX.0/metadata/deployRequest/deployRequestId

To include more details in the response, use:

https://host/services/data/vXX.0/metadata/deployRequest/deployRequestId?includeDetails=true

**Formats**

JSON

**HTTP Method**

GET

**Authentication**

Authorization: Bearer token

## Response Body: Deploy Metadata

The following example shows the response when ?includeDetails=true is added as a query to the GET request.

    { 
	       "id" : "0Afxx00000000lWCAQ"
	       "url" : "https://host/services/data/vXX.0/metadata/deployRequest/0Afxx00000000lWCAQ?includeDetails=true",
        "deployResult" :
            {
            "checkOnly" : "false",
            "ignoreWarnings" : "false",
            "rollbackOnError" : "false",
            
            "status : "InProgress",
            "numberComponentsDeployed" : "10", 
            "numberComponentsTotal" : "1032",
            "numberComponentErrors" : "0",
            "numberTestsCompleted" : "45",
            "numberTestsTotal" : "135",
            "numberTestErrors" : "0",            
            "details" :  { 
	             "componentFailures" : \[\],
             	"componentSuccesses" : \[\],
                    "retrieveResult" : null,
                    "runTestResults" : {
                    "numRun" : 0,
                    "successes" : \[ … \],
                    "failures" : \[\]
	         	         }
            },

            "createdDate" : "2017-10-10T08:22Z",       
            "startDate" : "2017-10-10T08:22Z",
            "lastModifiedDate" : "2017-10-10T08:44Z",
            "completedDate" : "2017-10-10T08:44Z",

            "errorStatusCode" : null,
            "errorMessage" : null,
            "stateDetail" : "Processing Type: Apex Component",

            "createdBy" : "005xx0000001Sv1m",
            "createdByName" : "stephanie stevens", 
            "canceledBy" : null,
            "canceledByName" : null,            
            "isRunTestsEnabled" : null
            }

       "deployOptions": {    
             "allowMissingFiles" : false,
             "autoUpdatePackage" : false,
             "checkOnly" : true,
             "ignoreWarnings" : false,
             "performRetrieve" : false,
             "purgeOnDelete" : false,
             "rollbackOnError" : false,
             "runTests" : null,
             "singlePackage" : true,
             "testLevel" : "RunAllTestsInOrg"
             }
     }

Expect an HTTP status code of 200 (OK) to be returned.

<!-- document id=d23cbfeb96b2cae2ad5fac109a602ff72f82d3e6d82aba15463f01d59c185eac url=/legacydeveloper/current/en-us/api_meta/meta_checkdeploystatus.md -->

# checkDeployStatus()

Checks the status of declarative metadata call deploy().

## Syntax

 [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") = metadatabinding.checkDeployStatus(ID id, includeDetails boolean);

## Usage

checkDeployStatus is used as part of the process for deploying packaged or unpackaged components to an organization:

1. Issue a deploy() call to start the asynchronous deployment. An [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is returned. Note the value in the id field, and use it for the next step.
2. Issue a checkDeployStatus() call in a loop until the done field of the returned [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") contains true, which means that the call is completed. The [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") object contains information about an in-progress or completed deployment started using the deploy() call. When calling checkDeployStatus(), pass in the id value from the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object from the first step.

In API version 29.0, Salesforce improved the deployment status properties and removed the requirement to use checkStatus() after a deploy() call to get information about deployments. Salesforce continues to support the use of checkStatus() when using deploy() with API version 28.0 or earlier.

## Sample Code—Java

See the deploy() sample code for sample usage of this call.

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm "Deleting Components from an Organization")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_canceldeploy.htm "cancelDeploy()")

## Arguments

### id

- **Type**: ID
- **Description**: ID obtained from an [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object returned by [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") or a subsequent [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") call.

### includeDetails

- **Type**: boolean
- **Description**: Sets the [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") object to include [DeployDetails](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") information ((true) or not (false). The default is false. Available in API version 29.0 and later.

## Response

[DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.")

<!-- document id=aa182a34396582b5b296f78b08847dbde95e943b873736d6ef0e927638aa23bd url=/legacydeveloper/current/en-us/api_meta/meta_checkretrievestatus.md -->

# checkRetrieveStatus()

Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.

## Syntax

In API version 34.0 and later:

RetrieveResult = metadatabinding.checkRetrieveStatus(ID id, boolean includeZip);

In API version 33.0 and earlier:

RetrieveResult = metadatabinding.checkRetrieveStatus(ID id);

## Usage

Use checkRetrieveStatus() to check the progress of the metadata retrieve() operation. The RetrieveResult object that this method returns indicates when the asynchronous retrieve() call is completed. If the retrieval is completed, RetrieveResult contains the zip file contents by default. Use the following process to retrieve metadata components with the retrieve() call.

1. Issue a retrieve() call to start the asynchronous retrieval. An [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is returned. Note the value in the id field, and use it for the next step.
2. Issue a [checkRetrieveStatus()](# "Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.") call, and pass in the id value from the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object from the first step. Check the value of the done field of the returned [RetrieveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm#meta_retrieveresult "The retrieve() call returns an array of RetrieveResult objects."). If it’s true, the call is completed, and you proceed to the next step. Otherwise, repeat this step to call [checkRetrieveStatus()](# "Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.") again until the done field is true.
3. Retrieve the zip file field and other desired fields from [RetrieveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm#meta_retrieveresult "The retrieve() call returns an array of RetrieveResult objects."), which the final call to [checkRetrieveStatus()](# "Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.") returned in the previous step.

In API version 31.0 and later, the process of making a retrieve() call has been simplified. You no longer have to call [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") after a retrieve() call to obtain the status of the retrieve operation. Instead, make calls to [checkRetrieveStatus()](# "Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.") only. If the retrieve operation is in progress, call checkRetrieveStatus() again until the retrieve operation is completed. The [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") call is still supported in versions API version 30.0 or earlier, but isn’t available in API version 31.0 and later.

## Retrieving the Zip File in a Second Process

By default, checkRetrieveStatus() returns the zip file on the last call to this operation when the retrieval is completed (RetrieveResult.isDone() == true) and then deletes the zip file from the server. Subsequent calls to checkRetrieveStatus() for the same retrieve operation can’t retrieve the zip file after it has been deleted. Starting with API version 34.0, pass a boolean value for the includeZip argument of checkRetrieveStatus() to indicate whether to retrieve the zip file. The includeZip argument gives you the option to retrieve the file in a separate process after the retrieval operation is completed. For example, a service polls the retrieval status by calling checkRetrieveStatus(id, false) in a loop. This call returns the status of the retrieval operation, but doesn’t retrieve the zip file. After the retrieval operation is completed, another process, such as a background file transfer service, calls checkRetrieveStatus(id, true) to retrieve the zip file. This last call causes the zip file to be deleted from the server.

// First process: Poll the retrieval but don’t retrieve the zip file.
AsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);
String asyncResultId = asyncResult.getId();
// Wait for the retrieve to complete
int poll = 0;
long waitTimeMilliSecs = ONE\_SECOND;
RetrieveResult result = null;
do {
    Thread.sleep(waitTimeMilliSecs);
    // Check the status but don’t retrieve zip file.
    result = metadataConnection.checkRetrieveStatus(asyncResultId, false);
} while (!result.isDone());

// Second process: Retrieve the zip file.
// For example, this process can be a background file transfer service.
// Retrieve the zip file.
result = metadataConnection.checkRetrieveStatus(asyncResultId, true);
// Get the zip file from the RetrieveResult (result) variable
if (result.getStatus() == RetrieveStatus.Succeeded) {
    ByteArrayInputStream bais = new ByteArrayInputStream(result.getZipFile());
    // ...
}

## Sample Code—Java

See the [retrieve() sample code](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve_sample_code_java) for sample usage of this call.

## Arguments

### id

- **Type**: ID
- **Description**: ID obtained from an [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object returned by a [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") call or a subsequent [RetrieveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm "The retrieve() call returns an array of RetrieveResult objects.") object returned by a [checkRetrieveStatus()](#meta_checkretrievestatus "Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.") call.

### includeZip

- **Type**: boolean
- **Description**: Set to true to retrieve the zip file. You can retrieve the zip file only after the retrieval operation is completed. After the zip file is retrieved, it’s deleted from the server. Set to false to check the status of the retrieval without attempting to retrieve the zip file. If set to null, this argument defaults to true, which means that the zip file is retrieved on the last call to checkRetrieveStatus() when the retrieval has finished. This argument is available in API version 34.0 and later.

## Response

[RetrieveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm "The retrieve() call returns an array of RetrieveResult objects.")

<!-- document id=e9a59a0a2e063895ce03e17bc89bc14eeb6b1694cb4e4b3edfad326037d2058e url=/legacydeveloper/current/en-us/api_meta/meta_checkstatus.md -->

# checkStatus()

Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Starting in API version 29.0, you no longer have to call [checkStatus()](#meta_checkstatus "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") after a [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm#meta_deploy "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call to get information about deployments. Similarly, starting in API version 31.0, you no longer have to call [checkStatus()](#meta_checkstatus "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") after a [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") call. The [checkStatus()](#meta_checkstatus "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") call has been replaced by [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy().") and [checkRetrieveStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkretrievestatus.htm "Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.") for deploy and retrieve operations respectively.

## Syntax

 [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")\[\] = metadatabinding.checkStatus(ID\[\] ids);

## Usage

Use this call to check whether an asynchronous metadata call or declarative metadata call has completed.

## Version

This call is available only in API version 30.0 and earlier. This call isn’t available in API version 31.0 and later.

## Sample Code—Java

See [Step 3: Walk Through the Java Sample Code](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_java_sample.htm) for sample Java code using this call.

## Arguments

### ids

- **Type**: ID\[\]
- **Description**: Array of one or more IDs. Each ID is returned in an [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") and corresponds to a component being created, updated, deleted, deployed, or retrieved.

## Response

[AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")\[\]

<!-- document id=3715eb73e9942b25c33ab83e47c2cd5194ca99e29e2b452831ac7594913fb513 url=/legacydeveloper/current/en-us/api_meta/meta_choicelist.md -->

# ChoiceList

Represents the Choicelist dropdown field that’s used for pre-chat.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ChoiceList components have the suffix .ChoiceList and are stored in the ChoiceList folder.

## Version

ChoiceList components are available in API version 62 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| choiceListValue | 
Field Type

[ChoiceListValue\[\]](#ChoiceListValue)

Description

A list of choices to display in the choice list.



 |
| description | 

Field Type

string

Description

A description of the choice list.



 |
| masterLabel | 

Field Type

string

Description

Required. The label for the choice list.





 |

## ChoiceListValue

Represents a choice list value in the pre-chat dropdown. ChoiceListValue is available in API version 62 or later.

| Field Name | Description |
| --- | --- |
| embeddedServiceCustomLabels | 
Field Type

[EmbeddedServiceCustomLabel\[\]](meta_embeddedserviceconfig.htm "Represents a setup node for creating an Embedded Service for Web deployment. This type extends the Metadata metadata type and inherits its fullName field.")

Description

Custom labels for the choicelist value.



 |
| isDefaultValue | 

Field Type

boolean

Description

Required. Indicates whether the choicelist value should be selected by default.





 |
| order | 

Field Type

int

Description

Required. The order of the choicelist value in the choicelist dropdown field.





 |
| valueName | 

Field Type

string

Description

Required. The value of the choicelist.





 |

## Declarative Metadata Sample Definition

The following is an example of a Choicelist component.

<?xml version="1.0" encoding="UTF-8"?>
<ChoiceList xmlns="http://soap.sforce.com/2006/04/metadata">
    <choiceListValue\>
        <embeddedServiceCustomLabels\>
            <customLabel\>EM\_PreChat\_ChoiceList\_PrechatCustomFieldLabel\_133xx0000004GG1\_7741637</customLabel\>
            <labelKey\>EM\_PreChat\_ChoiceList\_PrechatCustomFieldLabel</labelKey\>
            <feature\>EmbeddedMessaging</feature\>
        </embeddedServiceCustomLabels\>
        <isDefaultValue\>true</isDefaultValue\>
        <order\>0</order\>
        <valueName\>Pizza</valueName\>
    </choiceListValue\>
    <choiceListValue\>
        <embeddedServiceCustomLabels\>
            <customLabel\>EM\_PreChat\_ChoiceList\_PrechatCustomFieldLabel\_133xx0000004GG2\_5523047</customLabel\>
            <labelKey\>EM\_PreChat\_ChoiceList\_PrechatCustomFieldLabel</labelKey\>
            <feature\>EmbeddedMessaging</feature\>
        </embeddedServiceCustomLabels\>
        <isDefaultValue\>false</isDefaultValue\>
        <order\>1</order\>
        <valueName\>Burger</valueName\>
    </choiceListValue\>
    <masterLabel\>Food</masterLabel\>
    <description\>Food Choice List</description\>
</ChoiceList\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>ChoiceList</name>
    </types>
    <version>62.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=bb4e47f1b92f7552c5b9d459222f53f253e779a7bfe0b7bdf9bd8d8d822daf3c url=/legacydeveloper/current/en-us/api_meta/meta_claimfinancialsettings.md -->

# ClaimFinancialSettings

Represents the configuration settings for Insurance Claim Financial Services.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ClaimFinancialSettings components have the suffix claimFinancialSettings and are stored in the ClaimFinancialSettings folder.

## Version

ClaimFinancialSettings components are available in API version 57.0 and later.

## Special Access Rules

To access this metadata type, you require access to either InsurancePolicyAdminAccess or InsuranceClaimMgmtAccess add-on license.

## Fields

| Field Name | Description |
| --- | --- |
| claimCovPendingAuthStatus | 
Field Type

string

Description

Required.

The status of pending financial authority for claim coverage.



 |
| claimPendingAuthorityStatus | 

Field Type

string

Description

Required.

The status of pending financial authority for claim.



 |
| clmCovPymtDtlPendAuthSts | 

Field Type

string

Description

Required.

The status of pending financial authority for claim coverage payment detail.



 |
| masterLabel | 

Field Type

string

Description

Required.

The unique label that identifies the claim financial settings throughout the Salesforce user interface.



 |

## Declarative Metadata Sample Definition

The following is an example of a ClaimFinancialSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ClaimFinancialSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <claimCovPendingAuthStatus\>Pending Authority</claimCovPendingAuthStatus\>
    <claimPendingAuthorityStatus\>Pending Authority</claimPendingAuthorityStatus\>
    <clmCovPymtDtlPendAuthSts\>Pending Authority</clmCovPymtDtlPendAuthSts\>
    <masterLabel\>Claim Financial Settings</masterLabel\>
</ClaimFinancialSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?><!--
  ~ Copyright 2022 salesforce.com, inc.
  ~ All Rights Reserved
  ~ Company Confidential
  -->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ClaimFinancialSettings</name\>
    </types\>
    <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=bc1233c85a8291be7317e2f39660f44406de45a4f4e2866c34046a1cc98a8bd3 url=/legacydeveloper/current/en-us/api_meta/meta_clausecatgconfiguration.md -->

# ClauseCatgConfiguration

Represents the configuration about the clause category that can be used to categorize your disclosure and compliance reports from standardized disclosure templates in a response document.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ClauseCatgConfiguration components have the suffix .clauseCatgConfiguration and are stored in the clauseCatgConfigurations folder.

## Version

ClauseCatgConfiguration components are available in API version 57.0 and later.

## Special Access Rules

The ClauseManagementAddOn license is required to access this object along with user access for the Clause Designer User permission set license.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1080387e101">Field Name</th>

              <th class="featureTableHeader  " id="d1080387e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1080387e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1080387e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The description about the clause category
                  configuration.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1080387e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d1080387e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type. The default is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1080387e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1080387e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">A user-friendly name for
                  ClauseCatgConfiguration, which is defined when the
                  ClauseCatgConfiguration is created.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1080387e101" data-title="Field Name"><span class="keyword parmname">usageType</span></td>

              <td class="entry" headers="d1080387e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: ClmCategoryUsageType</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The usage type of the clause category
                  configuration.</p>

                <div class="p">Possible values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">ContractClauseCategory</samp></li>

                    <li class="li"><samp class="codeph nolang">DisclosureCategory</samp></li>

                  </ul>
                </div>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ClauseCatgConfiguration component.

<?xml version="1.0" encoding="UTF-8"?>
<ClauseCatgConfiguration
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<description\>This is to add description for Contract Clause Category.</description\>
	<usageType\>ContractClauseCategory</usageType\>
	<isProtected\>false</isProtected\>
	<masterLabel\>Contract Clause Cat</masterLabel\>
</ClauseCatgConfiguration\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<fullName\>Pkg</fullName\>
	<types\>
		<name\>ClauseCatgConfiguration</name\>
	</types\>
	<version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=964db079a2062b81911ca7d62504336003d4d9297a642877b8b0c00073fccd59 url=/legacydeveloper/current/en-us/api_meta/meta_cleandataservice.md -->

# CleanDataService

Represents a data service that adds and updates data in standard objects.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CleanDataService components have the .cleanDataService suffix and are stored in the cleanDataServices directory. The name of the component file is based on the name of the object associated with the data service. For example, the component file name cleanDataServices/DataCloudCompanyMatch.cleanDataService describes a data service component called DataCloudCompanyMatch that's associated with the company name in account objects.

## Version

CleanDataService components are available in API version 68.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| cleanRules | [CleanRule](#CleanRule)\[\] | Required. A list of data integration rules |
| description | string | Required. A description of the data service |
| masterLabel | string | Required. Label for this data service. Although this value is displayed, it’s an internal label for the data service and isn’t translated. |
| matchEngine | string | Required. A key that maps to the internal data service identifier. |

## CleanRule

Represents information that controls how the data service adds and updates data in an org.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d245701e203">Field Name</th>

              <th class="featureTableHeader  " id="d245701e206">Field Type</th>

              <th class="featureTableHeader  " id="d245701e209">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">bulkEnabled</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">boolean</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. If this field is set to <samp class="codeph nolang">true</samp>,
                Salesforce applies the data integration rule to existing records whenever the rule
                is updated or saved. </td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">bypassTriggers</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">boolean</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. If this field is set to <samp class="codeph nolang">true</samp>,
                Salesforce bypasses triggers when it applies the rule; otherwise, it applies
                triggers after it applies the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">bypassWorkflow</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">boolean</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. If this field is set to <samp class="codeph nolang">true</samp>,
                Salesforce bypasses workflow rules when it applies the data integration rule;
                otherwise, it applies workflow rules after it applies the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. User-friendly text that describes the data integration rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. This name can contain only underscores and alphanumeric characters,
                and must be unique in your org. It must begin with a letter, not include spaces, not
                end with an underscore, and not contain two consecutive underscores. This unique
                name prevents conflicts with rules from other packages that have the same
                <span class="keyword parmname">masterLabel</span>.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Only users with View DeveloperName OR View
                            Setup and Configuration permission can view, group, sort, and filter this
                            field.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">fieldMappings</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">
                <a class="xref" href="#FieldMapping">FieldMapping</a>[]
              </td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. A list of FieldMapping entries for the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. Label for this object. This display value is the internal label that
                is not translated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">matchRule</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. An internal label for a matching rule in the data service that’s
                associated with the CleanRule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">sourceSobjectType</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. A virtual object in the data service that is associated with the
                CleanRule. Specifying a non-existent object causes an error.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. Status of the data integration rule. Valid values are <samp class="codeph nolang">Active</samp> and <samp class="codeph nolang">Inactive</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e203" data-title="Field Name"><span class="keyword parmname">targetSobjectType</span></td>

              <td class="entry" headers="d245701e206" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e209" data-title="Description">Required. A standard object that’s the target of additions and updates
                specified by this CleanRule. Specifying an object that the data service does not
                support causes an error.</td>

            </tr>

          </tbody>

        </table>

## FieldMapping

Represents a mapping between fields in the data service and fields in an object in the org.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d245701e410">Field Name</th>

              <th class="featureTableHeader  " id="d245701e413">Field Type</th>

              <th class="featureTableHeader  " id="d245701e416">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d245701e410" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d245701e413" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e416" data-title="Description">Required. This name can contain only underscores and alphanumeric characters,
                and must be unique in your org. It must begin with a letter, not include spaces, not
                end with an underscore, and not contain two consecutive underscores. This unique
                name prevents conflicts with field mappings from other packages that have the same
                <span class="keyword parmname">masterLabel</span>.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Only users with View DeveloperName OR View
                            Setup and Configuration permission can view, group, sort, and filter this
                            field.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e410" data-title="Field Name"><span class="keyword parmname">fieldMappingRows</span></td>

              <td class="entry" headers="d245701e413" data-title="Field Type">
                <a class="xref" href="#FieldMappingRow">FieldMappingRow</a>[]
              </td>

              <td class="entry" headers="d245701e416" data-title="Description">Required. A list of FieldMappingRow entries. Each entry represents a field in a
                standard object that maps to a field in the data service.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e410" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d245701e413" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e416" data-title="Description">Required. Label for this object. This display value is the internal label that
                is not translated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d245701e410" data-title="Field Name"><span class="keyword parmname">SObjectType</span></td>

              <td class="entry" headers="d245701e413" data-title="Field Type">string</td>

              <td class="entry" headers="d245701e416" data-title="Description">Required. The standard object associated with this FieldMapping. Specifying an
                object that the data service does not support causes an error.</td>

            </tr>

          </tbody>

        </table>

## FieldMappingRow

Represents the status of a CleanRule.

| Field Name | Field Type | Description |
| --- | --- | --- |
| fieldName | string | The display name for the field represented by the FieldMappingRow. |
| fieldMappingFields | [FieldMappingField](#FieldMappingField)\[\] | Required. A list of FieldMappingField entries. Each entry is a field in a standard object that maps to a field in the data service. |
| mappingOperation | string | The comparison operation the data service applies when it compares the value of this FieldMappingRow to the mapped field in the object specified in SObjectType. The value of this field is AutoFill, which indicates that the data service only adds data if the object field is blank. |
| SObjectType | string | The standard object for the field mapped to the FieldMappingRow. Specifying an object that the data service does not support causes an error. |

## FieldMappingField

Represents a field in a standard object. A FieldMappingField maps to a FieldMappingRow entry in a data service.

| Field Name | Field Type | Description |
| --- | --- | --- |
| dataServiceField | string | Required. A field in the data service that is mapped to this field. |
| dataServiceObjectName | string | Required. An object in the data service that contains the FieldMappingRow associated with this FieldMappingField. Specifying a non-existent object causes an error. |
| priority | int | Required. Represents the priority that the data service uses when it updates the field, relative to other update rules for the same field. Valid values are 1-100. |

## Declarative Metadata Sample Definition

The following is an example of a CleanDataService component for the lead standard object.

<?xml version="1.0" encoding="UTF-8"?>
<CleanDataService xmlns="http://soap.sforce.com/2006/04/metadata">
    <cleanRules\>
        <bulkEnabled\>false</bulkEnabled\>
        <bypassTriggers\>false</bypassTriggers\>
        <bypassWorkflow\>false</bypassWorkflow\>
        <description\>Adds data info to leads</description\>
        <developerName\>DataService\_Leads\_Enrichment</developerName\>
        <fieldMappings\>
            <SObjectType\>DataServiceCompanyObject</SObjectType\>
            <developerName\>DataService\_Leads\_Enrichment\_InputMapping</developerName\>
            <fieldMappingRows\>
                <SObjectType\>DataServiceCompanyObject</SObjectType\>
                <fieldMappingFields\>
                    <dataServiceField\>Email</dataServiceField\>
                    <dataServiceObjectName\>Lead</dataServiceObjectName\>
                    <priority\>1</priority\>
                </fieldMappingFields\>
                <fieldName\>Email</fieldName\>
                <mappingOperation\>Autofill</mappingOperation\>
            </fieldMappingRows\>
            <fieldMappingRows\>
                <SObjectType\>DataServiceCompanyObject</SObjectType\>
                <fieldMappingFields\>
                    <dataServiceField\>Company</dataServiceField\>
                    <dataServiceObjectName\>Lead</dataServiceObjectName\>
                    <priority\>1</priority\>
                </fieldMappingFields\>
                <fieldName\>Name</fieldName\>
                <mappingOperation\>Autofill</mappingOperation\>
            </fieldMappingRows\>
            <masterLabel\>DataServiceInputMapping</masterLabel\>
        </fieldMappings\>
        <fieldMappings\>
            <SObjectType\>Lead</SObjectType\>
            <developerName\>DataService\_Leads\_Enrichment\_OutputMapping</developerName\>
            <fieldMappingRows\>
                <SObjectType\>Lead</SObjectType\>
                <fieldMappingFields\>
                    <dataServiceField\>EmployeesTotal</dataServiceField\>
                    <dataServiceObjectName\>DataServiceCompanyObject</dataServiceObjectName\>
                    <priority\>1</priority\>
                </fieldMappingFields\>
                <fieldName\>NumberOfEmployees</fieldName\>
                <mappingOperation\>Autofill</mappingOperation\>
            </fieldMappingRows\>
            <fieldMappingRows\>
                <SObjectType\>Lead</SObjectType\>
                <fieldMappingFields\>
                    <dataServiceField\>Revenue</dataServiceField\>
                    <dataServiceObjectName\>DataServiceCompanyObject</dataServiceObjectName\>
                    <priority\>1</priority\>
                </fieldMappingFields\>
                <fieldName\>AnnualRevenue</fieldName\>
                <mappingOperation\>Autofill</mappingOperation\>
            </fieldMappingRows\>
            <fieldMappingRows\>
                <SObjectType\>Lead</SObjectType\>
                <fieldMappingFields\>
                    <dataServiceField\>Industry</dataServiceField\>
                    <dataServiceObjectName\>DataServiceCompanyObject</dataServiceObjectName\>
                    <priority\>1</priority\>
                </fieldMappingFields\>
                <fieldName\>Industry</fieldName\>
                <mappingOperation\>Autofill</mappingOperation\>
            </fieldMappingRows\>
            <masterLabel\>DataServiceOutputMapping</masterLabel\>
        </fieldMappings\>
        <masterLabel\>Data Service Company Info for Leads</masterLabel\>
        <matchRule\>DataServiceLeadAppendMatchRule</matchRule\>
        <sourceSobjectType\>DataServiceCompanyObject</sourceSobjectType\>
        <status\>Active</status\>
        <targetSobjectType\>Lead</targetSobjectType\>
    </cleanRules\>
    <description\>Data Service Companies for Leads</description\>
    <masterLabel\>Data Service Companies for Leads</masterLabel\>
    <matchEngine\>LeadEnrichmentMatchEngine</matchEngine\>
</CleanDataService\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>DataService\_Leads\_Enrichment</members\>
        <name\>CleanDataService</name\>
    </types\>
    <version\>38.0</version\>
</Package\>

## Usage

Use CleanDataService to retrieve all the metadata that describes a data enrichment service. To configure the service in a new org, deploy the metadata you retrieved. Avoid using CRUD-Based Calls with CleanDataService.

To make small modifications to the CleanDataService component, use the Tooling API.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=bcad3a395891bcaeb6344bf0d3feed8103c9ce4733a2e519db325f058c0b1aab url=/legacydeveloper/current/en-us/api_meta/meta_cmsconnectsource.md -->

# CMSConnectSource

Represents the connection information for external content management systems that feed content to Experience Builder sites. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

For use with Change Sets, CMSConnectSource is a dependent of **Network** and **Community**.

## File Suffix and Directory Location

CMSConnectSource components have the suffix .cmsConnectSource and are stored in the cmsConnectSource folder. In that folder, separate files exist for each network (for example, networkname.sourcedevelopername.cmsConnectSource). Each file represents a CMS connection.

## Version

CMSConnectSource components are available in API version 43.0 and later.

## Special Access Rules

The **CMS Connect org** permission must be enabled.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d247845e123">Field Name</th>

              <th class="featureTableHeader  " id="d247845e126">Field Type</th>

              <th class="featureTableHeader  " id="d247845e129">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">cmsConnectAsset</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">
                <a class="xref" href="#cmsConnectAsset">CMSConnectAsset</a>[]
              </td>

              <td class="entry" headers="d247845e129" data-title="Description">Represents CSS or JavaScript defined for the connection.<ul class="ul bulletList">
                  <li class="li">0–10 for CSS</li>

                  <li class="li">0–10 for JavaScript</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">cmsConnectLanguage</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">
                <a class="xref" href="#cmsConnectLanguage">CMSConnectLanguage</a>[]
              </td>

              <td class="entry" headers="d247845e129" data-title="Description">0 to more. Represents language mappings defined for the connection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">cmsConnectPersonalization</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type"><a class="xref" href="#cmsConnectPersonalization">CMSConnectPersonalization[]</a></td>

              <td class="entry" headers="d247845e129" data-title="Description">0 or 1. Represents personalization defined for the connection. Only for use
                when <span class="keyword parmname">type</span> is <samp class="codeph nolang">AEM</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">cmsConnectResourceType</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">
                <a class="xref" href="#cmsConnectResourceType">CMSConnectResourceType</a>[]
              </td>

              <td class="entry" headers="d247845e129" data-title="Description">0–5. Represents JSON definitions defined for the connection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">connectionType</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">CMSSourceConnectionType(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required. Type of authentication being used with outside system. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Public</samp></li>

                  <li class="li"><samp class="codeph nolang">Authenticated</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">cssScope</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e129" data-title="Description">The class name used to prefix and scope the CSS rules.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required. API name of the CMSConnectSource entity.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">languageEnabled</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Y</samp> to enable language mapping for
                    connection.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">N</samp> if no language mapping is needed.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required. Connection name</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">namedCredential</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required when the <span class="keyword parmname">connectionType</span> is <samp class="codeph nolang">Authenticated</samp>. API name of
                <span class="keyword parmname">namedCredential</span>. Before deploying
                <span class="keyword parmname">namedCredential</span>, it must exist on the destination
                org.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">personalizationEnabled</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Y</samp> to enable personalization mapping for
                    connection.
                  </li>

                  <li class="li">Otherwise <samp class="codeph nolang">N</samp>.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">rootPath</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required. Root path.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">int</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required. Defines the load order of the connection when multiple connections
                defined on page. The load order begins with 1.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">CMSConnectionStatus(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required. Status of connection. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ACTIVE</samp></li>

                  <li class="li"><samp class="codeph nolang">INACTIVE</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname" id="type"><a name="type"><!-- --></a>type</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">CMSConnectionSourceType(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required. The identification of the source connection system. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">AEM</samp></li>

                  <li class="li"><samp class="codeph nolang">Drupal</samp></li>

                  <li class="li"><samp class="codeph nolang">WordPress</samp></li>

                  <li class="li"><samp class="codeph nolang">SDL</samp></li>

                  <li class="li"><samp class="codeph nolang">Sitecore</samp></li>

                  <li class="li"><samp class="codeph nolang">Other</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e123" data-title="Field Name"><span class="keyword parmname">websiteUrl</span></td>

              <td class="entry" headers="d247845e126" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e129" data-title="Description">Required if <span class="keyword parmname">connectionType</span> is <samp class="codeph nolang">Public</samp>
              </td>

            </tr>

          </tbody>

        </table>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Because there can be existing connections when a package comes in, there’s some INSERT or UPDATE logic to consider:

- If you find developerName in the destination, then update the existing collection with all details form source.
- namedCredential is handled through developerName. If you don’t find namedCredential with developerName, then an error is generated.
- If the destination isn’t sortOrder from the source, then insert or update with the source sortOrder.
- If sortOrder from the source is already in the destination, then increase the source sortOrder by 1 for connections such that the destination sortOrder > sortOrder from the source.

## CMSConnectAsset

CMSConnectAsset defines the location, types, and order of assets necessary to support the incoming content, such as JavaScript and CSS files.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Because there can be existing connections when a package comes in, there’s some INSERT or UPDATE logic to consider:

- If assetPath exists in the destination, then update the existing record, else the new assetPath is inserted.
- Always keep the sortOrder from the source and adjust the destination accordingly.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d247845e568">Field Name</th>

              <th class="featureTableHeader  " id="d247845e571">Field Type</th>

              <th class="featureTableHeader  " id="d247845e574">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d247845e568" data-title="Field Name"><span class="keyword parmname">assetPath</span></td>

              <td class="entry" headers="d247845e571" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e574" data-title="Description">Relative path of the asset.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e568" data-title="Field Name"><span class="keyword parmname">assetType</span></td>

              <td class="entry" headers="d247845e571" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e574" data-title="Description">
                <p class="p">When used in Apex, this value can be sent as an enum, otherwise, this field has a
                  type of string.</p>

                <p class="p">Allowed values as string</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CSS</samp></li>

                  <li class="li"><samp class="codeph nolang">Javascript</samp></li>

                </ul>

                <p class="p">Allowed values as enum</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CSS</samp></li>

                  <li class="li"><samp class="codeph nolang">Javascript</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e568" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d247845e571" data-title="Field Type">int</td>

              <td class="entry" headers="d247845e574" data-title="Description">Loading sequence on the page.</td>

            </tr>

          </tbody>

        </table>

## CMSConnectLanguage

CMSConnectLanguage components determine the presented language of the content.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d247845e677">Field Name</th>

              <th class="featureTableHeader  " id="d247845e680">Field Type</th>

              <th class="featureTableHeader  " id="d247845e683">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d247845e677" data-title="Field Name"><span class="keyword parmname">cmsLanguage</span></td>

              <td class="entry" headers="d247845e680" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e683" data-title="Description">When a language placeholder is in the URL path, this value is used to replace
                it.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e677" data-title="Field Name"><span class="keyword parmname">language</span></td>

              <td class="entry" headers="d247845e680" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e683" data-title="Description">Salesforce supported language.
                <p class="p">For information see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_translations.htm" target="_blank">https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm</a></p>

              </td>

            </tr>

          </tbody>

        </table>

## CMSConnectPersonalization

CMSConnectPersonalization is used only with Adobe Experience Manager (AEM).

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Because there can be existing connections when a package comes in, there’s some INSERT or UPDATE logic to consider. If personalization isn’t enabled in the source system, but is enabled in the destination, the destination is disabled. The record for the connection is deleted from the table.

| Field Name | Field Type | Description |
| --- | --- | --- |
| connectorPage | string | The path to the JSP file that you created and installed in AEM. |
| connectorPageAsset | string | The path to your Javascript file. Providing this path allows you to run scripts dynamically. |

## CMSConnectResourceType

CMSConnectResourceType is for use only to define JSON connections.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Because there can be existing connections when a package comes in, there’s some INSERT or UPDATE logic to consider. If you find the developer name in the destination, then update the existing record with all details from the source.

| Field Name | Field Type | Description |
| --- | --- | --- |
| cmsConnectResourceDefinition | [cmsConnectResourceDefinition](#cmsConnectResourceDefinition)\[\] | 0–10 allowed per CMSConnectResourceType. |
| developerName | string | API name of CMSConnectResourceType. |
| masterLabel | string | Content type name. |
| resourceType | string | The only allowed value is JSON. |

## CMSConnectResourceDefinition

cmsConnectResourceDefinition is used to define JSON connections.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Because there can be existing connections when a package comes in, there’s some INSERT or UPDATE logic to consider:

- If you find developerName in the destination, then the existing record is updated with all details from the new source, else the new value is inserted.
- If the current source is DETAIL and the destination has DETAIL with a different name, then the destination is updated to LIST and the source is inserted as DETAIL.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d247845e932">Field Name</th>

              <th class="featureTableHeader  " id="d247845e935">Field Type</th>

              <th class="featureTableHeader  " id="d247845e938">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d247845e932" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d247845e935" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e938" data-title="Description">Required. API name of CMSConnectResourceDefinition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e932" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d247845e935" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e938" data-title="Description">Required. developerName of Content Item or Content List.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e932" data-title="Field Name"><span class="keyword parmname">options</span></td>

              <td class="entry" headers="d247845e935" data-title="Field Type">int</td>

              <td class="entry" headers="d247845e938" data-title="Description">Required. Identifies whether the content from the external source is a single
                item or a list.<p dir="ltr" class="p">0 for Content List</p>
                <p dir="ltr" class="p">1 for Content
                  Item</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e932" data-title="Field Name"><span class="keyword parmname">payloadType</span></td>

              <td class="entry" headers="d247845e935" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e938" data-title="Description">Required. The only valid value is <samp class="codeph nolang">JSON</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e932" data-title="Field Name"><span class="keyword parmname">resourceIdPath</span></td>

              <td class="entry" headers="d247845e935" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e938" data-title="Description">Relative path to ID. Required for Content Item.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e932" data-title="Field Name"><span class="keyword parmname">resourceNamePath</span></td>

              <td class="entry" headers="d247845e935" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e938" data-title="Description">Relative path to resource name. Required for Content Item.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e932" data-title="Field Name"><span class="keyword parmname">resourcePath</span></td>

              <td class="entry" headers="d247845e935" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e938" data-title="Description">Required. JSON resource path.</td>

            </tr>

            <tr>
              <td class="entry" headers="d247845e932" data-title="Field Name"><span class="keyword parmname">rootNodePath</span></td>

              <td class="entry" headers="d247845e935" data-title="Field Type">string</td>

              <td class="entry" headers="d247845e938" data-title="Description">Only for Content List and collection. Defines the initial starting path for a
                collection or list.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a CMSConnectSource definition.

<?xml version="1.0" encoding="UTF-8"?>
<CMSConnectSource xmlns="http://soap.sforce.com/2006/04/metadata"\>
    <cmsConnectAsset>
        <assetPath>etc/designs/capricorn/app-prefixed.min.css</assetPath>
        <assetType>CSS</assetType>
        <sortOrder>1</sortOrder>
    </cmsConnectAsset>
    <cmsConnectAsset>
        <assetPath>etc/designs/capricorn/w3data.js</assetPath>
        <assetType>Javascript</assetType>
        <sortOrder>1</sortOrder>
    </cmsConnectAsset>
    <cmsConnectLanguage>
        <cmsLanguage>en</cmsLanguage>
        <language>en\_US</language>
    </cmsConnectLanguage>
    <cmsConnectLanguage>
        <cmsLanguage>fr</cmsLanguage>
        <language>fr</language>
    </cmsConnectLanguage>
    <cmsConnectPersonalization>
        <connectorPage>content/salesforceConnector.js</connectorPage>
        <connectorPageAsset>content/js/capricorn/assets.js</connectorPageAsset>
    </cmsConnectPersonalization>
    <cmsConnectResourceType>
        <cmsConnectResourceDefinition>
            <developerName>Details</developerName>
            <masterLabel>Details</masterLabel>
            <options>0</options>
            <payloadType>JSON</payloadType>
            <resourceIdPath>ID</resourceIdPath>
            <resourceNamePath>title</resourceNamePath>
            <resourcePath>rest/v1.1/sites/cmstry.wordpress.com/posts/{component}</resourcePath>
        </cmsConnectResourceDefinition>
        <cmsConnectResourceDefinition>
            <developerName>List</developerName>
            <masterLabel>List</masterLabel>
            <options>1</options>
            <payloadType>JSON</payloadType>
            <resourcePath>rest/v1.1/sites/cmstry.blog.wordpress.com/posts?number={itemsPerPage}&amp;page={pageNumber}</resourcePath>
        </cmsConnectResourceDefinition>
        <developerName>Posts</developerName>
        <masterLabel>Posts</masterLabel>
        <resourceType>JSON</resourceType>
    </cmsConnectResourceType>
    <connectionType>Public</connectionType>
    <cssScope>capricorn</cssScope>
    <developerName>Capricorn</developerName>
    <languageEnabled>Y</languageEnabled>
    <masterLabel>Capricorn</masterLabel>
    <personalizationEnabled>Y</personalizationEnabled>
    <rootPath>content/capricorn/{language}</rootPath>
    <sortOrder>11</sortOrder>
    <status>ACTIVE</status>
    <type>AEM</type>
    <websiteUrl>https://public-api.wordpress.com</websiteUrl>
</CMSConnectSource>

The following is an example package.xml.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>NetworkA.\*</members\>
        <name\>CMSConnectSource</name\>
    </types\>
    <version\>43.0</version\>
</Package\>

To retrieve a specific connection:

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>NetworkA.DeveloperName</members\>
        <name\>CMSConnectSource</name\>
    </types\>
    <version\>43.0</version\>
</Package\>

## Usage

The INSERT or UPDATE logic for the incoming information is always UPSERT. If data isn’t in the entity, then it’s inserted, otherwise the current data is updated.

Before doing upsert, the content from the package is validated against the maximum limits for the following:

- CSS assets <= 10
- JavaScript assets <= 10
- Resource types < =5
- Resource definitions for each type <=10

For example

1. The validation on a new connection totals only the elements in the incoming package.
2. Validation of existing connections totals the existing assets and new elements to assess validity. For example, if a connection on the destination org already has six CSS definitions, and the incoming package has defined seven CSS definitions (four new + three existing), the new total is the six current from the database. The total ignores the three repeated in the package and adds four new definitions from the incoming package. This totals 10 definitions, which number is at or below the 10 asset threshold, and it passes validation.

Refer to the following content for more details for how each entity how is handled while saving the details from package to destination org:

<table class="featureTable sort_table" summary="">


            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d247845e1139">Type</th>

                <th class="featureTableHeader  " id="d247845e1142">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d247845e1139" data-title="Type"><span class="keyword parmname">CMSConnectSource</span></td>

                <td class="entry" headers="d247845e1142" data-title="Description">
                  <ul class="ul bulletList">
                    <li class="li">If you find <span class="keyword parmname">developerName</span> in the destination, then update
                      the existing collection with all details form source.</li>

                    <li class="li">
                      <span class="keyword parmname">namedCredential</span> is handled through
                      <span class="keyword parmname">developerName</span>. If you don’t find
                      <span class="keyword parmname">namedCredential</span> with <span class="keyword parmname">developerName</span>,
                      then an error is generated.
                    </li>

                    <li class="li">If the destination isn’t <span class="keyword parmname">sortOrder</span> from the source, then
                      insert or update with the source <span class="keyword parmname">sortOrder</span>.</li>

                    <li class="li">If <span class="keyword parmname">sortOrder</span> from the source is already in the
                      destination, then increase the source <span class="keyword parmname">sortOrder</span> by 1 for
                      connections such that the destination <span class="keyword parmname">sortOrder</span> &gt;
                      <span class="keyword parmname">sortOrder</span> from the source.
                    </li>

                  </ul>

                </td>

              </tr>

              <tr>
                <td class="entry" headers="d247845e1139" data-title="Type"><span class="keyword parmname">CMSConnectAsset</span></td>

                <td class="entry" headers="d247845e1142" data-title="Description">
                  <ul class="ul bulletList">
                    <li class="li">If <span class="keyword parmname">assetPath</span> exists in the destination, then update the
                      existing record, else the new <span class="keyword parmname">assetPath</span> is inserted.</li>

                    <li class="li">Always keep the <span class="keyword parmname">sortOrder</span> from the source and adjust the
                      destination accordingly.</li>

                  </ul>

                </td>

              </tr>

              <tr>
                <td class="entry" headers="d247845e1139" data-title="Type"><span class="keyword parmname">CMSConnectPersonalization</span></td>

                <td class="entry" headers="d247845e1142" data-title="Description">If personalization
                  isn’t enabled in the source system, but is enabled in the destination, the destination is disabled.
                  The record for the connection is deleted from the table.</td>

              </tr>

              <tr>
                <td class="entry" headers="d247845e1139" data-title="Type"><span class="keyword parmname">CMSConnectResourceType</span></td>

                <td class="entry" headers="d247845e1142" data-title="Description">If you find the developer name in the destination,
                  then update the existing record with all details from the source.</td>

              </tr>

              <tr>
                <td class="entry" headers="d247845e1139" data-title="Type"><span class="keyword parmname">CMSConnectResourceDefinition</span></td>

                <td class="entry" headers="d247845e1142" data-title="Description">
                  <ul class="ul bulletList">
                    <li class="li">If you find developerName in the destination, then the existing record is
                      updated with all details from the new source, else the new value is
                      inserted.</li>

                    <li class="li">If the current source is DETAIL and the destination has DETAIL with a
                      different name, then the destination is updated to LIST and the source is
                      inserted as DETAIL. </li>

                  </ul>

                </td>

              </tr>

            </tbody>

          </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Select Components for an Outbound Change Set](https://help.salesforce.com/articleView?id=changesets_outbound_components_select.htm&type=5&language=en_US)
- [View and Add Dependent Components to a Change Set](https://help.salesforce.com/articleView?id=changesets_outbound_dependencies.htm&type=5&language=en_US)
- [Developer Guide: Deploying and Retrieving Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based.htm)
- [Salesforce Help: Use Personalized Content in CMS Connect](https://help.salesforce.com/articleView?id=communities_cms_connect_personalization.htm&type=5&language=en_US)
- [Developer Guide: Translations](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_translations.htm)

<!-- document id=38f725b5c57b21d2f387301c09d0d3e07a84daf4cebcd3b0911fd1ff36014fda url=/legacydeveloper/current/en-us/api_meta/meta_codebuildersettings.md -->

# CodeBuilderSettings

Represents Code Builder settings. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

CodeBuilderSettings values are stored in the CodeBuilder.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

CodeBuilderSettings is available in API versions 58.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableCodeBuilder | boolean | Indicates whether Code Builder is enabled (true) or not (false). When enabled, you can install and use the generally available (GA) Code Builder package in the org. |

## Declarative Metadata Sample Definition

The following is an example of the CodeBuilder.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<CodeBuilderSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCodeBuilder\>true</enableCodeBuilder\>
</CodeBuilderSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=c9100e6685dbda0d5cdc30de87182f6a79570cde21f58b14bdd04dc629932cf8 url=/legacydeveloper/current/en-us/api_meta/meta_collectionsdashboardsettings.md -->

# CollectionsDashboardSettings

Represents an org’s settings to add the Collections Dashboard application to an org.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

CollectionsDashboardSettings values are stored in the CollectionsDashboard.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

CollectionsDashboardSettings components are available in API version 56.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| enableCollectionsDashboard | 
Field Type

boolean

Description

Indicates whether to add the Collections Dashboard application to an org (true) or not (false). The default value is false.



 |

## Declarative Metadata Sample Definition

Thisexample shows a sample CollectionsDashboardSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<CollectionsDashboardSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCollectionsDashboard\>true</enableCollectionsDashboard\>
</CollectionsDashboardSettings\>

Theis example shows a sample package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>CollectionsDashboard</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=a646551c22ddfe841396f6e0c969dfaf76b6822053f02daa2139b1ba738216f5 url=/legacydeveloper/current/en-us/api_meta/meta_commercesettings.md -->

# CommerceSettings

Represents settings for various Commerce features.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

CommerceSettings values are stored in the Commerce.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

Commerce Settings are available in API version 50.0 and later.

## Special Access Rules

A B2B Commerce or D2C Commerce license and access to Commerce objects is required.

## Fields

| Field Name | Description |
| --- | --- |
| buyerGroupExtensibility | 
Field Type

boolean

Description

Indicates whether Buyer Group Extensibility is enabled (true) or not (false). Available in API version 64.0 and later.



 |
| commerceAnalyticsEnabled | 

Field Type

boolean

Description

Indicates whether Commerce Analytics is enabled (true) or not (false).



 |
| commerceAppEnabled | 

Field Type

boolean

Description

Indicates whether Commerce App is enabled (true) or not (false).



 |
| commerceConciergeEnabled | 

Field Type

boolean

Description

Indicates whether Commerce Concierge bots are enabled (true) or not (false).



 |
| commerceCopilotEcomEnabled | 

Field Type

boolean

Description

Indicates whether Commerce Copilot is enabled (true) or not (false).



 |
| commerceDCSegmentEnabled | 

Field Type

boolean

Description

Indicates whether the Data 360 segment integration is enabled (true) or not (false).



 |
| commerceDiscoveryExpansion | 

Field Type

boolean

Description

Indicates whether the Commerce Discovery Expansion service is enabled (true) or not (false).



 |
| commerceEnabled | 

Field Type

boolean

Description

Indicates whether Commerce is enabled (true) or not (false).



 |
| commerceNGPEnabled | 

Field Type

boolean

Description

Indicates whether NGP (“Salesforce”) Pricing is enabled (true) or not (false).



 |
| commerceRLMSubs | 

Field Type

boolean

Description

Indicates whether Commerce Revenue Lifecycle Management Subscriptions is enabled (true) or not (false).



 |
| generateInvPerSubscription | 

Field Type

boolean

Description

Indicates whether a separate invoice is generated per subscription (true) or not (false). Available in API version 64.0 and later.



 |
| lowestUnitPriceTracking | 

Field Type

boolean

Description

Indicates whether lowest unit price tracking (for EU customers) is enabled (true) or not (false).



 |
| messagingEngagementDataKit | 

Field Type

boolean

Description

Indicates whether Message Engagement data kit is enabled (true) or not (false). Message Engagement data kit is a Data 360 data model object (DMO) for a user’s engagement with a marketing message.



 |

## Declarative Metadata Sample Definition

The following is an example of a CommerceSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<CommerceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<buyerGroupExtensibility\>false</buyerGroupExtensibility\>
	<commerceAnalyticsEnabled\>false</commerceAnalyticsEnabled\>
	<commerceAppEnabled\>false</commerceAppEnabled\>
	<commerceConciergeEnabled\>false</commerceConciergeEnabled\>
	<commerceCopilotEcomEnabled\>false</commerceCopilotEcomEnabled\>
	<commerceDCSegmentEnabled\>false</commerceDCSegmentEnabled\>
	<commerceDiscoveryExpansion\>false</commerceDiscoveryExpansion\>
	<commerceEnabled\>false</commerceEnabled\>
	<commerceNGPEnabled\>false</commerceNGPEnabled\>
	<commerceRLMSubs\>false</commerceRLMSubs\>
	<generateInvPerSubscription\>false</generateInvPerSubscription\>
	<lowestUnitPriceTracking\>false</lowestUnitPriceTracking\>
	<messagingEngagementDataKit\>false</messagingEngagementDataKit\>
</CommerceSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Commerce</members\>
        <name\>Settings</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=8d99e8221e466b6a24b455d7c1b0d6b714cd7b3bcb1d2a024232248f7a0b9d88 url=/legacydeveloper/current/en-us/api_meta/meta_communitiessettings.md -->

# CommunitiesSettings

Represents community settings for an org. Enable digital experiences and workspaces. Manage moderation, guest user and partner settings, and more. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

CommunitiesSettings values are stored in the Communities.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

CommunitiesSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d253388e102">Field Name</th>

              <th class="featureTableHeader  " id="d253388e105">Field Type</th>

              <th class="featureTableHeader  " id="d253388e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">applyLoginPageTypeToEmbeddedLogin</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, applies the Experience Cloud
                site login page type (default, Login Discovery, Experience Builder, or Visualforce)
                to all Embedded Login implementations. When <samp class="codeph nolang">false</samp>, applies the username and password login page type to all Embedded
                Login implementations.<p class="p">For orgs created before the Salesforce Summer ‘20 release,
                  the default setting is <samp class="codeph nolang">false</samp>. For new orgs,
                  the default setting is <samp class="codeph nolang">true</samp>. Available in API
                  version 49.0 and later.</p>
              </td>


            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">blockEmbeddedLoginUnknownURLRedirect</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, blocks redirects to unknown
                URLs that are provided in the state parameter of the OAuth response during a
                server-side callback. Redirects are allowed when the URL is in the same host or
                domain as the site, or is allow-listed in the Embedded Login
                salesforce-allowed-domains meta tag. When <samp class="codeph nolang">false</samp>, all redirects are allowed. <p class="p">For orgs created before the
                  Salesforce Summer ‘21 release, the default setting is <samp class="codeph nolang">false</samp>. For new orgs, the default setting is <samp class="codeph nolang">true</samp>. Available in API version 52.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">canModerateAllFeedPosts</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows moderation features,
                such as flags and rules, to be set on all feed posts including posts that are
                visible in Experience Cloud sites. When set to <samp class="codeph nolang">false</samp>, only feed posts in sites can be moderated. Default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">canModerateInternalFeedPosts</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows moderation features,
                such as flags and rules, to be set on record feed posts created by internal users.
                Such posts can also be visible in multiple sites. Default is <samp class="codeph nolang">false</samp>.</td>


            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">embeddedVisualforcePages</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows links to Visualforce
                pages from other Visualforce pages in Salesforce via the API. Default is <samp class="codeph nolang">false</samp>. Available in API version 48.0 and
                later.</td>


            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableCommunityWorkspaces</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows admins to enable
                Experience Workspaces. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableCspContactVisibilityPref</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows users to see contacts
                from private accounts that they have read access to, when the contact is controlled
                by the parent record. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableCspNotesOnAccConPref</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows customer users to access
                notes and attachments associated with accounts and contacts. Available in API
                version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableEnablePRM</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows admins to enable partner
                users. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableExternalAccHierPref</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, enables the External Account
                Hierarchy object. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableGuestRecordReassignOrgPref</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">Deprecated in API version 63.0 and later. When <samp class="codeph nolang">true</samp>, allows admins to set a default owner for records created by guest
                users. Available in API version 48.0 through 63.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableGuvSecurityOptOutPref</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, guest user visibility can be
                turned off. Available in API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableInviteChatterGuestEnabled</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows guest users to be
                invited to use Chatter. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableNetPortalUserReportOpts</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows external users in
                Experience Cloud sites, with permission, to run reports. Available in API version
                48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableNetworksEnabled</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows users to enable digital
                experiences. Available in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableOotbProfExtUserOpsEnable</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows use of standard external
                profiles for self-registration and user creation. Available in API version 48.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enablePreventBadgeGuestAccess</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, hides badges from guest users
                in Experience Builder sites. Available in API version 53.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enablePowerCustomerCaseStatus</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows users with Customer
                Community Plus licenses to change case status. Available in API version 48.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enablePRMAccRelPref</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, enables Account Relationship
                object and Account Relationship Data Sharing Rule setup options. Available in API
                version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableRelaxPartnerAccountFieldPref</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, allows editing for partner
                account fields on and opportunities and leads. Available in API version 48.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableUnsupportedBrowserModalPref</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, warnings about unsupported
                browsers are displayed in Experience Cloud sites. Available in API version 48.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d253388e102" data-title="Field Name"><span class="keyword parmname">enableUsernameUniqForOrgPref</span></td>

              <td class="entry" headers="d253388e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d253388e108" data-title="Description">When <samp class="codeph nolang">true</samp>, username uniqueness is set at
                the org level. Available in API version 48.0 and later.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a CommunitiesSettings component.

<CommunitiesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <canModerateAllFeedPosts\>true</canModerateAllFeedPosts\>
    <canModerateInternalFeedPosts\>true</canModerateInternalFeedPosts\>
</CommunitiesSettings\>

The following is an example package.xml that references the previous definition.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>Communities</members\>
<name\>Settings</name\>
</types\>
<version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=29e6b1981bedc4e56c19bc91cbe004585a0d1f5cd9c38db047ff2c274f82e31e url=/legacydeveloper/current/en-us/api_meta/meta_community.md -->

# Community (Zone)

Represents a zone that contains Ideas or Chatter Answers objects. Zones are shared by the Ideas, Answers, and Chatter Answers features, allowing you to view and create zones from those locations.This type extends the Metadata metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Starting with the Summer ’13 release, Chatter Answers and Ideas “communities” have been renamed to “zones.” In API version 28, the API object label has changed to Zone, but the API type is still Community.

## File Suffix and Directory Location

Zones have the suffix community and are stored in the communities folder.

## Version

Community (Zone) components are available in API version 27.0 and later.

## Fields

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

When enableChatterAnswers is set to false, values specified for the following fields are ignored and not saved: communityFeedPage, emailFooterDocument, emailHeaderDocument, enablePrivateQuestions, emailNotificationUrl, and site.

| Field Name | Field Type | Description |
| --- | --- | --- |
| active | boolean | Indicates whether the zone is active (true) or not (false). |
| chatterAnswersFacebookSsoUrl | string | (Read only) The Facebook sign-on URL, which is based on the Facebook authentication provider selected in your Chatter Answers settings. This field is available only if Chatter Answers and Facebook Single Sign-On for Chatter Answers are enabled. |
| communityFeedPage | string | The Visualforce page that hosts the zone’s feeds. This field is available when Chatter Answers is enabled in the organization. |
| description | string | The description of the zone. |
| emailFooterDocument | string | The text or HTML file that incorporates your organization’s branding into the footer of email notifications. This field is available when Chatter Answers is enabled in the organization. |
| emailHeaderDocument | string | The text or HTML file that incorporates your organization’s branding into the header of email notifications. This field is available when Chatter Answers is enabled in the organization. |
| emailNotificationUrl | string | The URL that’s included in email notifications. This field is available when Chatter Answers is enabled in the organization. This field replaces portalEmailNotificationUrl in API version 28.0 and later. |
| enableChatterAnswers | boolean | Indicates whether the zone has Chatter Answers enabled (true) or not (false). This field is available when Chatter Answers is enabled in the organization. |
| enablePrivateQuestions | boolean | Indicates whether Chatter Answers questions can be escalated to cases (true) or not (false). This field is available when Chatter Answers is enabled in the organization. |
| expertsGroup | string | The name of the public group that act as experts in the zone. This field is available when eitherIdeas or Answers are enabled in the organization. |
| portal | string | The name of the portal in which to display the zone. |
| portalEmailNotificationUrl | string | The portal URL that’s included in email notifications. This field is available when Chatter Answers is enabled in the organization. This field has been replaced by emailNotificationUrl in API version 28.0 and later. |
| reputationLevels | [ReputationLevels](#reputationLevels) | The fields that define the points and name of each reputation level you define. You can create up to 25 reputation levels per zone. |
| showInPortal | boolean | Indicates whether the zone is available to all portals (true) or not available to any portals (false). |
| site | string | The name of the site for the zone. This field is available when Chatter Answers is enabled in the organization. |

## ReputationLevels

Represents the points and reputation label that displays on hover over a user’s photo in the feed.

| Field Name | Field Type | Description |
| --- | --- | --- |
| chatterAnswersReputationLevels | [ChatterAnswersReputationLevel](#ChatterAnswersreputationLevels) \[\] | Contains the name and value pair that describes the reputation level for Chatter Answers. Available in API version 28.0 and later. |
| ideaReputationLevels | [IdeaReputationLevel](#IdeasreputationLevels) | Contains the name and value pair that describes the reputation for Ideas. Available in API version 28.0 and later. |

## ChatterAnswersReputationLevel

Represents the reputation name and the number of points for that level for Chatter Answers.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | The name of the reputation level, for example, “Expert.” |
| value | int | The minimum number of points for the reputation level. |

## IdeaReputationLevel

Represents the reputation name and the number of points for that level for Ideas. Available in API version 28.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | The name of the reputation level, for example, “Expert.” |
| value | int | The minimum number of points for the reputation level. |

## Declarative Metadata Sample Definition

The following is the definition of a community (zone) component:

<?xml version="1.0" encoding="UTF-8"?>
<Community xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <communityFeedPage\>communityWithHeaderAndFooter\_main</communityFeedPage\>
    <description\>Metadata Test</description\>
    <emailFooterDocument\>sampleFolder/emailFooter.html</emailFooterDocument\>
    <emailHeaderDocument\>sampleFolder/emailHeader.html</emailHeaderDocument\>
    <enableChatterAnswers\>true</enableChatterAnswers\>
    <enablePrivateQuestions\>true</enablePrivateQuestions\>
    <expertsGroup\>CommunityExperts</expertsGroup\>
    <portal\>Customer Portal</portal\>
    <emailNotificationUrl\>http://yourURL</emailNotificationUrl\>
<reputationLevels\>
        <chatterAnswersReputationLevels\>
            <name\>Newbie</name\>
            <value\>0</value\>
        </chatterAnswersReputationLevels\>
        <chatterAnswersReputationLevels\>
            <name\>Smartie</name\>
            <value\>500</value\>
        </chatterAnswersReputationLevels\>
        <chatterAnswersReputationLevels\>
            <name\>Pro</name\>
            <value\>2000</value\>
        </chatterAnswersReputationLevels\>
        <chatterAnswersReputationLevels\>
            <name\>All Star</name\>
            <value\>5000</value\>
        </chatterAnswersReputationLevels\>
        <ideaReputationLevels\>
            <name\>Observer</name\>
            <value\>0</value\>
        </ideaReputationLevels\>
        <ideaReputationLevels\>
            <name\>Contributor</name\>
            <value\>100</value\>
        </ideaReputationLevels\>
        <ideaReputationLevels\>
            <name\>Influencer</name\>
            <value\>400</value\>
        </ideaReputationLevels\>
        <ideaReputationLevels\>
            <name\>Thought Leader</name\>
            <value\>1500</value\>
        </ideaReputationLevels\>
    </reputationLevels\>
    <showInPortal\>true</showInPortal\>
    <site\>ChatterAnswersSite</site\>
</Community\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=5d8f88a8ebadd79da526f93082b4b1bbe1ef13891cdf7d818145c7b3834954dd url=/legacydeveloper/current/en-us/api_meta/meta_communitytemplatedefinition.md -->

# CommunityTemplateDefinition

Represents the definition of an Experience Builder site template. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

CommunityTemplateDefinition components have the suffix .communityTemplateDefinition and are stored in the communityTemplateDefinitions folder.

## Version

CommunityTemplateDefinition components are available in API version 38.0 and later.

## Special Access Rules

This type is available only if Salesforce Digital Experiences is enabled in your org.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d256959e99">Field Name</th>

              <th class="featureTableHeader  " id="d256959e102">Field Type</th>

              <th class="featureTableHeader  " id="d256959e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">baseTemplate</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">CommunityBase​Template (enumeration of type
                string)</td>

              <td class="entry" headers="d256959e105" data-title="Description">Denotes that this CommunityTemplateDefinition was created in API
                version 41.0 or later. The only valid value is <samp class="codeph nolang">c</samp>. This field is available in API
                41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">bundlesInfo</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">
                <a class="xref" href="#CommunityTemplateBundleInfo">CommunityTemplateBundleInfo</a>[]
              </td>

              <td class="entry" headers="d256959e105" data-title="Description">The list of preview images and feature highlights of this
                CommunityTemplateDefinition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">category</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">CommunityTemplate​Category (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d256959e105" data-title="Description">Required. The optimized use case of this
                CommunityTemplateDefinition. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Commerce</samp></li>

                  <li class="li"><samp class="codeph nolang">IT</samp></li>

                  <li class="li"><samp class="codeph nolang">Marketing</samp></li>

                  <li class="li"><samp class="codeph nolang">Sales</samp></li>

                  <li class="li"><samp class="codeph nolang">Service</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">defaultBrandingSet</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e105" data-title="Description">The set of branding properties associated with this
                CommunityTemplateDefinition, as defined in the Theme panel in
                Experience Builder. Available in API version 40.0 and later.<p class="p">In
                  API version 44.0 and later, this field is read-only and can be
                  implemented in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_communitythemedefinition.htm#meta_communitythemedefinition" title="Represents the definition of a theme for an Experience Builder site. This type extends the Metadata metadata type and inherits its fullName field.">CommunityThemeDefinition</a>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">defaultThemeDefinition</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e105" data-title="Description">Required. The assigned theme definition for this
                CommunityTemplateDefinition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e105" data-title="Description">The optional description text of this
                CommunityTemplateDefinition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">enableExtendedCleanUp​OnDelete</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d256959e105" data-title="Description">False by default. Determines if deleting this
                CommunityTemplateDefinition attempts to delete other directly or
                indirectly referenced objects automatically, for example, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_communitythemedefinition.htm" title="Represents the definition of a theme for an Experience Builder site. This type extends the Metadata metadata type and inherits its fullName field.">CommunityThemeDefinition</a>, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_flexipage.htm" title="Represents the metadata associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components.">Flexipage</a>, or <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_staticresource.htm#meta_staticresource" title="Represents a static resource file, often a code library in a ZIP file. Static resources allow you to upload content that you can reference in a Visualforce page, including archives (such as .zip and .jar files), images, style sheets, JavaScript, and other files. Static resources can be used only within your Salesforce org, so you can’t host content here for other apps or websites.">StaticResource</a>. Values are true or false.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e105" data-title="Description">Required. The label for this CommunityTemplateDefinition, which
                displays in Setup.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">navigationLinkSet</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_network.htm#NavigationLinkSet">NavigationLinkSet</a></td>

              <td class="entry" headers="d256959e105" data-title="Description">The navigation menu associated with this
                CommunityTemplateDefinition. A navigation menu consists of items
                that users can click to go to other parts of the site. Available in
                API versions 37.0 to 46.0. In API versions 47.0 and later, use
                NavigationMenu.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">pageSetting</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">
                <a class="xref" href="#CommunityTemplatePageSetting">CommunityTemplatePageSetting</a>[]
              </td>

              <td class="entry" headers="d256959e105" data-title="Description">The list of FlexiPage of this
                CommunityTemplateDefinition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e99" data-title="Field Name"><span class="keyword parmname">publisher</span></td>

              <td class="entry" headers="d256959e102" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e105" data-title="Description">Defines the name of the publisher as seen in the Change Theme
                wizard. If no name is provided, the name of the org from which the
                package was originally exported is used.<p class="p">This field is available
                  in API version 45.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## CommunityTemplateBundleInfo

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d256959e357">Field Name</th>

              <th class="featureTableHeader  " id="d256959e360">Field Type</th>

              <th class="featureTableHeader  " id="d256959e363">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d256959e357" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d256959e360" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e363" data-title="Description">The optional description text of its
                CommunityTemplateBundleInfo.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e357" data-title="Field Name"><span class="keyword parmname">image</span></td>

              <td class="entry" headers="d256959e360" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e363" data-title="Description">Required only when the <span class="keyword parmname">type</span> is <samp class="codeph nolang">PreviewImage</samp>, otherwise this field
                is optional. A preview image for this
                CommunityTemplateDefinition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e357" data-title="Field Name"><span class="keyword parmname">order</span></td>

              <td class="entry" headers="d256959e360" data-title="Field Type">int</td>

              <td class="entry" headers="d256959e363" data-title="Description">Required. An integer specifying the position of this
                CommunityTemplateBundleInfo relative to others of the same
                <span class="keyword parmname">type</span> within its
                CommunityTemplateDefinition. <samp class="codeph nolang">1</samp>
                is the first position, <samp class="codeph nolang">3</samp> is the
                maximum position for <samp class="codeph nolang">PreviewImage</samp> type, and <samp class="codeph nolang">4</samp> is the maximum position for the <samp class="codeph nolang">Highlight</samp> type.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e357" data-title="Field Name"><span class="keyword parmname">title</span></td>

              <td class="entry" headers="d256959e360" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e363" data-title="Description">Required. The title of this CommunityTemplateBundleInfo to use in
                code.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e357" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d256959e360" data-title="Field Type">CommunityTemplate​BundleInfoType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d256959e363" data-title="Description">Required. Stores descriptive information about the template
                that’s included in the export. The template powers the interface of
                the Experience Creation Wizard. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Highlight</samp>—This
                    CommunityTemplateBundleInfo is used as a highlighted
                    feature. Up to 4 are supported.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PreviewImage</samp>—This
                    CommunityTemplateBundleInfo is used as a preview image. Up
                    to 3 are supported.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## CommunityTemplatePageSetting

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d256959e499">Field Name</th>

              <th class="featureTableHeader  " id="d256959e502">Field Type</th>

              <th class="featureTableHeader  " id="d256959e505">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d256959e499" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d256959e502" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e505" data-title="Description">Required. The list of FlexiPage of this
                CommunityTemplateDefinition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d256959e499" data-title="Field Name"><span class="keyword parmname" id="field_themeLayout_name"><a name="field_themeLayout_name"><!-- --></a>themeLayout</span></td>

              <td class="entry" headers="d256959e502" data-title="Field Type">string</td>

              <td class="entry" headers="d256959e505" data-title="Description">Required. The name of the FlexiPage
                for the theme layout.<p class="p">This field is available in API version 39.0
                  and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a CommunityTemplateDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<CommunityTemplateDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <baseTemplate\>c</baseTemplate\>
    <bundlesInfo\>
        <description\>Feature Description</description\>
        <order\>1</order\>
        <title\>Feature Heading</title\>
        <type\>Highlight</type\>
    </bundlesInfo\>
    <bundlesInfo\>
        <image\>siteAsset\_2dbe594eb6794173af78da264cd6a4a7</image\>
        <order\>1</order\>
        <title\>Preview Image</title\>
        <type\>PreviewImage</type\>
    </bundlesInfo\>
    <category\>Sales</category\>
    <defaultThemeDefinition\>communityTemplate</defaultThemeDefinition\>
    <description\>This is an Experience Builder template</description\>
    <enableExtendedCleanUpOnDelete\>true</enableExtendedCleanUpOnDelete\>
    <masterLabel\>communityTemplate</masterLabel\>
    <navigationLinkSet\>
        <navigationMenuItem\>
            <label\>Topics</label\>
            <position\>0</position\>
            <publiclyAvailable\>true</publiclyAvailable\>
            <target\>ShowMoreTopics</target\>
            <type\>NavigationalTopic</type\>
        </navigationMenuItem\>
    </navigationLinkSet\>
    <pageSetting\>
        <page\>communityTemplate\_Report\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Topic\_Catalog</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Check\_Password</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Login</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Error</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_User\_Settings</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Login</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Login</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Stream\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Sfdc\_Page</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Group\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Report\_Related\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Register</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Login</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_User\_Profile</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Case\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Stream\_Related\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Dashboard\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Group\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Canvasapp\_Page</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Login\_Error</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Login</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Create\_Record</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Group\_Related\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Search</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_File\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Case\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_User\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_File\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Question\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Dashboard\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Related\_Record\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_File\_Related\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Record\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Forgot\_Password</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Login</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Home</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Dashboard\_Related\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Account\_Management</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Case\_Related\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_User\_Related\_List</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Stream\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Topic\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Messages</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Report\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Record\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Feed\_Detail</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
    <pageSetting\>
        <page\>communityTemplate\_Contact\_Support</page\>
        <themeLayout\>communityTemplate\_themeLayout\_Default</themeLayout\>
    </pageSetting\>
</CommunityTemplateDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyTemplate</members\>
        <name\>CommunityTemplateDefinition</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ff46b215025774e0780f0b4a6217629cfb16ea08ca313d7a155c145d9d8ac6c8 url=/legacydeveloper/current/en-us/api_meta/meta_communitythemedefinition.md -->

# CommunityThemeDefinition

Represents the definition of a theme for an Experience Builder site. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

CommunityThemeDefinition components have the suffix .communityThemeDefinition and are stored in the communityThemeDefinitions folder.

## Version

CommunityThemeDefinition components are available in API version 38.0 and later.

## Special Access Rules

This type is available only if Salesforce Digital Experiences is enabled in your org.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d258644e98">Field Name</th>

              <th class="featureTableHeader  " id="d258644e101">Field Type</th>

              <th class="featureTableHeader  " id="d258644e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d258644e98" data-title="Field Name"><span class="keyword parmname">bundlesInfo</span></td>

              <td class="entry" headers="d258644e101" data-title="Field Type">
                <a class="xref" href="#CommunityThemeBundleInfo">CommunityThemeBundleInfo</a>[]
              </td>

              <td class="entry" headers="d258644e104" data-title="Description">If specified, at least one preview image and one highlight are required. Up to
                3 preview images and 4 highlights are supported. Available in API version 44.0 and
                later</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e98" data-title="Field Name"><span class="keyword parmname" id="field_customThemeLayoutType_name"><a name="field_customThemeLayoutType_name"><!-- --></a>customThemeLayoutType</span></td>

              <td class="entry" headers="d258644e101" data-title="Field Type">
                <a class="xref" href="#CommunityCustomThemeLayoutType">CommunityCustomThemeLayoutType</a>[]
              </td>

              <td class="entry" headers="d258644e104" data-title="Description"><span class="ph" id="field_customThemeLayoutType_desc"><a name="field_customThemeLayoutType_desc"><!-- --></a>The list of custom theme layout types
                  available to the theme layout.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e98" data-title="Field Name"><span class="keyword parmname">defaultBrandingSet</span></td>

              <td class="entry" headers="d258644e101" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e104" data-title="Description">The set of branding properties associated with this CommunityThemeDefinition,
                as defined in the Theme panel in Experience Builder. Available in API version 44.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e98" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d258644e101" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e104" data-title="Description">The optional description text of this CommunityThemeDefinition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e98" data-title="Field Name"><span class="keyword parmname">enableExtendedCleanUp​OnDelete</span></td>

              <td class="entry" headers="d258644e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d258644e104" data-title="Description">False by default. Determines if deleting this CommunityThemeDefinition attempts
                to delete other directly or indirectly referenced objects automatically, for
                example, FlexiPage. Values are true or false.</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e98" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d258644e101" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e104" data-title="Description">Required. The label for this CommunityThemeDefinition, which displays in Setup.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e98" data-title="Field Name"><span class="keyword parmname">publisher</span></td>

              <td class="entry" headers="d258644e101" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e104" data-title="Description">Defines the name of the publisher as seen in the wizard for creating Experience
                Builder sites. If no name is provided, the name of the org from which the package
                was originally exported is used.<p class="p">This field is available in API version 45.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e98" data-title="Field Name"><span class="keyword parmname">themeRouteOverride</span></td>

              <td class="entry" headers="d258644e101" data-title="Field Type">
                <a class="xref" href="#CommunityThemeRouteOverride">CommunityThemeRouteOverride</a>[]
              </td>

              <td class="entry" headers="d258644e104" data-title="Description">List of theme layout type overrides for flexipages (currently only for home).
                Available in API version 44.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e98" data-title="Field Name"><span class="keyword parmname">themeSetting</span></td>

              <td class="entry" headers="d258644e101" data-title="Field Type">
                <a class="xref" href="#CommunityThemeSetting">CommunityTheme Setting</a>
                []
              </td>

              <td class="entry" headers="d258644e104" data-title="Description">Required. The list of settings for this CommunityThemeDefinition.</td>

            </tr>

          </tbody>

        </table>

## CommunityThemeBundleInfo

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d258644e271">Field Name</th>

              <th class="featureTableHeader  " id="d258644e274">Field Type</th>

              <th class="featureTableHeader  " id="d258644e277">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d258644e271" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d258644e274" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e277" data-title="Description">The optional description text of its CommunityThemeBundleInfo.</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e271" data-title="Field Name"><span class="keyword parmname">image</span></td>

              <td class="entry" headers="d258644e274" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e277" data-title="Description">Required only when the <span class="keyword parmname">type</span> is <samp class="codeph nolang">PreviewImage</samp>, otherwise this field is optional. A preview image for this
                CommunityThemeDefinition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e271" data-title="Field Name"><span class="keyword parmname">order</span></td>

              <td class="entry" headers="d258644e274" data-title="Field Type">int</td>

              <td class="entry" headers="d258644e277" data-title="Description">Required. An integer specifying the position of this CommunityThemeBundleInfo
                relative to others of the same <span class="keyword parmname">type</span> within its
                CommunityThemeDefinition. <samp class="codeph nolang">1</samp> is the first
                position, <samp class="codeph nolang">3</samp> is the maximum position for <samp class="codeph nolang">PreviewImage</samp> type, and <samp class="codeph nolang">4</samp> is the maximum position for the <samp class="codeph nolang">Highlight</samp> type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e271" data-title="Field Name"><span class="keyword parmname">title</span></td>

              <td class="entry" headers="d258644e274" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e277" data-title="Description">Required. The title of this CommunityThemeBundleInfo to use in code.</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e271" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d258644e274" data-title="Field Type">CommunityTemplate​BundleInfoType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d258644e277" data-title="Description">Required. Stores descriptive information about the theme that is included in
                the export. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Highlight</samp>—This CommunityThemeBundleInfo
                    is used as a highlighted feature. Up to 4 are supported.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PreviewImage</samp>—This
                    CommunityThemeBundleInfo is used as a preview image. Up to 3 are supported.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## CommunityCustomThemeLayoutType

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | The description of the custom theme layout type. |
| label | string | Required. The name of the custom theme layout type. The values Inner, Home, and Login are reserved. |

## CommunityThemeRouteOverride

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d258644e485">Field Name</th>

              <th class="featureTableHeader  " id="d258644e488">Field Type</th>

              <th class="featureTableHeader  " id="d258644e491">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d258644e485" data-title="Field Name"><span class="keyword parmname">customThemeLayoutType</span></td>

              <td class="entry" headers="d258644e488" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e491" data-title="Description">Required when <span class="keyword parmname">themeLayoutType</span> isn’t specified. Provides
                the custom theme layout type associated with the theme layout. This field and
                <span class="keyword parmname">themeLayoutType</span> are mutually exclusive; you can’t specify
                both.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e485" data-title="Field Name"><span class="keyword parmname">pageAttributes</span></td>

              <td class="entry" headers="d258644e488" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e491" data-title="Description">Required. Specifies the attributes of the site page for which the default theme
                layout type is overridden. The only valid value is <samp class="codeph nolang">{"PageName":"Home"}</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e485" data-title="Field Name"><span class="keyword parmname">pageType</span></td>

              <td class="entry" headers="d258644e488" data-title="Field Type">string</td>

              <td class="entry" headers="d258644e491" data-title="Description">
                <p dir="ltr" class="p">Required. Specifies the type of the site page for which the default
                  theme layout type is overridden. The only valid value is <samp class="codeph nolang">comm__standardPage</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d258644e485" data-title="Field Name"><span class="keyword parmname">themeLayoutType</span></td>

              <td class="entry" headers="d258644e488" data-title="Field Type">CommunityTheme​LayoutType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d258644e491" data-title="Description">Required if <span class="keyword parmname">customThemeLayoutType</span> isn’t specified.
                Provides the default theme layout type associated with the theme layout. Valid
                values are <samp class="codeph nolang">Inner</samp>, <samp class="codeph nolang">Home</samp>, or <samp class="codeph nolang">Login</samp>. This field and
                <span class="keyword parmname">customThemeLayoutType</span> are mutually exclusive; you can’t
                specify both.
              </td>

            </tr>

          </tbody>

        </table>

## CommunityTheme Setting

| Field Name | Field Type | Description |
| --- | --- | --- |
| customThemeLayoutType | string | Required when themeLayoutType isn’t specified. The custom theme layout type associated with the theme layout. This field and themeLayoutType are mutually exclusive; you can’t specify both. |
| themeLayout | string | Required. The configuration and layout for this theme. |
| themeLayoutType | CommunityTheme​LayoutType ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | Required when customThemeLayoutType isn’t specified. The default theme layout type associated with the theme layout. Valid values are Inner, Home, or Login. This field and customThemeLayoutType are mutually exclusive; you can’t specify both. |

## Declarative Metadata Sample Definition

The following is an example of a CommunityThemeDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<CommunityThemeDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <bundlesInfo\>
        <description\>Batman Feature1 description</description\>
        <order\>1</order\>
        <title\>Batman Feature1</title\>
        <type\>Highlight</type\>
    </bundlesInfo\>
    <bundlesInfo\>
        <image\>siteAsset\_d90e2d5ce4cf4d8899e233c051091246</image\>
        <order\>1</order\>
        <title\>siteAsset\_d90e2d5ce4cf4d8899e233c051091246</title\>
        <type\>PreviewImage</type\>
    </bundlesInfo\>
    <defaultBrandingSet\>Batman</defaultBrandingSet\>
    <description\>Batman theme</description\>
    <enableExtendedCleanUpOnDelete\>true</enableExtendedCleanUpOnDelete\>
    <masterLabel\>Batman</masterLabel\>
    <themeRouteOverride\>
        <pageAttributes\>{&quot;PageName&quot;:&quot;Home&quot;}</pageAttributes\>
        <pageType\>comm\_\_standardPage</pageType\>
        <themeLayoutType\>Home</themeLayoutType\>
    </themeRouteOverride\>
    <themeSetting\>
        <themeLayout\>Batman\_themeLayout\_Login</themeLayout\>
        <themeLayoutType\>Login</themeLayoutType\>
    </themeSetting\>
    <themeSetting\>
        <themeLayout\>Batman\_themeLayout\_Home</themeLayout\>
        <themeLayoutType\>Home</themeLayoutType\>
    </themeSetting\>
    <themeSetting\>
        <themeLayout\>Batman\_themeLayout\_Default</themeLayout\>
        <themeLayoutType\>Inner</themeLayoutType\>
    </themeSetting\>
</CommunityThemeDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Batman</members\>
        <name\>BrandingSet</name\>
    </types\>
    <types\>
        <members\>Batman</members\>
        <name\>CommunityThemeDefinition</name\>
    </types\>
    <types\>
        <members\>Batman\_themeLayout\_Default</members\>
        <members\>Batman\_themeLayout\_Home</members\>
        <members\>Batman\_themeLayout\_Login</members\>
        <name\>FlexiPage</name\>
    </types\>
    <types\>
        <members\>siteAsset\_d90e2d5ce4cf4d8899e233c051091246</members\>
        <name\>StaticResource</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=92ed845d461b84ef6c4f9512dfc8e989c1845d12d9485ee9238f7e6ae301d46d url=/legacydeveloper/current/en-us/api_meta/meta_compactlayout.md -->

# CompactLayout

Represents the metadata associated with a compact layout. This type extends the Metadata metadata type and inherits its fullName field.

A compact layout displays a record’s key fields at a glance in the Salesforce mobile app, Lightning Experience, and in the Outlook and Gmail integrations.

Compact layouts support all field types except:

- text area
- long text area
- rich text area
- multi-select picklist

For more information on compact layouts, see [Compact Layouts](https://help.salesforce.com/s/articleView?id=platform.compact_layout_overview.htm&type=5&language=en_US "HTML (New Window)") in the Salesforce Help.

## File Suffix and Directory Location

Compact layouts are defined as part of the custom object, standard object, or external object definition. See [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.") for more information.

## Version

CompactLayout components are available in API version 29.0 and later. CompactLayout components are available for external objects in API version 42.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| fields | string | The fields assigned to the compact layout. Their order represents the prioritization given to them when defining the compact layout. |
| label | string | Label that represents the object throughout the Salesforce user interface. |

## Declarative Metadata Sample Definition

The following is an example of a CompactLayout component:

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides\>
        <actionName\>Accept</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>Clone</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>Delete</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>Edit</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>List</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>New</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>Tab</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>View</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <compactLayouts\>
        <fullName\>testCompactLayout</fullName\>
        <fields\>textfield\_\_c</fields\>
        <label\>testCompactLayoutLabel</label\>
    </compactLayouts\>
    <compactLayoutAssignment\>SYSTEM</compactLayoutAssignment\>
    <deploymentStatus\>Deployed</deploymentStatus\>
    <enableActivities\>false</enableActivities\>
    <enableFeeds\>false</enableFeeds\>
    <enableHistory\>false</enableHistory\>
    <enableReports\>false</enableReports\>
    <fields\>
        <fullName\>textfield\_\_c</fullName\>
        <externalId\>false</externalId\>
        <label\>textfield</label\>
        <length\>255</length\>
        <required\>false</required\>
        <type\>Text</type\>
        <unique\>false</unique\>
    </fields\>
    <label\>customObj</label\>
    <nameField\>
        <label\>customObj Name</label\>
        <type\>Text</type\>
    </nameField\>
    <pluralLabel\>customObjs</pluralLabel\>
    <recordTypes\>
        <fullName\>RT1</fullName\>
        <active\>true</active\>
        <label\>RT1</label\>
        <compactLayoutAssignment\>testCompactLayout</compactLayoutAssignment\>
    </recordTypes\>
    <recordTypes\>
        <fullName\>RT2</fullName\>
        <active\>true</active\>
        <label\>RT2</label\>
    </recordTypes\>
    <searchLayouts/\>
    <sharingModel\>ReadWrite</sharingModel\>
</CustomObject\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_businessprocess.htm "BusinessProcess")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm "CustomField")

<!-- document id=89674f751fe8170b456c1837c44fa8ba1ecfb98a13e955f25effc56e330ea1f9 url=/legacydeveloper/current/en-us/api_meta/meta_companyprofilesettings.md -->

# CompanySettings

Represents global settings that affect multiple features in your organization. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## Declarative Metadata File Suffix and Directory Location

CompanySettings values are stored in a single file named Company.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

Company Profile Settings are available in API version 27.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableCustomFiscalYear | boolean | If a custom fiscal period is set up, this field is used to determine whether the custom fiscal period is used for forecasts. If true, the custom fiscal period is used. If false (default), standard periods are used. Available in API version 47.0 and later. |
| fiscalYear | [FiscalYearSetting](#CompanyProfileSettingsFiscalYear) | The organization’s fiscal year setting based on year and start month. Not available if Custom Fiscal Year or Forecasts (Classic) is enabled. When changing fiscal year settings, quotas and adjustments can be purged. For example changing your start month results in purging this data. |

## FiscalYearSetting

Represents your organization’s fiscal year setting.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d261111e176">Field</th>

              <th class="featureTableHeader  " id="d261111e179">Field Type</th>

              <th class="featureTableHeader  " id="d261111e182">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d261111e176" data-title="Field"><span class="keyword parmname" id="field_fiscalyearnamebasedon"><a name="field_fiscalyearnamebasedon"><!-- --></a>fiscalYearNameBasedOn</span></td>

              <td class="entry" headers="d261111e179" data-title="Field Type">string</td>

              <td class="entry" headers="d261111e182" data-title="Description">
                <span class="ph" id="fiscalYearNameBasedOnDesc"><a name="fiscalYearNameBasedOnDesc"><!-- --></a>This field is used to
                  determine the fiscal year name. Valid values are <samp class="codeph nolang">endingMonth</samp> or <samp class="codeph nolang">startingMonth</samp>. For example, if
                  your fiscal year starts in April 2012 and ends in March 2013,
                  and this value is:</span>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">endingMonth</samp>, then 2013
                    is used for the fiscal year name.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">startingMonth</samp>, then
                    2012 is used for the fiscal year name.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d261111e176" data-title="Field"><span class="keyword parmname" id="field_startmonth"><a name="field_startmonth"><!-- --></a>startMonth</span></td>

              <td class="entry" headers="d261111e179" data-title="Field Type">string</td>

              <td class="entry" headers="d261111e182" data-title="Description"><span class="ph" id="startMonthDesc"><a name="startMonthDesc"><!-- --></a>The month on which the fiscal year is
                  based.</span></td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition — Fiscal Year Setting

A sample XML definition of a fiscal year setting is shown below. Note that this example is supported in API version 27.0 and later.

<?xml version="1.0" encoding="UTF-8"?>
<CompanySettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <fiscalYear\>
        <fiscalYearNameBasedOn\>endingMonth</fiscalYearNameBasedOn\>
        <startMonth\>January</startMonth\>
    </fiscalYear\>
</CompanySettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=f59f131d082bb9d5b0bba77db13b0f259c5dbf2ecf7fd508f3893cb450e83fde url=/legacydeveloper/current/en-us/api_meta/meta_connectedapp.md -->

# ConnectedApp

Represents a connected app configuration. A connected app enables an external application to integrate with Salesforce using APIs and standard protocols, such as SAML, OAuth, and OpenID Connect. Connected apps use these protocols to authenticate, authorize, and provide single sign-on (SSO) for external apps. The external apps that are integrated with Salesforce can run on the customer success platform, other platforms, devices, or SaaS subscriptions.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Connected apps creation is restricted as of Spring ‘26. You can use existing connected apps during and after Spring ‘26. However, we recommend using [external client apps](https://help.salesforce.com/s/articleView?id=xcloud.external_client_apps.htm&language=en_US) instead. If you must continue creating connected apps, contact Salesforce Support.

See [New connected apps can no longer be created in Spring ‘26](https://help.salesforce.com/s/articleView?id=005228017&type=1&language=en_US) for more details.

## File Suffix and Directory Location

ConnectedApp components have the suffix .connectedApp and are stored in the connectedApps folder.

## Version

ConnectedApp components are available in API version 29.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d262374e111">Field Name</th>

              <th class="featureTableHeader  " id="d262374e114">Field Type</th>

              <th class="featureTableHeader  " id="d262374e117">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">attributes</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type"><span class="keyword parmname">canvasConfig</span></td>

              <td class="entry" headers="d262374e117" data-title="Description">A custom attribute of the connected app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"></td>

              <td class="entry" headers="d262374e114" data-title="Field Type"><a class="xref" href="#ConnectedAppCanvasConfig_title">AppCanvasConfig</a></td>

              <td class="entry" headers="d262374e117" data-title="Description">The configuration options of the connected app
                if it's exposed as a canvas app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">contactEmail</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">Required. The email address that Salesforce uses to contact you
                or your support team.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">contactPhone</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">The phone number for Salesforce to use to contact you.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">An optional description for your app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">iconUrl</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">Reserved for future
                use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">infoUrl</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">An optional URL for a web page with more information about your app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">ipRanges</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type"><a class="xref" href="#connectedAppIpRange_title">ConnectedAppIpRange[]</a></td>

              <td class="entry" headers="d262374e117" data-title="Description">Specifies the ranges of IP addresses that can access the app without requiring the user
                to authenticate with the connected app. </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">Required. The name of the app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">logoUrl</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">An optional logo for the app. The logo appears with the app’s entry in the
                list of apps and on the consent page the user sees when authenticating.
                The URL must use HTTPS, and the logo can't be larger than 125 pixels high
                or 200 pixels wide. The default logo is a cloud.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">mobileStartUrl</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">Users are directed to this URL after they've authenticated when the app
                is accessed from a mobile device. If you don't give a URL, the user is sent to
                the app’s default start page after authentication completes. If the connected app
                that you’re creating is a canvas app, then you can leave this field blank. The Canvas
                App URL field contains the URL that gets called for the connected app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">oauthConfig</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type"><a class="xref" href="#connectedAppOauthConfig_title">connectedAppOauthConfig</a></td>

              <td class="entry" headers="d262374e117" data-title="Description">Specifies how your app communicates with Salesforce.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">oauthPolicy</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type"><a class="xref" href="#connectedAppOauthPolicy_title">ConnectedAppOauthPolicy</a></td>

              <td class="entry" headers="d262374e117" data-title="Description">Specifies OAuth access policies associated with your connected app. Available in API
                version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">permissionSetName</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">Specifies the permissions required to perform different functions with the connected
                app. Available in API version 46.0 and later.<p class="p">You can assign
                  multiple permission sets to the connected app, but you must
                  enter each permission set name on a separate line. You can’t
                  enter the same permission set name more than one time for each
                  connected app.</p>
                <p class="p">You can also change a permission set by
                  replacing the current permission set with a new permission set.
                  Make sure that each permission set name assigned to the
                  connected app is unique.</p>
                <p class="p">You can delete individual
                  permission sets or remove all permission sets from a connected
                  app by entering an empty <span class="keyword parmname">permissionSetName</span>
                  string on deployment of the connected app: (<samp class="codeph nolang">&lt;permissionSetName&gt;&lt;/permissionSetName&gt;</samp>).</p>
                <p class="p">To
                  use this field, the <span class="keyword parmname">isAdminApproved</span> field
                  on the ConnectedAppOauthConfig subtype must be set to <samp class="codeph nolang">true</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">plugin</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">The name of a custom Apex class that extends <samp class="codeph apex_code">Auth.ConnectedAppPlugin</samp> to customize the behavior of the app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">pluginExecutionUser</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">Specifies the user to run the plugin as. If the user isn’t authorized to use the
                connected app, use the <samp class="codeph nolang">authorize</samp> method. See the
                <span class="keyword parmname">ConnectedAppPlugin</span> class in the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_namespace_Auth.htm" target="_blank">Apex Developer Guide</a>.
                Available in API version 46.0 and later.<p class="p">Enter a user that is part
                  of your org. Otherwise, the user is removed from this field when
                  you deploy the connected app. If you don’t want to specify a
                  user, you can leave this field empty.</p>
                <p class="p">To use this field in
                  an org, the ConAppPluginExecuteAsUser setting must be
                  enabled.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">profileName</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string[]</td>

              <td class="entry" headers="d262374e117" data-title="Description">Specifies the profile (base-level user permissions) required to perform different
                functions with the connected app. Available in API version 46.0 and
                later.<p class="p">You can assign multiple profiles to the connected app,
                  but you must enter each profile name on a separate line. You
                  can’t enter the same profile name more than one time for each
                  connected app. </p>
                <p class="p">You can also change profiles by replacing
                  the current profiles with new profiles. Make sure that each
                  profile name assigned to the connected app is unique.</p>
                <p class="p">You
                  can also delete individual profiles or remove all profiles from
                  a connected app by entering an empty
                  <span class="keyword parmname">profileName</span> string on deployment of the
                  connected app: (<samp class="codeph nolang">&lt;profileName&gt;&lt;/profileName&gt;</samp>).
                </p>
                <p class="p">To use
                  this field, the <span class="keyword parmname">isAdminApproved</span> field on
                  the ConnectedAppOauthConfig subtype must be set to <samp class="codeph nolang">true</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">samlConfig</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type"><a class="xref" href="#connectedAppSamlConfig_title">ConnectedAppSamlConfig</a></td>

              <td class="entry" headers="d262374e117" data-title="Description">Controls how the app uses single sign-on.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">sessionPolicy</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type"><a class="xref" href="#connectedAppSessionPolicy_title">ConnectedAppSessionPolicy</a></td>

              <td class="entry" headers="d262374e117" data-title="Description">Specifies a connected app’s session policies.
                Available in API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e111" data-title="Field Name"><span class="keyword parmname">startUrl</span></td>

              <td class="entry" headers="d262374e114" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e117" data-title="Description">If the app isn’t accessed from a mobile device, users are directed to this
                URL after they've authenticated. If you don't give a URL, the user is sent
                to the app’s default start page after authentication completes. Whether you
                give a URL or not, the start URL can be updated later by managing the
                connected app. If the app is accessed from a mobile device, see
                <span class="keyword parmname">mobileStartUrl</span>. If the connected app that you’re
                creating is a canvas app, then you can leave this field empty.
                The Canvas App URL field contains the URL that gets called for the
                connected app.
              </td>

            </tr>

          </tbody>

        </table>

## ConnectedAppAttribute

Represents the field names that make up a custom attribute when using SAML with a ConnectedApp. Customize these values to a specific service provider.

| Field Name | Field Type | Description |
| --- | --- | --- |
| formula | string | Required. The value of the attribute. |
| key | string | Required. The attribute's identifier. |

## ConnectedAppCanvasConfig

Represents the configuration options of the connected app if it's exposed as a canvas app.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d262374e552">Field Name</th>

              <th class="featureTableHeader  " id="d262374e555">Field Type</th>

              <th class="featureTableHeader  " id="d262374e558">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d262374e552" data-title="Field Name"><span class="keyword parmname">accessMethod</span></td>

              <td class="entry" headers="d262374e555" data-title="Field Type">AccessMethod (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)
              </td>

              <td class="entry" headers="d262374e558" data-title="Description">Required. Indicates how the canvas app initiates the OAuth authentication flow.
                The valid values are:<a name="AccessMethod_values"><!-- --></a>
                <ul class="ul bulletList" id="AccessMethod_values">
                  <li class="li">
                    <samp class="codeph nolang">Get</samp>—OAuth
                    authentication is used, and the user is prompted to allow the
                    third-party application to access their information. When you
                    use this access method, the canvas app must initiate the
                    OAuth authentication flow.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Post</samp>—OAuth
                    authentication is used, but when the administrator installs the
                    canvas app, they implicitly allow access for users. Therefore,
                    the user isn’t prompted to allow the third party to access their
                    user information. When you use this access method, the
                    authentication is posted directly to the canvas app URL.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e552" data-title="Field Name"><span class="keyword parmname">canvasUrl</span></td>

              <td class="entry" headers="d262374e555" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e558" data-title="Description">Required. The URL of the third-party app that's exposed as a canvas app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e552" data-title="Field Name"><span class="keyword parmname">lifecycleClass</span></td>

              <td class="entry" headers="d262374e555" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e558" data-title="Description">
                <span class="ph" id="lifecycle_class_desc"><a name="lifecycle_class_desc"><!-- --></a>The name of the <samp class="codeph nolang">Canvas.CanvasLifecycleHandler</samp> Apex class, if you've implemented
                  this class for custom parameters.</span>
                <p class="p">Available in API version 31.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e552" data-title="Field Name"><span class="keyword parmname">locations</span></td>

              <td class="entry" headers="d262374e555" data-title="Field Type">CanvasLocationOptions (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)[]</td>

              <td class="entry" headers="d262374e558" data-title="Description">Indicates where the canvas app can appear to the user. The valid values are:<a name="CanvasLocationOptions_values"><!-- --></a>
                <ul class="ul bulletList" id="CanvasLocationOptions_values">
                  <li class="li">
                    <samp class="codeph nolang">Aura</samp>—The canvas app can appear in a custom
                    Lightning component.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AppLauncher</samp>—Reserved for future use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Chatter</samp>—The canvas app can appear in the
                    app navigation list on the Chatter tab in Salesforce
                    Classic.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ChatterFeed</samp>—The canvas app can appear as a Chatter feed item.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MobileNav</samp>—The canvas app can appear in a mobile card in the Salesforce mobile app. Available in API version 31.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">None</samp>—The canvas app can appear only in the Canvas App Previewer.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpenCTI</samp>—The canvas app can appear in the
                    call control tool in Salesforce Classic.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PageLayout</samp>—The canvas app can appear on a page layout. When viewed in the Salesforce mobile app, the canvas app
                    appears in the record detail page. Available in API version 31.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Publisher</samp>—The canvas app can appear as a global action.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ServiceDesk</samp>—The canvas app can appear in
                    the footer or sidebars of a console in Salesforce
                    Classic.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UserProfile</samp>—Reserved for future use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Visualforce</samp>—The canvas app can appear on a Visualforce page.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e552" data-title="Field Name"><span class="keyword parmname">options</span></td>

              <td class="entry" headers="d262374e555" data-title="Field Type">CanvasOptions (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)[]</td>

              <td class="entry" headers="d262374e558" data-title="Description">Indicates whether to hide the <strong class="ph uicontrol">Share</strong> button and header in the publisher for your canvas app and whether the app is a canvas personal app. Valid
                values are:<a name="options_values"><!-- --></a>
                <ul class="ul bulletList" id="options_values">
                  <li class="li">
                    <samp class="codeph nolang">HideShare</samp>—The <strong class="ph uicontrol">Share</strong> button is hidden in the publisher for the related canvas app. Available
                    in API version 30.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HideHeader</samp>—The header is hidden in the publisher for the related canvas app. Available in API version 30.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PersonalEnabled</samp>—End users can install the app as a canvas personal app. Available in API version 32.0 and
                    later.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e552" data-title="Field Name"><span class="keyword parmname">samlInitiationMethod</span></td>

              <td class="entry" headers="d262374e555" data-title="Field Type">SamlInitiationMethod (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d262374e558" data-title="Description">
                <span class="ph" id="saml_initiation_method_desc"><a name="saml_initiation_method_desc"><!-- --></a>If you're using SAML single sign-on (SSO), indicates which provider initiates the SSO flow.</span><a name="saml_initiation_method_options"><!-- --></a>
                <ul class="ul bulletList" id="saml_initiation_method_options">
                  <li class="li">
                    <samp class="codeph nolang">IdpInitiated</samp>—Identity provider initiated. Salesforce makes the initial request to start the SSO flow.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SpInitiated</samp>—Service provider initiated. The canvas app starts the SSO flow after it's invoked.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">None</samp>—The canvas app isn't using SAML SSO. Available in API version 31.0 and later.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ConnectedAppIpRange

Represents the list of IP addresses that can access the app without requiring the user to authenticate.

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Identifies the purpose of the range, such as which part of a network corresponds to this range. Available in API version 31.0 and later. |
| end | string | Required. The last address in the IP range, inclusive. |
| start | string | Required. The first address in the IP range, inclusive. |

## ConnectedAppOauthConfig

Represents the field names that configure how your connected app communicates with Salesforce.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d262374e893">Field Name</th>

              <th class="featureTableHeader  " id="d262374e896">Field Type</th>

              <th class="featureTableHeader  " id="d262374e899">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">assetTokenConfig</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type"><a class="xref" href="#connectedAppOauthAssetToken_title">connectedAppOauthAssetToken</a></td>

              <td class="entry" headers="d262374e899" data-title="Description">The OAuth asset token configuration for the connected app OAuth
                settings. Available in API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">callbackUrl</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e899" data-title="Description">Required. The endpoint that Salesforce calls back to your
                connected app during OAuth. It’s the OAuth <samp class="codeph nolang">redirect_uri</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">certificate</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e899" data-title="Description">The PEM-encoded certificate string, if the app uses a
                certificate.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">consumerKey</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e899" data-title="Description">A value used by the consumer for identification to Salesforce.
                Referred to as <samp class="codeph nolang">client_id</samp> in
                OAuth 2.0.<p class="p">In API version 32.0 and later, you can set this field’s
                  value only during creation. <span class="ph" id="consumerKey_field_desc2"><a name="consumerKey_field_desc2"><!-- --></a>After you define and save the value, it can’t be edited.
                    The value must be alphanumeric, can’t contain special
                    characters or spaces, and must be between 8–256 characters.
                    Consumer keys must be globally unique.</span></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="consumerSecret_field_name"><a name="consumerSecret_field_name"><!-- --></a>consumerSecret</span></span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e899" data-title="Description">
                <span class="ph" id="consumerSecret_field_desc"><a name="consumerSecret_field_desc"><!-- --></a>A value that is combined with
                  the <span class="keyword parmname">consumerKey</span> and used by the consumer
                  for identification to Salesforce. Referred to as <samp class="codeph nolang">client_secret</samp> in OAuth 2.0.
                  Typically, Salesforce generates this value when you create the
                  connected app. However, you can customize the shared secret
                  value during creation. After you save the value, it can’t be
                  edited. When set, the value isn’t returned in Metadata API
                  requests.</span>
                <p class="p"><span class="ph" id="consumerSecret_field_desc2"><a name="consumerSecret_field_desc2"><!-- --></a>The value
                    must be alphanumeric (no special characters and no spaces)
                    and a minimum of 8 characters (maximum of 256 characters).
                    If you specify a secret already in use for another connected
                    app in the organization, an error
                    occurs.</span></p>
                <p class="p">Available in API version 32.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">idTokenConfig</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type"><a class="xref" href="#connectedAppOauthIdToken_title">ConnectedAppOauthIdToken</a></td>

              <td class="entry" headers="d262374e899" data-title="Description">Specifies the ID token configuration for the connected app OAuth
                settings. Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isAdminApproved</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">If set to <samp class="codeph nolang">false</samp> (default),
                anyone in the org can authorize the app. Users must approve the app
                the first time they access it.<p class="p">If set to <samp class="codeph nolang">true</samp>, only users with the
                  appropriate profile or permission set can access the app. These
                  users don’t have to approve the app before they can access it.
                  Manage profiles for the app by editing each profile’s Connected
                  App Access list. Manage permission sets for the app by editing
                  each permission set’s Assigned Connected App list. This setting
                  isn’t available in Group Edition. Available in API version 46.0
                  and later.</p>

                <p class="p">Connected app consumers can edit this setting when deploying a
                  connected app in their org.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isClientCredentialEnabled</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">If set to <samp class="codeph nolang">true</samp>, the
                connected app can use the OAuth 2.0 client credentials flow. To use
                the client credentials flow, you must also specify a user for
                <span class="keyword parmname">oauthClientCredentialUser</span>.<p class="p">If set to
                  <samp class="codeph nolang">false</samp> (default), the
                  connected app can’t use the client credentials
                  flow.
                </p>
                <p class="p">Available in API version 56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isCodeCredentialEnabled</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">Determines whether the app can use the Authorization Code and
                Credentials Flow to provide identity services to headless,
                off-platform apps. The Authorization Code and Credentials Flow is
                the foundation of headless login, headless registration, headless
                passwordless login, and headless guest identity. <p class="p">If set to
                  <samp class="codeph nolang">true</samp>, the connected app
                  can use the Authorization Code and Credentials Flow and all
                  associated Headless Identity features. The default value is
                  <samp class="codeph nolang">false</samp>.
                </p>
                <p class="p">This field
                  is available in API version 57.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isCodeCredentialPostOnly </span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">For the Authorization Code and Credentials Flow, determines
                whether the user’s credentials must be sent in the body of the
                initial HTTPS POST request to the Salesforce authorization endpoint.
                Requiring the credentials in the POST body instead of in the header
                improves security.<p class="p">If set to <samp class="codeph nolang">true</samp>, the user’s credentials must be included in
                  the POST body. The default value is <samp class="codeph nolang">false</samp>.</p>
                <p class="p">This field is available in API
                  version 57.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isConsumerSecretOptional</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">If set to <samp class="codeph nolang">false</samp> (default),
                the connected app’s client secret is required in exchange for an
                access token in the OAuth 2.0 web server flow.<p class="p">If the client app
                  can’t keep the client secret confidential and it must use the
                  web server flow, set to <samp class="codeph nolang">true</samp>. A client secret is still generated for the
                  connected app, but this setting instructs the web server flow
                  not to require the <samp class="ph systemoutput">client_secret</samp>
                  parameter in the access token request. We recommend the user
                  agent flow as a more secure option than web server flow without
                  the secret. Available in API version 49.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isIntrospectAllTokens</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">If set to <samp class="codeph nolang">true</samp>, authorizes
                the connected app to introspect all access and refresh tokens within
                the entire org.<p class="p">If set to <samp class="codeph nolang">false</samp> (default), the connected app can introspect
                  its own tokens. In addition, an OAuth client that directly
                  registers OAuth 2.0 connected apps through the dynamic client
                  registration endpoint can check the tokens for itself and its
                  registered apps. Available in API version 49.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isNamedUserJwtEnabled</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">If set to <samp class="codeph nolang">true</samp>, the connected app is enabled to
                issue JSON Web Token (JWT)-based access tokens.<p class="p">This field is
                  generally available in API version 59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isPkceRequired</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">Determines whether the Proof Key for Code Exchange (PKCE)
                extension is required for variations of the OAuth 2.0 authorization
                code flow configured for the connected app, including the web server
                flow and Authorization Code and Credentials Flow. For public client
                apps that can’t keep the consumer secret confidential, such as
                mobile apps, the PKCE extension helps ensure that the client that
                initiates an authorization flow is the same client that completes
                it. For this reason, we always recommend implementing PKCE for
                public clients. We also strongly recommend that you implement PKCE
                for private clients.<p class="p">If set to <samp class="codeph nolang">true</samp>, the PKCE extension is required and any
                  authorization code flow variations that don’t implement it fail.
                  If set to <samp class="codeph nolang">false</samp>, you can
                  still implement PKCE but it isn’t required. The default value is
                  <samp class="codeph nolang">false</samp>.
                </p>
                <p class="p">This field
                  is available in API version 59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isRefreshTokenRotationEnabled</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">If set to <samp class="codeph nolang">true</samp>, the connected app issues a new
                refresh token each time the OAuth refresh token flow is invoked. The
                old refresh token is automatically invalidated. If a user tries to
                use a previous refresh token that’s been invalidated, the current
                refresh token and its associated access tokens get deleted. If set
                to <samp class="codeph nolang">false</samp>, the refresh token can
                be used to obtain multiple access tokens.<p class="p">This field is available
                  in API version 60.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isSecretRequiredForRefreshToken</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">If set to <samp class="codeph nolang">true</samp> (default),
                the app’s client secret is required in the authorization request of
                a refresh token and hybrid refresh token flow. If set to <samp class="codeph nolang">false</samp> and an app sends the client
                secret in the authorization request, Salesforce still validates it.
                <p class="p">Select this option for web-server based apps that can protect
                  client secrets. For apps that can’t protect client secrets, such
                  as mobile apps or apps installed on a user’s computer, we
                  recommend against selecting this option. Available in API
                  version 51.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isSecretRequiredForTokenExchange</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">If set to <samp class="codeph nolang">true</samp>, the connected app must include
                its consumer secret (<samp class="codeph nolang">client_secret</samp>) in the token request during the OAuth
                2.0 token exchange flow. For security, set this field to <samp class="codeph nolang">true</samp> only if your app has a private
                client backend where it can keep the secret safe. For public client
                apps, such as single-page apps and mobile apps, set this field to
                <samp class="codeph nolang">false</samp> and don’t include the
                consumer secret.<p class="p">This field is available in API version 60.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">isTokenExchangeEnabled</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">boolean</td>

              <td class="entry" headers="d262374e899" data-title="Description">If set to <samp class="codeph nolang">true</samp>, the connected app can use the
                OAuth 2.0 token exchange flow to exchange tokens from an external
                identity provider for Salesforce tokens.<p class="p">This field is available
                  in API version 60.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">oauthClientCredentialUser</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e899" data-title="Description">The execution user for the OAuth 2.0 client credentials flow.
                Salesforce returns access tokens on behalf of this user. This user
                must have the API Only permission.<p class="p">To use this field, set
                  <span class="keyword parmname">isClientCredentialEnabled</span> to <samp class="codeph nolang">true</samp> and specify a
                  <span class="keyword parmname">consumerKey</span>.
                </p>
                <p class="p">Available in API
                  version 56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">scopes</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">ConnectedAppOauthAccessScope (enumeration of type
                string)[]</td>

              <td class="entry" headers="d262374e899" data-title="Description">The permissions given by the user running the connected app. When
                deploying metadata, valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Basic</samp>—Allows
                    access to your identity URL service (the same behavior as
                    deploying <samp class="codeph nolang">Address</samp>,
                    <samp class="codeph nolang">Email</samp>, <samp class="codeph nolang">Phone</samp>, and <samp class="codeph nolang">Profile</samp>).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Api</samp>—Allows
                    access to the logged-in user's account over the APIs.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Web</samp>—Allows use
                    of the <samp class="codeph nolang">access_token</samp> on
                    the web. This usage also includes <samp class="codeph nolang">visualforce</samp>, allowing
                    access to Visualforce pages.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Full</samp>—Allows
                    access to all data accessible by the logged-in user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Chatter</samp>—Allows
                    access to only the Connect REST API resources.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomApplications</samp>—Provides access to
                    custom applications, such as those using Visualforce.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RefreshToken</samp>—Allows a refresh token to be
                    returned if you’re eligible to receive one (the same
                    behavior as deploying <samp class="codeph nolang">OfflineAccess</samp>).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpenID</samp>—Allows
                    access to the logged-in user's unique identifier for OpenID
                    Connect apps.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Profile</samp>—Allows
                    access to the logged-in user's profile (the same behavior as
                    deploying <samp class="codeph nolang">Basic</samp>).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Email</samp>—Allows
                    access to the logged-in user's email address (the same
                    behavior as deploying <samp class="codeph nolang">Basic</samp>).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Address</samp>—Allows
                    access to the logged-in user's street address (the same
                    behavior as deploying <samp class="codeph nolang">Basic</samp>).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Phone</samp>—Allows
                    access to the logged-in user's phone number value (the same
                    behavior as deploying <samp class="codeph nolang">Basic</samp>).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OfflineAccess</samp>—Allows the app to interact
                    with the user's data while the user is offline and get a
                    refresh token (the same behavior as deploying <samp class="codeph nolang">RefreshToken</samp>).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomPermissions</samp>—<span class="ph" id="scope_custom_perm_desc"><a name="scope_custom_perm_desc"><!-- --></a>Allows access to the custom
                      permissions in an organization associated with the
                      connected app and shows whether the current user has
                      each permission enabled.</span>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Wave</samp>—Allows
                    access to the Analytics REST API resources. Available in API
                    version 35.0 and later.
                  </li>

                  <li class="li"><span class="ph" id="eclair_scope"><a name="eclair_scope"><!-- --></a><samp class="codeph nolang">Eclair</samp>—Allows access to the
                      Analytics REST API Charts Geodata resource. Available in
                      API version 35.0 and later.</span></li>

                  <li class="li"><span class="ph" id="pardot_scope"><a name="pardot_scope"><!-- --></a><samp class="codeph nolang">Pardot</samp>—Allows access to Pardot API
                      services on behalf of the user. The full extent of
                      accessible services is managed by the Pardot account.
                      Available in API version 49.0 and later.</span></li>

                  <li class="li"><span class="ph" id="lightning_scope"><a name="lightning_scope"><!-- --></a><samp class="codeph nolang">Lightning</samp>—Allows hybrid apps to
                      directly obtain Lightning child sessions through the
                      OAuth 2.0 hybrid app token flow and hybrid app refresh
                      token flow. Available in API version 51.0 and
                      later.</span></li>

                  <li class="li"><span class="ph" id="content_scope"><a name="content_scope"><!-- --></a><samp class="codeph nolang">Content</samp>—Allows hybrid apps to
                      directly obtain content child sessions through the OAuth
                      2.0 hybrid app token flow and hybrid app refresh token
                      flow. Available in API version 51.0 and later.</span></li>

                  <li class="li"><span class="ph" id="CDPIngest"><a name="CDPIngest"><!-- --></a><samp class="codeph nolang">CDPIngest</samp>—Allows access to Data
                      Cloud ingest API services. Customers use these API
                      services to upload and maintain external datasets in the
                      <span class="ph">Data 360</span>. Available in API version 52.0 and
                      later.</span></li>

                  <li class="li"><span class="ph" id="chatbot_scope"><a name="chatbot_scope"><!-- --></a><samp class="codeph nolang">Chatbot</samp>—Allows access to Einstein
                      Bot API services. Available in API version 54.0 and
                      later.</span></li>

                  <li class="li">
                    <samp class="codeph nolang">ForgotPassword</samp>—Allows
                    access to Headless Forgot Password API. Assign to an
                    internal integration user to get an access token for
                    authenticated requests to this API. Available in API version
                    57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UserRegistration</samp>—Allows
                    access to Headless Registration API. Assign to an internal
                    integration user to get an access token for authenticated
                    requests to this API. Available in API version 58.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PwdlessLogin</samp>—Allows
                    access to Headless Passwordless Login API. Assign to an
                    internal integration user to get an access token for
                    authenticated requests to this API. Available in API version
                    59.0 and later.
                  </li>

                </ul>
                <p class="p">When retrieving metadata, valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Api</samp>—Allows
                    access to the logged-in user’s account over the APIs.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Basic</samp>—Allows
                    access to the user’s identity URL service, and includes
                    <samp class="codeph nolang">Address</samp>, <samp class="codeph nolang">Email</samp>, <samp class="codeph nolang">Phone</samp>, and <samp class="codeph nolang">Profile</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Chatter</samp>—Allows
                    access to only the Connect REST API resources.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomApplications</samp>—Allows access to custom
                    applications, such as those using Visualforce.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Full</samp>—Allows
                    access to all data accessible by the logged-in user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpenID</samp>—Allows
                    access to the logged-in user's unique identifier for OpenID
                    Connect apps.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CDPIngest</samp>—Allows access to Data
                    Cloud ingest API services. Customers use these API
                    services to upload and maintain external datasets in the
                    <span class="ph">Data 360</span>. Available in API version 52.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Pardot</samp>—Allows access to Pardot API
                    services on behalf of the user. The full extent of
                    accessible services is managed by the Pardot account.
                    Available in API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Lightning</samp>—Allows hybrid apps to
                    directly obtain Lightning child sessions through the
                    OAuth 2.0 hybrid app token flow and hybrid app refresh
                    token flow. Available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Content</samp>—Allows hybrid apps to
                    directly obtain content child sessions through the OAuth
                    2.0 hybrid app token flow and hybrid app refresh token
                    flow. Available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RefreshToken</samp>—Allows a refresh token to be
                    returned if you’re eligible to receive one and is synonymous
                    with allowing <samp class="codeph nolang">OfflineAccess</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Wave</samp>—Allows
                    access to the Analytics REST API resources. Available in API
                    version 35.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Eclair</samp>—Allows access to the
                    Analytics REST API Charts Geodata resource. Available in
                    API version 35.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Web</samp>—Allows usage
                    of the <samp class="codeph nolang">access_token</samp> on
                    the web. This usage also includes <samp class="codeph nolang">visualforce</samp>, allowing
                    access to Visualforce pages.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Chatbot</samp>—Allows access to Einstein
                    Bot API services. Available in API version 54.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ForgotPassword</samp>—Allows
                    access to Headless Forgot Password API. Assign to an
                    internal integration user to get an access token for
                    authenticated requests to this API. Available in API version
                    57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UserRegistration</samp>—Allows
                    access to Headless Registration API. Assign to an internal
                    integration user to get an access token for authenticated
                    requests to this API. Available in API version 58.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PwdlessLogin</samp>—Allows
                    access to Headless Passwordless Login API. Assign to an
                    internal integration user to get an access token for
                    authenticated requests to this API. Available in API version
                    59.0 and later.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e893" data-title="Field Name"><span class="keyword parmname">singleLogoutUrl</span></td>

              <td class="entry" headers="d262374e896" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e899" data-title="Description">The single logout endpoint. This URL is the endpoint where
                Salesforce sends a logout request when users log out of
                Salesforce.</td>

            </tr>

          </tbody>

        </table>

## ConnectedAppOauthAssetToken

Specifies an OAuth asset token configuration for the connected app OAuth settings. Available in API version 49.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assetAudiences | string | Required. The audience claim associated with the asset token payload. This claim identifies who the JWT is intended for. Value is an array of case-sensitive strings, each containing a StringOrURI value. An audience is specified for each intended consumer of the asset token. |
| assetIncludeAttributes | boolean | Required. If set to true (default), custom attributes associated with the connected app are included in the asset token payload. If set to false, these attributes aren’t included. |
| assetIncludeCustomPerms | boolean | Required. If set to true (default), custom permissions associated with the connected app are included in the asset token payload. If set to false, these permissions aren’t included. |
| assetSigningCertId | string | Required. The ID of the JWT certificate’s signing secret. The certificate size can’t exceed 4 KB. If it does, try using a DER encoded file to reduce the size. |
| assetValidityPeriod | int | Required. The asset token’s validity period. The validity must be the expiration time of the assertion within 3 minutes, expressed as the number of seconds from 1970-01-01T0:0:0Z measured in UTC. |

## ConnectedAppOauthIdToken

Specifies the ID token configuration for the connected app OAuth settings. Available in API version 43.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| idTokenAudience | string | The audiences that this ID token is intended for. The value is an array of case-sensitive strings. If no audiences are specified, the OAuth 2.0 client\_id of the relying party is returned as the default audience. Otherwise, the other audiences are returned with the client\_id in the aud value. |
| idTokenIncludeAttributes | boolean | Indicates whether attributes are included in the ID token. |
| idTokenIncludeCustomPerms | boolean | Indicates whether custom permissions are included in the ID token. |
| idTokenIncludeStandardClaims | boolean | Indicates whether standard claims about the authentication event are included in the ID token. |
| idTokenValidity | int | The length of time that the ID token is valid for after it’s issued. The value can be from 1 to 720 minutes. The default is 2 minutes. |

## ConnectedAppOauthPolicy

Specifies OAuth access policies for the connected app. Available in API version 49.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d262374e1894">Field Name</th>

              <th class="featureTableHeader  " id="d262374e1897">Field Type</th>

              <th class="featureTableHeader  " id="d262374e1900">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d262374e1894" data-title="Field Name"><span class="keyword parmname">ipRelaxation</span></td>

              <td class="entry" headers="d262374e1897" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e1900" data-title="Description">Required. Specifies whether a user’s access to the connected app is restricted by IP ranges. Valid options are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ENFORCE</samp> (default)—Enforces the IP restrictions configured for the org, such as the IP ranges assigned to a user
                    profile.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">BYPASS_2FACTOR</samp>—Allows a user running the app to bypass the org’s IP restrictions when either of these conditions is true.<ul class="ul bulletList">
                      <li class="li">The app has a list of allowed IP ranges and is using the web server OAuth authorization flow. Requests coming from only these IPs are allowed.</li>

                      <li class="li">The app doesn’t have a list of allowed IP ranges, but it uses the web server authentication flow. And the user successfully completes identity
                        verification if accessing Salesforce from a new browser or device.</li>

                    </ul>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">BYPASS</samp>—Allows a user to run this app without org IP restrictions.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ENFORCE_RELAXREFRESH</samp>—Enforces the IP restrictions configured for the org, such as the IP ranges assigned to a user
                    profile. However, this option bypasses these restrictions when the connected app uses refresh tokens to get access tokens.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e1894" data-title="Field Name"><span class="keyword parmname">refreshTokenPolicy</span></td>

              <td class="entry" headers="d262374e1897" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e1900" data-title="Description">Required. Specifies how long a refresh token is valid for. <p class="p">If refresh tokens are provided, users can continue to access the OAuth-enabled connected app without
                  having to reauthorize when the access token expires, as defined by the session timeout value. The connected app exchanges the refresh token with an access token to
                  start a new session. The Refresh Token policy is evaluated only during usage of the issued refresh token and doesn’t affect a user’s current session. Refresh tokens
                  are required only when a user’s session has expired or isn’t available. For example, you set a refresh token policy to expire the token after 1 hour. If a user uses
                  the app for 2 hours, the user isn’t forced to reauthenticate after 1 hour. However, the user is required to authenticate again when the session expires and the
                  client attempts to exchange its refresh token for a new session.</p>

                <p class="p">Valid options are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">zero</samp>—The refresh token is invalid immediately. The user can use the current session (access token) already
                    issued, but can’t obtain a new session when the access token expires.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">infinite</samp>—The refresh token is used indefinitely, unless revoked by the user or Salesforce admin. Default
                    setting.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">specific_lifetime:<var class="keyword varname">number</var>:<var class="keyword varname">HOURS, DAYS, MONTHS</var></samp>—The refresh token is valid
                    for a fixed amount of time. For example, if the policy states <samp class="codeph nolang">specific_lifetime:1:DAYS</samp>, the user can obtain new
                    sessions for only 24 hours.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">specific_inactivity:<var class="keyword varname">number</var>:<var class="keyword varname">HOURS, DAYS, MONTHS</var></samp>—The refresh token is valid
                    as long as it’s been used within the specified amount of time. For example, if set to <samp class="codeph nolang">specific_inactivity:7:DAYS</samp>, and
                    the refresh token isn’t exchanged for a new session within seven days, the next attempt to use the token fails. The expired token can’t generate new
                    sessions. If the refresh token is exchanged within seven days, the token is valid for another seven days. The monitoring period of inactivity also
                    resets.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e1894" data-title="Field Name"><span class="keyword parmname">singleLogoutUrl</span></td>

              <td class="entry" headers="d262374e1897" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e1900" data-title="Description">If single logout is enabled, specify the single logout URL. Salesforce sends logout requests to this URL when users log out of Salesforce. The single logout URL must
                be an absolute URL starting with <samp class="ph systemoutput">https://</samp>.</td>

            </tr>

          </tbody>

        </table>

## ConnectedAppSamlConfig

Specifies how an app uses single sign-on.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d262374e2050">Field Name</th>

              <th class="featureTableHeader  " id="d262374e2053">Field Type</th>

              <th class="featureTableHeader  " id="d262374e2056">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">acsUrl</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e2056" data-title="Description">Required. The assertion consumer service URL from the service provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">certificate</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e2056" data-title="Description">The PEM-encoded certificate string, if the app uses a certificate.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">encryptionCertificate</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e2056" data-title="Description">
                <span class="ph" id="encryption_cert_desc"><a name="encryption_cert_desc"><!-- --></a>The name of the certificate to use for encrypting SAML assertions to the service provider. This certificate is saved in the
                  organization's Certificate and Key Management list.</span> Available in API version 30.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">encryptionType</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">
                <p class="p">SamlEncryptionType</p>
                (enumeration of type string)
              </td>

              <td class="entry" headers="d262374e2056" data-title="Description">
                <span class="ph" id="encryptType_desc"><a name="encryptType_desc"><!-- --></a>When Salesforce is the identity provider, the SAML
                  configuration can specify the encryption method used for
                  encrypting SAML assertions to the service provider. The service
                  provider detects the encryption method in the SAML assertion for
                  decryption. Valid values are:</span><a name="encryptType_desc_list"><!-- --></a>
                <ul class="ul bulletList" id="encryptType_desc_list">
                  <li class="li">
                    <samp class="codeph nolang">AES_128</samp>—128–bit key
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AES_256</samp>—256–bit key
                  </li>

                </ul>
                Available in API version 30.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">entityUrl</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e2056" data-title="Description">Required. The entity ID from your service provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">issuer</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e2056" data-title="Description">
                <span class="ph" id="issuer_desc"><a name="issuer_desc"><!-- --></a>A URI that sends the SAML response. A service provider can use this URI to determine which identity provider sent the response.</span> Available
                in API version 29.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">samlIdpSLOBindingEnum</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">SamlIdpSLOBinding (enumeration of type string)</td>

              <td class="entry" headers="d262374e2056" data-title="Description">The SAML HTTP binding type from the service provider used for single logout. Available in API version 40.0 and later. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">PostBinding</samp></li>

                  <li class="li"><samp class="codeph nolang">RedirectBinding</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">samlNameIdFormat</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">SamlNameIdFormatType (enumeration of type string)</td>

              <td class="entry" headers="d262374e2056" data-title="Description">
                <span class="ph" id="samlNameIdFormat_desc"><a name="samlNameIdFormat_desc"><!-- --></a>Indicates the format the service provider (SP) requires for the user's single sign-on identifier.</span> Available in API version
                29.0 and later. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Unspecified</samp> (default)—No format given.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EmailAddress</samp>—Used if the subject type is the user's name or a federation ID (an ID internal to the SP).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Persistent</samp>—Used with the user ID and persistent ID subject types.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Transient</samp>—Used when the subject type is a custom attribute and can change every time the user logs in.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">samlSigningAlgoType</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">SamlSigningAlgoType (enumeration of type string)</td>

              <td class="entry" headers="d262374e2056" data-title="Description">Indicates the signing algorithm applied to SAML requests and responses when Salesforce is the identity provider. The selected signing algorithm is applied to both
                single sign-on and single logout responses from your org. Available in API version 50.0 and later. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">SHA1</samp></li>

                  <li class="li"><samp class="codeph nolang">SHA256</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">samlSloUrl</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e2056" data-title="Description">The SAML single-logout endpoint of the connected app service provider (SP). This endpoint is where SAML LogoutRequests and LogoutResponses are sent when users log
                out of Salesforce. The SP provides this endpoint. Available in API version 40.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">samlSubjectCustomAttr</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e2056" data-title="Description">
                <span class="ph" id="samlSubjectCustomAttr_desc"><a name="samlSubjectCustomAttr_desc"><!-- --></a>If the <span class="keyword parmname">samlSubjectType</span> is <samp class="codeph nolang">CustomAttr</samp>, include that custom value here;
                  otherwise, leave empty.</span> Available in API version 29.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2050" data-title="Field Name"><span class="keyword parmname">samlSubjectType</span></td>

              <td class="entry" headers="d262374e2053" data-title="Field Type">SamlSubjectType (enumeration of type string)</td>

              <td class="entry" headers="d262374e2056" data-title="Description">Required. The single sign-on identifier for the user. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Username</samp>—The user's Salesforce name.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FederationId</samp>—The user's identifier at the service provider. Get this value from the service provider.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UserId</samp>—The user's 15-character
                    Salesforce identifier.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PersistentID</samp>—A persistent opaque identifier that is specific to the identity provider and a service provider.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomAttr</samp>—The identifier is taken from a custom field value in <span class="keyword parmname">samlSubjectCustomAttr</span>.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ConnectedAppSessionPolicy

Specifies the configuration options for a connected app’s session policies. Use these policies to define how long a user’s session can last before reauthenticating, to block user access to the connected app, or to require multi-factor authentication (MFA) to access the app. Available in API version 49.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d262374e2350">Field Name</th>

              <th class="featureTableHeader  " id="d262374e2353">Field Type</th>

              <th class="featureTableHeader  " id="d262374e2356">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d262374e2350" data-title="Field Name"><span class="keyword parmname">policyAction</span></td>

              <td class="entry" headers="d262374e2353" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e2356" data-title="Description">If the High Assurance session security level is applied to the connected app, specify associated high assurance action. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Block</samp>—Makes the connected app inaccessible to your org’s users. Blocking an app ends all current user sessions with
                    the connected app and prevents all new sessions.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RaiseSessionLevel</samp>—Requires users to verify their identity with multi-factor authentication when they log in to the
                    connected app. This setting applies to authorization flows that include a user approval step for API logins. These flows are the OAuth 2.0 refresh token flow,
                    web server flow, and user-agent flow. All other flows, such as the JSON Web Token (JWT) bearer token flow, don’t include a user approval step. For flows without
                    a user approval step, API logins with the High Assurance session security level are blocked.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2350" data-title="Field Name"><span class="keyword parmname">sessionLevel</span></td>

              <td class="entry" headers="d262374e2353" data-title="Field Type">string</td>

              <td class="entry" headers="d262374e2356" data-title="Description">Applies the High Assurance session security level to the connected app. This session level requires users to verify their identity with multi-factor authentication
                when they log in to the connected app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d262374e2350" data-title="Field Name"><span class="keyword parmname">sessionTimeout</span></td>

              <td class="entry" headers="d262374e2353" data-title="Field Type">int</td>

              <td class="entry" headers="d262374e2356" data-title="Description">The length of time the connected app’s session lasts. If you don’t set a value, Salesforce uses the timeout value in the connected app user’s profile. If the user’s
                profile doesn’t specify a timeout value, Salesforce uses the timeout value in the org’s Session Settings.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ConnectedApp component.

<?xml version="1.0" encoding="UTF-8"?>
<ConnectedApp xmlns="http://soap.sforce.com/2006/04/metadata">
    <attributes\>
        <formula\>$Api.Enterprise\_Server\_URL\_100</formula\>
        <key\>test</key\>
    </attributes\>
    <attributes\>
        <formula\>$Api.Partner\_Server\_URL\_60</formula\>
        <key\>test1</key\>
    </attributes\>
   <canvasConfig\>
        <accessMethod\>Get</accessMethod\>
        <canvasUrl\>https://salesforce.com</canvasUrl\>
        <lifecycleClass\>MyCanvasListener</lifecycleClass\>
        <locations\>Chatter</locations\>
        <locations\>Visualforce</locations\>
        <locations\>Aura</locations\>
        <locations\>Publisher</locations\>
        <locations\>ChatterFeed</locations\>
        <locations\>OpenCTI</locations\>
        <locations\>MobileNav</locations\>
        <locations\>PageLayout</locations\>
        <options\>HideShare</options\>
        <options\>HideHeader</options\>
        <options\>PersonalEnabled</options\>
        <samlInitiationMethod\>None</samlInitiationMethod\>
    </canvasConfig\>
    <canvas\>
    	<locationOptions\>NONE</locationOptions\>
    	<samlInitiationMethod\>None</samlInitiationMethod\>
    	<accessMethod\>Get</accessMethod\>
    	<canvasOptions\>PE</canvasOptions\>
    	<lifecycleClass\>MyCanvasListener</lifecycleClass\>
    	<canvasUrl\>https://salesforce.com</canvasUrl\>
	</canvas\>
    <contactEmail\>example@salesforce.com</contactEmail\>
    <contactPhone\>1231231234</contactPhone\>
    <description\>Test App</description\>
    <iconUrl\>https://c1.sfdcstatic.com/content/dam/sfdc-docs/www/logos/salesforce-logo-cloud.png</iconUrl\>
    <infoUrl\>https://c1.sfdcstatic.com/content/dam/sfdc-docs/www/logos/salesforce-logo-cloud.png</infoUrl\>
    <startUrl\>https://www.salesforce.com</startUrl\>
    <ipRanges\>
        <end\>000.0.0.1</end\>
        <start\>000.0.0.2</start\>
	<description\>Test</description\>
    </ipRanges\>
    <ipRanges\>
        <end\>000.0.0.1</end\>
        <start\>000.0.0.2</start\>
	<description\>Test1</description\>
    </ipRanges\>
    <label\>TestApp</label\>
    <logoUrl\>https://c1.sfdcstatic.com/content/dam/sfdc-docs/www/logos/salesforce-logo-cloud.png</logoUrl\>
    <profileName\>Test</profileName\>
    <permissionSetName\>TestPermission</permissionSetName\>
    <mobileStartUrl\>http://www.mobile.com</mobileStartUrl\>
    <mobileAppConfig\>
        <applicationBinaryFile\></applicationBinaryFile\>
        <applicationBinaryFileName\>test</applicationBinaryFileName\>
        <applicationBundleIdentifier\>testtest</applicationBundleIdentifier\>
        <applicationIconFileName\>test</applicationIconFileName\>
	<applicationIconFile\>test</applicationIconFile\>
	<applicationFileLength\>5</applicationFileLength\>
        <applicationInstallUrl\>https://salesforce.com</applicationInstallUrl\>
        <devicePlatform\>ios</devicePlatform\>
        <deviceType\>minitablet</deviceType\>
        <minimumOsVersion\>2</minimumOsVersion\>
        <privateApp\>true</privateApp\>
        <version\>2</version\>
    </mobileAppConfig\>
    <oauthConfig\>
        <assetTokenConfig\>
            <assetAudiences\>http://asset.audience.com</assetAudiences\>
            <assetIncludeAttributes\>true</assetIncludeAttributes\>
            <assetIncludeCustomPerms\>true</assetIncludeCustomPerms\>
            <assetSigningCertId\>${cert.id}</assetSigningCertId\>
            <assetValidityPeriod\>1440</assetValidityPeriod\>
        </assetTokenConfig\>
        <callbackUrl\>https://www.callback.com</callbackUrl\>
        <!--  NOTE, TEST.orgId will get replaced with the org ID of the context org, so we will have a unique consumer key in every scratch org.  -->
        <consumerKey\>3MVG9AOp4kbriZOcnmoLmTrguy9ryzcLbBjoNY...${TEST.orgId}</consumerKey\>
		<consumerSecret\>3MVG9AOp4k...</consumerSecret\>
		<certificate\>3MVG9AOp4kbriZOInmoLmTrguy9ryzcLbBjoNY...</certificate\>
        <scopes\>Basic</scopes\>
        <scopes\>Chatter</scopes\>
        <scopes\>OpenID</scopes\>
        <scopes\>CustomPermissions</scopes\>
		<singleLogoutUrl\>https://www.logout.com</singleLogoutUrl\>
        <isAdminApproved\>false</isAdminApproved\>
        <isConsumerSecretOptional\>false</isConsumerSecretOptional\>
        <isIntrospectAllTokens\>false</isIntrospectAllTokens\>
		<idTokenConfig\>
			<idTokenAudience\>https://idtoken.audience.com</idTokenAudience\>
			<idTokenIncludeAttributes\>true</idTokenIncludeAttributes\>
			<idTokenIncludeCustomPerms\>true</idTokenIncludeCustomPerms\>
			<idTokenIncludeStandardClaims\>true</idTokenIncludeStandardClaims\>
			<idTokenValidity\>20</idTokenValidity\>
		</idTokenConfig\>
    </oauthConfig\>
    <oauthPolicy\>
        <ipRelaxation\>ENFORCE</ipRelaxation\>
        <refreshTokenPolicy\>infinite</refreshTokenPolicy\>
        <singleLogoutUrl\>https://www.logout.com</singleLogoutUrl\>
    </oauthPolicy\>
    <plugin\>ConnectedAppPluginTest</plugin\>
    <pluginExecutionUser\>testuser@salesforce.com</pluginExecutionUser\>
    <samlConfig\>
        <acsUrl\>http://www.acs.com</acsUrl\>
        <encryptionType\>AES\_128</encryptionType\>
	<encryptionCertificate\>3MVG9AOp4kbriZOInmoLmTrguy9ryzcLbBjoNY...</encryptionCertificate\>
	<certificate\>3MVG9AOp4kbriZOInmoLmTrguy9ryzcLbBjoNY...</certificate\>
	<samlSubjectCustomAttr\>test</samlSubjectCustomAttr\>
        <entityUrl\>http://www.entity.com</entityUrl\>
        <issuer\>https://salesforce.com</issuer\>
        <samlIdpSLOBindingEnum\>RedirectBinding</samlIdpSLOBindingEnum\>
        <samlNameIdFormat\>Unspecified</samlNameIdFormat\>
        <samlSloUrl\>https://www.salesforce.com</samlSloUrl\>
        <samlSubjectType\>CustomAttribute</samlSubjectType\>
    </samlConfig\>
    <sessionPolicy\>
        <policyAction\>RaiseSessionLevel</policyAction\>
        <sessionLevel\>HIGH\_ASSURANCE</sessionLevel\>
        <sessionTimeout\>720</sessionTimeout\>
    </sessionPolicy\>
</ConnectedApp\>

You can enter multiple callback URL values. At run time, Salesforce validates the callback URL specified by the app by matching it with one of the values. You must separate each callback URL with line breaks. To enter a new line programmatically, use the \\r line break character.

Here's an example of a ConnectedApp component with multiple callback URLs.

<?xml version="1.0" encoding="UTF-8"?>
<ConnectedApp xmlns="http://soap.sforce.com/2006/04/metadata">
 <contactEmail\>example@salesforce.com</contactEmail\>
 <label\>MyConnectedApp</label\>
 <oauthConfig\>
 <callbackUrl\>https://example.com/callback1
https://example.com/callback2
https://example.com/callback3</callbackUrl\>
 <consumerKey\>3MVG9AOp4kbriZOcnmoLmTrguy9ryzcLbBjoNY...</consumerKey\>
 <isAdminApproved\>false</isAdminApproved\>
 <isConsumerSecretOptional\>false</isConsumerSecretOptional\>
 <isIntrospectAllTokens\>false</isIntrospectAllTokens\>
 <isSecretRequiredForRefreshToken\>true</isSecretRequiredForRefreshToken\>
 <scopes\>Full</scopes\>
 <scopes\>RefreshToken</scopes\>
 </oauthConfig\>
 <oauthPolicy\>
 <ipRelaxation\>ENFORCE</ipRelaxation\>
 <refreshTokenPolicy\>infinite</refreshTokenPolicy\>
 </oauthPolicy\>
</ConnectedApp\>

The following is an example package manifest used to deploy or retrieve the ConnectedApp metadata for an organization.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>PortalTestApp</members\>
        <name\>ConnectedApp</name\>
    </types\>
    <version\>29.0</version\>
</Package\>

## Usage

If you're constructing a SAML-enabled connected app using Metadata API, and must set the IdP-Initiated Login URL for your service provider, you have two options:

You can use the service provider app ID with the app parameter in the following format. This value is displayed in the Salesforce user interface. From Setup, enter Connected Apps in the Quick Find box, then select **Connected Apps**, then click the name of the connected app to see its detail page.

https://<Salesforce\_base\_URL>/idp/login?app=<app\_id>

Or, if you're configuring the connected app using Metadata API only, you can use the apiName parameter of the service provider app in the following format. The apiName parameter is the fullName inherited from the Metadata type.

https://<Salesforce\_base\_URL>/idp/login?apiName=<fullName>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=97eb3da73e411e8722e3162a073908a035b08c239b2b45249b16fd51cd6f991e url=/legacydeveloper/current/en-us/api_meta/meta_connectedappsettings.md -->

# ConnectedAppSettings

Represents settings for connected apps. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

ConnectedAppSettings values are stored in a single file named ConnectedApp.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ConnectedAppSettings components are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableAdminApprovedAppsOnly | boolean | If false (default), any connected app can call the Salesforce API. If true, only apps that have been approved or installed by the admin can call the Salesforce API. To access this field, you must contact Salesforce Customer Support to enable API Access Control. |
| enableAdminApprovedAppsOnlyForExternalUser | boolean | If false (default), authenticated customers or partners can use any unblocked connected app to access the Salesforce API. If true, authenticated customers and partners can’t access the Salesforce API unless they use a connected app that is installed in the org and unblocked. Install and unblock connected apps on the Connected Apps OAuth Usage page. To access this field, you must contact Salesforce Customer Support to enable API Access Control. |
| enableSkipUserProvisioningWizardWelcomePage | boolean | If false (default), the User Provisioning Wizard Welcome page shows up when you access the wizard. To skip the welcome page in the future, you can select **Do not show me this next time**. If true, the Welcome page doesn’t show up the next time that you access the wizard. |

## Declarative Metadata Sample Definition

The following is an example of a ConnectedAppSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ConnectedAppSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAdminApprovedAppsOnly\>false</enableAdminApprovedAppsOnly\>
    <enableAdminApprovedAppsOnlyForExternalUser\>false</enableAdminApprovedAppsOnlyForExternalUser\>
    <enableSkipUserProvisioningWizardWelcomePage\>true</enableSkipUserProvisioningWizardWelcomePage\>
</ConnectedAppSettings\>

The following is an example package.xml manifest that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ConnectedApp</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</Package\>

<!-- document id=a9113481186fa94cbc746d4f7ff7f48a68087415f50bf0f4db845e6a299de1b0 url=/legacydeveloper/current/en-us/api_meta/meta_contentasset.md -->

# ContentAsset

Represents the metadata for creating an asset file. Asset files enable a Salesforce file to be used for org setup and configuration purposes. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

ContentAsset components have the suffix .asset and are stored in the contentassets folder.

## Version

ContentAsset components are available in API version 38.0 and later.

## Special Access Rules

The system prevents metadata retrieval if the total size of the asset’s file content exceeds 30 MB. All pre-existing limits for packaging apply to asset files.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d270256e102">Field Name</th>

              <th class="featureTableHeader  " id="d270256e105">Field Type</th>

              <th class="featureTableHeader  " id="d270256e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d270256e102" data-title="Field Name"><span class="keyword parmname">format</span></td>

              <td class="entry" headers="d270256e105" data-title="Field Type">ContentAssetFormat
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d270256e108" data-title="Description">Describes the format of the asset file. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Original</samp>—A single asset file
                    version.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ZippedVersions</samp>—Contains multiple versions
                    of the asset file.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d270256e102" data-title="Field Name"><span class="keyword parmname">isVisibleByExternalUsers</span></td>

              <td class="entry" headers="d270256e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d270256e108" data-title="Description">Indicates whether unauthenticated users can see the asset file (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If not specified, the default value is <samp class="codeph nolang">false</samp>. This field is available in API version 44.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d270256e102" data-title="Field Name"><span class="keyword parmname">language</span></td>

              <td class="entry" headers="d270256e105" data-title="Field Type">string</td>

              <td class="entry" headers="d270256e108" data-title="Description">Required. The language of the asset file label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d270256e102" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d270256e105" data-title="Field Type">string</td>

              <td class="entry" headers="d270256e108" data-title="Description">Required. The label for the asset file record, which displays in Setup.</td>

            </tr>

            <tr>
              <td class="entry" headers="d270256e102" data-title="Field Name"><span class="keyword parmname">originNetwork</span></td>

              <td class="entry" headers="d270256e105" data-title="Field Type">string</td>

              <td class="entry" headers="d270256e108" data-title="Description">For deploys, the name of the Experience Cloud site the file is assigned upon
                creation. For retrievals, the name of the Experience Cloud site the file is assigned
                to appears in the field value. If <samp class="codeph nolang">null</samp>, the
                file wasn’t assigned to an Experience Cloud site.</td>

            </tr>

            <tr>
              <td class="entry" headers="d270256e102" data-title="Field Name"><span class="keyword parmname">relationships</span></td>

              <td class="entry" headers="d270256e105" data-title="Field Type"><a class="xref" href="#ContentAssetRelationships">ContentAssetRelationships</a></td>

              <td class="entry" headers="d270256e108" data-title="Description">The list of ContentAssetLinks that describe whether the asset file can be
                shared with the org.</td>

            </tr>

            <tr>
              <td class="entry" headers="d270256e102" data-title="Field Name"><span class="keyword parmname">versions</span></td>

              <td class="entry" headers="d270256e105" data-title="Field Type"><a class="xref" href="#ContentAssetVersions">ContentAssetVersions</a></td>

              <td class="entry" headers="d270256e108" data-title="Description">Required. Captures basic information about the file version included the asset
                metadata. Typically the file has only one version.</td>

            </tr>

          </tbody>

        </table>

## ContentAssetRelationships

Represents the relationships between an asset file and the locations it's linked with.

| Field Name | Field Type | Description |
| --- | --- | --- |
| emailTemplate | ContentAsset\[\] | An array of email templates the content asset is related to. This field is available in API version 51.0 and later. |
| insightsApplication | ContentAsset\[\] | An array of the insights applications that use the content asset. This field is available in API version 39.0 and later. |
| network | ContentAsset\[\] | An array of networks that use the content asset. This field is available in API version 39.0 and later. |
| organization | ContentAsset\[\] | Stores information about sharing the asset file with the org. Maps to ContentDocumentLink. This field is available in API version 39.0 and later. |
| workspace | ContentAsset\[\] | An array of workspaces and libraries that own or share the content asset. This field is available in API version 39.0 and later. |

## ContentAssetLink

Represents a relationship link for an asset file, and includes details about the level of access for the link.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d270256e382">Field Name</th>

              <th class="featureTableHeader  " id="d270256e385">Field Type</th>

              <th class="featureTableHeader  " id="d270256e388">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d270256e382" data-title="Field Name"><span class="keyword parmname">access</span></td>

              <td class="entry" headers="d270256e385" data-title="Field Type">ContentAssetAccess
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d270256e388" data-title="Description">Required. The permission granted to the user of the shared file, determined by
                the permission the user already has. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">VIEWER</samp></li>

                  <li class="li"><samp class="codeph nolang">COLLABORATOR</samp></li>

                  <li class="li"><samp class="codeph nolang">INFERRED</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d270256e382" data-title="Field Name"><span class="keyword parmname">isManagingWorkspace</span></td>

              <td class="entry" headers="d270256e385" data-title="Field Type">boolean</td>

              <td class="entry" headers="d270256e388" data-title="Description">Indicates whether the content asset resides in the workspace or not. When
                <samp class="codeph nolang">true</samp>, the content asset resides in the
                workspace. If not specified, the default value is <samp class="codeph nolang">false</samp>. This field is available in API version 39.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d270256e382" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d270256e385" data-title="Field Type">string</td>

              <td class="entry" headers="d270256e388" data-title="Description">Reserved for future use.</td>

            </tr>

          </tbody>

        </table>

## ContentAssetVersions

Represents information about all file versions included in the asset metadata.

| Field Name | Field Type | Description |
| --- | --- | --- |
| version | [ContentAssetVersion\[\]](#ContentAssetVersion) | A list of file versions for the asset. |

## ContentAssetVersion

Represents information about one file version included in the asset metadata.

| Field Name | Field Type | Description |
| --- | --- | --- |
| number | string | Required. The version number. This field is based on, or sets, the ContentVersion. |
| pathOnClient | string | Required. Describes the original filename of the file. This field maps to ContentVersion.PathOnClient. It provides the data for the ContentVersion Title field. |
| zipEntry | string | If the asset file has more than one version, format is ZippedVersions. In this case, zipEntry is the name of the file within the zip. If the asset file has only one version, this field is empty. |

## Declarative Metadata Sample Definition

The following is an example of a ContentAsset component.

<?xml version="1.0" encoding="UTF-8"?>
<ContentAsset xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>some asset</masterLabel\>
    <relationships\>
        <organization\>
            <access\>VIEWER</access\>
        </organization\>
    </relationships\>
    <versions\>
        <version\>
            <number\>1</number\>
            <pathOnClient\>some asset.txt</pathOnClient\>
        </version\>
    </versions\>
</ContentAsset\>

For assets that include just one version, the format field can be omitted or specified with the value as Original. File assets with more than one version have versions wrapped in a zip file.

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyAsset</members\>
        <name\>ContentAsset</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ef1927132f822f1301542a9347a9161f862b0a2bee118a7ea5dbaa8ef8afcae1 url=/legacydeveloper/current/en-us/api_meta/meta_contentsettings.md -->

# ContentSettings

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

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

ContentSettings values are stored in the contentsettings.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

ContentSettings components are available in API version 48.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableChatterFileLink | boolean | When true, allows users to share files via links. When set to false, users can’t use file sharing. Default is true. |
| enableCMSC2CConnections | boolean | When true, allows org to enable Salesforce CMS Cloud to Cloud Connections. |
| enableContent | boolean | When true, allows org to enable Content. |
| enableContentAutoAssign | boolean | When true, allows org to auto assign Content feature licenses to users. |
| enableContentDistForPortalUsers | boolean | When true, allows portal users to create Content Deliveries for managed files in a library. |
| enableContentDistPwOptionsBit1 | boolean | When true, allow using with ContentDistPasswordOptionsBit2 to set up one of three possible delivery security options. |
| enableContentDistPwOptionsBit2 | boolean | When true, allow using with ContentDistPasswordOptionsBit1 to set up one of three possible delivery security options. |
| enableContentDistribution | boolean | When true, allows the Content Delivery user permission to be enabled for users. Content deliveries let users create links to share files externally, with optional security settings. |
| enableContentSupportMultiLanguage | boolean | When true, enables content to support multiple languages. |
| enableContentWorkspaceAccess | boolean | When true, content libraries are visible in the API and UI for users who have read access to libraries, even if they don't have access to the original Salesforce CRM Content app. |
| enableDeleteFileInContentPacks | boolean | When true, enables an org preference that allows a file's owner to delete the file, which is included in one or more content packs. The default setting is based on the org. |
| enableFileShareSetByRecord | boolean | When true, files shared to records default to Set by Record. |
| enableFilesUsrShareNetRestricted | boolean | When true, files respect user sharing settings. Files shared with users with **SharedUsers** visibility are only accessible to users who are members of the Experience Cloud site the file was created in. |
| enableJPGPreviews | boolean | When true, attempts to use other SVG alternative formats such as JPG as preview images. |
| enableLibraryManagedFiles | boolean | When true, controls the ability to publish files created in Chatter with a Content Library (ContentWorkspace). The library can manage the file. |
| enableShowChatterFilesInContent | boolean | When true, allows users to search for Chatter files in content. |
| enableSiteGuestUserToUploadFiles | boolean | When true, site guest users can upload files. |
| enableUploadFilesOnAttachments | boolean | When true, shows the **New File** button on the Attachments related lists to upload files, rather than legacy Attachments. |
| setValidContentTypeForAtchDocDownload | boolean | When true, enables an org preference that controls whether the Content-Type HTTP response header is set to a valid content type during file and attachment downloads. If false the response header is set to the value that the user provided during file upload. Values provided by the user can be invalid. If the content type provided by the user isn’t a valid content type, the system tries to determine a valid content type based on the file name extension. This field is available in API version 50.0 and later. |
| skipContentAssetTriggers | boolean | When true, disables content trigger execution and custom validation on content assets. |
| skipContentAssetTriggersOnDeploy | boolean | When true, disables content trigger execution when deploying content assets. |

## Declarative Metadata Sample Definition

The following is an example of a Content.settings file.

<ContentSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableChatterFileLink\>true</enableChatterFileLink\>
    <enableCMSC2CConnections\>true</enableCMSC2CConnections\>
    <enableContent\>true</enableContent\>
    <enableContentAutoAssign\>true</enableContentAutoAssign\>
    <enableContentDistForPortalUsers\>true</enableContentDistForPortalUsers\>
    <enableContentDistribution\>true</enableContentDistribution\>
    <enableContentSupportMultiLanguage\>false</enableContentSupportMultiLanguage\>
    <enableContentWorkspaceAccess\>true</enableContentWorkspaceAccess\>
    <enableFileShareSetByRecord\>true</enableFileShareSetByRecord\>
    <enableFilesUsrShareNetRestricted\>true</enableFilesUsrShareNetRestricted\>
    <enableJPGPreviews\>true</enableJPGPreviews\>
    <enableLibraryManagedFiles\>true</enableLibraryManagedFiles\>
    <enableShowChatterFilesInContent\>true</enableShowChatterFilesInContent\>
    <enableSiteGuestUserToUploadFiles\>true</enableSiteGuestUserToUploadFiles\>
    <enableUploadFilesOnAttachments\>true</enableUploadFilesOnAttachments\>
    <skipContentAssetTriggers\>true</skipContentAssetTriggers\>
    <skipContentAssetTriggersOnDeploy\>true</skipContentAssetTriggersOnDeploy\>
</ContentSettings\>

The following is an example ContentSettings.xml manifest that references the ContentSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>
<ContentSettings xmlns=
    <types\>
        <members\>Content</members\>
        <name\>Settings</name\>
    </types\>
    <version\>48.0</version\>
</ContentSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=d553cf1252c76dc0510975c1f91d5286d1fc9ea280e596f5cdba274d3e66a25a url=/legacydeveloper/current/en-us/api_meta/meta_contenttypebundle.md -->

# ContentTypeBundle

Represents the definition of enhanced custom content types for use with enhanced CMS workspaces. When you create an enhanced custom content type, deploy this bundle to your org. Enhanced custom content types are displayed as forms with defined fields. When deployed, enhanced custom content types are available for use with enhanced LWR site channels. To use enhanced custom content types with Aura and non-enhanced LWR site channels, use enhanced CMS workspaces resources.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") type and inherits its fullName field.

## ContentTypeBundle Structure and Directory Location

ContentTypeBundle components are stored in the contentTypes folder. Here’s an example of how the folder is structured.

+--myMetadataPackage
    +--contentTypes (1)
        +--bbHost (2)
           +--schema.json (3)

- The contentTypes folder (1) contains a folder for each enhanced custom content type.
- Each enhanced custom content type folder is named in the format contentTypeName. In this example (2), the name is bbHost.
- Each contentTypeName folder contains a JSON file, schema.json (3), that defines the enhanced custom content type. The JSON file contains a title and one or more Lightning property types. Use this file to edit the properties of the enhanced custom content type on your local machine or scratch org and then deploy it.

## Version

ContentTypeBundle components are available in version 64.0 and later.

## Special Access Rules

ContentTypeBundle is available only when Salesforce CMS and digital experiences are enabled for your org.

## Fields

| Name | Description |
| --- | --- |
| description | 
Type

string

Description

Explanatory text about the content type.



 |
| masterLabel | 

Type

string

Description

Required.

A name for ContentTypeBundle, which is defined when the ContentTypeBundle is created.



 |
| resources | 

Type

[ContentTypeBundleResource\[\]](#ContentTypeBundleResource)

Description

A list of source files in the ContentTypeBundle folder.



 |

## ContentTypeBundleResource

Represents the resource file inside the ContentTypeBundle.

| Name | Description |
| --- | --- |
| fileName | 
Type

string

Description

Required.

The name of the resource file.



 |
| filePath | 

Type

string

Description

Required.

The path to the resource.



 |
| source | 

Type

base64Binary

Description

Required.

The content of the resource.



 |

## Declarative Metadata Sample Definition

This package.xml retrieves all of the ContentTypeBundle components in an org.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ContentTypeBundle</name\>
    </types\>
    <version\>64.0</version\>
</Package\>

In the retrieved .zip file, each enhanced custom content type is nested under a contentTypes folder.

This example shows the directory structure in the .zip file of an enhanced custom content type. The enhaced custom content type is named bbHost and in this example it represents the profile of a bed and breakfast host.

contentTypes
    bbHost
        schema.json
      

Here are the example contents of the schema.json file in the contentTypes directory. The bbHost is a complex type that includes subproperties for fullName, aboutMe, interests, profilePicture, dateOfBirth, lastModified, personalWebsite, hostIdentityVerified, hostingExperienceInYears, rating, residenceCountry, and preferredModeOfContact. Each subproperty is a primitive type. The subproperty types included in the schema.json file are completely configurable and must include a lightning:type for each property.

{
  "title": "Bed & Breakfast Host",
  "description": "Schema for capturing B&B host details",
  "lightning:type": "lightning\_\_objectType",
  "lightning:mixinTypes": {
    "sfdc\_cms:metadataContent": {}
  },
  "properties": {
    "fullName": {
      "title": "Full Name",
      "lightning:type": "lightning\_\_textType",
      "lightning:textIndexed": true,
      "minLength": 5,
      "maxLength": 50,
      "lightning:uiOptions": {
        "placeholderText": "Enter your full name (e.g., John Doe)"
      },
      "lightning:localizable": false
    },
    "aboutMe": {
      "title": "About Me",
      "lightning:type": "lightning\_\_richTextType",
      "minLength": 10,
      "maxLength": 3000,
      "lightning:textIndexed": false,
      "lightning:uiOptions": {
        "placeholderText": "Write something about yourself"
      },
      "lightning:localizable": true
    },
    "interests": {
      "title": "Interests and Hobbies",
      "lightning:type": "lightning\_\_multilineTextType",
      "lightning:textIndexed": true,
      "minLength": 10,
      "maxLength": 500,
      "lightning:uiOptions": {
        "placeholderText": "Summarize your interests and hobbies in a few lines"
      },
      "lightning:localizable": true
    },
    "profilePicture": {
      "title": "Profile Picture",
      "lightning:type": "lightning\_\_imageType",
      "lightning:uiOptions": {
        "placeholderText": "Upload a professional headshot"
      },
      "lightning:localizable": false
    },
    "dateOfBirth": {
      "title": "Date of Birth",
      "lightning:type": "lightning\_\_dateType",
      "lightning:localizable": true,
      "lightning:uiOptions": {
        "placeholderText": "Select your date of birth"
      }
    },
    "lastModified": {
      "title": "Last Profile Update",
      "lightning:type": "lightning\_\_dateTimeType",
      "lightning:localizable": false,
      "lightning:uiOptions": {
        "placeholderText": "Auto-filled on profile update"
      }
    },
    "personalWebsite": {
      "title": "Personal Website",
      "lightning:type": "lightning\_\_urlType",
      "lightning:localizable": false,
      "lightning:uiOptions": {
        "placeholderText": "https://yourwebsite.com"
      }
    },
    "hostIdentityVerified": {
      "title": "Host Identity Verified",
      "lightning:type": "lightning\_\_booleanType",
      "lightning:uiOptions": {
        "placeholderText": "Check if host identity is verified"
      }
    },
    "hostingExperienceInYears": {
      "title": "Years of Experience hosting B&B",
      "lightning:type": "lightning\_\_integerType",
      "minimum": 0,
      "maximum": 50,
      "lightning:localizable": false,
      "lightning:uiOptions": {
        "placeholderText": "Enter total years of experience being a B&B host"
      }
    },
    "rating": {
      "title": "Rating",
      "lightning:type": "lightning\_\_numberType",
      "minimum": 0.0,
      "maximum": 5.0,
      "lightning:localizable": false,
      "lightning:uiOptions": {
        "placeholderText": "e.g., 4.5"
      }
    },
    "residenceCountry": {
      "title": "Country of Residence",
      "lightning:type": "lightning\_\_textType",
      "const": \["India"\]
    },
    "preferredModeOfContact": {
      "title": "Preferred Mode of Contact",
      "lightning:type": "lightning\_\_textType",
      "enum": \["email", "SMS", "phone"\],
      "lightning:uiOptions": {
        "placeholderText": "Choose your preferred mode of contact"
      }
    }
  },
  "required": \["fullName", "hostIdentityVerified"\]

## Usage

For each custom content type that you create, you must also create a CMS content page created in the enhanced LWR, LWR, or Aura site that displays the content. Each content page serves as the detail page for all content of a single content type. See [Create Custom Site Pages with Experience Builder](https://help.salesforce.com/articleView?id=community_builder_create_page.htm&language=en_US).

To use enhanced custom content types with Aura and non-enhanced LWR site channels, use the enhanced CMS workspaces resources for [CMS Delivery Contents](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_cms_delivery_contents.htm) and [CMS Delivery Content](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_cms_delivery_content.htm).

## Wildcard Support in the Manifest

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 with the Zip](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.") .

<!-- document id=c73587eb3552fb94ab42558a6b3349187abb0aa9aeca0c201797eac9a454821c url=/legacydeveloper/current/en-us/api_meta/meta_contextdefinition.md -->

# ContextDefinition

Represents the details of a context definition that describe the relationship between the node structures within a context.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ContextDefinition components have the suffix .contextDefinition and are stored in the contextDefinitions folder.

## Version

ContextDefinition components are available in API version 59.0 and later.

## Special Access Rules

Enable the organization preference ContextDefinitionsEnabled to access the ContextDefinition metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| canBeReferenceDefinition | 
Field Type

boolean

Description

Indicates whether the context definition can be referred by other context definitions (true) or not (false). Available in API version 63.0 and later.

The default value is false.



 |
| clonedFrom | 

Field Type

string

Description

The name of the context definition that's used to clone the current context definition.



 |
| contextDefinitionReferences | 

Field Type

[ContextDefinitionReference](#ContextDefinitionReference)\[\]

Description

References of the context definition.



 |
| contextDefinitionVersions | 

Field Type

[ContextDefinitionVersion\[\]](#ContextDefinitionVersion)

Description

Version of the context definition.



 |
| contextTtl | 

Field Type

int

Description

Duration to persist the data, which is loaded in the run-time context instances created by this context definition, in the cache.

The default value is 10 minutes.



 |
| description | 

Field Type

string

Description

Description of the context definition.



 |
| hasSystemTags | 

Field Type

boolean

Description

Indicates whether the context definition has system tags (true) or not (false). Available in API version 63.0 and later.

The default value is false.



 |
| inheritedFrom | 

Field Type

string

Description

Name of the parent context definition that's used to derive the current context definition.



 |
| inheritedFromVersion | 

Field Type

string

Description

Version number of the parent definition that's used to derive the current context definition.



 |
| isProtected | 

Field Type

boolean

Description

Auto-generated value that doesn’t impact the behavior of the metadata type.



 |
| masterLabel | 

Field Type

string

Description

Required.

User-friendly name for the context definition, which is defined when the context definition is created.





 |
| title | 

Field Type

string

Description

Required.

Name of the context definition.





 |

## ContextDefinitionReference

Represents details about the context definition reference.

| Field Name | Description |
| --- | --- |
| inheritedFrom | 
Field Type

string

Description

ID of the parent context definition reference that's used to derive the current context definition reference.



 |
| referenceContextDefinition | 

Field Type

string

Description

Required.

ID or name of the referred context definition.





 |

## ContextDefinitionVersion

Represents details about the context definition version. Only one version can be active at a time.

| Field Name | Description |
| --- | --- |
| contextMappings | 
Field Type

[ContextMapping\[\]](#ContextMapping)

Description

Mapping of attributes and nodes to related objects.



 |
| contextNodes | 

Field Type

[ContextNode\[\]](#ContextNode)

Description

Details of the structure of the nodes within the context.



 |
| endDate | 

Field Type

string

Description

Date and time when the context definition version becomes inactive.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the context definition version is active (true) or not (false).

The default value is false.



 |
| startDate | 

Field Type

string

Description

Required.

Date and time when the context definition version becomes active.



 |
| versionNumber | 

Field Type

int

Description

Required.

Version number of the context definition.



 |

## ContextMapping

Represents the mapping of attributes and nodes to related objects.

| Field Name | Description |
| --- | --- |
| contextMappingIntents | 
Field Type

[ContextMappingIntent\[\]](#ContextMappingIntent)

Description

Purpose associated to a context mapping.



 |
| contextNodeMappings | 

Field Type

[ContextNodeMapping\[\]](#ContextNodeMapping)

Description

Mapping of the node in the context and values in the input schema.



 |
| default | 

Field Type

boolean

Description

Indicates whether the mapping for a context definition version is default (true) or not (false).

The default value is false.



 |
| description | 

Field Type

string

Description

Description of the context mapping.



 |
| inheritedFrom | 

Field Type

string

Description

Name of the parent mapping that's used to derive the current mapping.



 |
| title | 

Field Type

string

Description

Required.

Name of the context mapping.



 |

## ContextMappingIntent

Represents the purpose associated to a context mapping.

| Field Name | Description |
| --- | --- |
| mappingIntent | 
Field Type

ContextMappingIntentType (enumeration of type string)

Description

Required.

Specifies the purpose that's used to identify the type of context mapping required.

Valid values are:

- hydration
- association
- persistence
- translation





 |

## ContextNodeMapping

Represents the relationship between the node in the context and values in the input schema.

| Field Name | Description |
| --- | --- |
| contextAttributeMappings | 
Field Type

[ContextAttributeMapping\[\]](#ContextAttributeMapping)

Description

Mapping of the attribute defined in the context and the values in the related objects.



 |
| contextNode | 

Field Type

string

Description

Context node record associated with the context node mapping.



 |
| contextNodeAttrDictionaries | 

Field Type

[ContextNodeAttrDictionary\[\]](#ContextNodeAttrDictionary)

Description

Facilitates relationships between context node mapping and context dictionary. Additionally, it records the relationship between context node and context dictionary.



 |
| inheritedFrom | 

Field Type

string

Description

Name of the parent context node mapping that's used to derive the current context node mapping.



 |
| mappedContextDefinition | 

Field Type

string

Description

API name of the context definition for existing context-to-context mappings.



 |
| object | 

Field Type

string

Description

Name of the object used for the mapping.



 |

## ContextAttributeMapping

Represents the relationship between the attributes defined in the context and the values in the related objects.

| Field Name | Description |
| --- | --- |
| contextAttrHydrationDetails | 
Field Type

[ContextAttrHydrationDetail\[\]](#ContextAttrHydrationDetail)

Description

Details of the SOQL (database) queries that fetch data for a chosen attribute from the input schema.



 |
| contextAttribute | 

Field Type

string

Description

Context attribute record associated with the context attribute mapping.



 |
| contextInputAttributeName | 

Field Type

string

Description

Required.

Name of the input attribute.



 |
| ctxAttrHydrationCtxs | 

Field Type

[CtxAttrHydrationCtx\[\]](#CtxAttrHydrationCtx)

Description

Query that fetches data for a chosen attribute from the input schema for context-to-context mapping.



 |
| inheritedFrom | 

Field Type

string

Description

Name of the parent context attribute mapping that's used to derive the current context attribute mapping.



 |

## ContextAttrHydrationDetail

Represents the SOQL (database) queries that fetch data for a chosen attribute from the input schema.

| Field Name | Description |
| --- | --- |
| contextAttrHydrationDetails | 
Field Type

[ContextAttrHydrationDetail\[\]](#ContextAttrHydrationDetail)

Description

Details of the query that fetches the data for the specific query attribute.



 |
| inheritedFrom | 

Field Type

string

Description

Name of the parent context attribute hydration detail that's used to derive the current context attribute hydration detail.



 |
| objectName | 

Field Type

string

Description

Required.

Name of the object used for the attribute hydration detail.



 |
| queryAttribute | 

Field Type

string

Description

Required.

The SOQL query that is the source of the hydration.



 |

## CtxAttrHydrationCtx

Represents the queries that fetch data for a chosen attribute from the input schema for context-to-context mapping.

| Field Name | Description |
| --- | --- |
| contextQueryAttribute | 
Field Type

string

Description

Required.

Attribute in context definition that's the source of context hydration.



 |
| inheritedFrom | 

Field Type

string

Description

Name of the parent context attribute hydration detail that's used to derive the current context attribute.



 |

## ContextNodeAttrDictionary

Represents the relationship between a context node and the context attribute dictionary.

| Field Name | Description |
| --- | --- |
| contextAttrDictIdentifier | 
Field Type

string

Description

Required.

Developer name of the context attribute dictionary.



 |
| contextNodeTagPrefix | 

Field Type

string

Description

Required.

Tag prefix of the context node that's used to create the unique identifier of the parent context node.



 |

## ContextNode

Represents details of the structure of the nodes within the context. Each node can have other nodes related to them and attributes to describe the object. You can also define a hierarchy for the nodes.

| Field Name | Description |
| --- | --- |
| canonicalNode | 
Field Type

string

Description

Canonical node that's associated with the context node.



 |
| contextAttributes | 

Field Type

[ContextAttribute\[\]](#ContextAttribute)

Description

Details of the attribute used to describe the context node.



 |
| contextNodeAttrDictionaries | 

Field Type

[ContextNodeAttrDictionary\[\]](#ContextNodeAttrDictionary)

Description

Facilitates relationships between context node and context dictionary. Additionally, it records the relationship between context node and context dictionary.



 |
| contextTags | 

Field Type

[ContextTag\[\]](#ContextTag)

Description

Unique identifier of the attribute or node.



 |
| displayName | 

Field Type

string

Description

Display name of the context node.



 |
| inheritedFrom | 

Field Type

string

Description

Name of the parent context node that's used to derive the current context node.



 |
| title | 

Field Type

string

Description

Required.

Name of the context node.



 |
| transposable | 

Field Type

boolean

Description

Indicates whether the data in the Context Node record can be converted to field names (true) or not (false).

The default value is false.



 |

## ContextAttribute

Represents details of an attribute used to describe a context node. Each node can have one or many associated attributes.

| Field Name | Description |
| --- | --- |
| contextTags | 
Field Type

[ContextTag\[\]](#ContextTag)

Description

Shortened name of the attribute or node.



 |
| dataType | 

Field Type

ContextAttributeDataType (enumeration of type string)

Description

Required.

Type of data that's stored in the context attribute.

Valid values are:

- boolean
- currency
- date
- datetime
- number
- percent
- picklist
- reference
- string
- selfreference—Available in API version 63.0 and later.





 |
| description | 

Field Type

string

Description

Description of the context attribute.



 |
| displayName | 

Field Type

string

Description

Display name of the context attribute.



 |
| domainSet | 

Field Type

string

Description

List of node references to show the parent-child relationship between the nodes in a definition.



 |
| fieldType | 

Field Type

ContextAttributeFieldType (enumeration of type string)

Description

Required.

List of node references to depict the parent-child relation between the nodes in a definition.

Valid values are:

- aggregate
- input
- inputoutput
- output





 |
| inheritedFrom | 

Field Type

string

Description

Name of the parent attribute that's used to derive the current attribute.



 |
| key | 

Field Type

boolean

Description

Indicates whether the attribute is a key attribute in the node (true) or not (false).

The default value is false.



 |
| title | 

Field Type

string

Description

Required.

Name of the context attribute.



 |
| transient | 

Field Type

boolean

Description

Indicates if an attribute is skipped in context persistence (true) or not (false). Available in API version 63.0 and later.

The default value is false.



 |
| value | 

Field Type

boolean

Description

Indicates whether the attribute identifies as a value in a node (true) or not (false).

The default value is false.



 |

## ContextTag

Represents a unique identifier of an attribute or node instead of a fully qualified tag structure name.

| Field Name | Description |
| --- | --- |
| title | 
Field Type

string

Description

Required.

Name of the context tag.



 |
| inheritedFrom | 

Field Type

string

Description

Name of the parent context tag that's used to derive the current context tag.



 |

## Declarative Metadata Sample Definition

The following is an example of a ContextDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<ContextDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>Test</fullName\>
    <contextDefinitionVersions\>
        <contextMappings\>
            <contextNodeMappings\>
                <contextNodeAttrDictionaries\>
                    <contextAttrDictIdentifier\>Context Attribute Dictionary Name</contextAttrDictIdentifier\>
                    <contextNodeTagPrefix\>Context Node Tag Prefix</contextNodeTagPrefix\>
                </contextNodeAttrDictionaries\>
                <contextAttributeMappings\>
                    <contextAttrHydrationDetails\>
                        <objectName\>CustomAccount\_\_c</objectName\>
                        <queryAttribute\>Name</queryAttribute\>
                        <inheritedFrom\>StandardDefinition/version/CustomAccountMapping/Praneeth/AccountName/hydrationInfo-1</inheritedFrom\>
                    </contextAttrHydrationDetails\>
                    <ctxAttrHydrationCtxs\>
                        <contextQueryAttribute\>StandardDefinition</contextQueryAttribute\>
                        <inheritedFrom\>StandardDefinition/version/AccountMapping/Praneeth/AccountName/ctxToCtxhydrationInfo-1</inheritedFrom\>
                    </ctxAttrHydrationCtxs\>
                    <contextAttribute\>AccountName</contextAttribute\>
                    <contextInputAttributeName\>AccountName</contextInputAttributeName\>
                    <inheritedFrom\>StandardDefinition/version/CustomAccountMapping/Praneeth/AccountName</inheritedFrom\>
                </contextAttributeMappings\>
                <contextAttributeMappings\>
                    <contextAttrHydrationDetails\>
                        <objectName\>CustomAccount\_\_c</objectName\>
                        <queryAttribute\>CustomAccountName\_\_c</queryAttribute\>
                        <inheritedFrom\>StandardDefinition/version/CustomAccountMapping/Praneeth/CustomAccountName/hydrationInfo-1</inheritedFrom\>
                    </contextAttrHydrationDetails\>
                    <ctxAttrHydrationCtxs\>
                        <contextQueryAttribute\>StandardDefinition</contextQueryAttribute\>
                        <inheritedFrom\>StandardDefinition/version/AccountMapping/Praneeth/AccountName/ctxToCtxhydrationInfo-1</inheritedFrom\>
                    </ctxAttrHydrationCtxs\>
                    <contextAttribute\>CustomAccountName</contextAttribute\>
                    <contextInputAttributeName\>CustomAccountName</contextInputAttributeName\>
                    <inheritedFrom\>StandardDefinition/version/CustomAccountMapping/Praneeth/CustomAccountName</inheritedFrom\>
                </contextAttributeMappings\>
                <contextNode\>Praneeth</contextNode\>
                <object\>CustomAccount\_\_c</object\>
                <inheritedFrom\>StandardDefinition/version/CustomAccountMapping/Praneeth</inheritedFrom\>
                <mappedContextDefinition\>CustomContextDefinition</mappedContextDefinition\>
            </contextNodeMappings\>
            <contextMappingIntents\>
                <mappingIntent\>hydration</mappingIntent\>
            </contextMappingIntents\>
            <default\>true</default\>
            <title\>CustomAccountMapping</title\>
            <inheritedFrom\>StandardDefinition/version/CustomAccountMapping</inheritedFrom\>
        </contextMappings\>
        <contextMappings\>
            <contextNodeMappings\>
                <contextNodeAttrDictionaries\>
                    <contextAttrDictIdentifier\>Context Attribute Dictionary Name</contextAttrDictIdentifier\>
                    <contextNodeTagPrefix\>Context Node Tag Prefix</contextNodeTagPrefix\>
                </contextNodeAttrDictionaries\>
                <contextAttributeMappings\>
                    <contextAttrHydrationDetails\>
                        <objectName\>Account</objectName\>
                        <queryAttribute\>Name</queryAttribute\>
                        <inheritedFrom\>StandardDefinition/version/AccountMapping/Praneeth/CustomAccountName/AccountName/hydrationInfo-1</inheritedFrom\>
                    </contextAttrHydrationDetails\>
                    <ctxAttrHydrationCtxs\>
                        <contextQueryAttribute\>StandardDefinition</contextQueryAttribute\>
                        <inheritedFrom\>StandardDefinition/version/AccountMapping/Praneeth/AccountName/ctxToCtxhydrationInfo-1</inheritedFrom\>
                    </ctxAttrHydrationCtxs\>
                    <contextAttribute\>AccountName</contextAttribute\>
                    <contextInputAttributeName\>AccountName</contextInputAttributeName\>
                    <inheritedFrom\>StandardDefinition/version/AccountMapping/Praneeth/CustomAccountName/AccountName</inheritedFrom\>
                </contextAttributeMappings\>
                <contextAttributeMappings\>
                    <contextAttrHydrationDetails\>
                        <objectName\>Account</objectName\>
                        <queryAttribute\>CustomAccountName\_\_c</queryAttribute\>
                        <inheritedFrom\>StandardDefinition/version/AccountMapping/Praneeth/CustomAccountName/hydrationInfo-1</inheritedFrom\>
                    </contextAttrHydrationDetails\>
                    <ctxAttrHydrationCtxs\>
                        <contextQueryAttribute\>StandardDefinition</contextQueryAttribute\>
                        <inheritedFrom\>StandardDefinition/version/AccountMapping/Praneeth/AccountName/ctxToCtxhydrationInfo-1</inheritedFrom\>
                    </ctxAttrHydrationCtxs\>
                    <contextAttribute\>CustomAccountName</contextAttribute\>
                    <contextInputAttributeName\>CustomAccountName</contextInputAttributeName\>
                    <inheritedFrom\>StandardDefinition/version/AccountMapping/Praneeth/CustomAccountName</inheritedFrom\>
                </contextAttributeMappings\>
                <contextNode\>Praneeth</contextNode\>
                <object\>Account</object\>
                <inheritedFrom\>StandardDefinition/version/AccountMapping/Praneeth</inheritedFrom\>
                <mappedContextDefinition\>CustomContextDefinition</mappedContextDefinition\>
            </contextNodeMappings\>
             <contextMappingIntents\>
                <mappingIntent\>persistence</mappingIntent\>
             </contextMappingIntents\>
            <description\>Account Mapping</description\>
            <default\>false</default\>
            <title\>AccountMapping</title\>
            <inheritedFrom\>StandardDefinition/version/AccountMapping</inheritedFrom\>
        </contextMappings\>
        <contextNodes\>
            <contextNodeAttrDictionaries\>
                <contextAttrDictIdentifier\>Context Attribute Dictionary Name</contextAttrDictIdentifier\>
                <contextNodeTagPrefix\>Context Node Tag Prefix</contextNodeTagPrefix\>
            </contextNodeAttrDictionaries\>
            <contextAttributes\>
                <contextTags\>
                    <title\>AccountName</title\>
                    <inheritedFrom\>StandardDefinition/version/Praneeth/AccountName/AccountName</inheritedFrom\>
                </contextTags\>
                <dataType\>string</dataType\>
                <fieldType\>inputoutput</fieldType\>
                <key\>false</key\>
                <title\>AccountName</title\>
                <displayName\>AccountName</displayName\>
                <description\>Test Description</description\>
                <value\>false</value\>
                <inheritedFrom\>StandardDefinition/version/Praneeth/AccountName</inheritedFrom\>
            </contextAttributes\>
            <contextAttributes\>
                <dataType\>string</dataType\>
                <fieldType\>inputoutput</fieldType\>
                <key\>false</key\>
                <title\>CustomAccountName</title\>
                <value\>false</value\>
                <displayName\>CustomAccountName</displayName\>
                <description\>Test Description</description\>
                <inheritedFrom\>StandardDefinition/version/Praneeth/CustomAccountName</inheritedFrom\>
            </contextAttributes\>
            <contextTags\>
                <title\>Praneeth</title\>
                <inheritedFrom\>StandardDefinition/version/Praneeth/Praneeth</inheritedFrom\>
            </contextTags\>
            <title\>Praneeth</title\>
            <transposable\>false</transposable\>
            <inheritedFrom\>StandardDefinition/version/Praneeth</inheritedFrom\>
            <canonicalNode\></canonicalNode\>
            <displayName\>Praneeth</displayName\>
        </contextNodes\>
        <endDate\>2097-05-10 00:00:00</endDate\>
        <startDate\>2023-05-10 00:00:00</startDate\>
        <versionNumber\>1</versionNumber\>
        <isActive\>true</isActive\>
    </contextDefinitionVersions\>
    <description\>Test Description</description\>
    <contextTtl\>10</contextTtl\>
    <inheritedFrom\>StandardDefinition</inheritedFrom\>
    <inheritedFromVersion\>1.0</inheritedFromVersion\>
    <clonedFrom\>OriginalDefinition</clonedFrom\>
    <isProtected\>false</isProtected\>
    <masterLabel\>Test Label</masterLabel\>
    <title\>TestTitle</title\>
    <displayName\>TestTitle</displayName\>
</ContextDefinition\>

The following is an example package.xml that references the previous definition.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Test</members\>
        <name\>ContextDefinition</name\>
    </types\>
    <types\>
        <members\>Account.CustomAccountName\_\_c</members\>
        <name\>CustomField</name\>
    </types\>
    <types\>
        <members\>CustomAccount\_\_c</members\>
        <name\>CustomObject</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=e17a3c25acb3fdd2963600cb00e633f6588990b045a04b80926aaef9309f13a5 url=/legacydeveloper/current/en-us/api_meta/meta_contractsettings.md -->

# ContractSettings

Represents contract settings.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

There is one contract settings file stored in a file named Contract.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ContractSettings is available in API version 27.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| autoCalculateEndDate | boolean | Indicates whether the end date of a contract is automatically calculated (true) or not (false). |
| notifyOwnersOnContractExpiration | boolean | Indicates whether account and contract owners are automatically sent email notifications when a contract expires (true) or not (false). |

## Declarative Metadata Sample Definition

This is a sample contract settings file.

<?xml version="1.0" encoding="UTF-8"?>
<ContractSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <autoCalculateEndDate\>true</autoCalculateEndDate\>
    <notifyOwnersOnContractExpiration\>false</notifyOwnersOnContractExpiration\>
</ContractSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=7b77c5a6ebf306c65cd50fcb7568e8aaf24175a44fa74fb813d6945b59185f0a url=/legacydeveloper/current/en-us/api_meta/meta_conversationalintelligencesettings.md -->

# ConversationalIntelligenceSettings

Represents the org's Einstein Conversation Insights settings, such as whether Einstein Conversation Insights is enabled. Einstein Conversation Insights lets you analyze your rep's call recordings, and gives you the insights you need to optimize every call.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

ConversationalIntelligenceSettings values are stored in the ConversationalIntelligence.settings file in the settings folder.

## Version

ConversationalIntelligenceSettings components are available in API version 49.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| enableCallCoaching | 
Field Type

boolean

Description

Indicates whether Einstein Conversation Insights is enabled (true) or not (false). The default value is false. Available in API version 49.0 and later.



 |
| enableCallCoachingZoom | 

Field Type

boolean

Description

Indicates whether Zoom video calls are enabled for Einstein Conversation Insights (true) or not (false). The default value is false. Available in API version 51.0 and later.



 |
| enableCallExplorer | 

Field Type

boolean

Description

Indicates whether Call Explorer is enabled (true) or not (false). The default value is false. Available in API version 60.0 and later.



 |
| enableCallSummarization | 

Field Type

boolean

Description

Indicates whether Call Summary is enabled (true) or not (false). The default value is false. Available in API version 59.0 and later.



 |
| enableConversationMining | 

Field Type

boolean

Description

Indicates whether Einstein Conversation Mining is enabled (true) or not (false). The default value is false. Available in API version 61.0 and later.



 |
| enableDiarizationPref | 

Field Type

boolean

Description

Indicates whether optimal speaker separation is enabled (true) or not (false). The default value is false. Available in API version 58.0 and later.

Optimal speaker separation lets Einstein Conversation Insights use acoustic features of speaker voices to separate an audio stream into separate segments.



 |
| enableECIOOTBFlows | 

Field Type

boolean

Description

Indicates whether the out-of-the-box (OOTB) flow templates for Einstein Conversation Insights are enabled (true) or not (false). The default value is false. Available in API version 65.0 and later.

These flow templates provide examples of how to use ECI-generated transcripts and insights for common actions, such as drafting follow-up emails or creating next steps.



 |
| enableGenerativeConvInsights | 

Field Type

boolean

Description

Indicates whether Generative Conversation Insights is enabled (true) or not (false). The default value is false. Available in API version 61.0 and later.



 |
| enableManualUpload | 

Field Type

boolean

Description

Indicates whether Video Call Upload is enabled (true) or not (false). The default value is false. Available in API version 62.0 and later.

Reserved for future use.



 |
| enableOpptyMatching | 

Field Type

boolean

Description

Indicates whether voice and video calls are related to opportunities automatically (true) or not (false). The default value is false. Available in API version 53.0 and later.



 |
| enableRealtimeInsights | 

Field Type

boolean

Description

Indicates whether Realtime Insights is enabled (true) or not (false). The default value is false. Available in API version 62.0 and later.



 |
| enableUnifiedActivities | 

Field Type

boolean

Description

Indicates whether Activity 360 Reporting is enabled (true) or not (false). The default value is false. Available in API version 58.0 and later.



 |

## Declarative Metadata Sample Definition

The following is an example of a ConversationalIntelligenceSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ConversationalIntelligenceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableCallCoaching\>true</enableCallCoaching\>
</ConversationalIntelligenceSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>ConversationalIntelligence</members\>
		<name\>Settings</name\>
	</types\>
	<version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ec4e50fd4f9e137519f8a64925516955786d5d3238b1e38f534fea67387d8b40 url=/legacydeveloper/current/en-us/api_meta/meta_conversationchanneldefinition.md -->

# ConversationChannelDefinition

Represents the conversation channel definition that’s implemented for Interaction Service for Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS messaging channels. This object is available in API version 60.0 and later.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ConversationChannelDefinition components have the suffix .ConversationChannelDefinition and are stored in the conversationChannelDefinitions folder.

## Version

ConversationChannelDefinition components are available in API version 60.0 and later.

## Special Access Rules

Interaction service must be configured. Access to tooling objects requires Salesforce administrator privileges or the Customize Application permission.

## Fields

| Field Name | Description |
| --- | --- |
| connectedAppOauthLink | 
Field Type

string

Description

DO NOT SET OR CHANGE THIS VALUE. This value is automatically generated. This field represents the OAuth link for the external client app (ECA) or connected app if the connectedAppType value is Partner. This is a string identifier to the ECA or connected app containing the partner Org ID and the consumer ID minus the key prefixes. Used to identify the ECA or connected app to use for the channel definition and channel at runtime.





 |
| connectedAppType | 

Field Type

CustomChannelConnectedAppType

Description

The owner of the external client app (ECA) or connected app used to manage authentication between Salesforce Interaction Service and the Messaging or CCaaS partner’s system.

Possible values are:

- Partner
- Customer

The default value is Partner.

If set to Partner, the partner creates the ECA or connected app and includes it in their managed package. If set to Customer, the admin creates the ECA or connected app.

Available in API version 62.0 and later.



 |
| consentOwner | 

Field Type

ConsentOwner (enumeration of type string)

Description

The system the customer uses to manage consent levels.

Possible values are:

- Partner
- Salesforce

The default value is Salesforce.

For example, if set to Salesforce, consent levels are managed by the Salesforce system. If set to Partner, consent levels are managed by the partner’s telephony system.

For Bring Your Own Channel for Messaging, this value must be set to Salesforce.



 |
| conversationVendorInfo | 

Field Type

string

Description

The ConversationVendorInfo.developerName used to link this record to the ConversationVendorInfo record. For example, PartnerName.



 |
| customEventChnlAddrIdField | 

Field Type

string

Description

The mapping field that points to the custom field used to point to the ChannelAddressIdentifier field.

This field is available in API version 60.0 and earlier. Use a combination of customEventTypeField and customEventPayloadField in API version 61.0 and later instead.



 |
| customEventPayloadField | 

Field Type

string

Description

Required. The mapping field that points to the custom field used to point to the Payload field in the format <orgNamespace>\_\_<CustomFieldName>\_\_c. This is the API name of the custom Payload field in the custom platform event. For example, devorg\_\_Payload\_\_c.



 |
| customEventRecipientField | 

Field Type

string

Description

The mapping field that points to the custom field used to point to the Recipient field.

This field is available in API version 60.0 and earlier. Use a combination of customEventTypeField and customEventPayloadField in API version 61.0 and later instead.



 |
| customEventTypeField | 

Field Type

string

Description

The mapping field that points to the custom field used to point to the Platform event type (EventType) field, in the format <orgNamespace>\_\_<CustomFieldName>\_\_c. This is the API name of the custom EventType field in the custom platform event. For example, devorg\_\_EventType\_\_c.



 |
| customIcon | 

Field Type

string

Description

For Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS, this field represents the name of the status resource image used to identify the channel integration, such as a channel logo. For the best results, set the image size to 50px x 50px and save the image in SVG file format. This field is optional. This field is a relationship field. Available in API version 61.0 and later.



 |
| customPlatformEvent | 

Field Type

string

Description

Required. The API name of the custom platform event created for the Interaction Service API in the format <orgNamespace>\_\_<CustomPlatformEventName>\_\_e. For example, devorg\_\_TestEvent\_\_e.



 |
| customerConnectedAppOauthLink | 

Field Type

string

Description

DO NOT SET OR CHANGE THIS VALUE. This value is automatically generated. This field represents the OAuth link for the external client app or connected app created by an admin if the ConnectedAppType is Customer. Available in API version 62.0 and later.



 |
| developerName | 

Field Type

string

Description

The unique name of the custom metadata type object in the API in the format <Prefix>\_<ConversationChannelDefinition>, where Prefix matches the prefix you gave to the name of the Interaction Service external client app or connected app. For example, Partner1\_ChannelDefinition1, where Partner1 is the prefix and ChannelDefinition1 is the given name.



 |
| isConferenceSupported | 

Field Type

boolean

Description

Indicates whether the partner supports conferencing for Bring Your Own Channel (true), or not (false). With conferencing, more than two participants are allowed in a messaging session. The default is false.

This field is available in API version 64.0 and later.



 |
| isInboundAcknwOptionExposed | 

Field Type

boolean

Description

Indicates whether the partner supports read receipts and delivery receipts for inbound messages (true) or whether the partner doesn’t support these inbound acknowledgments and the functionality is hidden from the Salesforce admin in the Messaging settings (false). The default value is false.

This field is available in API version 65.0 and later. Use this field instead of isInboundReceiptsEnabled.



 |
| isInboundReceiptsEnabled | 

Field Type

boolean

Description

Indicates whether the partner supports read receipts and delivery receipts for inbound messages (true) or whether the partner doesn’t support these inbound acknowledgements and the functionality is hidden from the Salesforce admin in the Messaging settings (false). The default value is false.

Available in API versions 63.0 to 65.0. In API version 66.0 and later, this field is removed. Use isInboundAcknwOptionExposed instead.



 |
| isProgressIndicatorOptExposed | 

Field Type

boolean

Description

Indicates whether the partner supports progress indicators for AI agents (true) or whether the partner doesn’t support them and the functionality is hidden from the Salesforce admin in the Messaging settings (false). The default value is false.

This field is available in API version 65.0 and later.



 |
| isRoutingWorkResultEnabled | 

Field Type

boolean

Description

Indicates whether the Routing Work Result event is sent as a Custom Platform event or not.

The default value is false.

Available in API versions 64.0 and 65.0. In API version 66.0 and later, this field is removed. Use isRoutingWorkResultSupported instead.



 |
| isRoutingWorkResultSupported | 

Field Type

boolean

Description

Indicates whether the Routing Work Result event is sent as a Custom Platform event (true) or not (false). The default value is false.

This field is available in API version 65.0 and later. Use this field instead of isRoutingWorkResultEnabled.



 |
| isTypingIndicatorDisabled | 

Field Type

boolean

Description

Indicates whether the partner doesn’t support typing indicators for outbound messages and the functionality is hidden from the Salesforce admin in the Messaging settings (true) or whether outbound typing indicators are supported by the partner (false). The default value is false, meaning the outbound typing indicator feature is supported by default. To disable the outbound typing indicator feature, set this value to true.

Available in API versions 63.0 to 65.0. In API version 66.0 and later, this field is removed. Use isTypingIndicatorOptionHidden instead.



 |
| isTypingIndicatorOptionHidden | 

Field Type

boolean

Description

Indicates whether the partner doesn’t support typing indicators for outbound messages and the functionality is hidden from the Salesforce admin in the Messaging settings (true) or whether outbound typing indicators are supported by the partner (false). The default value is false, meaning the outbound typing indicator feature is supported by default. To disable the outbound typing indicator feature, set this value to true.

This field is available in API version 65.0 and later. Use this field instead of isTypingIndicatorDisabled.



 |
| masterLabel | 

Field Type

string

Description

The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values.

- In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
- In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

NamespacePrefix is null if the publisher is Salesforce.



 |
| maxParticipantsForCnfrOverride | 

Field Type

int

Description

Specifies the limit for how many participants can be in a messaging conference. If set, this field overrides the platform limit for the number of participants in a conference. If not set, the limit defaults to the messaging platform limit of how many participants can be in a messaging conference at one time.

This field is available in API version 64.0 and later.



 |
| routingOwner | 

Field Type

RoutingOwner (enumeration of type string)

Description

The system the customer uses to manage routing for Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS.

Possible values are:

- Partner
- Salesforce

The default value is Salesforce.

For example, if set to Salesforce, routing is managed by the Salesforce system. If set to Partner, routing is managed by the partner’s telephony or Contact Center as a Service (CCaaS) system.

For Bring Your Own Channel for Messaging, this value must be set to Salesforce.



 |
| supportsCustomChannelParameters | 

Field Type

boolean

Description

Indicates whether admins can configure custom parameters and parameter mappings for messaging channels. Custom parameters and parameter mappings are used to pass additional information at runtime to Omni-Channel flows. The default value is false.

This field is available in API version 61.0 and later.



 |
| supportsDoubleOptInConsent | 

Field Type

boolean

Description

Indicates whether the channel supports (true) the Double Opt-In consent level. The default value is false. If set to true, then capabilitiesSupportsExplicitConsent must also be set to true. This field is optional and isn’t supported for Bring Your Own Channel for Messaging. It's only supported for Bring Your Own Channel for CCaaS.



 |
| supportsExplicitConsent | 

Field Type

boolean

Description

Indicates whether the channel supports (true) the Explicit Opt-In consent level. This field is optional.



 |
| supportsImplicitConsent | 

Field Type

boolean

Description

Indicates whether the channel supports (true) the Implicit Opt-In consent level. This value is required and must always be set to true. The default value is false.



 |
| supportsIsoCountryCode | 

Field Type

boolean

Description

Indicates whether the channel supports (true) ISO country codes. The default value is false.



 |
| supportsKeywords | 

Field Type

boolean

Description

Indicates whether the channel supports (true) keywords. The default value is false.



 |

## Declarative Metadata Sample Definition

The following is an example of a ConversationChannelDefinition component.

The following is an example package.xml that references the previous definition.

<!-- document id=32a2ac914c7b158a107acc1adfbf819d6bf045c324c1947479e34eff57fa3bab url=/legacydeveloper/current/en-us/api_meta/meta_conversationmessagedefinition.md -->

# ConversationMessageDefinition

Represents a messaging component in an Enhanced Messaging channel or Messaging for In-App and Web session.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

ConversationMessageDefinition components have the suffix .conversationMessageDefinition and are stored in the conversationMessageDefinitions folder.

## Version

ConversationMessageDefinition is supported for use in enhanced Messaging channels and Messaging for In-App and Web, and is available in API version 59.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| constants | 
Field Type

[ConversationMessageConstant](#ConversationMessageConstant)\[\]

Description

An array of constants that defines the messaging components. Constants support multiple data types, including text, URL, and image.



 |
| contentCategory | 

Field Type

ConversationMessageContentCategory (enumeration of type string)

Description

Specifies the business intent of the Conversation Message Definition. Valid values are:

- AccountUpdate
- Authentication
- Feedback
- OrderUpdate
- PromotionalOutreach
- Reminder
- Response





 |
| description | 

Field Type

string

Description

The description of the conversation message definition.



 |
| label | 

Field Type

string

Description

A user-friendly name for ConversationMessageDefinition, which is defined whenConversationMessageDefinition is created.



 |
| language | 

Field Type

string

Description

The language of the conversation message definition.



 |
| messageHandlers | 

Field Type

[ConversationMessageHandler](#ConversationMessageHandler)\[\]

Description

An array of message handlers.



 |
| messageLayouts | 

Field Type

[ConversationMessageLayout](#ConversationMessageLayout)\[\]

Description

An array of message layouts.



 |
| optionsParameter | 

Field Type

[ConversationMessageOptionsParameter](#ConversationMessageOptionsParameter)\[\]

Description

An array of options parameter of the ConversationMessageDefinition.



 |
| parameters | 

Field Type

[ConversationMessageParameter](#ConversationMessageParameter)\[\]

Description

An array of parameters.



 |
| type | 

Field Type

ConversationMessageDefinitionType (enumeration of type string)

Description

Required. The type of the conversation message definition. Valid values are:

- Action
- ApexForm
- AuthenticationRequest
- AutoResponse
- GuidedActions—Available in API version 68.0 and later.
- Link
- Notification
- PaymentRequest
- Picklist
- RecordPicker
- RecordView
- TimePicker





 |

## ConversationMessageConstant

Represents a constant value on the messaging component. When a messaging component is created in the UI, the text and images entered during creation are saved as standard constants. Custom constants can also be added.

| Field Name | Description |
| --- | --- |
| compositeValues | 
Field Type

[ConversationMessageConstantCompositeValue](#ConversationMessageConstantCompositeValue)\[\]

Description

An array of composite values of ConversationMessageConstant.



 |
| constantType | 

Field Type

ConversationMessageConstantType (enumeration of type string)

Description

Required. The conversation message constant type. Valid values are:

- Custom
- Image
- Options
- SubTitle
- Title
- Url





 |
| label | 

Field Type

string

Description

The UI label of the conversation message constant.



 |
| name | 

Field Type

string

Description

The name of the conversation message constant.



 |
| primitiveValues | 

Field Type

[ConversationMessageConstantPrimitiveValue](#ConversationMessageConstantPrimitiveValue) (enumeration of type string)

Description

An array of primitive values of ConversationMessageConstant.



 |
| valueType | 

Field Type

ConversationMessageValueType (enumeration of type string)

Description

The type of the conversation message constant value. Valid values are:

- Boolean
- Date
- DateTime
- Double
- ImageId
- Integer
- RecordId
- Text
- Url
- VideoId—Available in API version 68.0 and later.





 |

## ConversationMessageConstantCompositeValue

Represents the composite values of the [ConversationMessageConstant](#ConversationMessageConstant).

| Field Name | Description |
| --- | --- |
| constantItems | 
Field Type

[ConversationMessageConstant](#ConversationMessageConstant)\[\]

Description

An array of constant items.



 |
| identifier | 

Field Type

string

Description

Required. The client identifier.



 |

## ConversationMessageConstantPrimitiveValue

Represents the primitive values of the [ConversationMessageConstant](#ConversationMessageConstant).

| Field Name | Description |
| --- | --- |
| contentAssetName | 
Field Type

string

Description

Represents the value for type = ImageAsset



 |
| textValue | 

Field Type

string

Description

Represents the value for type = Text



 |
| type | 

Field Type

ConversationMessageConstantValueType (enumeration of type string)

Description

Required. The type of the conversation message constant primitive value. Valid values are:

- FileAsset
- ImageAsset
- Text
- Url





 |
| urlValue | 

Field Type

string

Description

Represents the value for type = Url



 |

## ConversationMessageHandler

Represents the conversation message handler.

| Field Name | Description |
| --- | --- |
| activeRequestDurationMinutes | 
Field Type

int

Description

Required. The duration of an active request in minutes.



 |
| handlerName | 

Field Type

string

Description

Required. The name of the message handler.



 |
| handlerType | 

Field Type

ConversationMessageHandlerType (enumeration of type string)

Description

Required. The type of message handler. Valid values are:

- ApexFormProvider. Available in API version 65.0 and later.
- AuthProvider
- PaymentProvider
- QuickAction
- Survey. Available in API version 65.0 and later.





 |

## ConversationMessageLayout

Represents the conversation message layout.

| Field Name | Description |
| --- | --- |
| externalTemplates | 
Field Type

[ConvMsgExternalTemplateVersion](#ConvMsgExternalTemplateVersion)\[\]

Description

The external template version of the ConversationMessageLayout.



 |
| formatType | 

Field Type

ConversationMessageFormatType (enumeration of type string)

Description

Required. The format type of the conversation message layout. Valid values are:

- Application
- BusinessUpdate—Available in API version 68.0 and later.
- Buttons
- Carousel
- EncryptedOAuthToken
- ExternalTemplate
- Flow
- Inputs
- ListPicker
- Media
- Payment
- QuickReplies
- RichLink
- Suggestions—Available in API version 68.0 and later.
- Text
- TimePicker
- WebView





 |
| layoutItems | 

Field Type

[ConversationMessageLayoutItem](#ConversationMessageLayoutItem)\[\]

Description

An array of layout items.



 |
| messageType | 

Field Type

ConversationMessageType (enumeration of type string)

Description

Required. The conversation message type. Valid values are:

- AuthenticationRequest
- Choices
- Form
- PaymentRequest
- StaticContent





 |

## ConvMsgExternalTemplateVersion

Represents the external template version of the conversation message layout.

| Field Name | Description |
| --- | --- |
| accountIdentifier | 
Field Type

string

Description

Required. The account identifier. For WhatsApp channels, this is the WABA ID.



 |
| accountName | 

Field Type

string

Description

Required. The account name.



 |
| language | 

Field Type

string

Description

Required. The language of the conversation message external template.



 |
| status | 

Field Type

ConvMsgExternalTemplateVersionStatus (enumeration of type string)

Description

Required. The status of the conversation message external template. Valid values are:

- Approved. The template version is approved.
- Blocked. The template version is blocked. Available in API version 65.0 and later.
- Deleted. The template version is deleted. Available in API version 65.0 and later.
- Disabled. The template version is disabled because of recurring negative customer feedback.
- InAppeal. The rejected template version is being appealed. Available in API version 65.0 and later.
- LimitExceeded. Available in API version 65.0 and later.
- OutOfSync. The template versions in the messaging service and Salesforce are out of sync. Available in API version 65.0 and later.
- Paused. The template version is paused because of recurring negative customer feedback or low read rates.
- Pending. The template version awaits Meta's approval.
- PendingDeletion. The template version is pending deletion. Available in API version 65.0 and later.
- Rejected. The template version was rejected during Meta’s review process.





 |
| templateName | 

Field Type

string

Description

Required. The name of the conversation message external template.



 |
| templateVersionIdentifier | 

Field Type

string

Description

Required. The template version identifier.



 |

## ConversationMessageLayoutItem

Represents the conversation message layout item.

| Field Name | Description |
| --- | --- |
| collectionType | 
Field Type

ConversationMessageCollectionType (enumeration of type string)

Description

Required. The type of conversation message collection. Valid values are:

- DynamicList
- None
- StaticList





 |
| compositeValues | 

Field Type

[ConversationMessageLayoutCompositeValue](#ConversationMessageLayoutCompositeValue)\[\]

Description

An array of composite values of the ConversationMessageLayoutItem.



 |
| name | 

Field Type

string

Description

The name of the conversation message layout item.



 |
| primitiveValues | 

Field Type

[ConversationMessageLayoutPrimitiveValue](#ConversationMessageLayoutPrimitiveValue)\[\]

Description

An array of primitive values of the ConversationMessageLayoutItem.



 |

## ConversationMessageLayoutCompositeValue

Represents the composite value of the [ConversationMessageLayoutItem](#ConversationMessageLayoutItem).

| Field Name | Description |
| --- | --- |
| compositeTypeName | 
Field Type

string

Description

Required. The name of the conversation message layout composite value type.



 |
| layoutItems | 

Field Type

[ConversationMessageLayoutItem](#ConversationMessageLayoutItem)\[\]

Description

An array of layout items.



 |
| valueSourceReference | 

Field Type

string

Description

The source of the conversation message layout composite value.



 |

## ConversationMessageLayoutPrimitiveValue

Represents the primitive value of the [ConversationMessageLayoutItem](#ConversationMessageLayoutItem).

| Field Name | Description |
| --- | --- |
| contentAssetName | 
Field Type

string

Description

The content asset name.



 |
| fieldName | 

Field Type

string

Description

The name of the conversation message layout primitive value field.



 |
| formulaTemplate | 

Field Type

string

Description

The formula template defines the content for each entry in the list.



 |
| literalValue | 

Field Type

string

Description

The literal primitive value of the conversation message layout.



 |
| mergeFields | 

Field Type

[ConversationMessageMergeField](#ConversationMessageMergeField)\[\]

Description

Inserts multiple values to a list.



 |
| type | 

Field Type

ConversationMessageLayoutValueType (enumeration of type string)

Description

Required. The type of the conversation message layout primitive value. Valid values are:

- FormulaTemplate
- Literal
- MediaAsset
- SourcePrimitiveValue
- SourceSobjectField
- SourceSobjectFieldValue
- SourceSobjectFormula





 |
| valueFormula | 

Field Type

string

Description

The formula of the conversation message layout primitive value.



 |
| valueSourceReference | 

Field Type

string

Description

The source of the conversation message layout primitive value.



 |

## ConversationMessageMergeField

Merge field is used to insert multiple values to a list.

| Field Name | Description |
| --- | --- |
| formulaTemplate | 
Field Type

string

Description

Required. The formula template of the conversation message merge field.



 |
| mergeFieldType | 

Field Type

ConversationMessageMergeFieldType (enumeration of type string)

Description

Required. The type of the conversation message merge field. Valid value is ListTemplate.



 |
| name | 

Field Type

string

Description

Required. The name of the conversation message merge field.



 |
| valueSourceReference | 

Field Type

string

Description

Required. The source of the conversation message merge field value.



 |

## ConversationMessageOptionsParameter

Represents a conversation message options parameter.

| Field Name | Description |
| --- | --- |
| compositeTypeDetails | 
Field Type

[ConversationMessageParameterCompositeDetails](#ConversationMessageParameterCompositeDetails)\[\]

Description

An array of composite details of ConversationMessageOptionsParameter.



 |
| optionsParameterType | 

Field Type

ConversationMessageOptionsParameterType (enumeration of type string)

Description

Required. The type of conversation message options parameter. Valid values are:

- CustomCompositeOptions
- CustomPrimitiveOptions
- RecordIdOptions
- TimeSlotOptions





 |
| primitiveTypeDetails | 

Field Type

ConversationMessageParameterPrimitiveDetails

Description

The primitive type details of conversation message options parameter.



 |

## ConversationMessageParameterCompositeDetails

Represents the composite details of a conversation message parameter.

| Field Name | Description |
| --- | --- |
| compositeChildItems | 
Field Type

ConversationMessageParameterCompositeDetails\[\]

Description

The composite child items of the conversation message parameter.



 |
| isList | 

Field Type

boolean

Description

Indicates whether the conversation message parameter composite details field is a list item (true) or not (false). The default value is false.



 |
| isRequired | 

Field Type

boolean

Description

Indicates whether the conversation message parameter is required (true) or not (false). The default value is false.



 |
| label | 

Field Type

string

Description

The UI label of the conversation message parameter composite details field.



 |
| maxListItems | 

Field Type

int

Description

The maximum number of list items in the conversation message parameter composite details field.



 |
| name | 

Field Type

string

Description

The name of the conversation message parameter composite details field.



 |
| primitiveChildItems | 

Field Type

[ConversationMessageParameterPrimitiveDetails](#ConversationMessageParameterPrimitiveDetails)\[\]

Description

An array of primitive child items.



 |

## ConversationMessageParameterPrimitiveDetails

Represents the primitive details of the conversation message parameter.

| Field Name | Description |
| --- | --- |
| isList | 
Field Type

boolean

Description

Indicates whether the conversation message parameter primitive details field is a list item (true) or not (false). The default value is false.



 |
| isRequired | 

Field Type

boolean

Description

Indicates whether the conversation message parameter primitive details field is required (true) or not (false). The default value is false.



 |
| label | 

Field Type

string

Description

The UI label of the conversation message parameter primitive details field.



 |
| maxListItems | 

Field Type

int

Description

The maximum number of list items that are allowed in the conversation message parameter primitive details field.



 |
| name | 

Field Type

string

Description

The name of the conversation message parameter primitive details field.



 |
| sobjectType | 

Field Type

string

Description

The sObject type.



 |
| valueType | 

Field Type

ConversationMessageValueType (enumeration of type string)

Description

The type of the conversation message parameter value. Valid values are:

- Boolean
- Date
- DateTime
- Double
- ImageId
- Integer
- RecordId
- Text
- Url
- VideoId—Available in API version 68.0 and later.





 |

## ConversationMessageParameter

Represents a conversation message parameter.

| Field Name | Description |
| --- | --- |
| compositeTypeDetails | 
Field Type

[ConversationMessageParameterCompositeDetails](#ConversationMessageParameterCompositeDetails)

Description

An array of composite type details.



 |
| parameterType | 

Field Type

ConversationMessageParameterType (enumeration of type string)

Description

Required. The type of conversation message parameter. Valid values are:

- CustomComposite
- CustomPrimitive
- RecordIds





 |
| primitiveTypeDetails | 

Field Type

[ConversationMessageParameterPrimitiveDetails](#ConversationMessageParameterPrimitiveDetails)

Description

An array of primitive type details.



 |

## Declarative Metadata Sample Definition

The following is an example of a ConversationMessageDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<ConversationMessageDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <constants\>
        <constantType\>Custom</constantType\>
        <label\>imageAsset</label\>
        <name\>imageAsset</name\>
        <primitiveValues\>
            <contentAssetName\>Screenshot\_20240402\_at\_32437PM</contentAssetName\>
            <type\>ImageAsset</type\>
        </primitiveValues\>
        <valueType\>ImageId</valueType\>
    </constants\>
    <constants\>
        <constantType\>Custom</constantType\>
        <label\>message</label\>
        <name\>message</name\>
        <primitiveValues\>
            <textValue\>Favourite Season</textValue\>
            <type\>Text</type\>
        </primitiveValues\>
        <valueType\>Text</valueType\>
    </constants\>
    <constants\>
        <constantType\>Custom</constantType\>
        <label\>Prompt1</label\>
        <name\>Prompt1</name\>
        <primitiveValues\>
            <textValue\>Choose one option</textValue\>
            <type\>Text</type\>
        </primitiveValues\>
        <valueType\>Text</valueType\>
    </constants\>
    <constants\>
        <compositeValues\>
            <constantItems\>
                <constantType\>Image</constantType\>
                <primitiveValues\>
                    <contentAssetName\>Screenshot\_20240321\_at\_53957PM3</contentAssetName\>
                    <type\>ImageAsset</type\>
                </primitiveValues\>
            </constantItems\>
            <constantItems\>
                <constantType\>SubTitle</constantType\>
                <primitiveValues\>
                    <textValue\>January</textValue\>
                    <type\>Text</type\>
                </primitiveValues\>
            </constantItems\>
            <constantItems\>
                <constantType\>Title</constantType\>
                <primitiveValues\>
                    <textValue\>Jan</textValue\>
                    <type\>Text</type\>
                </primitiveValues\>
            </constantItems\>
            <identifier\>1c6f8c4d-7bce-1649-fa45-db587bcfbb29</identifier\>
        </compositeValues\>
        <compositeValues\>
            <constantItems\>
                <constantType\>Image</constantType\>
                <primitiveValues\>
                    <contentAssetName\>Screenshot\_20240321\_at\_53957PM4</contentAssetName\>
                    <type\>ImageAsset</type\>
                </primitiveValues\>
            </constantItems\>
            <constantItems\>
                <constantType\>SubTitle</constantType\>
                <primitiveValues\>
                    <textValue\>December</textValue\>
                    <type\>Text</type\>
                </primitiveValues\>
            </constantItems\>
            <constantItems\>
                <constantType\>Title</constantType\>
                <primitiveValues\>
                    <textValue\>Dec</textValue\>
                    <type\>Text</type\>
                </primitiveValues\>
            </constantItems\>
            <identifier\>fb8bb328-7bc7-2830-6194-2ae7ece055ad</identifier\>
        </compositeValues\>
        <compositeValues\>
            <constantItems\>
                <constantType\>Image</constantType\>
                <primitiveValues\>
                    <contentAssetName\>Screenshot\_20240321\_at\_53912PM1</contentAssetName\>
                    <type\>ImageAsset</type\>
                </primitiveValues\>
            </constantItems\>
            <constantItems\>
                <constantType\>SubTitle</constantType\>
                <primitiveValues\>
                    <textValue\>March</textValue\>
                    <type\>Text</type\>
                </primitiveValues\>
            </constantItems\>
            <constantItems\>
                <constantType\>Title</constantType\>
                <primitiveValues\>
                    <textValue\>March</textValue\>
                    <type\>Text</type\>
                </primitiveValues\>
            </constantItems\>
            <identifier\>570baa88-fa4d-4b31-0e84-92f87b35af0a</identifier\>
        </compositeValues\>
        <constantType\>Options</constantType\>
    </constants\>
    <constants\>
        <constantType\>Title</constantType\>
        <primitiveValues\>
            <textValue\>What is your favourite month?</textValue\>
            <type\>Text</type\>
        </primitiveValues\>
    </constants\>
    <label\>Favourite Month</label\>
    <language\>en\_US</language\>
    <messageLayouts\>
        <formatType\>Buttons</formatType\>
        <layoutItems\>
            <collectionType\>DynamicList</collectionType\>
            <compositeValues\>
                <compositeTypeName\>TitleOptionItem</compositeTypeName\>
                <layoutItems\>
                    <collectionType\>None</collectionType\>
                    <compositeValues\>
                        <compositeTypeName\>TitleItem</compositeTypeName\>
                        <layoutItems\>
                            <collectionType\>None</collectionType\>
                            <name\>title</name\>
                            <primitiveValues\>
                                <type\>SourcePrimitiveValue</type\>
                                <valueSourceReference\>Constants.Options.ListItem.SubTitle</valueSourceReference\>
                            </primitiveValues\>
                        </layoutItems\>
                    </compositeValues\>
                    <name\>titleItem</name\>
                </layoutItems\>
                <valueSourceReference\>Constants.Options</valueSourceReference\>
            </compositeValues\>
            <name\>optionItems</name\>
        </layoutItems\>
        <layoutItems\>
            <collectionType\>None</collectionType\>
            <name\>text</name\>
            <primitiveValues\>
                <type\>SourcePrimitiveValue</type\>
                <valueSourceReference\>Constants.Title</valueSourceReference\>
            </primitiveValues\>
        </layoutItems\>
        <messageType\>Choices</messageType\>
    </messageLayouts\>
    <messageLayouts\>
        <formatType\>ListPicker</formatType\>
        <layoutItems\>
            <collectionType\>None</collectionType\>
            <compositeValues\>
                <compositeTypeName\>TitleImageItem</compositeTypeName\>
                <layoutItems\>
                    <collectionType\>None</collectionType\>
                    <name\>imageId</name\>
                    <primitiveValues\>
                        <type\>SourcePrimitiveValue</type\>
                        <valueSourceReference\>Constants.imageAsset</valueSourceReference\>
                    </primitiveValues\>
                </layoutItems\>
                <layoutItems\>
                    <collectionType\>None</collectionType\>
                    <name\>title</name\>
                    <primitiveValues\>
                        <type\>SourcePrimitiveValue</type\>
                        <valueSourceReference\>Constants.Title</valueSourceReference\>
                    </primitiveValues\>
                </layoutItems\>
            </compositeValues\>
            <name\>message</name\>
        </layoutItems\>
        <layoutItems\>
            <collectionType\>DynamicList</collectionType\>
            <compositeValues\>
                <compositeTypeName\>TitleOptionItem</compositeTypeName\>
                <layoutItems\>
                    <collectionType\>None</collectionType\>
                    <compositeValues\>
                        <compositeTypeName\>TitleImageItem</compositeTypeName\>
                        <layoutItems\>
                            <collectionType\>None</collectionType\>
                            <name\>imageId</name\>
                            <primitiveValues\>
                                <type\>SourcePrimitiveValue</type\>
                                <valueSourceReference\>Constants.Options.ListItem.Image</valueSourceReference\>
                            </primitiveValues\>
                        </layoutItems\>
                        <layoutItems\>
                            <collectionType\>None</collectionType\>
                            <name\>title</name\>
                            <primitiveValues\>
                                <type\>SourcePrimitiveValue</type\>
                                <valueSourceReference\>Constants.Options.ListItem.Title</valueSourceReference\>
                            </primitiveValues\>
                        </layoutItems\>
                    </compositeValues\>
                    <name\>titleItem</name\>
                </layoutItems\>
                <valueSourceReference\>Constants.Options</valueSourceReference\>
            </compositeValues\>
            <name\>optionItems</name\>
        </layoutItems\>
        <layoutItems\>
            <collectionType\>None</collectionType\>
            <compositeValues\>
                <compositeTypeName\>TitleImageItem</compositeTypeName\>
                <layoutItems\>
                    <collectionType\>None</collectionType\>
                    <name\>imageId</name\>
                    <primitiveValues\>
                        <type\>SourcePrimitiveValue</type\>
                        <valueSourceReference\>Constants.imageAsset</valueSourceReference\>
                    </primitiveValues\>
                </layoutItems\>
                <layoutItems\>
                    <collectionType\>None</collectionType\>
                    <name\>title</name\>
                    <primitiveValues\>
                        <type\>SourcePrimitiveValue</type\>
                        <valueSourceReference\>Constants.message</valueSourceReference\>
                    </primitiveValues\>
                </layoutItems\>
            </compositeValues\>
            <name\>reply</name\>
        </layoutItems\>
        <layoutItems\>
            <collectionType\>None</collectionType\>
            <name\>title</name\>
            <primitiveValues\>
                <type\>SourcePrimitiveValue</type\>
                <valueSourceReference\>Constants.Title</valueSourceReference\>
            </primitiveValues\>
        </layoutItems\>
        <messageType\>Choices</messageType\>
    </messageLayouts\>
    <messageLayouts\>
        <formatType\>Carousel</formatType\>
        <layoutItems\>
            <collectionType\>DynamicList</collectionType\>
            <compositeValues\>
                <compositeTypeName\>TitleItemWithInteractions</compositeTypeName\>
                <layoutItems\>
                    <collectionType\>StaticList</collectionType\>
                    <compositeValues\>
                        <compositeTypeName\>TitleOptionItem</compositeTypeName\>
                        <layoutItems\>
                            <collectionType\>None</collectionType\>
                            <compositeValues\>
                                <compositeTypeName\>TitleItem</compositeTypeName\>
                                <layoutItems\>
                                    <collectionType\>None</collectionType\>
                                    <name\>title</name\>
                                    <primitiveValues\>
                                        <literalValue\>Select One</literalValue\>
                                        <type\>Literal</type\>
                                    </primitiveValues\>
                                </layoutItems\>
                            </compositeValues\>
                            <name\>titleItem</name\>
                        </layoutItems\>
                    </compositeValues\>
                    <name\>interactionItems</name\>
                </layoutItems\>
                <layoutItems\>
                    <collectionType\>None</collectionType\>
                    <compositeValues\>
                        <compositeTypeName\>TitleImageItem</compositeTypeName\>
                        <layoutItems\>
                            <collectionType\>None</collectionType\>
                            <name\>imageId</name\>
                            <primitiveValues\>
                                <type\>SourcePrimitiveValue</type\>
                                <valueSourceReference\>Constants.Options.ListItem.Image</valueSourceReference\>
                            </primitiveValues\>
                        </layoutItems\>
                        <layoutItems\>
                            <collectionType\>None</collectionType\>
                            <name\>subTitle</name\>
                            <primitiveValues\>
                                <type\>SourcePrimitiveValue</type\>
                                <valueSourceReference\>Constants.Options.ListItem.SubTitle</valueSourceReference\>
                            </primitiveValues\>
                        </layoutItems\>
                        <layoutItems\>
                            <collectionType\>None</collectionType\>
                            <name\>title</name\>
                            <primitiveValues\>
                                <type\>SourcePrimitiveValue</type\>
                                <valueSourceReference\>Constants.Title</valueSourceReference\>
                            </primitiveValues\>
                        </layoutItems\>
                    </compositeValues\>
                    <name\>titleItem</name\>
                </layoutItems\>
                <valueSourceReference\>Constants.Options</valueSourceReference\>
            </compositeValues\>
            <name\>items</name\>
        </layoutItems\>
        <messageType\>Choices</messageType\>
    </messageLayouts\>
    <messageLayouts\>
        <formatType\>Text</formatType\>
        <layoutItems\>
            <collectionType\>None</collectionType\>
            <name\>text</name\>
            <primitiveValues\>
                <formulaTemplate\>{!$Constants.Title}
{!$Constants.Prompt1}:
{!$ListTemplates.OptionsList}</formulaTemplate\>
                <mergeFields\>
                    <formulaTemplate\>{!$ListItem.Index}. {!$ListItem.Value.Title}{!BR()}</formulaTemplate\>
                    <mergeFieldType\>ListTemplate</mergeFieldType\>
                    <name\>OptionsList</name\>
                    <valueSourceReference\>Constants.Options</valueSourceReference\>
                </mergeFields\>
                <type\>FormulaTemplate</type\>
            </primitiveValues\>
        </layoutItems\>
        <messageType\>StaticContent</messageType\>
    </messageLayouts\>
    <type\>Picklist</type\>
</ConversationMessageDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Favourite\_Month</members\>
        <name\>ConversationMessageDefinition</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=fb0c053ccbd8e16b04c5f579837d7817e78970d832ac265269c837d35f515449 url=/legacydeveloper/current/en-us/api_meta/meta_conversationmessagedefinitiontranslation.md -->

# ConversationMessageDefinitionTranslation

Represents translated labels and constant values for conversation message definitions in Enhanced Messaging and Messaging for In-App and Web.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This complex type is used as a nested element within the ConversationMessageDefinition metadata type and is not deployed as a standalone metadata component. It enables multilingual support by allowing constant values and labels to be translated into different languages for customer-facing messaging.

## Parent Type

This type is used as a nested complex type within the [ConversationMessageDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_conversationmessagedefinition.htm "Represents a messaging component in an Enhanced Messaging channel or Messaging for In-App and Web session.") metadata type.

## Version

ConversationMessageDefinitionTranslation is available in API version 61.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| constantValueTranslations | 
Field Type

[ConversationMessageConstantValueTranslation\[\]](#ConversationMessageConstantValueTranslation)

Description

Optional. An array of constant value translations that define translated versions of constants within the messaging component. Each element provides translations for specific constant values that customers see in the messaging interface. Available in API version 61.0 and later.



 |
| label | 

Field Type

string

Description

Required. The translated label or display name for the conversation message definition. This represents the name that agents see when selecting messaging components in their preferred language. Available in API version 61.0 and later.



 |
| name | 

Field Type

string

Description

Required. The unique identifier or name of the conversation message definition being translated. This must match the name of the base ConversationMessageDefinition for which this translation is created. Available in API version 61.0 and later.



 |

## ConversationMessageConstantValueTranslation

Represents a translated constant value for conversation message definitions. Available in API version 61.0 and later.

| Field Name | Description |
| --- | --- |
| name | 
Field Type

string

Description

Required. The name of the constant value being translated.



 |
| value | 

Field Type

string

Description

Required. The translated value for this constant.



 |

## Usage Example

This complex type is used within ConversationMessageDefinition to provide translations. Here's an example context:

<?xml version="1.0" encoding="UTF-8"?>
<ConversationMessageDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>Welcome\_Message</fullName\>
    <label\>Welcome Message</label\>
    <conversationMessageDefinitionTranslations\>
        <constantValueTranslations\>
            <name\>greeting\_text</name\>
            <value\>Bienvenido</value\>
        </constantValueTranslations\>
        <label\>Mensaje de Bienvenida</label\>
        <name\>Welcome\_Message</name\>
    </conversationMessageDefinitionTranslations\>
</ConversationMessageDefinition\>

<!-- document id=70ab452c173c8591a1cad8db12e4708642b06bb4f59bd346fbdf86cf72b8f60a url=/legacydeveloper/current/en-us/api_meta/meta_conversationvendorinfo.md -->

# ConversationVendorInfo

Represents the connection between the partner vendor system and the Service Cloud feature. For example, for Service Cloud Voice, this type contains information about the partner telephony system or Contact Center as a Service (CCaaS) system. For Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS, this type contains information about the partner messaging system or CCaaS system.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ConversationVendorInfo components have the suffix .ConversationVendorInformation and are stored in the ConversationVendorInformation folder.

## Version

ConversationVendorInfo components are available in API version 52.0 and later.

## Special Access Rules

This type requires an add-on license for Service Cloud Voice for Partner Telephony or Digital Engagement.

## Fields

The fields in the ConversationVendorInfo type apply to all Service Cloud features unless otherwise stated in the field description. For example, if a field applies to just one Service Cloud Voice telephony model setup or is applied differently by different partner systems, this is stated in the field description.

| Field Name | Description |
| --- | --- |
| agentSSOSupported | 
Field Type

boolean

Description

If set to true, agents can single sign-on (SSO) into their contact center using Salesforce as the identity provider (IdP). Behind the scenes, Salesforce is used as the SAML IdP in the Single Sign-On external client app for the contact center. If set to false, an IdP other than Salesforce is used or an IdP isn’t used at all. The default value is false.

If this value is set to false and you want to use Salesforce as the IdP for your contact center, set this value and the namedCredentialSupported value to true and configure the service\_cloud\_voice.PartnerSSO interface in your Apex integration class.

Available in API version 53.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| awsAccountKey | 

Field Type

string

Description

The 12-digit AWS subaccount ID that’s automatically provisioned for you when Service Cloud Voice was turned on. Available in API version 55.0 and later.

Applies to the following implementation:

- Service Cloud Voice with Amazon Connect





 |
| awsRootEmail | 

Field Type

string

Description

The email address used by Salesforce to create the root user for the provisioned AWS subaccount when Service Cloud Voice was turned on. Available in API version 55.0 and later.

Applies to the following implementation:

- Service Cloud Voice with Amazon Connect





 |
| awsTenantVersion | 

Field Type

double

Description

The version number of the SVCTenantStack AWS CloudFormation stack that’s deployed. The stack is deployed in AWS region "us-east-1". Available in API version 55.0 and later.

Applies to the following implementation:

- Service Cloud Voice with Amazon Connect





 |
| bridgeComponent | 

Field Type

string

Description

The Lightning component used to communicate between the telephony or messaging system and other Lightning components.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| clientAuthMode | 

Field Type

ClientAuthMode (enumeration of type string)

Description

The client authentication mode.

Values are:

- Custom
- Mixed
- SSO

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect





 |
| connectorUrl | 

Field Type

string

Description

The URL that hosts your Service Cloud Voice or Bring Your Own Channel for CCaaS connector. This value could be a Visualforce page or a public URL.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| customConfig | 

Field Type

string

Description

The foreign key to the CustomEntityDefinition, which contains partner-specific custom settings. Available in API version 53.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| customIcon | 

Field Type

string

Description

ID of the static resource used to identify the contact center integration, such as a Contact Center as a Service (CCaaS) provider logo. The static resource must be in SVG format. This field is optional. Available in API version 62.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Bring Your Own Channel for CCaaS





 |
| customLoginUrl | 

Field Type

string

Description

The URL that hosts your telephony system or CCaaS system login page.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS (supported when combined with a telephony CCaaS integration)





 |
| developerName | 

Field Type

string

Description

The unique name of the type in the API.



 |
| einsteinConversationInsightsSupported | 

Field Type

boolean

Description

If set to true, Einstein Conversation Insights is turned on. The default value is false. Available in API version 53.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect





 |
| integrationClass | 

Field Type

string

Description

The foreign key to the partner Apex class implementing supported interfaces. Available in API version 53.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| integrationClassName | 

Field Type

string

Description

Deprecated in API version 53.0. Don't set this field. Instead, use integrationClass.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect





 |
| intelligenceSupported | 

Field Type

boolean

Description

If set to true, Salesforce ingests real-time signals sent from a partner telephony system. If set to false, Salesforce won't ingest real-time intelligence signals from a partner telephony system. The default value is false. Available in API version 59.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony





 |
| isTaxCompliant | 

Field Type

boolean

Description

Indicates whether the Amazon tax settings for the AWS subaccount provisioned for Service Cloud Voice have been confirmed (true). The default value is false. Available in API version 55.0 and later.

Applies to the following implementation:

- Service Cloud Voice with Amazon Connect





 |
| keyProvisioningSupported | 

Field Type

boolean

Description

If set to true, key provisioning and renewal are automated. The default value is false. Available in API version 54.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect





 |
| masterLabel | 

Field Type

string

Description

The partner vendor's display name as it appears in the UI. This name appears in several places in the UI, so include the partner vendor name for easy identification. For Service Cloud Voice, this label also represents the telephony provider name in the contact center record.

For Service Cloud Voice with Amazon Connect, this field is always set to Service Cloud Voice.



 |
| namedCredential | 

Field Type

string

Description

A sample-named credential that can be used for Apex callouts to the partner system. Available in API version 53.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| namedCredentialSupported | 

Field Type

boolean

Description

A sample-named credential that can be used for Apex callouts to the partner system. Available in API version 53.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| partnerContactCenterListSupported | 

Field Type

boolean

Description

If set to true, enables the customer to select one contact center from a list of multiple contact centers to connect with Salesforce. The default value is false. Available in API version 53.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| partnerPhoneNumbersSupported | 

Field Type

boolean

Description

If set to true, displays a list of phone numbers used to create contact center channels. The default value is false. Available in API version 54.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect





 |
| partnerTransferDestinationsSupported | 

Field Type

boolean

Description

If set to true, allows Salesforce to fetch contact center queues so that Salesforce and contact center queues can be mapped. The default value is false. Available in API version 53.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| queueManagementSupported | 

Field Type

boolean

Description

If set to true, support queue management. The default value is false. Available in API version 56.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| serverAuthMode | 

Field Type

ServerAuthMode (enumeration of type string)

Description

Deprecated in API 53.0. Server authentication mode. Set this value to None.

Values are:

- None
- OAuth

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect





 |
| telephonySettingsComponent | 

Field Type

string

Description

The name of the Lightning Web Component (LWC) that is used to display additional agent settings in the Omni-Channel widget. This value is in the format mynamespace:componentName, where mynamespace is the namespace associated with the Service Cloud Voice package that was created, and componentName is the FQDN of the Lightning component.

Available in API version 54.0 and later.

Applies to the following implementation:

- Service Cloud Voice with Partner Telephony





 |
| unifiedRoutingSupported | 

Field Type

boolean

Description

Indicates whether unified routing is supported (true) or not supported (false) for voice calls in voice channels. The default value is false. Once this value is set to true, it can’t be changed to false.

Available in API version 63.0 and later.

Applies to the following implementation:

- Service Cloud Voice with Partner Telephony





 |
| universalCallRecordingAccessSupported | 

Field Type

boolean

Description

If set to true, Universal Call Recording Access is turned on. The default value is false.

If this value is set to false and you want to turn on Universal Call Recording, set this value to true and configure the service\_cloud\_voice.RecordingMediaProvider interface in your Apex integration class.

Available in API version 54.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect





 |
| userSyncingSupported | 

Field Type

boolean

Description

If set to true, supports automated user syncing whenever a user is added to or removed from a contact center. The default value is false. Available in API version 53.0 and later.

Applies to the following implementations:

- Service Cloud Voice with Partner Telephony
- Service Cloud Voice with Partner Telephony from Amazon Connect
- Bring Your Own Channel for CCaaS





 |
| vendorType | 

Field Type

ConversationVendorType (enumeration of type string)

Description

The Service Cloud feature the partner vendor supports.

Possible values are:

- Amazon\_Connect — For Service Cloud Voice with Amazon Connect.
- BringYourOwnChannelPartner — For Bring Your Own Channel for Messaging. Available in API version 60.0 and later.
- BringYourOwnContactCenter — For Bring Your Own Channel for Contact Center as a Service (CCaaS). Available in API version 60.0 and later.
- ServiceCloudVoicePartner — For Service Cloud Voice with Partner Telephony or Service Cloud Voice with Partner Telephony from Amazon Connect.

Available in API version 53.0 and later.



 |

## Declarative Metadata Sample Definition

The following is an example of a ConversationVendorInfo component.

<?xml version="1.0" encoding="UTF-8"?>
<ConversationVendorInfo xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <einsteinConversationInsightsSupported\>true</einsteinConversationInsightsSupported\>
    <partnerContactCenterListSupported\>true</partnerContactCenterListSupported\>
    <namedCredentialSupported\>true</namedCredentialSupported\>
    <partnerTransferDestinationsSupported\>true</partnerTransferDestinationsSupported\>
    <agentSSOSupported\>true</agentSSOSupported\>
    <keyProvisioningSupported\>true</keyProvisioningSupported\>
    <universalCallRecordingAccessSupported\>true</universalCallRecordingAccessSupported\>
    <partnerPhoneNumbersSupported\>true</partnerPhoneNumbersSupported\>
    <queueManagementSupported\>true</queueManagementSupported\>
    <clientAuthMode\>SSO</clientAuthMode\>
    <connectorUrl\>https://exampleconnectorurl.com</connectorUrl\>
    <customConfig\>exampleCustomConfig\_\_c</customConfig\>
    <customLoginUrl\>testurl</customLoginUrl\>
    <integrationClass\>ExampleIntegrationImpl</integrationClass\>
    <masterLabel\>Example Partner Name</masterLabel\>
    <developerName\>exampledevname</developerName\>
    <namedCredential\>exampleNamedCredential</namedCredential\>
    <userSyncingSupported\>true</userSyncingSupported\>
    <vendorType\>BringYourOwnContactCenter</vendorType\>
</ConversationVendorInfo\>

The following is an example package.xml that references the previous definition.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ConversationVendorInfo</name\>
    </types\>
    <version\>59.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=9817cd62994c7980b59bdb54bd1ac38e35d31731e203a2dc2fd5af36910864ed url=/legacydeveloper/current/en-us/api_meta/meta_convintelligencesignalrule.md -->

# ConvIntelligenceSignalRule

Represents the conversation intelligence signal rule. The rule triggers actions based on real-time intelligence signals from your telephony system or keywords mentioned by support reps or customers. The rule contains a set of conditions (subrules) and the filter logic used to evaluate those conditions to determine whether to trigger actions.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ConvIntelligenceSignalRule components have the suffix .ConvIntelligenceSignalRule and are stored in the ConvIntelligenceSignalRule folder.

## Version

ConvIntelligenceSignalRule components are available in API version 62.0 and later.

## Special Access Rules

This type requires an add-on license for Service Cloud Voice for Amazon Connect, Service Cloud Voice for Partner Telephony with Amazon Connect, Service Cloud Voice for Partner Telephony, or Digital Engagement.

## Fields

| Field Name | Description |
| --- | --- |
| actionType | 
Field Type

ConvIntelligenceActionType (enumeration of type string)

Description

Required. The conversation intelligence signal type. Values are:

- AlertSupervisor–Sends an alert to the supervisor.
- AlertSupervisorAndAgent–Sends an alert to the rep and supervisor.
- LaunchFlow–Triggers an auto-launched flow. If set, also set ActionValue.
- LaunchNBA–Recommends the next best action to the rep.





 |
| actionValue | 

Field Type

string

Description

Action to perform based on the actionType specified.

If actionType is set to LaunchFlow, this value is the developerName of the flow to be launched. For example, EmailAlert.

For all other actionType values, don’t set this parameter.





 |
| active | 

Field Type

boolean

Description

Required. Indicates whether the conversation intelligence signal rule is active (true) or inactive (false). The default value is false.



 |
| channelAddressIdentifier | 

Field Type

string

Description

Required. ID (ChannelAddressIdentifier) of the Messaging channel or name (InternalName) of the Voice channel.





 |
| channelType | 

Field Type

string

Description

Required. Channel type.

For Messaging, possible values are:

- AppleBusinessChat—Represents Apple Messages for Business.
- Custom—Represents Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS.
- EmbeddedMessaging—Represents Messaging for In-App and Web.
- Facebook
- Text
- WhatsApp

For Voice, set this parameter to Phone.





 |
| criteria | 

Field Type

string

Description

Required. Filter logic applied to the rule conditions (subrules). For example, ((1 AND 2) OR 3). The numbers in the formula are derived from the ConvIntelligenceSignalSubRule.order value plus 1. For example, filter logic (1 AND 2) is calculated by adding the first condition (order\=0) with the second condition (order\=1).



 |
| developerName | 

Field Type

string

Description

Required. API name of the conversation intelligence signal rule.



 |
| participantRole | 

Field Type

ConvParticipantRole (enumeration of type string)

Description

If service is set to KeywordMatch, this value determines whether the rule applies to utterances made by reps, customers, or both roles. Possible values are:

Possible values are:

- Agent
- AgentOrCustomer
- Customer

If Service is not set to KeywordMatch, don’t set this parameter.



 |
| ruleName | 

Field Type

string

Description

Required. Name of the conversation intelligence signal rule.



 |
| service | 

Field Type

ConvIntelligenceService (enumeration of type string)

Description

Required. Salesforce- or partner-provided intelligence source.

For Salesforce-provided intelligence sources, set this parameter to KeywordMatch.

For partner-provided intelligence sources, possible values are:

- KeywordMatch
- AmazonConnectContactLens

If none of the options apply to you, contact your Salesforce representative for the service name.





 |
| subrule | 

Field Type

[ConvIntelligenceSignalSubRule\[\]](#ConvIntelligenceSignalSubRule)

Description

A set of intelligence rules used to measure an agent or customer’s sentiment during a voice call.



 |

## ConvIntelligenceSignalSubRule

Represents a condition (subrule) within a conversation intelligence signal rule.

| Field Name | Description |
| --- | --- |
| operandValue | 
Field Type

string

Description

Required. Value of the signal type used to determine if the rule condition is met.





 |
| operator | 

Field Type

ConvIntelligenceOperator (enumeration of type string)

Description

Required. Filter logic operator used to determine if the rule condition is met. Possible values are:

- Equals
- GreaterThan
- In
- LessThan
- NotEquals



 |
| order | 

Field Type

int

Description

Required. Order the condition appears in relation to the other conditions in the list, with zero (0) being the first condition listed. If type is set to Keyword, the maximum value is 24. For all other type values, the maximum value is 4. This value is used when applying filter logic to the rule.





 |
| type | 

Field Type

ConvIntelligenceType (enumeration of type string)

Description

Required. Type of conversation intelligence signal used by the rule to determine whether to trigger an action. This value depends on the ConvIntelligenceSignalRule.channelType and ConvIntelligenceSignalRule.service values.

If service is set to KeywordMatch, possible values are:

- Keyword–A word or group of words spoken or typed.

If service is set to AmazonConnectContactLens, possible values are:

- Category–Category name defined in your telephony system.

If service is set to another value, contact your Salesforce representative for the conversation intelligence signal types available for your intelligence source.



 |

## Declarative Metadata Sample Definition

The following is an example of a ConvIntelligenceSignalRule component.

<?xml version="1.0" encoding="UTF-8"?>
<ConvIntelligenceSignalRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionType\>AlertSupervisor</actionType\>
    <active\>true</active\>   <channelAddressIdentifier\>a12bc345-1303-44c2-866c-f30d546b58de</channelAddressIdentifier\>
    <channelType\>Phone</channelType\>
    <criteria\>1 OR 2</criteria\>
    <developerName\>ConvIntelligenceRuleAPIName</developerName\>
    <participantRole\>AgentOrCustomer</participantRole\>
    <ruleName\>ConvIntelligenceRuleName</ruleName\>
    <service\>KeywordMatch</service\>
    <subrule\>
        <operandValue\>escalate\_level\_1</operandValue\>
        <operator\>Equals</operator\>
        <order\>0</order\>
        <type\>Keyword</type\>
    </subrule\>
    <subrule\>
        <operandValue\>escalate\_level\_2</operandValue\>
        <operator\>Equals</operator\>
        <order\>1</order\>
        <type\>Keyword</type\>
    </subrule\>
</ConvIntelligenceSignalRule\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ConversationIntelligenceSignalRule</name\>
    </types\>
    <version\>62.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=a041bda28fa15b4388e7cd89d7d84d2930817b68bf1f3ed81bf0bb738e79e27a url=/legacydeveloper/current/en-us/api_meta/meta_corswhitelistorigin.md -->

# CorsWhitelistOrigin

Represents an origin in the CORS allowlist.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

## File Suffix and Directory Location

CorsWhitelistOrigin components have the suffix .corswhitelistorigin and are stored in the corswhitelistorigins folder.

## Version

CorsWhitelistOrigin components are available in API version 32.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d296354e87">Field Name</th>

              <th class="featureTableHeader  " id="d296354e90">Field Type</th>

              <th class="featureTableHeader  " id="d296354e93">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d296354e87" data-title="Field Name"><span class="keyword parmname">urlPattern</span></td>

              <td class="entry" headers="d296354e90" data-title="Field Type">String</td>

              <td class="entry" headers="d296354e93" data-title="Description">A URL pattern for the origin. <p class="p">The origin URL pattern must include the HTTPS
                  protocol and a domain name, and can include a port. The wildcard character (*) is
                  supported and must be in front of a second-level domain name. For example,
                  <span class="ph filepath">https://*.example.com</span> adds all subdomains of
                  <span class="ph filepath">example.com</span> to the allowlist.
                </p>
                <p class="p">Google Chrome™ and
                  Mozilla® Firefox® browser extensions are also allowed as resources in API version
                  53 and later. Chrome extensions must use the prefix <samp class="codeph nolang">chrome-extension://</samp> and 32 characters without
                  digits or capital letters, for example <samp class="codeph nolang">chrome-extension://abdkkegmcbiomijcbdaodaflgehfffed</samp>. Firefox
                  extensions must use the prefix <samp class="codeph nolang">moz-extension://</samp> and an 8-4-4-4-12 format of small alphanumeric
                  characters, for example <samp class="codeph nolang">moz-extension://1234ab56-78c9-1df2-3efg-4567891hi1j2</samp>.</p>
                <p class="p">The origin
                  URL pattern can be an IP address. But an IP address and a domain that resolve to
                  the same address aren’t the same origin, and you must add them to the CORS
                  allowlist as separate entries.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s an example package manifest used to deploy or retrieve the CorsWhitelistOrigin metadata for an organization.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>CorsWhitelistOrigin</name\>
    </types\>
    <version\>32.0</version\>
</Package\>

Here’s an example of a CorsWhitelistOrigin component.

<?xml version="1.0" encoding="UTF-8"?>
<CorsWhitelistOrigin xmlns="http://soap.sforce.com/2006/04/metadata">
    <developerName\>CorsWhitelistEntry1</developerName\>
    <urlPattern\>https://\*.example.com</urlPattern\>
</CorsWhitelistOrigin\>

## Usage

[CORS](http://www.w3.org/TR/cors/ "HTML (New Window)") (cross-origin resource sharing) is a W3C recommendation that enables Web browsers to request resources from origins other than their own. For example, using CORS, a JavaScript script at https://www.example.com could request a resource from https://www.salesforce.com.

If a browser that supports CORS makes a request to an origin in your allowlist, Salesforce returns the origin in the Access-Control-Allow-Origin HTTP header, along with any additional CORS HTTP headers. If the origin isn’t allow listed, Salesforce returns HTTP status code 404.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=10271d07e7691249716ee5491b2b6ecc2cddbae3247e6082281b1661c44fd6f9 url=/legacydeveloper/current/en-us/api_meta/meta_create.md -->

# create()

Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.

## Syntax

 [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")\[\] = metadatabinding.create([Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\] metadata);

## Usage

Use this call to add one or more metadata components to your organization.

## Version

This call is available in API version 30.0 and earlier only. This call isn’t available in API version 31.0 and later. Use [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") instead.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Required Fields

The metadata components being created determine required fields. For more information about specific component types, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

## Valid Data Values

You must supply values that are valid for the field’s data type, such as integers for integer fields (not alphabetic characters). In your client application, follow the data formatting rules specified for your programming language and development tool. (Your development tool handles the appropriate mapping of data types in SOAP messages).

## String Values

When storing values in string fields, the API trims any leading and trailing whitespace. For example, if the value of a label field is entered as "MyObject ", the value is stored in the database as "MyObject".

## Basic Steps for Creating Metadata Components

Use the following process to create metadata components:

1. Design an array, and populate it with the components you want to create. All components must be of the same type.
2. Call [create()](# "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.") with the component array passed in as an argument.
3. An [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is returned for each component you try to create, and is updated with status information as the operation moves from a queue to completed or error state. Call [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") in a loop until the status values in [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") indicate that all create operations are completed. Start with a wait time of 1 second between iterations of [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") calls, and double the wait time each time you make a subsequent call.

## Sample Code—Java

See [Step 3: Walk Through the Java Sample Code](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_java_sample.htm) for sample Java code using the create() call.

#### See Also

- [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.")
- [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead.")
- [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead.")
- [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.")

## Arguments

### metadata

- **Type**: [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\]
- **Description**: Array of one or more metadata components.
    
    Limit: 10.
    
    You must submit arrays of only one type of component. For example, you could submit an array of 10 custom objects or 10 profiles, but not a mix of both types.

## Response

[AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")\[\]

<!-- document id=ad8d8815f5c0b7317eddda85f34808d80868b8ec2bf9e0e4c2fa890466ac7993 url=/legacydeveloper/current/en-us/api_meta/meta_createMetadata.md -->

# createMetadata()

Adds one or more new metadata components to your organization synchronously.

## Syntax

[SaveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_saveResult.htm "Contains result information for the createMetadata, updateMetadata, or renameMetadata call.")\[\] = metadatabinding.createMetadata(
                [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\] metadata);

## Usage

Use the createMetadata() call to create any component that extends [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm). All components must be of the same type in the same call. For more details, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

This call executes synchronously, which means that the call returns only when the operation completes.

Starting in API version 34.0, this call supports the [AllOrNoneHeader](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_allornoneheader.htm "Indicates whether to roll back all metadata changes when some of the records in a call result in failures.") header. By default, if AllOrNoneHeader isn’t used in API version 34.0 and later, this call can save a partial set of records for records with no errors (equivalent to AllOrNoneHeader=false). In API version 33.0 and earlier, the default behavior is to only save all records when there are no failures in any record in the call (equivalent to AllOrNoneHeader=true).

## Version

Available in API version 30.0 and later.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Required Fields

The metadata components being created determine required fields. For more information about specific component types, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

## Valid Data Values

You must supply values that are valid for the field’s data type, such as integers for integer fields (not alphabetic characters). In your client application, follow the data formatting rules specified for your programming language and development tool. (Your development tool handles the appropriate mapping of data types in SOAP messages.)

## String Values

When storing values in string fields, the API trims any leading and trailing whitespace. For example, if the value of a label field is entered as "MyObject ", the value is stored in the database as "MyObject".

## Basic Steps for Creating Metadata Components

Follow this process to create metadata components.

1. Design an array, and populate it with the components that you want to create. All components must be of the same type.
2. Call createMetadata() with the component array passed in as an argument.
3. A SaveResult object is returned for each component you tried to create. It contains information about whether the operation was successful, the name of the component created, and any errors returned if the operation wasn’t successful.

## Sample Code—Java

public void createCustomObjectSync() {
    try {
        CustomObject co = new CustomObject();
        String name = "MyCustomObject1";
        co.setFullName(name + "\_\_c");
        co.setDeploymentStatus(DeploymentStatus.Deployed);
        co.setDescription("Created by the Metadata API");
        co.setEnableActivities(true);
        co.setLabel(name + " Object");
        co.setPluralLabel(co.getLabel() + "s");
        co.setSharingModel(SharingModel.ReadWrite);

        CustomField nf = new CustomField();
        nf.setType(FieldType.Text);
        nf.setLabel(co.getFullName() + " Name");
        co.setNameField(nf);

        SaveResult\[\] results = metadataConnection
                .createMetadata(new Metadata\[\] { co });

        for (SaveResult r : results) {
            if (r.isSuccess()) {
                System.out.println("Created component: " + r.getFullName());
            } else {
                System.out
                        .println("Errors were encountered while creating "
                                + r.getFullName());
                for (Error e : r.getErrors()) {
                    System.out.println("Error message: " + e.getMessage());
                    System.out.println("Status code: " + e.getStatusCode());
                }
            }
        }
    } catch (ConnectionException ce) {
        ce.printStackTrace();
    }
}

## Arguments

### metadata

- **Type**: [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\]
- **Description**: Array of one or more metadata components.
    
    Limit: 10. (For [CustomMetadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_custommetadata.htm) and [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_customapplication.htm) only, the limit is 200.)
    
    You must submit arrays of only one type of component. For example, you can submit an array of 10 custom objects or 10 profiles, but not a mix of both types.

## Response

[SaveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_saveResult.htm "Contains result information for the createMetadata, updateMetadata, or renameMetadata call.")\[\]

<!-- document id=7ba673b7c06ea981c0b844ca5dfb5512cdc5104a2dd9213e889519a75545695f url=/legacydeveloper/current/en-us/api_meta/meta_cbsrule.md -->

# CriteriaBasedSharingRule

This component is removed as of API version 33.0 and is available in earlier versions only. Use [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm "Represents the base container for sharing rules, which can be criteria-based, ownership-based, territory-based, or for guest user access. SharingRules enables you to share records with a set of users, using rules that specify the access level for the target user group.") instead. Represents a criteria-based sharing rule. CriteriaBasedSharingRule enables you to share records based on specific criteria.

It extends the [BaseSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_basesharingrule.htm "This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingBaseRule instead. Represents the base container for criteria-based and owner-based sharing rules.") metadata type and inherits its sharedTo field. For more information, see “Criteria-Based Sharing Rules Overview” in Salesforce Help.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can’t create a CrteriaBasedSharingRule component directly. Use the child components instead.

## Declarative Metadata File Suffix and Directory Location

CriteriaBasedSharingRule components are stored within the SharingRules component in the criteriaBasedRules field.

## Version

CriteriaBasedSharingRule components are available in API version 24.0 and later.

## Special Access Rules

As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object, and only users with the Manage Sharing permission can edit this object.

## Fields

The following information assumes that you’re familiar with implementing sharing rules for standard objects and custom objects. For more information on these fields, see Sharing Settings in Salesforce Help.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234897e125">Field</th>

              <th class="featureTableHeader  " id="d234897e128">Field Type</th>

              <th class="featureTableHeader  " id="d234897e131">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234897e125" data-title="Field"><span class="keyword parmname" id="CriteriaItems-BA2C0F3A"><a name="CriteriaItems-BA2C0F3A"><!-- --></a>criteriaItems</span></td>

              <td class="entry" headers="d234897e128" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a>[]
              </td>

              <td class="entry" headers="d234897e131" data-title="Description">List that represents the criteria for the sharing rule. The possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">field</samp></li>

                  <li class="li"><samp class="codeph nolang">operation</samp></li>

                  <li class="li"><samp class="codeph nolang">value</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## AccountCriteriaBasedSharingRule

Represents a criteria-based sharing rule for accounts. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field.

AccountCriteriaBasedSharingRule is used by the criteriaBasedRules field in [AccountSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#AccountSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234897e207">Field</th>

              <th class="featureTableHeader  " id="d234897e210">Field Type</th>

              <th class="featureTableHeader  " id="d234897e213">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234897e207" data-title="Field"><span class="keyword parmname">accountAccessLevel</span></td>

              <td class="entry" headers="d234897e210" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoNone</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e213" data-title="Description">Required. A value that represents the level of access that the user or group
                has to the account. The possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">All</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e207" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d234897e210" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e213" data-title="Description">Represents the filter logic of the sharing rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e207" data-title="Field"><span class="keyword parmname">caseAccessLevel</span></td>

              <td class="entry" headers="d234897e210" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoAll</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e213" data-title="Description">Required. A value that represents the level of access that the user or group
                has to cases associated with the account. The possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e207" data-title="Field"><span class="keyword parmname">contactAccessLevel</span></td>

              <td class="entry" headers="d234897e210" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoAll</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e213" data-title="Description">Required. A value that represents the level of access that the user or group
                has to contacts associated with the account. The possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e207" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d234897e210" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e213" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters. <p class="p" id="descAPI"><a name="descAPI"><!-- --></a>This field is available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e207" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d234897e210" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e213" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e207" data-title="Field"><span class="keyword parmname">opportunityAccessLevel</span></td>

              <td class="entry" headers="d234897e210" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoAll</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e213" data-title="Description">Required. A value that represents the level of access that a target group is
                granted for any associated opportunity. The possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## CampaignCriteriaBasedSharingRule

Represents a criteria-based sharing rule for campaigns. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field.

CampaignCriteriaBasedSharingRule is used by the criteriaBasedRules field in [CampaignSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#CampaignSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234897e420">Field</th>

              <th class="featureTableHeader  " id="d234897e423">Field Type</th>

              <th class="featureTableHeader  " id="d234897e426">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234897e420" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d234897e423" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e426" data-title="Description">Represents the filter logic of the sharing rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e420" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d234897e423" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e426" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.
                This field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e420" data-title="Field"><span class="keyword parmname">campaignAccessLevel</span></td>

              <td class="entry" headers="d234897e423" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoNone</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e426" data-title="Description">Required. A value that represents the level of access that a target group is
                granted for a campaign. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">All</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e420" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d234897e423" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e426" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

          </tbody>

        </table>

## CaseCriteriaBasedSharingRule

Represents a criteria-based sharing rule for cases. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field.

CaseCriteriaBasedSharingRule is used by the criteriaBasedRules field in [CaseSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#CaseSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234897e543">Field</th>

              <th class="featureTableHeader  " id="d234897e546">Field Type</th>

              <th class="featureTableHeader  " id="d234897e549">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234897e543" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d234897e546" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e549" data-title="Description">Represents the filter logic of the sharing rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e543" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d234897e546" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e549" data-title="Description">Represents the description of the sharing rule. Maximum of 1000
                characters.<p class="p">This field is available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e543" data-title="Field"><span class="keyword parmname">caseAccessLevel</span></td>

              <td class="entry" headers="d234897e546" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e549" data-title="Description">Required. A value that represents the level of access being granted for a case.
                The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e543" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d234897e546" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e549" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

          </tbody>

        </table>

## ContactCriteriaBasedSharingRule

Represents a criteria-based sharing rule for contacts. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field.

ContactCriteriaBasedSharingRule is used by the criteriaBasedRules field in [ContactSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#ContactSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234897e664">Field</th>

              <th class="featureTableHeader  " id="d234897e667">Field Type</th>

              <th class="featureTableHeader  " id="d234897e670">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234897e664" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d234897e667" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e670" data-title="Description">Represents the filter logic of the sharing rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e664" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d234897e667" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e670" data-title="Description">Represents the description of the sharing rule. Maximum of 1000
                characters.<p class="p">This field is available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e664" data-title="Field"><span class="keyword parmname">contactAccessLevel</span></td>

              <td class="entry" headers="d234897e667" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e670" data-title="Description">Required. A value that represents the level of access being granted to the
                target group, role, or user for a contact. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e664" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d234897e667" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e670" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

          </tbody>

        </table>

## LeadCriteriaBasedSharingRule

Represents a criteria-based sharing rule for leads. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field.

LeadCriteriaBasedSharingRule is used by the criteriaBasedRules field in [LeadSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#LeadSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234897e785">Field</th>

              <th class="featureTableHeader  " id="d234897e788">Field Type</th>

              <th class="featureTableHeader  " id="d234897e791">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234897e785" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d234897e788" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e791" data-title="Description">Represents the filter logic of the sharing rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e785" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d234897e788" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e791" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.
                This field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e785" data-title="Field"><span class="keyword parmname">leadAccessLevel</span></td>

              <td class="entry" headers="d234897e788" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e791" data-title="Description">Required. A value that represents the level of allowed access. The possible
                values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e785" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d234897e788" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e791" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

          </tbody>

        </table>

## OpportunityCriteriaBasedSharingRule

Represents a criteria-based sharing rule for opportunities. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field.

OpportunityCriteriaBasedSharingRule is used by the criteriaBasedRules field in [OpportunitySharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#OpportunitySharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234897e905">Field</th>

              <th class="featureTableHeader  " id="d234897e908">Field Type</th>

              <th class="featureTableHeader  " id="d234897e911">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234897e905" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d234897e908" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e911" data-title="Description">Represents the filter logic of the sharing rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e905" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d234897e908" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e911" data-title="Description">Represents the description of the sharing rule. Maximum of 1000
                characters.<p class="p">This field is available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e905" data-title="Field"><span class="keyword parmname">opportunityAccessLevel</span></td>

              <td class="entry" headers="d234897e908" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e911" data-title="Description">Required. A value that represents the level of allowed access. The possible
                values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e905" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d234897e908" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e911" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

          </tbody>

        </table>

## CustomObjectCriteriaBasedSharingRule

Represents a criteria-based sharing rule for custom objects. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field.

CustomObjectCriteriaBasedSharingRule is used by the criteriaBasedRules field in [CustomObjectSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#CustomObjectSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234897e1026">Field</th>

              <th class="featureTableHeader  " id="d234897e1029">Field Type</th>

              <th class="featureTableHeader  " id="d234897e1032">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234897e1026" data-title="Field"><span class="keyword parmname">accessLevel</span></td>

              <td class="entry" headers="d234897e1029" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e1032" data-title="Description">Required. A value that represents the type of allowed sharing. The possible
                values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">All</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e1026" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d234897e1029" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e1032" data-title="Description"><span class="ph" id="bool"><a name="bool"><!-- --></a>Represents the filter logic of the sharing rule.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e1026" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d234897e1029" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e1032" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.
                <p class="p">This field is available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e1026" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d234897e1029" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e1032" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

          </tbody>

        </table>

## UserCriteriaBasedSharingRule

Represents a criteria-based sharing rule for users. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field.

UserCriteriaBasedSharingRule is used by the criteriaBasedRules field in [UserSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#UserSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d234897e1150">Field</th>

              <th class="featureTableHeader  " id="d234897e1153">Field Type</th>

              <th class="featureTableHeader  " id="d234897e1156">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d234897e1150" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d234897e1153" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e1156" data-title="Description">Represents the filter logic of the sharing rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e1150" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d234897e1153" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e1156" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.
                <p class="p">This field is available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e1150" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d234897e1153" data-title="Field Type">string</td>

              <td class="entry" headers="d234897e1156" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d234897e1150" data-title="Field"><span class="keyword parmname">userAccessLevel</span></td>

              <td class="entry" headers="d234897e1153" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d234897e1156" data-title="Description">Required. A value that represents the type of allowed sharing. The possible
                values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of two owner-based sharing rules and one criteria-based sharing rule containing two criteria items. The file name corresponds to the Account.sharingRules file under the accountSharingRules directory.

<?xml version="1.0" encoding="UTF-8"?>
<AccountSharingRules xmlns="http://soap.sforce.com/2006/04/metadata">
  <ownerRules\>
    <fullName\>G1Dev\_G2New</fullName\>
    <sharedTo\>
      <group\>G2New</group\>
    </sharedTo\>
    <sharedFrom\>
      <group\>G1Dev</group\>
    </sharedFrom\>
    <accountAccessLevel\>Read</accountAccessLevel\>
    <caseAccessLevel\>None</caseAccessLevel\>
    <contactAccessLevel\>Read</contactAccessLevel\>
  </ownerRules\>
    <fullName\>G2New\_R1New</fullName\>
    <sharedTo\>
      <roleAndSubordinates\>R1New</roleAndSubordinates\>
    </sharedTo\>
    <sharedFrom\>
      <group\>G2New</group\>
    </sharedFrom\>
    <accountAccessLevel\>Edit</accountAccessLevel\>
    <caseAccessLevel\>Read</caseAccessLevel\>
    <contactAccessLevel\>Edit</contactAccessLevel\>
    <name\>G2New\_R1New</name\>
    <opportunityAccessLevel\>None</opportunityAccessLevel\>
  </ownerRules\>
  <criteriaBasedRules\>
    <fullName\>AccountCriteria</fullName\>
    <sharedTo\>
      <group\>G1</group\>
    </sharedTo\>
    <criteriaItems\>
      <field\>BillingCity</field\>
      <operation\>equals</operation\>
      <value\>San Francisco</value\>
    </criteriaItems\>
    <criteriaItems\>
      <field\>MyChkBox\_\_c</field\>
      <operation\>notEqual</operation\>
      <value\>False</value\>
    </criteriaItems\>
    <accountAccessLevel\>Read</accountAccessLevel\>
    <booleanFilter\>1 OR 2</booleanFilter\>
    <caseAccessLevel\>None</caseAccessLevel\>
    <contactAccessLevel\>Read</contactAccessLevel\>
    <name\>AccountCriteria</name\>
    <opportunityAccessLevel\>None</opportunityAccessLevel\>
  </criteriaBasedRules\>
</AccountSharingRules\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_basesharingrule.htm "BaseSharingRule")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm "OwnerSharingRule")

<!-- document id=e417fd97e4516aca3393ba4466f38376ca6b39b08eebfa0ead1c19b70f4fe4ef url=/legacydeveloper/current/en-us/api_meta/meta_crud_based_calls_intro.md -->

# CRUD-Based Calls

Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects.

- **[createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm)**  
    Adds one or more new metadata components to your organization synchronously.
- **[readMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_readMetadata.htm)**  
    Returns one or more metadata components from your organization synchronously.
- **[updateMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_updateMetadata.htm)**  
    Updates one or more metadata components in your organization synchronously.
- **[upsertMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_upsertMetadata.htm)**  
    Creates or updates one or more metadata components in your organization synchronously.
- **[deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm)**  
    Deletes one or more metadata components from your organization synchronously.
- **[renameMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_renameMetadata.htm)**  
    Renames a metadata component in your organization synchronously.
- **[create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm)**  
    Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.
- **[delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm)**  
    Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead.
- **[update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm)**  
    Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead.

<!-- document id=f34241a90ff73c9bc688003c33256feb67ed9f99ef75513262d37c02c144c9c7 url=/legacydeveloper/current/en-us/api_meta/meta_calls_intro.md -->

# CRUD-Based Metadata API Calls

Use the CRUD-based metadata calls to create, update, or delete setup and configuration components for your organization or application. These configuration components include custom objects, custom fields, and other configuration metadata. The metadata calls mimic the behavior in the Salesforce user interface for creating, updating, or deleting components. Whatever rules apply there also apply to these calls.

Metadata calls are different from the core, synchronous API calls in these ways.

- Metadata API calls are available in a separate WSDL. To download the WSDL, log into Salesforce, from Setup, enter API in the Quick Find box, then select **API** and click the Download Metadata WSDL link.
- After logging in, you must send Metadata API calls to the Metadata API endpoint, which has a different URL than SOAP API. Retrieve the metadataServerUrl from the LoginResult returned by your SOAP API login() call. For more information about SOAP API, see the [SOAP API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/ "HTML (New Window)").
- Metadata calls are either synchronous or asynchronous. CRUD calls are synchronous in API version 30.0 and later, and similar to the API core calls the results are returned in a single call. In earlier API versions, create, update, and delete are only asynchronous, which means that the results aren’t immediately returned in one call.
- There are synchronous metadata calls that map to the corresponding core SOAP API synchronous calls.
    - [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") maps to the create() SOAP API call.
    - [updateMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_updateMetadata.htm "Updates one or more metadata components in your organization synchronously.") maps to the update() SOAP API call.
    - [deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm "Deletes one or more metadata components from your organization synchronously.") maps to the delete() SOAP API call.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Metadata API also supports retrieve() and deploy() calls for retrieving and deploying metadata components. For more information, see [Declarative (File-Based) Metadata API Calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based.htm).

## Java Sample for CRUD-Based Development with Synchronous Calls

This section guides you through a sample Java client application that uses CRUD-based calls. This sample application performs the following main tasks.

1. Uses the MetadataLoginUtil.java class to create a Metadata connection. For more information, see [Step 3: Walk Through the Java Sample Code](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_java_sample.htm).
2. Calls [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") to create a custom object. This call returns the result in one call.
3. Inspects the returned SaveResult object to check if the operation succeeded, and if it didn’t, writes the component name, error message, and status code to the output.

import com.sforce.soap.metadata.\*;

/\*\*
 \* Sample that logs in and creates a custom object through the metadata API
 \*/
public class CRUDSampleCreate {
    private MetadataConnection metadataConnection;

    // one second in milliseconds
    private static final long ONE\_SECOND = 1000;

    public CRUDSampleCreate() {
    }

    public static void main(String\[\] args) throws Exception {
        CRUDSampleCreate crudSample = new CRUDSampleCreate();
        crudSample.runCreate();
    }

    /\*\*
     \* Create a custom object. This method demonstrates usage of the
     \* create() and checkStatus() calls.
     \*
     \* @param uniqueName Custom object name should be unique.
     \*/
    private void createCustomObjectSync(final String uniqueName) throws Exception {
        final String label = "My Custom Object";
        CustomObject co = new CustomObject();
        co.setFullName(uniqueName);
        co.setDeploymentStatus(DeploymentStatus.Deployed);
        co.setDescription("Created by the Metadata API Sample");
        co.setEnableActivities(true);
        co.setLabel(label);
        co.setPluralLabel(label + "s");
        co.setSharingModel(SharingModel.ReadWrite);

        // The name field appears in page layouts, related lists, and elsewhere.
        CustomField nf = new CustomField();
        nf.setType(FieldType.Text);
        nf.setDescription("The custom object identifier on page layouts, related lists etc");
        nf.setLabel(label);
        nf.setFullName(uniqueName);
        customObject.setNameField(nf);

        SaveResult\[\] results = metadataConnection
                .createMetadata(new Metadata\[\] { co });

        for (SaveResult r : results) {
            if (r.isSuccess()) {
                System.out.println("Created component: " + r.getFullName());
            } else {
                System.out
                        .println("Errors were encountered while creating "
                                + r.getFullName());
                for (Error e : r.getErrors()) {
                    System.out.println("Error message: " + e.getMessage());
                    System.out.println("Status code: " + e.getStatusCode());
                }
            }
        }
    }

    private void runCreate() throws Exception {
        metadataConnection = MetadataLoginUtil.login();
        // Custom objects and fields must have \_\_c suffix in the full name.
        final String uniqueObjectName = "MyCustomObject\_\_c";
        createCustomObjectSync(uniqueObjectName);
    }
}

## Java Sample for CRUD-Based Development with Asynchronous Calls

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

The sample in this section depends on the asynchronous create() CRUD call. Asynchronous CRUD calls are no longer available as of API version 31.0 and are available only in earlier API versions.

This section guides you through a sample Java client application that uses asynchronous CRUD-based calls. This sample application performs the following main tasks:

1. Uses the MetadataLoginUtil.java class to create a Metadata connection. For more information, see [Step 3: Walk Through the Java Sample Code](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_java_sample.htm).
2. Calls [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.") to create a custom object.
    
    Salesforce returns an [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object for each component you tried to create. The [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is updated with status information as the operation moves from a queue to completed or error state.
3. Calls [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") in a loop until the status value in [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") indicates that the create operation is completed.

Note the error handling code that follows each API call.

import com.sforce.soap.metadata.\*;

/\*\*
 \* Sample that logs in and creates a custom object through the metadata api
 \*/
public class CRUDSample {
    private MetadataConnection metadataConnection;

    // one second in milliseconds
    private static final long ONE\_SECOND = 1000;

    public CRUDSample() {
    }

    public static void main(String\[\] args) throws Exception {
        CRUDSample crudSample = new CRUDSample();
        crudSample.runCreate();
    }

    /\*\*
     \* Create a custom object. This method demonstrates usage of the
     \* create() and checkStatus() calls.
     \*
     \* @param uniqueName Custom object name should be unique.
     \*/
    private void createCustomObject(final String uniqueName) throws Exception {
        final String label = "My Custom Object";
        CustomObject customObject = new CustomObject();
        customObject.setFullName(uniqueName);
        customObject.setDeploymentStatus(DeploymentStatus.Deployed);
        customObject.setDescription("Created by the Metadata API Sample");
        customObject.setLabel(label);
        customObject.setPluralLabel(label + "s");
        customObject.setSharingModel(SharingModel.ReadWrite);

        // The name field appears in page layouts, related lists, and elsewhere.
        CustomField nf = new CustomField();
        nf.setType(FieldType.Text);
        nf.setDescription("The custom object identifier on page layouts, related lists etc");
        nf.setLabel(label);
        nf.setFullName(uniqueName);
        customObject.setNameField(nf);

        AsyncResult\[\] asyncResults = metadataConnection.create(
            new CustomObject\[\]{customObject});
        if (asyncResults == null) {
            System.out.println("The object was not created successfully");
            return;
        }

        long waitTimeMilliSecs = ONE\_SECOND;

        // After the create() call completes, we must poll the results of the checkStatus()
        // call until it indicates that the create operation has completed.
        do {
            printAsyncResultStatus(asyncResults);
            waitTimeMilliSecs \*= 2;
            Thread.sleep(waitTimeMilliSecs);
            asyncResults = metadataConnection.checkStatus(new String\[\]{asyncResults\[0\].getId()});
        } while (!asyncResults\[0\].isDone());

        printAsyncResultStatus(asyncResults);
    }

    private void printAsyncResultStatus(AsyncResult\[\] asyncResults) throws Exception {
        if (asyncResults == null || asyncResults.length == 0 || asyncResults\[0\] == null) {
            throw new Exception("The object status cannot be retrieved");
        }

        AsyncResult asyncResult = asyncResults\[0\]; //we are creating only 1 metadata object

        if (asyncResult.getStatusCode() != null) {
            System.out.println("Error status code: " +
                    asyncResult.getStatusCode());
            System.out.println("Error message: " + asyncResult.getMessage());
        }

        System.out.println("Object with id:" + asyncResult.getId() + " is " +
            asyncResult.getState());
    }

    private void runCreate() throws Exception {
        metadataConnection = MetadataLoginUtil.login();
        // Custom objects and fields must have \_\_c suffix in the full name.
        final String uniqueObjectName = "MyCustomObject\_\_c";
        createCustomObject(uniqueObjectName);
    }
}

<!-- document id=7cbae72822d31066bb763a28bed82e357909012d539b0e58bb51d7b11e833098 url=/legacydeveloper/current/en-us/api_meta/meta_csptrustedsite.md -->

# CspTrustedSite

Represents a trusted URL. For each CspTrustedSite component, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite components included only CSP directives and were referred to as CSP Trusted Sites.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Declarative Metadata File Suffix and Directory Location

CspTrustedSite components are stored in the cspTrustedSites directory of the corresponding package directory. The file name matches the unique name of the trusted site, and the extension is .cspTrustedSite.

![Tip](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_tip.png)

#### Tip

Some infrastructure limits the maximum size of HTTP headers. If you allow multiple domains to frame content served by your org, keep the size of the CSP header under 12 KB. Salesforce customers report issues when the header size approaches 16 KB, and third parties often add to the header during processing.

## Version

CspTrustedSite components are available in API version 39.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d296715e100">Field</th>

              <th class="featureTableHeader  " id="d296715e103">Field Type</th>

              <th class="featureTableHeader  " id="d296715e106">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">canAccessCamera</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d296715e106" data-title="Description">Indicates whether this CspTrustedSite can access the user’s
                camera (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>.<p class="p">This field takes
                  effect only when the
                  <span class="keyword parmname">enablePermissionsPolicy</span> field equals
                  <samp class="codeph nolang">true</samp> and the
                  <span class="keyword parmname">grantCameraAccess</span> field equals <samp class="codeph nolang">TrustedUrls</samp> in the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_securitysettings.htm" title="Represents an org’s security settings. For example, settings define trusted IP ranges for network access, password and login requirements, session expiration, and single sign-on settings.">SecuritySettings</a>
                  metadata API type.
                </p>
                <p class="p">This field is available in API version
                  59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">canAccessMicrophone</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d296715e106" data-title="Description">Indicates whether this CspTrustedSite can access the user’s
                microphone (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value
                is <samp class="codeph nolang">false</samp>.<p class="p">This field takes
                  effect only when the
                  <span class="keyword parmname">enablePermissionsPolicy</span> field equals
                  <samp class="codeph nolang">true</samp> and the
                  <span class="keyword parmname">grantMicrophoneAccess</span> field equals
                  <samp class="codeph nolang">TrustedUrls</samp> in the
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_securitysettings.htm" title="Represents an org’s security settings. For example, settings define trusted IP ranges for network access, password and login requirements, session expiration, and single sign-on settings.">SecuritySettings</a>
                  metadata API type.
                </p>
                <p class="p">This field is available in API version
                  59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">context</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">CspTrustedSiteContext (enumeration of type string)</td>

              <td class="entry" headers="d296715e106" data-title="Description">Declares the scope of the CSP directives for this trusted URL.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">All</samp>—Apply the
                    CSP directives to all supported context types.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Communities</samp>—Apply the CSP directives to
                    Experience Builder sites only.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FieldServiceMobileExtension</samp>—Apply the
                    CSP directives to the Field Service Mobile Extensions only.
                    This value is available in API version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LEX</samp>—Apply the
                    CSP directives to Lightning Experience pages only.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LightningOut</samp>—Reserved
                    for future use. Available in API version 64.0 and later
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">VisualForce</samp>—Apply the CSP directives to
                    custom Visualforce pages only. This value is available in
                    API version 55.0 and later.
                  </li>

                </ul>
                <p class="p">For custom Visualforce pages, content is restricted to
                  trusted URLs only if the page’s <samp class="codeph nolang">cspHeader</samp> attribute is set to <samp class="codeph nolang">true</samp>.</p>
                <p class="p">This field is
                  available in API version 44.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">string</td>

              <td class="entry" headers="d296715e106" data-title="Description">The description of this trusted URL.</td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">endpointUrl</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">string</td>

              <td class="entry" headers="d296715e106" data-title="Description">Required. The URL for this CspTrustedSite.<a name="ul_nmd_kwn_fkc"><!-- --></a>
                <ul class="ul bulletList" id="ul_nmd_kwn_fkc">
                  <li class="li">This field must include a domain name and can include a
                    port. For example, <samp class="codeph nolang">https://example.com</samp> or <samp class="codeph nolang">https://example.com:8080</samp>.
                    To reduce repetition, you can use the wildcard character
                    <samp class="codeph nolang">*</samp> (asterisk). For
                    example, <samp class="codeph nolang">*.example.com</samp>.<p class="p">Don't include placeholders or
                      invalid characters. For example, don't use <samp class="codeph nolang">malformed^url.example.com</samp>, and <samp class="codeph nolang">https://{subdomain}.example.com</samp>. </p>
                  </li>

                  <li class="li">For a third-party API, the URL must begin with https://. For
                    example, <samp class="codeph nolang">https://example.com</samp>.</li>

                  <li class="li">For a WebSocket connection, the URL must begin with wss://.
                    For example, <span class="ph filepath">wss://example.com</span>.</li>

                  <li class="li">For a Chrome extension, use the 32-character extension ID in
                    the format<samp class="codeph nolang">
                      chrome-extension://abcdefghijklmnopabcdefghijklmnop</samp>.
                    The ID can contain only lowercase letters a–p. Wildcards
                    aren’t supported in Chrome extension URIs.</li>

                </ul>
                <p class="p">Before February 2025, it was possible to save a malformed
                  URL. Malformed URLs are excluded from generated CSP HTTP
                  headers. To keep your Trusted URLs list accurate, remove any
                  malformed entries. You can use an Apex class to find all
                  malformed URLs. See the knowledge article, <a class="xref" href="https://help.salesforce.com/s/articleView?id=005317938&amp;type=1&amp;language=en_US" target="_blank">Identify Malformed Trusted
                    URLs</a>.</p>
                <p class="p">To add an <samp class="codeph nolang">EndpointUrl</samp> based on parameters, build the URL
                  before you add it to this Metadata Type.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d296715e106" data-title="Description">Required. Indicates whether this CspTrustedSite is active
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). The default value is <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">isApplicableToConnectSrc</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d296715e106" data-title="Description">Indicates whether Lightning components, third-party APIs, and
                WebSocket connections can load URLs using script interfaces from
                this trusted URL (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). This field has a
                default value of <samp class="codeph java">false</samp>.<p class="p">This
                  field is available in API version 48.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">isApplicableToFontSrc</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d296715e106" data-title="Description">Indicates whether Lightning components, third-party APIs, and
                WebSocket connections can load fonts from this trusted URL (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). This field has a default
                value of <samp class="codeph java">false</samp>.<p class="p">This field is
                  available in API version 48.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">isApplicableToFrameSrc</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d296715e106" data-title="Description">Indicates whether Lightning components, third-party APIs, and
                WebSocket connections can load resources contained in <samp class="codeph nolang">&lt;iframe&gt;</samp> elements from this
                trusted URL (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). This field has a
                default value of <samp class="codeph java">false</samp>.This field
                is available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">isApplicableToImgSrc</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d296715e106" data-title="Description">Indicates whether Lightning components, third-party APIs, and
                WebSocket connections can load images from this trusted URL (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). This field has a default
                value of <samp class="codeph java">false</samp>. This field is
                available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">isApplicableToMediaSrc</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d296715e106" data-title="Description">Indicates whether Lightning components, third-party APIs, and
                WebSocket connections can load audio and video from this trusted URL
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). This field has a default
                value of <samp class="codeph java">false</samp>.<p class="p">In API version
                  59.0 and later, for each trusted URL, at least one
                  CSPTrustedSite starting with <span class="keyword parmname">isApplicable</span>
                  or <span class="keyword parmname">canAccess</span> must be set to <samp class="codeph nolang">true.</samp></p>
                <p class="p">In API version 50.0
                  to 58.0, if all <span class="keyword parmname">isApplicable</span> fields are
                  <samp class="codeph java">false</samp>, the
                  <span class="keyword parmname">isApplicableToImgSrc</span> field is set to
                  <samp class="codeph java">true</samp>. In API version 49.0
                  and earlier, if all <span class="keyword parmname">isApplicable</span> fields are
                  <samp class="codeph java">false</samp>, these fields all
                  default to <samp class="codeph java">true</samp>.
                </p>
                This
                field is available in API version 48.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">isApplicableToStyleSrc</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d296715e106" data-title="Description">Indicates whether Lightning components, third-party APIs, and
                WebSocket connections can load style sheets from this trusted URL
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). This field has a default
                value of <samp class="codeph java">false</samp>. This field is
                available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d296715e100" data-title="Field"><span class="keyword parmname">mobileExtension</span></td>

              <td class="entry" headers="d296715e103" data-title="Field Type">string</td>

              <td class="entry" headers="d296715e106" data-title="Description">Reserved for future use.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample XML definition of a trusted site is shown below.

<?xml version="1.0" encoding="UTF-8"?>
<CspTrustedSite xmlns="http://soap.sforce.com/2006/04/metadata">
    <canAccessCamera\>false</canAccessCamera\>
    <canAccessMicrophone\>true</canAccessMicrophone\>
    <description\>Used for Lightning component callout to mapping web service</description\>
    <context\>LEX</context\>
    <endpointUrl\>https://www.maptestsite.net/</endpointUrl\>
    <isActive\>true</isActive\>
    <isApplicableToConnectSrc\>true</isApplicableToConnectSrc\>
    <isApplicableToFontSrc\>true</isApplicableToFontSrc\>
    <isApplicableToFrameSrc\>false</isApplicableToFrameSrc\>
    <isApplicableToImgSrc\>true</isApplicableToImgSrc\>
    <isApplicableToMediaSrc\>false</isApplicableToMediaSrc\>
    <isApplicableToStyleSrc\>true</isApplicableToStyleSrc\>
</CspTrustedSite\>

## Usage

For each CSPTrustedSite component, at least one field starting with grantAccess or isApplicableTo must be set to true.

In API versions 50.0 to 58.0, if all isApplicable fields are false, the isApplicableToImgSrc field is set to true. In API version 49.0 and earlier, if all isApplicable fields are false, those fields all default to true.

To ensure smooth integration across Salesforce products, Salesforce includes URLs in each of the CSP directives that correspond to the isApplicable fields, even though those URLs aren’t defined as CspTrustedSite components. Salesforce regularly updates those URLs based on the latest requirements.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=841e2bda1a9e38cfe5ff4e7340255d41918e88d7980fd9ae62e1cf6613e9ab5a url=/legacydeveloper/current/en-us/api_meta/meta_currencysettings.md -->

# CurrencySettings

Represents an organization's currency settings, including turning on multiple currencies, configuring active currencies, setting the corporate currency, and enabling currency effective dates. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

CurrencySettings values are stored in the Currency.settings file in the settings directory. The .settings files are different from other named components because there's only one settings file for each settings component.

## Version

CurrencySettings is available in API version 47.0 and later. The corporateCurrency and currency fields, and the deploy behavior for enableMultiCurrency, are available in API version 68.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d298341e112">Field Name</th>

              <th class="featureTableHeader  " id="d298341e115">Field Type</th>

              <th class="featureTableHeader  " id="d298341e118">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">corporateCurrency</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">string</td>

              <td class="entry" headers="d298341e118" data-title="Description">The ISO 4217 code of the org's corporate currency, such as <samp class="codeph nolang">USD</samp> or <samp class="codeph nolang">EUR</samp>. The
                corporate currency's conversion rate is fixed at <samp class="codeph nolang">1.0</samp>; all other currencies are denominated against it. Setting this field
                in a deploy switches the org's corporate currency, which demotes the previously
                corporate currency and rebases conversion rates. The new corporate currency must
                already be registered in the org and be active. Has no effect unless
                <span class="keyword parmname">enableMultiCurrency</span> is <samp class="codeph nolang">true</samp>, either previously or in the same deploy. Available in API version
                68.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">currency</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">Currency[]</td>

              <td class="entry" headers="d298341e118" data-title="Description">One or more currency entries. New currencies are inserted; entries that match
                an existing currency by <span class="keyword parmname">isoCode</span> update its
                <span class="keyword parmname">active</span>, <span class="keyword parmname">scale</span>, and
                <span class="keyword parmname">conversionRate</span> values. Has no effect unless
                <span class="keyword parmname">enableMultiCurrency</span> is <samp class="codeph nolang">true</samp>, either previously or in the same deploy. See <a class="xref" href="#currency_subtype">Currency
                  Fields</a>. Available in API version 68.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">enableCurrencyEffectiveDates</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Indicates whether effective dated currency is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>. To enable this preference,
                <span class="keyword parmname">enableMultiCurrency</span> must be set to <samp class="codeph nolang">true</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">enableCurrencySymbolWithMultiCurrency</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Indicates whether the currency symbol (<samp class="codeph nolang">true</samp>) or ISO code (<samp class="codeph nolang">false</samp>) displays
                in multi-currency orgs. This field has a default value of <samp class="codeph nolang">false</samp>. This field has no effect if
                <span class="keyword parmname">enableMultiCurrency</span> is set to <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="ph" id="enableMultiCurrency"><a name="enableMultiCurrency"><!-- --></a><span class="keyword parmname">enableMultiCurrency</span></span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Indicates whether multiple currencies are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field
                has a default value of <samp class="codeph nolang">false</samp>. Starting in API
                version 68.0, deploying <samp class="codeph nolang">true</samp> against an org
                that doesn't have multi-currency enabled turns on multi-currency for the org.
                Deploying <samp class="codeph nolang">true</samp> against an org that already has
                multi-currency enabled is a no-op. When multi-currency is turned on, the corporate
                currency is taken from <span class="keyword parmname">corporateCurrency</span> if provided in the
                same deploy; otherwise it defaults to the org's locale-derived currency. <div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                        <div class="mediaBd">
                          <h4 class="mbs">Important</h4>
                          <p>Turning on multi-currency is irreversible. After you deploy
                            <samp class="codeph nolang">enableMultiCurrency=true</samp>, the org can't
                            return to single-currency operation through Metadata API. Deploying <samp class="codeph nolang">enableMultiCurrency=false</samp> against an org that has
                            multi-currency enabled returns an error. See <a class="xref" href="https://help.salesforce.com/articleView?id=admin_enable_multicurrency_implications.htm&amp;language=en_US" target="_blank">Considerations for Enabling Multiple
                              Currencies</a> for more information.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">isMultiCurrencyActivationAllowed</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Deprecated in API version 49.0 and later. Regardless of the value in this
                field, a Salesforce admin can activate multiple currencies.<p class="p">In API version 48.0
                  and earlier, if Customizable Forecasting was enabled, this field indicated whether
                  Salesforce Customer Support could activate multiple currencies (<samp class="codeph nolang">true</samp>) or the feature couldn't be activated (<samp class="codeph nolang">false</samp>).</p>
                <div class="p">This field is only visible if
                  multiple currencies are disabled. It has a default of <samp class="codeph nolang">false</samp> to provide an extra layer of protection against accidentally
                  enabling multiple currencies when Customizable Forecasting was enabled. In API
                  version 48.0 and earlier, customers with Customizable Forecasting enabled in their
                  orgs had to contact Salesforce Customer Support to activate multiple currencies.
                  Customers set this field to <samp class="codeph nolang">true</samp> when
                  Salesforce Customer Support requested that they do so to validate their request to
                  activate multiple currencies.<div class="box message info">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p>Customizable Forecasting was retired in Summer
                              '20. Users can't access the Customizable Forecasting feature and its underlying
                              data via the user interface or API. To predict sales revenue and quantities from
                              your opportunity pipeline, use Salesforce Forecasting.</p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">isParenCurrencyConvDisabled</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Indicates whether parenthetical currency conversion is disabled (<samp class="codeph nolang">true</samp>) or enabled (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">true</samp>. When this field is set to <samp class="codeph nolang">false</samp>, Salesforce displays converted currency amounts to users whose
                personal currency differs from the currency of the record they're viewing.</td>

            </tr>

          </tbody>

        </table>

## Currency Fields

Represents one entry in the org's currency type list. Used as the element type of the CurrencySettings.currency collection. Available in API version 68.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| active | boolean | Indicates whether this currency is available for users to assign to records (true) or not (false). Inactive currencies can't be set as the corporate currency. Defaults to true for new currencies. Optional. |
| conversionRate | double | The conversion rate from this currency to the corporate currency. Must be 1.0 if this entry is the corporate currency. Required for new currencies. |
| isoCode | string | The currency's ISO 4217 code, such as USD, JPY, or EUR. The code must be one of the ISO codes that Salesforce supports; an unsupported code returns an error. Required. |
| scale | int | The number of decimal places to use for this currency. Valid values are 0 through 6. Optional. |

## Declarative Metadata Sample Definition

The following is an example of a CurrencySettings file that turns on multi-currency and seeds two currencies.

<?xml version="1.0" encoding="UTF-8"?>
<CurrencySettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableMultiCurrency\>true</enableMultiCurrency\>
    <corporateCurrency\>USD</corporateCurrency\>
    <currency\>
        <isoCode\>USD</isoCode\>
        <active\>true</active\>
        <conversionRate\>1.0</conversionRate\>
        <scale\>2</scale\>
    </currency\>
    <currency\>
        <isoCode\>JPY</isoCode\>
        <active\>true</active\>
        <conversionRate\>110.0</conversionRate\>
        <scale\>0</scale\>
    </currency\>
    <enableCurrencyEffectiveDates\>false</enableCurrencyEffectiveDates\>
    <enableCurrencySymbolWithMultiCurrency\>false</enableCurrencySymbolWithMultiCurrency\>
    <isParenCurrencyConvDisabled\>false</isParenCurrencyConvDisabled\>
</CurrencySettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Currency</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=55f509c896dc034311fe272047189e17daf7207ed7d2bbcb20b9cdcce7cb7517 url=/legacydeveloper/current/en-us/api_meta/meta_custommetadatatypes.md -->

# Custom Metadata Types (CustomObject)

Represents the metadata associated with a custom metadata type.

For more information, see [Custom Metadata Types](https://help.salesforce.com/s/articleView?id=platform.custommetadatatypes_overview.htm&language=en_US "HTML (New Window)").

## File Suffix and Directory Location

A custom metadata type is defined as a custom object and is stored in the objects folder. Custom metadata types have a suffix of \_\_mdt (instead of \_\_c for custom objects). Custom metadata type field names have a suffix of \_\_c, like other custom fields. Custom metadata type field names must be dot-qualified with the name of the custom metadata type to which they belong.

Names of custom metadata types must be unique within their namespace. All custom metadata types belong to the CustomMetadata namespace and can optionally belong to a second namespace. In your organization, you can use custom metadata types with your namespace and also other organizations’ namespaces.

## Version

Custom metadata type components are available in API version 31.0 and later.

## Special Access Rules

To create custom metadata types, you must have the “Author Apex” permission. Apex code can create, read, and update (but not delete) custom metadata records, as long as the metadata is subscriber-controlled and visible from within the code's namespace. You can edit records in memory but not upsert or delete them. Apex code can deploy custom metadata records, but not via a DML operation. Moreover, DML operations aren’t allowed on custom metadata in the Partner or Enterprise APIs. Customers who install a managed custom metadata type can’t add new custom fields to it. With unpackaged metadata, both developer-controlled and subscriber-controlled access behave the same: like subscriber-controlled access. Refer to [Trust, but Verify: Apex Metadata API and Security](https://developer.salesforce.com/blogs/engineering/2017/06/apex-metadata-api-security.html) to learn more.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Audit fields (CreatedDate, CreatedBy, LastModifiedDate, LastModifiedBy, SystemModStamp) remain uneditable.

## Fields

Custom metadata types can contain the following CustomObject fields.

To make the fields on your custom metadata types unique and indexable, mark your fields as Unique and ExternalId.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d315419e142">Field Name</th>

              <th class="featureTableHeader  " id="d315419e145">Field Type</th>

              <th class="featureTableHeader  " id="d315419e148">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d315419e142" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d315419e145" data-title="Field Type">string</td>

              <td class="entry" headers="d315419e148" data-title="Description">A description of the custom metadata type. This field can contain a maximum of
                1,000 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d315419e142" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d315419e145" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm" title="Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.">CustomField[]</a></td>

              <td class="entry" headers="d315419e148" data-title="Description">Represents one or more custom fields in the custom metadata type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d315419e142" data-title="Field Name"><span class="keyword parmname">gender</span></td>

              <td class="entry" headers="d315419e145" data-title="Field Type">Gender</td>

              <td class="entry" headers="d315419e148" data-title="Description">Indicates the gender of the noun that represents the object. This field is used
                for languages where words need different treatment depending on their
                gender.</td>

            </tr>

            <tr>
              <td class="entry" headers="d315419e142" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d315419e145" data-title="Field Type">string</td>

              <td class="entry" headers="d315419e148" data-title="Description">A label that represents the object throughout the Salesforce Setup user
                interface. Custom metadata types are visible only through the recently used objects
                list on the Lightning Platform Home Page and in the packaging user
                interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d315419e142" data-title="Field Name"><span class="keyword parmname">pluralLabel</span></td>

              <td class="entry" headers="d315419e145" data-title="Field Type">string</td>

              <td class="entry" headers="d315419e148" data-title="Description">The plural version of the label value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d315419e142" data-title="Field Name"><span class="keyword parmname">startsWith</span></td>

              <td class="entry" headers="d315419e145" data-title="Field Type">StartsWith (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d315419e148" data-title="Description">Indicates whether the noun starts with a vowel, a consonant, or a special
                character. This field is used for languages where words need different treatment
                depending on their first character.</td>

            </tr>

            <tr>
              <td class="entry" headers="d315419e142" data-title="Field Name"><span class="keyword parmname">visibility</span></td>

              <td class="entry" headers="d315419e145" data-title="Field Type">SetupObjectVisibility (enumeration of type string)</td>

              <td class="entry" headers="d315419e148" data-title="Description">This field returns the visibility of a custom metadata type. The following
                values are valid:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Public</samp>—If the custom setting or
                    custom metadata type is packaged, it’s accessible to all subscribing
                    organizations.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Protected</samp>—If the custom object,
                    custom setting, or custom metadata type is in a managed package, it’s accessible
                    only to the developer org. Subscribing orgs can’t access it.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PackageProtected</samp>—If the custom
                    metadata type is <samp class="codeph nolang">PackageProtected</samp>, it’s
                    only accessible by the custom Apex code in the package. Use this value to secure
                    secrets such as API access keys and security tokens. Available in API version
                    47.0 and later.
                  </li>

                </ul>
                <p class="p">The default value is <samp class="codeph nolang">Public</samp>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

In this example, Picklists R Us creates its Reusable Picklist custom metadata type by deploying a file in the objects folder, named ReusablePicklistOption\_\_mdt.object, with these contents.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
   <fields\>
      <fullName\>AlphaSort\_\_c</fullName\>
      <defaultValue\>false</defaultValue\>
      <externalId\>false</externalId\>
      <label\>Sorted Alphabetically</label\>
      <type\>Checkbox</type\>
   </fields\>
   <label\>Reusable Picklist</label\>
   <pluralLabel\>Reusable Picklist</pluralLabel\>
   <visibility\>Public</visibility\>
</CustomObject\>

This excerpt from a package.xml file shows the use of dot notation and the \_\_mdt suffix. If you’re using a namespace, for example picklist1234,​ the full name of ReusablePicklistOption\_\_mdt would be picklist1234​\_\_ReusablePicklistOption\_\_mdt.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
...
   <types\>
      <members\>PicklistTest\_\_c.PicklistTestField\_\_c</members\>
      <members\>ReusablePicklistOption\_\_mdt.Picklist\_\_c</members\>
      <members\>ReusablePicklistOption\_\_mdt.SortOrder\_\_c</members\>
      <members\>PicklistUsage\_\_mdt.Field\_\_c</members\>
      <members\>PicklistUsage\_\_mdt.Picklist\_\_c</members\>
      <members\>PicklistUsage\_\_mdt.SObjectType\_\_c</members\>
      <members\>ReusablePicklist\_\_mdt.AlphaSort\_\_c</members\>
      <name\>CustomField</name\>
   </types\>
...
   <types\>
      <members\>PicklistTest\_\_c</members\>
      <members\>ReusablePicklistOption\_\_mdt</members\>
      <members\>PicklistUsage\_\_mdt</members\>
      <members\>ReusablePicklist\_\_mdt</members\>
      <name\>CustomObject</name\>
   </types\>
...
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

1. [CustomMetadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_custommetadata.htm)  
    Represents a record of a custom metadata type.

<!-- document id=d5474f4c4f3dd6339722df590532e1e2d862ecb19b258d91c1a5b9b45fa3bca1 url=/legacydeveloper/current/en-us/api_meta/meta_customaddressfieldsettings.md -->

# CustomAddressFieldSettings

Represents the settings for custom address fields.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

CustomAddressFieldSettings values are stored in the CustomAddressField.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

CustomAddressFieldSettings components are available in API version 55.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d299632e119">Field Name</th>

              <th class="featureTableHeader  " id="d299632e122">Field Type</th>

              <th class="featureTableHeader  " id="d299632e125">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d299632e119" data-title="Field Name"><span class="keyword parmname">enableCustomAddressField</span></td>

              <td class="entry" headers="d299632e122" data-title="Field Type">boolean</td>

              <td class="entry" headers="d299632e125" data-title="Description">Indicates whether the <samp class="codeph nolang">Address</samp>
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm" title="These field types extend the field types described in the Salesforce Object Reference.">Field Type</a> is available
                for custom fields (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value
                is <samp class="codeph nolang">false</samp>.<p class="p">Custom Address
                  Fields can’t be disabled. When
                  <span class="keyword parmname">enableCustomAddressField</span> is set to
                  <samp class="codeph nolang">true</samp>, you can’t change
                  the value to <samp class="codeph nolang">false</samp>.
                </p>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Before you set this field to <samp class="codeph nolang">true</samp>, review <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.fields_caf_requirements.htm&amp;type=5&amp;language=en_US" target="_blank">Custom Address Fields
                              Requirements and Limitations</a> in Salesforce
                            Help.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a CustomAddressFieldSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<CustomAddressFieldSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCustomAddressField\>true</enableCustomAddressField\>
</CustomAddressFieldSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>CustomAddressField</members\>
        <name\>Settings</name\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=3e55edac7a703926e0e3fac77439f269739fa1587bfec8efaeb75a7e638e0588 url=/legacydeveloper/current/en-us/api_meta/meta_customapplication.md -->

# CustomApplication

CustomApplication represents a custom or standard application. In API version 29.0 and earlier, CustomApplication represents only a custom application. An application is a list of tab references, with a description and a logo. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

Custom and standard applications have the suffix .app and are stored in the applications folder.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet components that are retrieved in the same package.

## Version

Custom applications are available in API version 10.0 and later. Standard applications are available in API version 30.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d300065e87">Field Name</th>

              <th class="featureTableHeader  " id="d300065e90">Field Type</th>

              <th class="featureTableHeader  " id="d300065e93">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">actionOverrides</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">
                <a class="xref" href="#CustomApplicationAppActionOverride">AppActionOverride</a>[]
              </td>

              <td class="entry" headers="d300065e93" data-title="Description">
                <p class="p">Represents an action override for an application. Use it to create, update, edit,
                  or delete action overrides.This field is available for Lightning Experience in API
                  version 38.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">brand</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type"><a class="xref" href="#CustomApplicationAppBrand">AppBrand</a></td>

              <td class="entry" headers="d300065e93" data-title="Description">
                <p class="p">The color scheme and logo used for the app.This field is available for Lightning
                  Experience in API version 38.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">consoleConfig</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type"><a class="xref" href="#ServiceCloudConsoleConfig">ServiceCloudConsoleConfig</a></td>

              <td class="entry" headers="d300065e93" data-title="Description">
                <p class="p">Represents configuration settings for a Salesforce console app.This field is
                  available in API version 42.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">defaultLandingTab</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e93" data-title="Description">The <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_tab.htm#fullName">fullName</a> of a standard tab or custom tab that opens when this application
                is selected.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e93" data-title="Description">The optional description text of the application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">formFactors</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">FormFactor (enumeration of type string)</td>

              <td class="entry" headers="d300065e93" data-title="Description">
                <span class="ph" id="form_factors_desc"><a name="form_factors_desc"><!-- --></a>Indicates the form factors for which the app is
                  visible for Lightning Experience.</span> Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Null</samp> (no value)—For a desktop using
                    Salesforce Classic
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Small</samp>—For a mobile device using the
                    Salesforce mobile app
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Medium</samp>—Reserved for future use
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Large</samp>—For a desktop using Lightning
                    Experience
                  </li>

                </ul>

                <p class="p">This field is available in API version 38.0 and later.</p>

                <p class="p" id="CustomApplication_formFactors_limitation"><a name="CustomApplication_formFactors_limitation"><!-- --></a>As of API version 38.0,
                  <span class="keyword parmname">formFactors</span> is set to <samp class="codeph nolang">Large</samp> for existing Salesforce Classic apps, except for Salesforce
                  Classic consoles. Salesforce Classic apps installed from packages created before
                  API version 38.0 also have <span class="keyword parmname">formFactors</span> set to <samp class="codeph nolang">Large</samp>. For Salesforce Classic apps in packages
                  created with API 38.0 or later, you must set <span class="keyword parmname">formFactors</span> to
                  <samp class="codeph nolang">Large</samp> for Salesforce Classic apps to appear
                  in the Lightning Experience desktop.
                </p>

                <p class="p">As of API version 47.0, the <samp class="codeph nolang">Small</samp> value is
                  supported for Lightning apps. The <span class="keyword parmname">formFactors</span> field can be
                  set to <samp class="codeph nolang">Small</samp> or <samp class="codeph nolang">Large</samp> for Lightning apps, and it can be set to <samp class="codeph nolang">Null</samp> or <samp class="codeph nolang">Large</samp>
                  for Salesforce Classic apps.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">isNavAutoTempTabsDisabled</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">boolean</td>

              <td class="entry" headers="d300065e93" data-title="Description">Indicates whether the navigation automatically creates temporary tabs settings.
                Applies only to Lightning apps with standard navigation. Available in API version
                43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">isNavPersonalizationDisabled</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">boolean</td>

              <td class="entry" headers="d300065e93" data-title="Description">Indicates whether navigation personalization is disabled. Applies only to
                Lightning apps. Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">isNavTabPersistenceDisabled</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">boolean</td>

              <td class="entry" headers="d300065e93" data-title="Description">Indicates whether workspace tabs are cleared for each new console session
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Applies only to Lightning apps with console navigation.
                Available in API version 54.0 and later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname" id="console_field"><a name="console_field"><!-- --></a>isServiceCloudConsole</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">boolean</td>

              <td class="entry" headers="d300065e93" data-title="Description"><span class="ph" id="console_field_desc"><a name="console_field_desc"><!-- --></a>Indicates if the application is a Salesforce
                  Classic console app. For Lightning Experience console apps, this field is <samp class="codeph nolang">null</samp> and the <span class="keyword parmname">navType</span> field is
                  set to <samp class="codeph nolang">Console</samp>.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e93" data-title="Description">The name of the application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">logo</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e93" data-title="Description">The optional reference to the image document for a Salesforce app or Salesforce
                console app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">navType</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">NavType (enumeration of type string)</td>

              <td class="entry" headers="d300065e93" data-title="Description">
                <span class="ph" id="nav_type_desc"><a name="nav_type_desc"><!-- --></a>Not updateable. Indicates the type of navigation the app
                  uses.</span> The value <samp class="codeph nolang">Standard</samp> is for a
                Lightning app with standard navigation. The value <samp class="codeph nolang">Console</samp> is for a Lightning app with console navigation.<p class="p">This field is
                  available in API version 38.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">preferences</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">
                <a class="xref" href="#CustomApplicationAppPreferences">AppPreferences</a>
              </td>

              <td class="entry" headers="d300065e93" data-title="Description">
                <p class="p">Represents the preferences for a Salesforce Classic console app. All of the
                  AppPreferences fields are required.This field is available in API version 42.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">profileActionOverrides</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">
                <a class="xref" href="#AppProfileActionOverride">AppProfileActionOverride</a>[]
              </td>

              <td class="entry" headers="d300065e93" data-title="Description">
                <span class="ph" id="profileActionOverrides_desc"><a name="profileActionOverrides_desc"><!-- --></a>A list of the Lightning Experience record
                  page ProfileActionOverrides that are assigned to this custom app. When a user
                  invokes the custom app, a matching ProfileActionOverride assignment takes
                  precedence over existing overrides for the record page specified in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm#actionoverride" title="Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can access ActionOverride only by accessing its encompassing CustomObject.">ActionOverride</a>. You can override a record page for the custom app
                  by record type and profile.</span>
                <p class="p">In API version 45.0 and later, you can override
                  a home page for the custom app by profile.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">setupExperience</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e93" data-title="Description">The type of Setup experience associated with the app. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">all</samp>—Represents the full Setup tree.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">essentials</samp>—Represents the Essentials
                    Setup tree, which contains a subset of Setup items configured for Essentials
                    edition.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">service</samp>—Represents the Service Setup
                    tree, which contains a subset of Setup items configured for Service
                    Console.
                  </li>

                </ul>
                <p class="p">A <samp class="codeph nolang">null</samp> value is equivalent to <samp class="codeph nolang">all</samp>.</p>
                <p class="p">Previous valid values <samp class="codeph nolang">AllSetup</samp>, <samp class="codeph nolang">ServiceSetup</samp>, and <samp class="codeph nolang">EssentialsSetup</samp>
                  have been deprecated.</p>
                <p class="p">This field is available in API version 39.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">subscriberTabs</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">string[]</td>

              <td class="entry" headers="d300065e93" data-title="Description">
                <span class="ph" id="subscriberTabs_field_desc"><a name="subscriberTabs_field_desc"><!-- --></a>Represents the list of tabs appended by a
                  subscriber to a Lightning app installed from a managed package. Records in a
                  subscriber tab always open as primary tabs.</span>
                <p class="p">This field is available in API
                  version 41.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">tabs</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">string[]</td>

              <td class="entry" headers="d300065e93" data-title="Description">The list of tabs included in this application. In API version 12.0, the
                <span class="keyword parmname">fullName</span> for built-in tabs like Home, Account, and Reports,
                is the name of the tab (Home, for example). In API version 13.0 and later, built-in
                tabs are prefixed with <samp class="codeph nolang">standard-</samp>. For example,
                to reference the Account tab you would use <samp class="codeph nolang">standard-Account</samp>.<p class="p">In API version 42.0, this field was renamed from
                  <span class="keyword parmname">tab</span> to <span class="keyword parmname">tabs</span>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">uiBundle</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">string[]</td>

              <td class="entry" headers="d300065e93" data-title="Description">The fully qualified name of an interal React app, which is represented by the
                UIBundle metadata type, such as <samp class="codeph nolang">c__propertymanagementapp</samp>. When configured, makes the app available in
                the App Launcher. <p class="p">This field is available in API version 67.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">uiType</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">UiType (enumeration of type string)</td>

              <td class="entry" headers="d300065e93" data-title="Description">Not updateable. <span class="ph" id="uiType_field_desc"><a name="uiType_field_desc"><!-- --></a>Identifies the type of custom
                  app.</span> The value is:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Aloha</samp> for Salesforce Classic
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Lightning</samp> for Lightning Experience
                  </li>

                </ul>
                <p class="p">This field is available in API version 38.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname">utilityBar</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e93" data-title="Description">
                <span class="ph" id="utilityBar_field_desc"><a name="utilityBar_field_desc"><!-- --></a>The developer name of the utility bar associated
                  with this app.</span>
                <p class="p">We recommend assigning a utility bar to only one Lightning App, because utility
                  bars are shared. Sharing means that if you change the utility bar in one app, it
                  automatically changes in all apps associated with it.</p>

                <p class="p">This field is available in API version 38.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e87" data-title="Field Name"><span class="keyword parmname" id="workspace_mappings_field"><a name="workspace_mappings_field"><!-- --></a>workspaceConfig</span></td>

              <td class="entry" headers="d300065e90" data-title="Field Type"><a class="xref" href="#AppWorkspaceConfig">AppWorkspaceConfig</a></td>

              <td class="entry" headers="d300065e93" data-title="Description">isServiceCloudConsole<samp class="codeph xml"> is
                  true</samp>.<span class="keyword parmname">Represents how records open in a Salesforce console app.
                  Required if workspaceConfig</span> from
                <span class="keyword parmname">workspaceMappings</span>.
              </td>

            </tr>

          </tbody>

        </table>

## AppActionOverride

Represents an action override for an application. Use it to create, update, edit, or delete action overrides. AppActionOverride inherits from [ActionOverride](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm#actionoverride "Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can access ActionOverride only by accessing its encompassing CustomObject.") and extends it by one field, pageOrSobjectType. Available for Lightning Experience in API version 38.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d300065e670">Field Name</th>

              <th class="featureTableHeader  " id="d300065e673">Field Type</th>

              <th class="featureTableHeader  " id="d300065e676">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d300065e670" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d300065e673" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e676" data-title="Description">The only valid value is <samp class="codeph nolang">view</samp> for API
                version 43.0 and earlier. The value <samp class="codeph nolang">tab</samp> is
                supported for API version 44.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e670" data-title="Field Name"><span class="keyword parmname">comment</span></td>

              <td class="entry" headers="d300065e673" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e676" data-title="Description">Any comments you want associated with the override.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e670" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d300065e673" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e676" data-title="Description">Set this field if <span class="keyword parmname">type</span> is set to <samp class="codeph nolang">flexipage</samp>. It refers to the name of the page to use
                as the override. To reference installed components, use the format of <samp class="codeph nolang"><var class="keyword varname">Component_namespace</var>__<var class="keyword varname">Component_name</var></samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e670" data-title="Field Name"><span class="keyword parmname">formFactor</span></td>

              <td class="entry" headers="d300065e673" data-title="Field Type">FormFactor(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d300065e676" data-title="Description">
                <span class="ph" id="meta_actionOverride_formFactor_desc"><a name="meta_actionOverride_formFactor_desc"><!-- --></a>The size of the page being
                  overridden.</span>
                <p class="p">If the <span class="keyword parmname">type</span> field is set to <samp class="codeph nolang">flexipage</samp>, set this field to <samp class="codeph nolang">Large</samp> to override the View action with a Lightning
                  page in Lightning Experience.</p>

                <p class="p" id="formfactor_value_desc"><a name="formfactor_value_desc"><!-- --></a>The <samp class="codeph nolang">Large</samp> value
                  represents the Lightning Experience desktop environment and is valid only for the
                  <samp class="codeph nolang">flexipage</samp> and <samp class="codeph nolang">lightningcomponent</samp> types. The <samp class="codeph nolang">Small</samp> value represents the Salesforce mobile app on a phone or tablet.
                  The <samp class="codeph nolang">Medium</samp> value is reserved for future use.
                  The <samp class="codeph nolang">null</samp> value (which is the same as
                  specifying no value) represents Salesforce Classic.
                </p>

                <p class="p">This field is available in API version 37.0 and later and is part of the feature
                  for creating and editing record pages in Lightning Experience.</p>
                Lightning
                component overrides return different <span class="keyword parmname">FormFactor</span> values
                depending on the API version used. <ul class="ul bulletList">
                  <li class="li">In API version 41.0 and earlier, Lightning component overrides return only the
                    <samp class="codeph nolang">null</samp> value (no value), representing the
                    Salesforce Classic environment.
                  </li>

                  <li class="li">In API version 42.0, if you specify different Lightning component overrides
                    for Lightning Experience and mobile, one component is selected randomly for both
                    overrides and its <span class="keyword parmname">FormFactor</span> value is returned. If there’s
                    a conflict between Lightning components, and a Visualforce page override is also
                    specified for Salesforce Classic, the Visualforce page takes precedence.</li>

                  <li class="li">In API version 43.0 and later, a Lightning component override for Lightning
                    Experience returns the <samp class="codeph nolang">Large</samp> value and a
                    Lightning component override for mobile returns the <samp class="codeph nolang">Small</samp> value, as expected.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e670" data-title="Field Name"><span class="keyword parmname">pageOrSobjectType</span></td>

              <td class="entry" headers="d300065e673" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e676" data-title="Description">The name of the
                sObject type being overridden. Valid values are <samp class="codeph nolang">standard</samp> and <samp class="codeph nolang">custom</samp>.<p class="p">This value must be <samp class="codeph nolang">standard-home</samp> when actionName is <samp class="codeph nolang">tab</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e670" data-title="Field Name"><span class="keyword parmname">skipRecordTypeSelect</span></td>

              <td class="entry" headers="d300065e673" data-title="Field Type">boolean</td>

              <td class="entry" headers="d300065e676" data-title="Description">Set this field to <samp class="codeph nolang">true</samp> if you prefer that
                any new records created by this action override aren’t forwarded to the record type
                selection page. This field is only valid if the <span class="keyword parmname">actionName</span> is a
                “create” type (like <samp class="codeph nolang">new</samp>), and
                <span class="keyword parmname">type</span> is set to <samp class="codeph nolang">visualforce</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e670" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d300065e673" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm#actionOverrideType_section">ActionOverrideType</a>
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)
              </td>

              <td class="entry" headers="d300065e676" data-title="Description">Required. Represents the type of action override. The valid values are <samp class="codeph nolang">Flexipage</samp> and <samp class="codeph nolang">Default</samp>.
                <p class="p">A
                  <samp class="codeph nolang">Flexipage</samp> AppActionOverride set to App
                  Default can’t be deleted via Metadata API. Instead, remove the override using the
                  page assignment wizard in the Lightning App Builder UI.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## AppBrand

The color scheme and logo used for the app. Available for Lightning apps in API version 38.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| footerColor | string | Optional. Specify the color with a hexadecimal code, such as #0000FF for blue.Determines the footer color in the app. |
| headerColor | string | Optional. Specify the color with a hexadecimal code, such as #0000FF for blue.Determines the header color in the app. |
| logo | string | The optional reference to the image document for the application. |
| logoVersion | int | An optional version number for the logo. |
| shouldOverrideOrgTheme | boolean | Indicates whether to override the global theme for the org. When true, the color scheme and logo that the user has set are used. When false, the global theme for the org is used, even if the user has set a color scheme and logo. |

## AppComponentList

Represents custom console components (Visualforce pages) assigned to a Salesforce console app. In API version 42.0, this type was renamed from CustomApplicationComponents to AppComponentList.

| Field Name | Field Type | Description |
| --- | --- | --- |
| alignment | string | Required. Determines how custom console components are aligned in the footer of a Salesforce console app. |
| components | string\[\] | The name of a custom console component assigned to a Salesforce console app. In API version 42.0, this field was renamed from customApplicationComponent to components. |

## AppPreferences

Represents the preferences for a Salesforce Classic console app. All of the AppPreferences fields are required. Available in API version 42.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableCustomizeMyTabs | boolean | Indicates if a Salesforce Classic console app has Customize My Tabs enabled. If enabled, users can hide, display, and organize items in the navigation tab. |
| enableKeyboardShortcuts | boolean | Indicates if a Salesforce Classic console app has keyboard shortcuts enabled. Shortcuts let users perform actions by pressing a combination of keys instead of having to use a mouse. After keyboard shortcuts are enabled, several default shortcuts are available for customization. Before you can create custom shortcuts, a developer must define the shortcut’s action with the addEventListener() method in the Salesforce Console Integration Toolkit. You can’t create keyboard shortcuts for actions performed outside of the console. This field is required if isServiceCloudConsole is true. |
| enableListViewHover | boolean | Indicates if a Salesforce Classic console app has list view hovers enabled. If set to true, summary information is displayed about a record in a responsive list when the user hovers over a record name. For cases, hover over the subject field. |
| enableListViewReskin | boolean | Indicates if Salesforce Classic console apps use responsive list views instead of Salesforce Classic lists views. |
| enableMultiMonitorComponents | boolean | Indicates if a Salesforce Classic console app has multi-monitor components enabled, which lets users move portions of a console from their browsers to locations on their screens. This field is required if isServiceCloudConsole is true. |
| enablePinTabs | boolean | Indicates if a Salesforce Classic console app has pinned tabs enabled, which lets users pin primary tabs to the tab bar for quick access. |
| enableTabHover | boolean | Indicates if a Salesforce Classic console app has tab hover enabled. If enabled, summary information is displayed about a record in an overlay when the user hovers over a tab. |
| enableTabLimits | boolean | Indicates whether limits are enabled on the number of primary tabs and subtabs that can be opened in a Salesforce Classic console session. When true, values for tabLimitConfig are required |
| saveUserSessions | boolean | Indicates if a Salesforce Classic console app saves user sessions automatically. If enabled, when console users close their browsers or log out of Salesforce, any previously open tabs display when users log in again. Required if isServiceCloudConsole is true. |

## AppProfileActionOverride

Represents a ProfileActionOverride for a custom app. This type inherits from [ProfileActionOverride](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profileactionoverride.htm#meta_profileactionoverride "Represents an override of an ActionOverride by a user profile. You can use it to override an ActionOverride on a standard Home tab or object record page in Lightning Experience. When a user logs in with a profile, a matching ProfileActionOverride assignment takes precedence over existing overrides for the Home tab or record page specified in ActionOverride. In API versions 39.0 to 44.0, you can access ProfileActionOverride by accessing its encompassing CustomApplication or Profile metadata types. In API version 45.0 and later, you can access ProfileActionOverride only by accessing its encompassing CustomApplication.") and extends it by one field, profile. Available for Lightning Experience in API version 39.0 and later. In API version 45.0 and later, you can override a home page for the custom app by profile.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d300065e1368">Field Name</th>

              <th class="featureTableHeader  " id="d300065e1371">Field Type</th>

              <th class="featureTableHeader  " id="d300065e1374">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d300065e1368" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d300065e1371" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e1374" data-title="Description">Required. The name of the action. The only valid values are <samp class="codeph nolang">Tab</samp> and <samp class="codeph nolang">View</samp>.<p class="p">If <span class="keyword parmname">pageOrSobjectType</span> is <samp class="codeph nolang">record-home</samp>, this field must be <samp class="codeph nolang">View</samp>. The <samp class="codeph nolang">View</samp>
                  action is supported only when ProfileActionOverride is being specified as part of
                  a CustomApplication.</p>
                <p class="p">In API version 45.0 and later, this action is supported
                  only when ProfileActionOverride is being specified as part of a CustomApplication,
                  <span class="keyword parmname">pageOrSobjectType</span> is <samp class="codeph nolang">standard-home</samp>, and this field is <samp class="codeph nolang">Tab</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1368" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d300065e1371" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e1374" data-title="Description">Read-only. Represents the name of the Lightning page being used as the
                override.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1368" data-title="Field Name"><span class="keyword parmname">formFactor</span></td>

              <td class="entry" headers="d300065e1371" data-title="Field Type">FormFactor (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d300065e1374" data-title="Description">Required. The size of the page being overridden. The <samp class="codeph nolang">Large</samp> value represents the Lightning Experience
                desktop environment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1368" data-title="Field Name"><span class="keyword parmname">pageOrSobjectType</span></td>

              <td class="entry" headers="d300065e1371" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e1374" data-title="Description">Required. The name of the page being overridden. The only valid values are
                <samp class="codeph nolang">record-home</samp> and <samp class="codeph nolang">standard-home</samp>. If the <span class="keyword parmname">actionName</span> is <samp class="codeph nolang">Tab</samp>, this field must be <samp class="codeph nolang">standard-home</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1368" data-title="Field Name"><span class="keyword parmname">profile</span></td>

              <td class="entry" headers="d300065e1371" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e1374" data-title="Description">The profile associated with the ProfileActionOverride.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1368" data-title="Field Name"><span class="keyword parmname">recordType</span></td>

              <td class="entry" headers="d300065e1371" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e1374" data-title="Description">The record type associated with the override. If
                <span class="keyword parmname">pageOrSobjectType</span> is <samp class="codeph nolang">standard-home</samp>, this field must be <samp class="codeph nolang">null</samp>. This field is required when <span class="keyword parmname">actionName</span> is set
                to <samp class="codeph nolang">View</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1368" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d300065e1371" data-title="Field Type">ActionOverrideType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d300065e1374" data-title="Description">Required. Read-only. The type of action override. The only valid value is
                <samp class="codeph nolang">flexipage</samp>.
              </td>

            </tr>

          </tbody>

        </table>

## AppWorkspaceConfig

Represents how records open in a Salesforce console app. Required if isServiceCloudConsole is true. Available for Salesforce Classic console apps in API version 25.0 and later. Available for Lightning console apps in API version 41.0 and later. In API version 42.0, this type was renamed from WorkspaceMappings to AppWorkspaceConfig.

| Field Name | Field Type | Description |
| --- | --- | --- |
| mappings | [WorkspaceMappingSingle](#WorkspaceMappingSingle)\[\] | Represents how records for a specific tab open in a Salesforce console app. Required for each tab specified in the CustomApplication.workspaceMapping to mappings. |

## WorkspaceMapping

Represents how records for a specific tab open in a Salesforce console app. Required for each tab specified in the CustomApplication. Available in API version 25.0 and later for Salesforce Classic console apps. Available in API version 41.0 and later for Lightning console apps.

| Field Name | Field Type | Description |
| --- | --- | --- |
| fieldName | string | The name of the field that specifies the primary tab in which to display tab as a subtab. If not specified, tab opens as a primary tab. |
| tab | string | Required. Name of the tab. |

## CustomShortcut

Represents custom keyboard shortcuts assigned to a Salesforce console app in Salesforce Classic. Before you can create custom shortcuts, a developer must define the shortcut’s action with the addEventListener() method in the Salesforce Console Integration Toolkit. You can’t create keyboard shortcuts for actions performed outside of the console. Available in API version 28.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d300065e1718">Field Name</th>

              <th class="featureTableHeader  " id="d300065e1721">Field Type</th>

              <th class="featureTableHeader  " id="d300065e1724">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d300065e1718" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d300065e1721" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e1724" data-title="Description">Required. The action performed in the console when a user presses the keyboard
                shortcut.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1718" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d300065e1721" data-title="Field Type">boolean</td>

              <td class="entry" headers="d300065e1724" data-title="Description"><span class="ph" id="KeyboardShortcutActive"><a name="KeyboardShortcutActive"><!-- --></a>Required. Indicates whether the keyboard
                  shortcut is active (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1718" data-title="Field Name"><span class="keyword parmname">keyCommand</span></td>

              <td class="entry" headers="d300065e1721" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e1724" data-title="Description">
                <span class="ph" id="KeyCommandDesc"><a name="KeyCommandDesc"><!-- --></a>Required. The combination of keys a user presses to
                  trigger the keyboard shortcut. Keyboard shortcuts aren’t case-sensitive, but they
                  display as uppercase on setup pages in the Salesforce user interface so that
                  they’re easier to read.</span>
                <p class="p" id="KeyCommandDesc1"><a name="KeyCommandDesc1"><!-- --></a>Each key command can
                  include up to four modifier keys followed by one non-modifier key. Modifier and
                  non-modifier keys are separated by the <samp class="codeph nolang">+</samp> key.
                  Modifier keys can occur in any order, but you must place non-modifier keys at the
                  end of the key command sequence. For example, <samp class="codeph nolang">SHIFT+CTRL+ALT+META +A</samp>.</p>
                <p class="p" id="KeyCommandDesc2"><a name="KeyCommandDesc2"><!-- --></a>Valid modifier keys
                  are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">SHIFT</samp></li>

                  <li class="li"><samp class="codeph nolang">CTRL</samp></li>

                  <li class="li"><samp class="codeph nolang">ALT</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">META</samp> (represents the COMMAND key on
                    Macs)
                  </li>

                </ul>
                <p class="p" id="KeyCommandDesc3"><a name="KeyCommandDesc3"><!-- --></a>Valid non-modifier keys are letters A through Z and
                  numbers 0 through 9. Other valid keys are:</p>
                <a name="KeyCommandKeys"><!-- --></a>
                <ul class="ul bulletList" id="KeyCommandKeys">
                  <li class="li"><samp class="codeph nolang">TAB</samp></li>

                  <li class="li"><samp class="codeph nolang">ENTER</samp></li>

                  <li class="li"><samp class="codeph nolang">PAUSE/BREAK</samp></li>

                  <li class="li"><samp class="codeph nolang">CAPS LOCK</samp></li>

                  <li class="li"><samp class="codeph nolang">ESC</samp></li>

                  <li class="li"><samp class="codeph nolang">SPACE</samp></li>

                  <li class="li"><samp class="codeph nolang">PAGE UP</samp></li>

                  <li class="li"><samp class="codeph nolang">PAGE DOWN</samp></li>

                  <li class="li"><samp class="codeph nolang">END</samp></li>

                  <li class="li"><samp class="codeph nolang">HOME</samp></li>

                  <li class="li"><samp class="codeph nolang">LEFT ARROW</samp></li>

                  <li class="li"><samp class="codeph nolang">UP ARROW</samp></li>

                  <li class="li"><samp class="codeph nolang">RIGHT ARROW</samp></li>

                  <li class="li"><samp class="codeph nolang">DOWN ARROW</samp></li>

                  <li class="li"><samp class="codeph nolang">PRINT SCREEN</samp></li>

                  <li class="li"><samp class="codeph nolang">INSERT</samp></li>

                  <li class="li"><samp class="codeph nolang">DELETE</samp></li>

                  <li class="li"><samp class="codeph nolang">RIGHT WINDOW</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 0</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 1</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 2</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 3</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 4</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 5</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 6</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 7</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 8</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMPAD 9</samp></li>

                  <li class="li"><samp class="codeph nolang">MULTIPLY</samp></li>

                  <li class="li"><samp class="codeph nolang">ADD</samp></li>

                  <li class="li"><samp class="codeph nolang">SUBTRACT</samp></li>

                  <li class="li"><samp class="codeph nolang">DECIMAL POINT</samp></li>

                  <li class="li"><samp class="codeph nolang">DIVIDE</samp></li>

                  <li class="li"><samp class="codeph nolang">F1</samp></li>

                  <li class="li"><samp class="codeph nolang">F2</samp></li>

                  <li class="li"><samp class="codeph nolang">F3</samp></li>

                  <li class="li"><samp class="codeph nolang">F4</samp></li>

                  <li class="li"><samp class="codeph nolang">F5</samp></li>

                  <li class="li"><samp class="codeph nolang">F6</samp></li>

                  <li class="li"><samp class="codeph nolang">F7</samp></li>

                  <li class="li"><samp class="codeph nolang">F8</samp></li>

                  <li class="li"><samp class="codeph nolang">F9</samp></li>

                  <li class="li"><samp class="codeph nolang">F10</samp></li>

                  <li class="li"><samp class="codeph nolang">F11</samp></li>

                  <li class="li"><samp class="codeph nolang">F12</samp></li>

                  <li class="li"><samp class="codeph nolang">NUM LOCK</samp></li>

                  <li class="li"><samp class="codeph nolang">SCROLL LOCK</samp></li>

                  <li class="li"><samp class="codeph nolang">;</samp></li>

                  <li class="li"><samp class="codeph nolang">=</samp></li>

                  <li class="li"><samp class="codeph nolang">,</samp></li>

                  <li class="li"><samp class="codeph nolang">—</samp></li>

                  <li class="li"><samp class="codeph nolang">.</samp></li>

                  <li class="li"><samp class="codeph nolang">/</samp></li>

                  <li class="li"><samp class="codeph nolang">‘</samp></li>

                  <li class="li"><samp class="codeph nolang">[</samp></li>

                  <li class="li"><samp class="codeph nolang">]</samp></li>

                  <li class="li"><samp class="codeph nolang">\</samp></li>

                  <li class="li"><samp class="codeph nolang">'</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1718" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d300065e1721" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e1724" data-title="Description">The optional description text for the keyboard shortcut.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e1718" data-title="Field Name"><span class="keyword parmname">eventName</span></td>

              <td class="entry" headers="d300065e1721" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e1724" data-title="Description">Required. Code available to developers who want to add custom shortcut
                functions to the console via the Salesforce Console Integration Toolkit.</td>

            </tr>

          </tbody>

        </table>

## DefaultShortcut

Represents default keyboard shortcuts assigned to a Salesforce console app. After you enable keyboard shortcuts for a console, several default shortcuts are available for customization. These include opening and closing tabs, moving between tabs, and saving records. Available in API version 28.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d300065e2107">Field Name</th>

              <th class="featureTableHeader  " id="d300065e2110">Field Type</th>

              <th class="featureTableHeader  " id="d300065e2113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d300065e2107" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d300065e2110" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e2113" data-title="Description">Required. The action performed in the console when a user presses the
                keyboard shortcut. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FOCUS_CONSOLE</samp></li>

                  <li class="li"><samp class="codeph nolang">FOCUS_NAVIGATOR_TAB</samp></li>

                  <li class="li"><samp class="codeph nolang">FOCUS_DETAIL_VIEW</samp></li>

                  <li class="li"><samp class="codeph nolang">FOCUS_PRIMARY_TAB_PANEL</samp></li>

                  <li class="li"><samp class="codeph nolang">FOCUS_SUBTAB_PANEL</samp></li>

                  <li class="li"><samp class="codeph nolang">FOCUS_LIST_VIEW</samp></li>

                  <li class="li"><samp class="codeph nolang">FOCUS_FIRST_LIST_VIEW</samp></li>

                  <li class="li"><samp class="codeph nolang">FOCUS_SEARCH_INPUT</samp></li>

                  <li class="li"><samp class="codeph nolang">MOVE_LEFT</samp></li>

                  <li class="li"><samp class="codeph nolang">MOVE_RIGHT</samp></li>

                  <li class="li"><samp class="codeph nolang">UP_ARROW</samp></li>

                  <li class="li"><samp class="codeph nolang">DOWN_ARROW</samp></li>

                  <li class="li"><samp class="codeph nolang">OPEN_TAB_SCROLLER_MENU</samp></li>

                  <li class="li"><samp class="codeph nolang">OPEN_TAB</samp></li>

                  <li class="li"><samp class="codeph nolang">CLOSE_TAB</samp></li>

                  <li class="li"><samp class="codeph nolang">ENTER</samp></li>

                  <li class="li"><samp class="codeph nolang">EDIT</samp></li>

                  <li class="li"><samp class="codeph nolang">SAVE</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2107" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d300065e2110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d300065e2113" data-title="Description">Required. Indicates whether the keyboard
                shortcut is active (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2107" data-title="Field Name"><span class="keyword parmname">keyCommand</span></td>

              <td class="entry" headers="d300065e2110" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e2113" data-title="Description">
                <p class="p">Each key command can include up to four modifier keys followed by one
                  non-modifier key. Modifier and non-modifier keys are separated by the <samp class="codeph nolang">+</samp> key. Modifier keys can occur in any order, but
                  you must place non-modifier keys at the end of the key command sequence. For
                  example, <samp class="codeph nolang">SHIFT+CTRL+ALT+META +A</samp>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## KeyboardShortcuts

Represents keyboard shortcuts assigned to a Salesforce console app. Required if isServiceCloudConsole is true. Available in API version 28.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d300065e2285">Field Name</th>

              <th class="featureTableHeader  " id="d300065e2288">Field Type</th>

              <th class="featureTableHeader  " id="d300065e2291">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d300065e2285" data-title="Field Name"><span class="keyword parmname">customShortcuts</span></td>

              <td class="entry" headers="d300065e2288" data-title="Field Type">
                <a class="xref" href="#CustomShortcut">CustomShortcut</a>[]
              </td>

              <td class="entry" headers="d300065e2291" data-title="Description">
                <samp class="codeph javascript">addEventListener()</samp> method in the Salesforce Console Integration Toolkit. You
                can’t create keyboard shortcuts for actions performed outside of the console.<p class="p">Represents custom keyboard shortcuts assigned to a Salesforce
                  console app in Salesforce Classic. Before you can create custom shortcuts, a developer
                  must define the shortcut’s action with the In API version
                  42.0, this field was renamed from <span class="keyword parmname">customShortcut</span> to
                  <span class="keyword parmname">customShortcuts</span>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2285" data-title="Field Name"><span class="keyword parmname">defaultShortcuts</span></td>

              <td class="entry" headers="d300065e2288" data-title="Field Type">
                <a class="xref" href="#DefaultShortcut">DefaultShortcut</a>[]
              </td>

              <td class="entry" headers="d300065e2291" data-title="Description">
                <p class="p">Represents default keyboard shortcuts assigned to a Salesforce
                  console app. After you enable keyboard shortcuts for a console, several default shortcuts
                  are available for customization. These include opening and closing tabs, moving between
                  tabs, and saving records.In API version
                  42.0, this field was renamed from <span class="keyword parmname">defaultShortcut</span> to
                  <span class="keyword parmname">defaultShortcuts</span>.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## ListPlacement

Represents how lists display in a Salesforce console app. Required if isServiceCloudConsole is true. Available in API version 25.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d300065e2381">Field Name</th>

              <th class="featureTableHeader  " id="d300065e2384">Field Type</th>

              <th class="featureTableHeader  " id="d300065e2387">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d300065e2381" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d300065e2384" data-title="Field Type">int</td>

              <td class="entry" headers="d300065e2387" data-title="Description">Height of the list in pixels or percentage. Required if
                <span class="keyword parmname">location</span> is top.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2381" data-title="Field Name"><span class="keyword parmname">location</span></td>

              <td class="entry" headers="d300065e2384" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e2387" data-title="Description">Required. Location of the list on the screen. Valid values are:<ul class="ul bulletList">
                  <li class="li">full</li>

                  <li class="li">top</li>

                  <li class="li">left</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2381" data-title="Field Name"><span class="keyword parmname">units</span></td>

              <td class="entry" headers="d300065e2384" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e2387" data-title="Description">Required. Represents if <span class="keyword parmname">height</span> or
                <span class="keyword parmname">width</span> is in pixels or percentage.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2381" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d300065e2384" data-title="Field Type">int</td>

              <td class="entry" headers="d300065e2387" data-title="Description">Width of the list in pixels or percentage. Required if
                <span class="keyword parmname">location</span> is left.
              </td>

            </tr>

          </tbody>

        </table>

## LiveAgentConfig

Represents your organization's settings for using Chat in the Salesforce Console.

<table class="featureTable sort_table" summary="">



        <thead class="thead sorted" align="left">
          <tr>
            <th class="featureTableHeader  " id="d300065e2499">Field Name</th>

            <th class="featureTableHeader  " id="d300065e2502">Field Type</th>

            <th class="featureTableHeader  " id="d300065e2505">Description</th>

          </tr>

        </thead>

        <tbody class="tbody">
          <tr>
            <td class="entry" headers="d300065e2499" data-title="Field Name"><span class="keyword parmname">enableLiveChat</span></td>

            <td class="entry" headers="d300065e2502" data-title="Field Type">boolean</td>

            <td class="entry" headers="d300065e2505" data-title="Description">Specifies whether Chat is enabled in your organization (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

          </tr>

          <tr>
            <td class="entry" headers="d300065e2499" data-title="Field Name"><span class="keyword parmname">openNewAccountSubtab</span></td>

            <td class="entry" headers="d300065e2502" data-title="Field Type">boolean</td>

            <td class="entry" headers="d300065e2505" data-title="Description">Specifies whether to open a new Account subtab in a Salesforce console app
              automatically (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) when an agent accepts a chat.</td>

          </tr>

          <tr>
            <td class="entry" headers="d300065e2499" data-title="Field Name"><span class="keyword parmname">openNewCaseSubtab</span></td>

            <td class="entry" headers="d300065e2502" data-title="Field Type">boolean</td>

            <td class="entry" headers="d300065e2505" data-title="Description">Specifies whether to open a new Case subtab in a Salesforce console app
              automatically (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) when an agent accepts a chat.</td>

          </tr>

          <tr>
            <td class="entry" headers="d300065e2499" data-title="Field Name"><span class="keyword parmname">openNewContactSubtab</span></td>

            <td class="entry" headers="d300065e2502" data-title="Field Type">boolean</td>

            <td class="entry" headers="d300065e2505" data-title="Description">Specifies whether to open a new Contact subtab in a Salesforce console app
              automatically (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) when an agent accepts a chat.</td>

          </tr>

          <tr>
            <td class="entry" headers="d300065e2499" data-title="Field Name"><span class="keyword parmname">openNewLeadSubtab</span></td>

            <td class="entry" headers="d300065e2502" data-title="Field Type">boolean</td>

            <td class="entry" headers="d300065e2505" data-title="Description">Specifies whether to open a new Lead subtab in a Salesforce console app
              automatically (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) when an agent accepts a chat.</td>

          </tr>

          <tr>
            <td class="entry" headers="d300065e2499" data-title="Field Name"><span class="keyword parmname">openNewVFPageSubtab</span></td>

            <td class="entry" headers="d300065e2502" data-title="Field Type">boolean</td>

            <td class="entry" headers="d300065e2505" data-title="Description">Specifies whether to open a new Visualforce page as a subtab in a Salesforce
              console app automatically (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) when an agent accepts a chat.</td>

          </tr>

          <tr>
            <td class="entry" headers="d300065e2499" data-title="Field Name"><span class="keyword parmname">pageNamesToOpen</span></td>

            <td class="entry" headers="d300065e2502" data-title="Field Type">string [array of strings]</td>

            <td class="entry" headers="d300065e2505" data-title="Description">Specifies the Visualforce pages to open in subtabs when an agent accepts a chat
              in a Salesforce console app.<p class="p">This field is available in API version 42.0 and
                later.</p>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d300065e2499" data-title="Field Name"><span class="keyword parmname">showKnowledgeArticles</span></td>

            <td class="entry" headers="d300065e2502" data-title="Field Type">boolean</td>

            <td class="entry" headers="d300065e2505" data-title="Description">Specifies whether to display the Knowledge component while using Chat in a
              Salesforce console app (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

          </tr>

        </tbody>

      </table>

## PushNotification

Represents a set of push notifications, which are visual indicators on lists and detail pages that show when a record or field has changed during a user’s session. Available for use if isServiceCloudConsole is true. Available in API version 28.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| fieldNames | string\] | The name of the field or fields that trigger push notifications for the selected object. |
| objectName | string | Required. Name of the object that triggers push notifications. |

## ServiceCloudConsoleConfig

Represents configuration settings for a Salesforce console app. Available in API version 42.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d300065e2762">Field Name</th>

              <th class="featureTableHeader  " id="d300065e2765">Field Type</th>

              <th class="featureTableHeader  " id="d300065e2768">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname">componentList</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type"><a class="xref" href="#AppComponentList">AppComponentList</a></td>

              <td class="entry" headers="d300065e2768" data-title="Description">Represents custom console components (Visualforce pages) assigned to a
                Salesforce console app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="detail_refresh_field"><a name="detail_refresh_field"><!-- --></a>detailPageRefreshMethod</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e2768" data-title="Description">
                <span class="ph" id="detail_refresh_desc"><a name="detail_refresh_desc"><!-- --></a>Determines how detail pages refresh in a
                  Salesforce console app.</span> Required if
                <span class="keyword parmname">isServiceCloudConsole</span> is <samp class="codeph xml">true</samp>. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph xml">none</samp></li>

                  <li class="li"><samp class="codeph xml">autoRefresh</samp></li>

                  <li class="li"><samp class="codeph xml">flag</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="footer_color_field"><a name="footer_color_field"><!-- --></a>footerColor</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e2768" data-title="Description">
                <span class="ph" id="footer_color_field_desc"><a name="footer_color_field_desc"><!-- --></a>Determines the footer color in a Salesforce
                  console app.</span>
                <span class="ph" id="hex_code"><a name="hex_code"><!-- --></a>Specify the color with a hexadecimal code, such as #0000FF for
                  blue.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="header_color_field"><a name="header_color_field"><!-- --></a>headerColor</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e2768" data-title="Description">Specify the color with a hexadecimal code, such as #0000FF for
                blue.<span class="ph" id="header_color_field_desc"><a name="header_color_field_desc"><!-- --></a>Determines the header color in a Salesforce
                  console app.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="keyboard_shortcuts_field"><a name="keyboard_shortcuts_field"><!-- --></a>keyboardShortcuts</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type"><a class="xref" href="#KeyboardShortcuts">KeyboardShortcuts</a></td>

              <td class="entry" headers="d300065e2768" data-title="Description"><span class="ph" id="keyboard_field_desc"><a name="keyboard_field_desc"><!-- --></a>Represents the keyboard shortcuts for a Salesforce
                  console app. Keyboard shortcuts let users perform actions by pressing a
                  combination of keys instead of having to use a mouse.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="listplacement_field"><a name="listplacement_field"><!-- --></a>listPlacement</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type"><a class="xref" href="#ListPlacement">ListPlacement</a></td>

              <td class="entry" headers="d300065e2768" data-title="Description">Represents how lists display in a Salesforce console app. Required if
                <span class="keyword parmname">isServiceCloudConsole</span> is <samp class="codeph xml">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="list_refresh_field"><a name="list_refresh_field"><!-- --></a>listRefreshMethod</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e2768" data-title="Description">
                <span class="ph" id="refresh_list_desc"><a name="refresh_list_desc"><!-- --></a>Determines how lists refresh in a Salesforce console
                  app.</span> Required if <span class="keyword parmname">isServiceCloudConsole</span> is <samp class="codeph xml">true</samp>. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph xml">none</samp></li>

                  <li class="li"><samp class="codeph xml">refreshList</samp></li>

                  <li class="li"><samp class="codeph xml">refreshListRows</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="live_agent_config"><a name="live_agent_config"><!-- --></a>liveAgentConfig</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type"><a class="xref" href="#LiveAgentConfig-CCD76B45">LiveAgentConfig</a></td>

              <td class="entry" headers="d300065e2768" data-title="Description"><span class="ph" id="liveAgentConfig_desc"><a name="liveAgentConfig_desc"><!-- --></a>Represents the configurations for using Chat in
                  the Salesforce Console.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="primarytab_color_field"><a name="primarytab_color_field"><!-- --></a>primaryTabColor</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e2768" data-title="Description">
                <span class="ph" id="primarytab_color_field_desc"><a name="primarytab_color_field_desc"><!-- --></a>Determines the primary tab color in a
                  Salesforce console app.</span>
                <span class="ph" id="hex_code_blue"><a name="hex_code_blue"><!-- --></a>Specify the color with a hexadecimal code, such as #0000FF
                  for blue.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="pushnotifications_field"><a name="pushnotifications_field"><!-- --></a>pushNotifications</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type">
                <a class="xref" href="#PushNotification">PushNotification</a>[]
              </td>

              <td class="entry" headers="d300065e2768" data-title="Description"><span class="ph" id="pushnotifications_field_desc"><a name="pushnotifications_field_desc"><!-- --></a>Represents push notifications for a
                  Salesforce console app. Push notifications are visual indicators on lists and
                  detail pages that show when a record or field has changed during a user’s
                  session. For example, assume that two support agents are working on the same case.
                  If one agent changes the&nbsp;<span class="keyword parmname">Priority</span>, a push notification
                  displays to the other agent so the agent notices the change and doesn’t duplicate
                  the effort.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="tabLimitConfig_name"><a name="tabLimitConfig_name"><!-- --></a>tabLimitConfig</span></span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type"><a class="xref" href="#TabLimitConfig">TabLimitConfig</a></td>

              <td class="entry" headers="d300065e2768" data-title="Description"><span class="ph" id="tabLimitsConfig_field_desc"><a name="tabLimitsConfig_field_desc"><!-- --></a>Represents the maximum number of primary
                  tabs and subtabs allowed in one Salesforce console session. Required if
                  <span class="keyword parmname">enableTabLimits</span> is <samp class="codeph xml">true</samp>.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e2762" data-title="Field Name"><span class="keyword parmname" id="whitelist_field"><a name="whitelist_field"><!-- --></a>whiteListedDomains</span></td>

              <td class="entry" headers="d300065e2765" data-title="Field Type">string[]</td>

              <td class="entry" headers="d300065e2768" data-title="Description">Any external domains that users can access from within a Salesforce console
                app. For example, <span class="ph filepath">www.yourdomain.com</span>.</td>

            </tr>

          </tbody>

        </table>

## TabLimitConfig

Represents the maximum number of primary tabs and subtabs allowed in one Salesforce console session. Required if enableTabLimits is true.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d300065e3056">Field Name</th>

              <th class="featureTableHeader  " id="d300065e3059">Field Type</th>

              <th class="featureTableHeader  " id="d300065e3062">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d300065e3056" data-title="Field Name"><span class="keyword parmname">maxNumberOfPrimaryTabs</span></td>

              <td class="entry" headers="d300065e3059" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e3062" data-title="Description">The maximum number of primary tabs allowed in one console session. Valid values are:<ul class="ul bulletList">
                  <li class="li">5</li>

                  <li class="li">10</li>

                  <li class="li">20</li>

                  <li class="li">30</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d300065e3056" data-title="Field Name"><span class="keyword parmname">maxNumberOfSubTabs</span></td>

              <td class="entry" headers="d300065e3059" data-title="Field Type">string</td>

              <td class="entry" headers="d300065e3062" data-title="Description">The maximum number of subtabs allowed in one console session. Valid values are:<ul class="ul bulletList">
                  <li class="li">5</li>

                  <li class="li">10</li>

                  <li class="li">15</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Usage

You can't delete custom app ProfileActionOverrides by deploying with destructiveChange.xml. To delete a ProfileActionOverride, retrieve the app. In the app definition file, find the <profileActionOverrides> section, and remove the <content> row. Then, change the <type> value in that same section to default instead of flexipage. Do this for every override you want to reset. After making the changes, rezip the folder and deploy.

You can remove one override at a time each with its own deploy, or you can remove multiple overrides in a single deploy. However, we recommend that you do a fresh retrieve every time you want to delete a new override. Don’t use a previously retrieved file.

## Retrieving Apps

To retrieve apps in your organization, use the CustomApplication type name in the package.xml manifest file. You can either retrieve all apps or specify which apps to retrieve in the types section of package.xml.

To retrieve all apps in your organization—custom and standard apps, specify the wildcard character (\*), as follows.

<types\>
    <members\>\*</members\>
    <name\>CustomApplication</name\>
</types\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

In API version 29.0 and earlier, use of the wildcard returns only all custom applications but not standard applications.

To retrieve a custom app, specify the app name.

<types\>
    <members\>MyCustomApp</members\>
    <name\>CustomApplication</name\>
</types\>

To retrieve a standard app, add the standard\_\_ prefix to the app name. For example, to retrieve the Chatter standard app, specify standard\_\_Chatter.

<types\>
    <members\>standard\_\_Chatter</members\>
    <name\>CustomApplication</name\>
</types\>

To retrieve an app that is part of an installed package, add the package namespace prefix followed by two underscores and the app name. For example, if the package namespace is myInstalledPackageNS and the app name is PackageApp, specify myInstalledPackageNS\_\_PackageApp, as follows.

<types\>
    <members\>myInstalledPackageNS\_\_PackageApp</members\>
    <name\>CustomApplication</name\>
</types\>

## Declarative Metadata Sample Definition

Here’s the definition of a custom Lightning Experience app:

<?xml version="1.0" encoding="UTF-8"?>
<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides\>
        <actionName\>View</actionName\>
        <comment\>Action override created by Lightning App Builder during activation.</comment\>
        <content\>Custom\_Mobile\_Oppty\_Page</content\>
        <formFactor\>Small</formFactor\>
        <skipRecordTypeSelect\>false</skipRecordTypeSelect\>
        <type\>Flexipage</type\>
        <pageOrSobjectType\>Opportunity</pageOrSobjectType\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>View</actionName\>
        <comment\>Action override created by Lightning App Builder during activation.</comment\>
        <content\>Custom\_Mobile\_Oppty\_Page</content\>
        <formFactor\>Large</formFactor\>
        <skipRecordTypeSelect\>false</skipRecordTypeSelect\>
        <type\>Flexipage</type\>
        <pageOrSobjectType\>Opportunity</pageOrSobjectType\>
    </actionOverrides\>
    <brand\>
        <headerColor\>#EE1518</headerColor\>
        <shouldOverrideOrgTheme\>true</shouldOverrideOrgTheme\>
    </brand\>
    <description\>Manage inventory and deliveries for our warehouses.</description\>
    <formFactors\>Small</formFactors\>
    <formFactors\>Large</formFactors\>
    <isNavAutoTempTabsDisabled\>false</isNavAutoTempTabsDisabled\>
    <isNavPersonalizationDisabled\>false</isNavPersonalizationDisabled\>
    <label\>Warehouse Lightning</label\>
    <navType\>Standard</navType\>
    <profileActionOverrides\>
        <actionName\>View</actionName\>
        <content\>Warehouse\_test\_page</content\>
        <formFactor\>Large</formFactor\>
        <pageOrSobjectType\>Warehouse\_\_c</pageOrSobjectType\>
        <type\>Flexipage</type\>
        <profile\>Admin</profile\>
    </profileActionOverrides\>
    <profileActionOverrides\>
        <actionName\>View</actionName\>
        <content\>Warehouse\_test\_page</content\>
        <formFactor\>Small</formFactor\>
        <pageOrSobjectType\>Warehouse\_\_c</pageOrSobjectType\>
        <type\>Flexipage</type\>
        <profile\>Admin</profile\>
    </profileActionOverrides\>
    <setupExperience\>all</setupExperience\>
    <tabs\>standard-Feed</tabs\>
    <tabs\>standard-File</tabs\>
    <tabs\>standard-Account</tabs\>
    <tabs\>standard-Case</tabs\>
    <tabs\>Merchandise\_\_c</tabs\>
    <tabs\>Invoice\_\_c</tabs\>
    <tabs\>Warehouse\_\_c</tabs\>
    <tabs\>Delivery\_\_c</tabs\>
    <tabs\>standard-report</tabs\>
    <tabs\>standard-Dashboard</tabs\>
    <uiType\>Lightning</uiType\>
</CustomApplication\>

The following is a definition of a standard app (Chatter):

<?xml version="1.0" encoding="UTF-8"?>
<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
    <defaultLandingTab\>standard-home</defaultLandingTab\>
    <label\>Collaboration</label\>
    <tabs\>standard-Chatter</tabs\>
    <tabs\>standard-UserProfile</tabs\>
    <tabs\>standard-OtherUserProfile</tabs\>
    <tabs\>standard-CollaborationGroup</tabs\>
    <tabs\>standard-File</tabs\>
</CustomApplication\>

## Declarative Metadata Sample Definition—Salesforce Console

The following is the definition of a custom app where isServiceCloudConsole is true:

<?xml version="1.0" encoding="UTF-8"?>
<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
    <consoleConfig\>
        <componentList\>
            <alignment\>left</alignment\>
            <components\>MyComponent</components\>
        </componentList\>
        <detailPageRefreshMethod\>autoRefresh</detailPageRefreshMethod\>
        <keyboardShortcuts\>
            <customShortcuts\>
                <action\>MyCustomShortcutAction</action\>
                <active\>true</active\>
                <keyCommand\>X</keyCommand\>
                <description\>Custom Shortcut example</description\>
                <eventName\>myCustomShortcutExample</eventName\>
            </customShortcuts\>
            <defaultShortcuts\>
                <action\>FOCUS\_CONSOLE</action\>
                <active\>true</active\>
                <keyCommand\>ESC</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>FOCUS\_NAVIGATOR\_TAB</action\>
                <active\>true</active\>
                <keyCommand\>V</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>FOCUS\_DETAIL\_VIEW</action\>
                <active\>true</active\>
                <keyCommand\>SHIFT+S</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>FOCUS\_PRIMARY\_TAB\_PANEL</action\>
                <active\>true</active\>
                <keyCommand\>P</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>FOCUS\_SUBTAB\_PANEL</action\>
                <active\>true</active\>
                <keyCommand\>S</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>FOCUS\_LIST\_VIEW</action\>
                <active\>true</active\>
                <keyCommand\>N</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>FOCUS\_FIRST\_LIST\_VIEW</action\>
                <active\>true</active\>
                <keyCommand\>SHIFT+F</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>FOCUS\_SEARCH\_INPUT</action\>
                <active\>true</active\>
                <keyCommand\>R</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>MOVE\_LEFT</action\>
                <active\>true</active\>
                <keyCommand\>LEFT ARROW</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>MOVE\_RIGHT</action\>
                <active\>true</active\>
                <keyCommand\>RIGHT ARROW</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>UP\_ARROW</action\>
                <active\>true</active\>
                <keyCommand\>UP ARROW</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>DOWN\_ARROW</action\>
                <active\>true</active\>
                <keyCommand\>DOWN ARROW</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>OPEN\_TAB\_SCROLLER\_MENU</action\>
                <active\>true</active\>
                <keyCommand\>D</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>OPEN\_TAB</action\>
                <active\>true</active\>
                <keyCommand\>T</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>CLOSE\_TAB</action\>
                <active\>true</active\>
                <keyCommand\>C</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>ENTER</action\>
                <active\>true</active\>
                <keyCommand\>ENTER</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>EDIT</action\>
                <active\>true</active\>
                <keyCommand\>E</keyCommand\>
            </defaultShortcuts\>
            <defaultShortcuts\>
                <action\>SAVE</action\>
                <active\>true</active\>
                <keyCommand\>CTRL+S</keyCommand\>
            </defaultShortcuts\>
        </keyboardShortcuts\>
        <listPlacement\>
            <location\>left</location\>
            <units\>percent</units\>
            <width\>20</width\>
        </listPlacement\>
        <listRefreshMethod\>refreshList</listRefreshMethod\>
        <pushNotifications\>
            <fieldNames\>CreatedBy</fieldNames\>
            <objectName\>Campaign</objectName\>
        </pushNotifications\>
        <pushNotifications\>
            <fieldNames\>CustomField1\_\_c</fieldNames\>
            <objectName\>CustomObject1\_\_c</objectName\>
        </pushNotifications\>
    </consoleConfig\>
    <defaultLandingTab\>standard-home</defaultLandingTab\>
    <isServiceCloudConsole\>true</isServiceCloudConsole\>
    <label\>MyConsole</label\>
    <preferences\>
        <enableCustomizeMyTabs\>false</enableCustomizeMyTabs\>
        <enableKeyboardShortcuts\>true</enableKeyboardShortcuts\>
        <enableListViewHover\>true</enableListViewHover\>
        <enableListViewReskin\>true</enableListViewReskin\>
        <enableMultiMonitorComponents\>true</enableMultiMonitorComponents\>
        <enablePinTabs\>true</enablePinTabs\>
        <enableTabHover\>false</enableTabHover\>
        <enableTabLimits\>false</enableTabLimits\>
        <saveUserSessions\>false</saveUserSessions\>
    </preferences\>
    <tabs\>standard-Case</tabs\>
    <tabs\>standard-Account</tabs\>
    <tabs\>standard-Contact</tabs\>
    <tabs\>standard-Contract</tabs\>
    <workspaceConfig\>
        <mappings\>
            <tab\>standard-Case</tab\>
        </mappings\>
        <mappings\>
            <fieldName\>ParentId</fieldName\>
            <tab\>standard-Account</tab\>
        </mappings\>
        <mappings\>
            <fieldName\>AccountId</fieldName\>
            <tab\>standard-Contact</tab\>
        </mappings\>
        <mappings\>
            <tab\>standard-Contract</tab\>
        </mappings\>
    </workspaceConfig\>
</CustomApplication\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [CustomTab](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_tab.htm "Represents a custom tab. Custom tabs let you display custom object data or other web content in Salesforce. When you add a custom tab to an app in Salesforce Classic, it appears as a tab. When you add a custom tab to an app in Lightning Experience, it appears as an item in the app’s navigation bar and in the App Launcher. When a tab displays a custom object, the tab name is the same as the custom object name. For page, s-control, or URL tabs, the name is arbitrary.")

<!-- document id=666ab9126866608c8447c547ad2a43902cc43caadfa0748b19ea91410c3d356e url=/legacydeveloper/current/en-us/api_meta/meta_customapplicationcomponent.md -->

# CustomApplicationComponent

Represents a custom console component (Visualforce page) assigned to a CustomApplication that is marked as a Salesforce console. Custom console components extend the capabilities of Salesforce console apps. See Customize a Console with Custom Components in Salesforce Classic in Salesforce Help.

## File Suffix and Directory Location

Custom application components have the suffix .customApplicationComponent and are stored in the customApplicationComponents folder.

## Version

Custom applications are available in API version 25.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| buttonIconUrl | string | The address of a page that hosts an icon for the button. |
| buttonStyle | string | The inline style used to define how the button looks. |
| buttonText | string | The label on the button used to launch the custom console component. |
| buttonWidth | int | The pixel width of the button displayed in the Salesforce console. |
| height | int | The pixel height of the window used to display the custom console component. |
| isHeightFixed | boolean | Required. Indicates whether users can change the custom console component height (false) or not (true). |
| isHidden | boolean | Required. Indicates whether the custom console component is hidden from users (true) or not (false). |
| isWidthFixed | boolean | Required. Indicates whether users can change the component width (false) or not (true). |
| visualforcePage | string | Required. Name of the Visualforce page that represents the custom console component. |
| width | int | The pixel width of the window used to display the custom console component. |

## Declarative Metadata Sample Definition

The following is the definition of a custom application component:

<?xml version="1.0" encoding="UTF-8"?>
<CustomApplicationComponent xmlns="http://soap.sforce.com/2006/04/metadata">
    <buttonIconUrl\>https://salesforce.com</buttonIconUrl\>
    <buttonStyle\>buttonStyleCSS</buttonStyle\>
    <buttonText\>buttonText</buttonText\>
    <buttonWidth\>200</buttonWidth\>
    <height\>200</height\>
    <isHeightFixed\>false</isHeightFixed\>
    <isHidden\>false</isHidden\>
    <isWidthFixed\>false</isWidthFixed\>
    <visualforcePage\>MyVisualforcePage</visualforcePage\>
    <width\>50</width\>
</CustomApplicationComponent\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b7687393566710c65fc4deb371e18fa7fd443aab52feeccba8686c4a03027bad url=/legacydeveloper/current/en-us/api_meta/meta_customerdataplatformsettings.md -->

# CustomerDataPlatformSettings

Represents an org's Data 360 settings.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

CustomerDataPlatformSettings values are stored in the CustomerDataPlatformSettings.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

CustomerDataPlatformSettings components are available in API version 48.0 and later.

## Special Access Rules

## Fields

| Field Name | Description |
| --- | --- |
| enableCustomerDataPlatform | 
Field Type

boolean

Description

Indicates whether an org has Data 360 enabled (true) or not (false).



 |

## Declarative Metadata Sample Definition

The following is an example of a CustomerDataPlatformSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<CustomerDataPlatformSettings xmlns=“http://soap.sforce.com/2006/04/metadata">
  <enableCustomerDataPlatform\>true</enableCustomerDataPlatform\>
</CustomerDataPlatformSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns=“http://soap.sforce.com/2006/04/metadata">
  <types\>
    <members\>CustomerDataPlatform</members\>
    <name\>Settings</name\>
  </types\>
  <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=69d689103518ce8bcdf3a01394d3692cb780b66da6b890077aeab44b34b2e468 url=/legacydeveloper/current/en-us/api_meta/meta_customfeedfilter.md -->

# CustomFeedFilter

Represents a custom feed filter that limits the feed view to feeds from the Cases object. The custom feed filter shows only feed items that satisfy the criteria specified in the CustomFeedFilter definition. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

CustomFeedFilter components have the suffix .feedFilter and are stored in the feedFilters folder.

## Version

CustomFeedFilter components are available in API version 35.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| criteria | [FeedFilterCriterion](#FeedFilterCriteria) \[\] | The criterion that defines which feed items are shown when the filter is applied. The feed filter displays all feed items that satisfy the criteria. |
| description | string | The description of the custom feed filter. For example, specify what feed items that filter shows. |
| label | string | Required. The API label of the custom feed filter. |
| isProtected | boolean | An auto-generated value. It currently has no impact. |

## FeedFilterCriterion

Represents the conditions that a feed item must satisfy to be displayed when a feed filter is applied.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d310579e178">Field Name</th>

              <th class="featureTableHeader  " id="d310579e181">Field Type</th>

              <th class="featureTableHeader  " id="d310579e184">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d310579e178" data-title="Field Name"><span class="keyword parmname">feedItemType</span></td>

              <td class="entry" headers="d310579e181" data-title="Field Type"><span class="ph" id="FeedItemType"><a name="FeedItemType"><!-- --></a>FeedItemType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</span></td>

              <td class="entry" headers="d310579e184" data-title="Description">
                <p class="p">Required. The type of feed items that the filter shows.</p>

                <p class="p">The feed item type can be one of the following values:</p>

                <ul class="ul bulletList">
                  <li class="li">AttachArticleEvent</li>

                  <li class="li">CallLogPost</li>

                  <li class="li">CanvasPost</li>

                  <li class="li">CaseCommentPost</li>

                  <li class="li">ChangeStatusPost</li>

                  <li class="li">ChatTranscriptPost</li>

                  <li class="li">ContentPost</li>

                  <li class="li">CreateRecordEvent</li>

                  <li class="li">EmailMessageEvent</li>

                  <li class="li">LinkPost</li>

                  <li class="li">MilestoneEvent</li>

                  <li class="li">QuestionPost</li>

                  <li class="li">PollPost</li>

                  <li class="li">ReplyPost</li>

                  <li class="li">SocialPost</li>

                  <li class="li">TextPost</li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d310579e178" data-title="Field Name"><span class="keyword parmname">feedItemVisibility</span></td>

              <td class="entry" headers="d310579e181" data-title="Field Type">FeedItemVisibility (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d310579e184" data-title="Description">
                <p class="p">The visibility of feed items that the filter shows. For example, you can show
                  only poll posts that are visible internally.</p>

                <p class="p">Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">AllUsers</li>

                  <li class="li">InternalUsers</li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d310579e178" data-title="Field Name"><span class="keyword parmname">relatedSObjectType</span></td>

              <td class="entry" headers="d310579e181" data-title="Field Type">string</td>

              <td class="entry" headers="d310579e184" data-title="Description">
                <p class="p">The API name of the object that the feed item refers to. This field is typically
                  used with the CreateRecordEvent feed item type.</p>

                <p class="p">For example, a feed filter can show CreateRecordEvent feed items for the Cases
                  object.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a [CustomFeedFilter](#meta_customfeedfilter "Represents a custom feed filter that limits the feed view to feeds from the Cases object. The custom feed filter shows only feed items that satisfy the criteria specified in the CustomFeedFilter definition. This type extends the Metadata metadata type and inherits its fullName field.") component.

<?xml version="1.0" encoding="UTF-8"?>
<CustomFeedFilter xmlns="http://soap.sforce.com/2006/04/metadata">
    <criteria\>
        <feedItemType\>CreateRecordEvent</feedItemType\>
        <relatedSObjectType\>MyCO01\_\_c</relatedSObjectType\>
    </criteria\>
    <criteria\>
        <feedItemType\>CreateRecordEvent</feedItemType\>
        <relatedSObjectType\>Case</relatedSObjectType\>
    </criteria\>
    <criteria\>
        <feedItemType\>PollPost</feedItemType\>
        <feedItemVisibility\>InternalUsers</feedItemVisibility\>
    </criteria\>
    <label\>Sample Custom Feed Filter</label\>
</CustomFeedFilter\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>myCaseFeedFilter</members\>
        <name\>CustomFeedFilter</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=d29f14307e1f7aa55500aa46adab0b4107955e861d50448fef779d83db824341 url=/legacydeveloper/current/en-us/api_meta/customfield.md -->

# CustomField

Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

Only standard fields that you can customize are supported, that is, standard fields to which you can add help text or turn on history tracking or Chatter feed tracking. Other standard fields aren't supported, including system fields (such as CreatedById or LastModifiedDate) and auto number fields. Some standard picklist fields aren’t supported. See [Unsupported Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_unsupported_types.htm "Some Salesforce features have metadata types that aren’t available in Metadata API. These metadata types can’t be retrieved or deployed with Metadata API. To make changes to these types, you must do it manually in each of your organizations."). By default, a custom object doesn’t have any standard fields that are customizable.

Specify the full name whenever you create or update a field. For example, a custom field on a custom object:

MyCustomObject\_\_c.MyCustomField\_\_c

An example of a custom field on a standard object:

Account.MyAcctCustomField\_\_c

An example of a standard field on a standard object:

Account.Phone

An example of a custom field on an external object:

MyExternalObject\_\_x.MyCustomField\_\_c

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

In Metadata API, external objects are represented by the CustomObject metadata type.

These custom field types aren’t available for external objects.

- Auto number (available only with the cross-org adapter for Salesforce Connect)
- Currency (available only with the cross-org adapter for Salesforce Connect)
- Formula
- Location
- Master-detail relationship
- Picklist and multi-select picklist (available only with the cross-org adapter for Salesforce Connect)
- Rollup summary
- Text (encrypted)
- Text area (rich)

## Declarative Metadata File Suffix and Directory Location

Custom fields are user-defined fields and are part of the custom object or standard object definition. See [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.") for more information. Standard fields are predefined on standard objects.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet components that are retrieved in the same package.

## Retrieving Fields on Custom or Standard Objects

When you retrieve a custom or standard object, you return everything associated with the object, except for standard fields that aren't customizable. You can also retrieve only specific fields for an object by explicitly naming the object and fields in package.xml. The following definition in package.xml creates the files objects/MyCustomObject\_\_c.object and objects/Account.object, each containing the requested field definitions.

<types\>
  <members\>MyCustomObject\_\_c.MyCustomField\_\_c</members\>
  <members\>Account.MyCustomAccountField\_\_c</members\>
  <members\>Account.Phone</members\>
  <name\>CustomField</name\>
</types\>

## Retrieving or Deploying Fields on Data 360 Objects

When you retrieve a Data 360 object, such as a data lake object (DLO) or data model object (DMO), not all custom field properties are returned. The properties returned depend on the data type of the custom field.

When you deploy a Data 360 object via Metadata API, in API version 60.0 or later, the call succeeds only if the properties are supported by the custom field's data type. If you include a property that isn't supported by the field's data type, the API returns an error.

Data 360 objects support these data types.

- Boolean/Checkbox
- Date
- DateTime
- Email
- Lookup (DMOs only)
- Number
- Percent
- Phone
- Text
- Url

## Version

Custom and standard fields are available in API version 10.0 and later.

## Fields

Unless otherwise noted, all fields are creatable, filterable, and nillable.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d50443e282">Field Name</th>

              <th class="featureTableHeader  " id="d50443e285">Field Type</th>

              <th class="featureTableHeader  " id="d50443e288">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">businessOwnerGroup</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">reference</td>

              <td class="entry" headers="d50443e288" data-title="Description">Group associated with this field. The business owner group
                understands the importance of the field’s data to your company, and
                can be responsible for determining the minimum security
                classification. This field is available in API version 45.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">businessOwnerUser</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">reference</td>

              <td class="entry" headers="d50443e288" data-title="Description">Person associated with this field. The business owner understands
                the importance of the field’s data to your company, and can be
                responsible for determining the minimum security classification.
                This field is available in API version 45.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">businessStatus</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">picklist</td>

              <td class="entry" headers="d50443e288" data-title="Description">Indicates if the field is in use. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Active</samp></li>

                  <li class="li"><samp class="codeph nolang">DeprecateCandidate</samp></li>

                  <li class="li"><samp class="codeph nolang">Hidden</samp></li>

                </ul>
                This field is available in API version 45.0 and later</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">caseSensitive</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">Indicates whether the field is case-sensitive (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).<p class="p">For indirect lookup
                  relationship fields on external objects, this attribute affects
                  how this custom field’s values are matched against the values of
                  the <span class="keyword parmname">referenceTargetField</span>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">complianceGroup</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">multipicklist</td>

              <td class="entry" headers="d50443e288" data-title="Description">Compliance acts, definitions, or regulations related to the
                field’s data. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CCPA</samp></li>

                  <li class="li"><samp class="codeph nolang">COPPA</samp></li>

                  <li class="li"><samp class="codeph nolang">GDPR</samp></li>

                  <li class="li"><samp class="codeph nolang">HIPAA</samp></li>

                  <li class="li"><samp class="codeph nolang">PCI</samp></li>

                  <li class="li"><samp class="codeph nolang">PII</samp></li>

                </ul>
                This field is available in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">customDataType</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description">Deprecated in the Spring ‘19 (API version 45.0) release.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_defaultValue_name"><a name="field_defaultValue_name"><!-- --></a>defaultValue</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_defaultValue_desc"><a name="field_defaultValue_desc"><!-- --></a>If specified, represents the
                  default value of the field.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="delete_constraint"><a name="delete_constraint"><!-- --></a>deleteConstraint</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">DeleteConstraint (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="del_constraint_def"><a name="del_constraint_def"><!-- --></a>Deletion options for lookup
                  relationships. Valid values are:</span>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Cascade</samp>—Deletes the
                    lookup record and associated lookup fields.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Restrict</samp>—Prevents the
                    record from being deleted if it's in a lookup
                    relationship.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SetNull</samp>—Default value.
                    If the lookup record is deleted, the lookup field is
                    cleared.
                  </li>

                </ul>
                <p class="p" id="field_deleteConstraint_moreinfo"><a name="field_deleteConstraint_moreinfo"><!-- --></a>For more information on
                  lookup relationships, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.overview_of_custom_object_relationships.htm&amp;type=5&amp;language=en_US" target="_blank">Object
                    Relationships Overview</a>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_deprecated"><a name="field_deprecated"><!-- --></a>deprecated</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="description_name"><a name="description_name"><!-- --></a>description</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="description_desc"><a name="description_desc"><!-- --></a>Description of the field.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">displayFormat</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description">Display format of the field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="isDisplayLocInDecimal_name"><a name="isDisplayLocInDecimal_name"><!-- --></a>displayLocationInDecimal</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="isDisplayLocInDec_desc"><a name="isDisplayLocInDec_desc"><!-- --></a>Indicates how the geolocation
                  values of a custom location field appear in the user interface.
                  If <samp class="codeph apex_code"><span class="keyword">true</span></samp>, the
                  geolocation values appear in decimal notation. If <samp class="codeph apex_code"><span class="keyword">false</span></samp>, the geolocation
                  values appear as degrees, minutes, and seconds.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">elementType</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">ElementType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e288" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">encryptionScheme</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">EncryptionScheme (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e288" data-title="Description">For encrypted fields, determines which encryption scheme a field
                takes. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CaseInsensitiveDeterministicEncryption</samp></li>

                  <li class="li"><samp class="codeph nolang">CaseSensitiveDeterministicEncryption</samp></li>

                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">ProbabilisticEncryption</samp></li>

                </ul>
                This value pertains to Shield Platform Encryption, not Classic
                Encryption. This field is available in API version 44.0 and
                later.</td>

            </tr>

            <tr>

              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_externalDeveloperName"><a name="field_externalDeveloperName"><!-- --></a>externalDeveloperName</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description">Available only for external objects. Name of the table column on
                the external data source that maps to this custom field in
                Salesforce. Corresponds to the <span class="keyword parmname">External Column
                  Name</span> in the user interface. This field is available
                in API version 32.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">externalId</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_externalId_desc"><a name="field_externalId_desc"><!-- --></a>Indicates whether the field is an
                  external ID field (<samp class="codeph java">true</samp>) or
                  not (<samp class="codeph java">false</samp>). This property is
                  returned only if the custom field data type is auto number,
                  email, number, or text.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">fieldManageability</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">FieldManageability (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e288" data-title="Description">Determines who can update the field after it’s released in a
                managed package. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Locked</samp>—The field can’t
                    be updated.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DeveloperControlled</samp>—The
                    creator of the record can update the field with a package
                    upgrade.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SubscriberControlled</samp>—Anyone with proper
                    permissions can update the field. The field can’t be updated
                    with a package upgrade.
                  </li>

                </ul>
                Available only for fields on custom metadata types. If the
                field type is <samp class="codeph nolang">MetadataRelationship</samp>, and the manageability of the
                entity definition field is:<ul class="ul bulletList">
                  <li class="li">Subscriber-controlled, then the Field Definition field must
                    be subscriber-controlled.</li>

                  <li class="li">Upgradeable, then the Field Definition field must be either
                    upgradeable or subscriber-controlled.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_formula_name"><a name="field_formula_name"><!-- --></a>formula</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_formula_desc"><a name="field_formula_desc"><!-- --></a>If specified, represents a formula on
                  the field.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_formulaTreatBlankAs_name"><a name="field_formulaTreatBlankAs_name"><!-- --></a>formulaTreatBlanksAs</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">TreatBlanksAs (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_formulaTreatBlankAs_desc"><a name="field_formulaTreatBlankAs_desc"><!-- --></a>Indicates how to treat
                  blanks in a formula. Valid values are <samp class="codeph nolang">BlankAsBlank</samp> and <samp class="codeph nolang">BlankAsZero</samp>.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_fullName"><a name="field_fullName"><!-- --></a>fullName</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description">Full name of the object. It must be specified when creating,
                updating, or deleting the object. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a> to see an
                example of this field specified for a call.<p class="p" id="no_null_para"><a name="no_null_para"><!-- --></a>This
                  value can't be <samp class="codeph java">null</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="globalPickList_name"><a name="globalPickList_name"><!-- --></a>globalPicklist</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string.</td>

              <td class="entry" headers="d50443e288" data-title="Description">If this custom field is a picklist that’s based on a global
                picklist, <span class="keyword parmname">globalPicklist</span> is the name of the
                global picklist whose value set this picklist inherits. A custom
                picklist that’s based on a global picklist is restricted. You can
                only add or remove values by editing the global picklist. This field
                is available only in API version 37.0. </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">indexed</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">Indicates whether the field is indexed (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). If this field is unique or the
                <span class="keyword parmname">externalId</span> is set <samp class="codeph java">true</samp>, the <span class="keyword parmname">isIndexed</span> value is set
                to true. This field is available only in API version 14.0 and
                earlier.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="inlinehelptext_name"><a name="inlinehelptext_name"><!-- --></a>inlineHelpText</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="inlinehelptext_desc"><a name="inlinehelptext_desc"><!-- --></a>Content of field-level help. For
                  more information, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.customhelp_defining_field_level_help.htm&amp;type=5&amp;language=en_US" target="_blank">Define Field-Level Help</a>.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name">
                <span class="keyword parmname" id="field_isAIPredictionField"><a name="field_isAIPredictionField"><!-- --></a>isAIPredictionField</span>
              </td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="ffield_isAIPredictionField_desc"><a name="ffield_isAIPredictionField_desc"><!-- --></a>Available for number
                  type custom fields when you use Einstein Prediction Builder.
                  Indicates whether the field can store and display Einstein
                  prediction data on an object (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Use Einstein Prediction Builder to
                  determine the data for the target field.</span> This field is
                available in API version 43.0 and later.
              </td>

            </tr>

            <tr>

              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_isFilteringDisabled"><a name="field_isFilteringDisabled"><!-- --></a>isFilteringDisabled</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="field_isFilteringDisabled_desc"><a name="field_isFilteringDisabled_desc"><!-- --></a>Available only for
                  external objects. Indicates whether the custom field is
                  available in filters (<samp class="codeph java">true</samp>)
                  or not (<samp class="codeph java">false</samp>).</span> This
                field is available in API version 32.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_isNameField"><a name="field_isNameField"><!-- --></a>isNameField</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="field_isNameField_desc"><a name="field_isNameField_desc"><!-- --></a>Available only for external
                  object fields of type text. Indicates whether the custom field
                  is the name field (<samp class="codeph java">true</samp>) or
                  not (<samp class="codeph java">false</samp>). For each
                  external object, you can specify one field as the name
                  field.</span> If you set this value to <samp class="codeph java">true</samp>, ensure the external table column identified by
                the <span class="keyword parmname">externalDeveloperName</span> attribute contains
                name values. This field is available in API version 32.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_isSortingDisabled"><a name="field_isSortingDisabled"><!-- --></a>isSortingDisabled</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="field_isSortingDisabled_desc"><a name="field_isSortingDisabled_desc"><!-- --></a>Available only for external
                  objects. Indicates whether the custom field is sortable (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</span> This field is
                available in API version 32.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_label"><a name="field_label"><!-- --></a>label</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="field_label_desc"><a name="field_label_desc"><!-- --></a>Label for the field.</span> You can't
                update the label for standard picklist fields, such as the
                <span class="keyword parmname">Industry</span> field for accounts.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="length_name"><a name="length_name"><!-- --></a>length</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">int</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="length_desc"><a name="length_desc"><!-- --></a>Length of the field.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_lookupFilter"><a name="field_lookupFilter"><!-- --></a>lookupFilter</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">LookupFilter</td>

              <td class="entry" headers="d50443e288" data-title="Description">Metadata associated with a lookup
                filter definition. This field is only available in API version 30.0
                and earlier. <span class="ph" id="namedfilter_vs_lookup_filter"><a name="namedfilter_vs_lookup_filter"><!-- --></a>The metadata
                  associated with a lookup filter is now represented by the
                  <span class="keyword parmname">lookupFilter</span> field in the CustomField
                  component.</span>
                <p class="p">LookupFilter isn't supported on the article
                  type object.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="mask_kar"><a name="mask_kar"><!-- --></a>maskChar</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">EncryptedFieldMaskChar (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <p class="p">For encrypted fields, specifies the character to be used as a
                  mask. Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">asterisk</samp></li>

                  <li class="li"><samp class="codeph nolang">X</samp></li>

                </ul>

                <p class="p">This value pertains to Classic Encryption, not Shield Platform
                  Encryption. For more information on encrypted fields, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.fields_about_encrypted_fields.htm&amp;type=5&amp;language=en_US" target="_blank">Classic
                    Encryption for Custom Fields in Salesforce Help</a>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="masktype"><a name="masktype"><!-- --></a>maskType</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">EncryptedFieldMaskType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <p class="p">For encrypted text fields, specifies the format of the masked
                  and unmasked characters in the field. Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">all</samp>—all characters in
                    the field are hidden. This option is equivalent to the
                    <span class="keyword parmname">Mask All Characters</span> option in
                    Salesforce.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">creditCard</samp>—The first 12
                    characters are hidden and the last four appear. This option
                    is equivalent to the <span class="keyword parmname">Credit Card Number</span>
                    option in Salesforce.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">lastFour</samp>—all characters
                    are hidden but the last four appear. This option is
                    equivalent to the <span class="keyword parmname">Last Four Characters
                      Clear</span> option in Salesforce.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">nino</samp>—all characters are
                    hidden. Salesforce automatically inserts spaces after each
                    pair of characters if the field contains nine characters.
                    This option is equivalent to the <span class="keyword parmname">National
                      Insurance Number</span> option in Salesforce.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sin</samp>—all characters are
                    hidden but the last four appear This option is equivalent to
                    the <span class="keyword parmname">Social Insurance Number</span> option in
                    Salesforce.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ssn</samp>—The first five
                    characters are hidden and the last four appear This option
                    is equivalent to the <span class="keyword parmname">Social Security
                      Number</span> option in Salesforce.
                  </li>

                </ul>
                This value pertains to Classic Encryption, not Shield Platform
                Encryption. For more information on encrypted fields, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.fields_about_encrypted_fields.htm&amp;type=5&amp;language=en_US" target="_blank">Classic
                  Encryption for Custom Fields in Salesforce Help</a>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_metadataRelationshipControllingField_name"><a name="field_metadataRelationshipControllingField_name"><!-- --></a>metadataRelationshipControllingField</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="field_metadataRelationshipControllingField_desc"><a name="field_metadataRelationshipControllingField_desc"><!-- --></a>In
                  custom metadata relationships, represents the controlling field
                  that specifies the standard or custom object in an entity
                  definition metadata relationship. Required when creating a field
                  definition or entity particle metadata relationship on a custom
                  metadata type. The object specified in the controlling field
                  determines the values available in its dependent field
                  definition or entity particle. For example, specifying the
                  Account object filters the available fields in the field
                  definition to Account fields only.</span> This field is available
                in API version 39.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="picklist_field"><a name="picklist_field"><!-- --></a>picklist</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm" title="Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.">Picklist</a></td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="picklist_field_desc"><a name="picklist_field_desc"><!-- --></a>If specified, the field is a
                  picklist, and this field counts the picklist values and labels.
                  This field is available only in API version 37.0 and earlier. In
                  later versions, use <span class="keyword parmname">valueSet</span>
                  instead.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">populateExistingRows</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">Indicates whether existing rows are going to be populated
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">precision</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">int</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_precision_desc"><a name="field_precision_desc"><!-- --></a>Precision, or number of digits in a
                  number value. For example, the number 256.99 has a precision
                  value of 5.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_referenceTargetField"><a name="field_referenceTargetField"><!-- --></a>referenceTargetField</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description">Specifies the custom field on the parent object to match against
                this indirect lookup relationship field, whose values come from an
                external data source. The specified custom field on the parent
                object must have both <span class="keyword parmname">externalId</span> and
                <span class="keyword parmname">unique</span> set to <samp class="codeph java">true</samp>. Available only for indirect lookup relationship
                fields on external objects. This field is available in API version
                32.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_referenceTo_name"><a name="field_referenceTo_name"><!-- --></a>referenceTo</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_referenceTo_desc"><a name="field_referenceTo_desc"><!-- --></a>Reference this field has to
                  another object.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_relationshipLabel_name"><a name="field_relationshipLabel_name"><!-- --></a>relationshipLabel</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_relationshipLabel_desc"><a name="field_relationshipLabel_desc"><!-- --></a>Label for the
                  relationship.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_relationshipName_name"><a name="field_relationshipName_name"><!-- --></a>relationshipName</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_relationshipName_desc"><a name="field_relationshipName_desc"><!-- --></a>Value for one-to-many
                  relationships. For example, if MyObject has a relationship to
                  YourObject, the relationship name can be
                  YourObjects.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="relationshiporder_name"><a name="relationshiporder_name"><!-- --></a>relationshipOrder</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">int</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="relationshiporder_desc1"><a name="relationshiporder_desc1"><!-- --></a>This field is valid for all
                  master-detail relationships, but the value is only non-zero for
                  junction objects. A junction object has two master-detail
                  relationships, and is analogous to an association table in a
                  many-to-many relationship. Junction objects must define one
                  parent object as primary (0), the other as secondary (1). The
                  definition of primary or secondary affects delete behavior and
                  inheritance of look and feel, and record ownership for junction
                  objects.</span>
                <p class="p" id="relationshiporder_desc2"><a name="relationshiporder_desc2"><!-- --></a>0 or 1 are the only
                  valid values, and 0 is always the value for objects that aren't
                  junction objects.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="isUpdateableMasterDetail_name"><a name="isUpdateableMasterDetail_name"><!-- --></a>reparentableMasterDetail</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="isUpdateableMasterDetail_desc"><a name="isUpdateableMasterDetail_desc"><!-- --></a>Indicates whether the
                  child records in a master-detail relationship on a custom object
                  can be reparented to different parent records (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). The default value is
                  <samp class="codeph java">false</samp>.</span>
                <p class="p">This field
                  is available in API version 25.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_required_name"><a name="field_required_name"><!-- --></a>required</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_required_desc"><a name="field_required_desc"><!-- --></a>Indicates whether the field requires
                  a value on creation (<samp class="codeph java">true</samp>) or
                  not (<samp class="codeph java">false</samp>).</span></td>

            </tr>

            <tr>

              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="field_scale"><a name="field_scale"><!-- --></a>scale</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">int</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="field_scale_desc"><a name="field_scale_desc"><!-- --></a>Scale, or the number of digits to the
                  right of the decimal point in a number. For example, the number
                  256.99 has a scale of 2.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">securityClassification</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">picklist</td>

              <td class="entry" headers="d50443e288" data-title="Description">Sensitivity of the data contained in the field. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Public</samp></li>

                  <li class="li"><samp class="codeph nolang">Internal</samp></li>

                  <li class="li"><samp class="codeph nolang">Confidential</samp></li>

                  <li class="li"><samp class="codeph nolang">Restricted</samp></li>

                  <li class="li"><samp class="codeph nolang">MissionCritical</samp></li>

                </ul>
                This field is available in API version 45.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">startingNumber</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">int</td>

              <td class="entry" headers="d50443e288" data-title="Description">Starting number for the field. When you create records, the
                <span class="keyword parmname">Starting Number</span> value increments to store
                the number that will be assigned to the next auto number field
                created. <ul class="ul bulletList">
                  <li class="li">You can’t retrieve the starting number of an auto number
                    field through the Metadata API. To specify a
                    <span class="keyword parmname">Starting Number</span> while deploying,
                    add a <samp class="codeph xml">startingNumber</samp> tag
                    for your field to your <span class="ph filepath">package.xml</span>
                    file. For example: <samp class="codeph xml"><span class="tag">&lt;startingNumber</span>&gt;42<span class="tag">&lt;/startingNumber</span>&gt;</samp>
                  </li>

                  <li class="li">If you deploy without specifying a <span class="keyword parmname">Starting
                      Number</span> value in your
                    <span class="ph filepath">package.xml</span> file, the default
                    starting number for standard fields is <samp class="codeph nolang">0</samp>. The default starting
                    number for custom fields is <samp class="codeph nolang">1</samp>.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">stripMarkup</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">Indicates whether to remove markup (<samp class="codeph java">true</samp>) or preserve it (<samp class="codeph java">false</samp>). Used when converting a rich text area to a
                long text area.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">summarizedField</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description">Field on the detail row that’s being summarized. This field can't
                be null unless the <span class="keyword parmname">summaryOperation</span> value is
                <samp class="codeph nolang">count</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="summaryfilteritems"><a name="summaryfilteritems"><!-- --></a>summaryFilterItems</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type"><a class="xref" href="#filteritem">FilterItem[]</a></td>

              <td class="entry" headers="d50443e288" data-title="Description">Set of filter conditions for this field if it's a summary field.
                This field is summed in the child if the filter conditions are
                met.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">summaryForeignKey</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e288" data-title="Description">Master-detail field on the child that defines the relationship
                between the parent and the child.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="summaryoperation"><a name="summaryoperation"><!-- --></a>summaryOperation</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">SummaryOperations (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e288" data-title="Description">Represents the type of sum operation to be performed. Valid
                values are:
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph soql">Count</samp></li>

                  <li class="li"><samp class="codeph soql">Min</samp></li>

                  <li class="li"><samp class="codeph soql">Max</samp></li>

                  <li class="li"><samp class="codeph soql">Sum</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="trackfeedhistory"><a name="trackfeedhistory"><!-- --></a>trackFeedHistory</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="trackfeedhistory_desc"><a name="trackfeedhistory_desc"><!-- --></a>Indicates whether the field is
                  enabled for feed tracking (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</span> To set this field to <samp class="codeph java">true</samp>, the
                <span class="keyword parmname">enableFeeds</span> field on the associated <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm" title="Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.">CustomObject</a>
                must also be <samp class="codeph java">true</samp>. For more
                information, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=experience.collab_feed_tracking.htm&amp;type=5&amp;language=en_US" target="_blank">Customize
                  Chatter Feed Tracking</a>. <p class="p">This field is available in API
                  version 18.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">trackHistory</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="field_track_hist_desc"><a name="field_track_hist_desc"><!-- --></a>Indicates whether history tracking
                  is enabled for the field (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</span> Also available for standard object
                fields (picklist and lookup fields only) in API version 30.0 and
                later.<p class="p">To set <span class="keyword parmname">trackHistory</span> to
                  <span class="keyword parmname">true</span>, the
                  <span class="keyword parmname">enableHistory</span> field on the associated
                  standard or custom object must also be
                  <span class="keyword parmname">true</span>.
                </p>
                <p class="p">Field history tracking isn’t
                  available for external objects.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="tracktrending_name"><a name="tracktrending_name"><!-- --></a>trackTrending</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="field_track_trending_desc"><a name="field_track_trending_desc"><!-- --></a>Indicates whether historical
                  trending data is captured for the field (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</span>
                <span class="ph" id="field_tracktrending_desc2"><a name="field_tracktrending_desc2"><!-- --></a>An object is enabled for
                  historical trending if this attribute is <samp class="codeph java">true</samp> for at least one field.</span>
                This field is available in API version 29.0 and later.<p class="p">For more
                  information, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=analytics.reports_historical_trending.htm&amp;type=5&amp;language=en_US" target="_blank">Report on
                    Historical Changes</a>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">trueValueIndexed</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">Relevant only for a checkbox field. If set, <samp class="codeph nolang">true</samp> values are built into the
                index. This field is available only in API version 14.0 and
                earlier.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="type_name"><a name="type_name"><!-- --></a>type</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">FieldType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e288" data-title="Description">Type of field. Optional for standard fields on standard objects.
                This field is included for some standard field types, such as
                picklist or lookup, but not for others. The
                <span class="keyword parmname">type</span> field is included for custom
                fields.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname">unique</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">Indicates whether the field is unique (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="valueSet_name"><a name="valueSet_name"><!-- --></a>valueSet</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">ValueSet</td>

              <td class="entry" headers="d50443e288" data-title="Description">Set of values that make up a picklist on a custom field. Each
                value is defined as a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customvalue.htm" title="Represents the definition of a value used in a global value set or local custom picklist. Custom picklist fields can be local and unique, or can inherit their values from a global picklist (called a global value set in API version 38.0). This type extends the Metadata metadata type and inherits its fullName field.">CustomValue</a>. If this custom field is a picklist that
                uses a global value set, <span class="keyword parmname">valueSet</span> is the name
                of the global value set whose values this picklist inherits. A
                custom picklist that uses a global value set is restricted. You can
                only add or remove values by editing the global value set. <p class="p">A
                  ValueSet component has either a
                  <span class="keyword parmname">valueSetDefinition</span> or a
                  <span class="keyword parmname">valueName</span> specified, but never
                  both.
                </p>
                <p class="p">This field is available in API version 38.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="visiblelines_name"><a name="visiblelines_name"><!-- --></a>visibleLines</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">int</td>

              <td class="entry" headers="d50443e288" data-title="Description"><span class="ph" id="visiblelines_desc"><a name="visiblelines_desc"><!-- --></a>Number of lines shown for the
                  field.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e282" data-title="Field Name"><span class="keyword parmname" id="writerequiresmasterread_name"><a name="writerequiresmasterread_name"><!-- --></a>writeRequiresMasterRead</span></td>

              <td class="entry" headers="d50443e285" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e288" data-title="Description">
                <span class="ph" id="write_req_mast_read_desc1"><a name="write_req_mast_read_desc1"><!-- --></a>Minimum sharing access level
                  required on the primary record to create, edit, or delete child
                  records. This field applies only to master-detail or junction
                  object custom field types.</span><a name="write_req_mast_read_desc2"><!-- --></a>
                <ul class="ul bulletList" id="write_req_mast_read_desc2">
                  <li class="li">
                    <samp class="codeph java">true</samp>—Allows users with
                    Read access to the primary record permission to create,
                    edit, or delete child records. This setting makes sharing
                    less restrictive.
                  </li>

                  <li class="li">
                    <samp class="codeph java">false</samp>—Allows users with
                    Read/Write access to the primary record permission to
                    create, edit, or delete child records. This setting is more
                    restrictive than <samp class="codeph java">true</samp>,
                    and is the default value.
                  </li>

                </ul>
                <p class="p" id="write_req_mast_read_desc3"><a name="write_req_mast_read_desc3"><!-- --></a>For junction objects, the
                  most restrictive access from the two parents is enforced. For
                  example, if you set to <samp class="codeph java">true</samp>
                  on both master-detail fields, but users have Read access to one
                  primary record and Read/Write access to the other primary
                  record, users aren't able to create, edit, or delete child
                  records.</p>
              </td>

            </tr>

          </tbody>

        </table>

Fields use additional data types. For more information, see [Metadata Field Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm "These field types extend the field types described in the Salesforce Object Reference.").

## MktDataModelFieldAttributes

Represents the Data 360 data model field attributes for a custom field. This type is a subtype of CustomField.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d50443e1769">Field Name</th>

              <th class="featureTableHeader  " id="d50443e1772">Field Type</th>

              <th class="featureTableHeader  " id="d50443e1775">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d50443e1769" data-title="Field Name"><span class="keyword parmname">definitionCreationType</span></td>

              <td class="entry" headers="d50443e1772" data-title="Field Type">DefinitionCreationType <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a>
              </td>

              <td class="entry" headers="d50443e1775" data-title="Description">How the object was added. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Bridge</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom</samp></li>

                  <li class="li"><samp class="codeph nolang">Derived</samp></li>

                  <li class="li"><samp class="codeph nolang">Standard</samp></li>

                  <li class="li"><samp class="codeph nolang">System</samp></li>

                </ul>
                <p class="p">In API version 62.0 and later, additional valid values are:
                </p>
                <a name="ul_wgp_dzd_t2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_wgp_dzd_t2c">
                  <li class="li">
                    <samp class="codeph nolang">Activation_Audience</samp>
                  </li>

                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">ADG</samp></li>

                  <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                  <li class="li"><samp class="codeph nolang">CG_Audience</samp></li>

                  <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                  <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                  <li class="li"><samp class="codeph nolang">External</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Segment_Membership</samp></li>

                  <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                  <li class="li"><samp class="codeph nolang">Transform</samp></li>

                  <li class="li"><samp class="codeph nolang">Vector_Embedding</samp></li>

                </ul>
                <p class="p">In API version 67.0 and later, additional valid values are:
                </p>
                <a name="ul_ypj_l4f_sjc_cf"><!-- --></a>
                <ul class="ul bulletList" id="ul_ypj_l4f_sjc_cf">
                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                  <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                  <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e1769" data-title="Field Name"><span class="keyword parmname">invalidMergeActionType</span></td>

              <td class="entry" headers="d50443e1772" data-title="Field Type">InvalidMergeActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e1775" data-title="Description">Action to take when an invalid merge occurs for a field used to
                merge data. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Drop</samp></li>

                  <li class="li"><samp class="codeph nolang">Keep</samp></li>

                  <li class="li"><samp class="codeph nolang">Override</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e1769" data-title="Field Name"><span class="keyword parmname">isDynamicLookup</span></td>

              <td class="entry" headers="d50443e1772" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e1775" data-title="Description">Indicates whether existing data is queried for the field’s unique
                values (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e1769" data-title="Field Name"><span class="keyword parmname">labelOverride</span></td>

              <td class="entry" headers="d50443e1772" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e1775" data-title="Description">Custom label that overrides the field’s default display label in
                the data model. If unspecified, the default label is used. Maximum
                length is 255 characters. This field is available in API version
                65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e1769" data-title="Field Name"><span class="keyword parmname">mappingAlertType</span></td>

              <td class="entry" headers="d50443e1772" data-title="Field Type">MappingAlertType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e1775" data-title="Description">
                <p dir="ltr" class="p">Type of alert shown when this field isn't mapped in the
                  data model. This field is available in API version 65.0 and
                  later. Valid values are:</p>

                <a name="ul_cyb_rbk_lkc"><!-- --></a>
                <ul class="ul bulletList" id="ul_cyb_rbk_lkc">
                  <li class="li">
                    <samp class="codeph nolang">None</samp>—No alert is shown when the mapping is
                    incomplete or invalid.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Warning</samp>—A non-blocking warning is shown
                    when the field mapping is incomplete or invalid.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Error</samp>—A blocking error prevents saving when
                    the mapping is invalid.
                  </li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e1769" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d50443e1772" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e1775" data-title="Description">Master label for the field. Maximum length is 40 characters. This
                field is available in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e1769" data-title="Field Name"><span class="keyword parmname">primaryIndexOrder</span></td>

              <td class="entry" headers="d50443e1772" data-title="Field Type">int</td>

              <td class="entry" headers="d50443e1775" data-title="Description">Position of the field in the primary key, starting at
                <samp class="codeph nolang">1</samp>. If specified, the field is part of the
                primary key. For a compound primary key, the value specifies the
                field’s position in the key.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e1769" data-title="Field Name"><span class="keyword parmname">refAttrDeveloperName</span></td>

              <td class="entry" headers="d50443e1772" data-title="Field Type">string</td>


              <td class="entry" headers="d50443e1775" data-title="Description">Developer name of the field in the reference model. Applies only
                to standard fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e1769" data-title="Field Name"><span class="keyword parmname">mktDatalakeSrcKeyQualifier</span></td>

              <td class="entry" headers="d50443e1772" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e1775" data-title="Description">Developer name of the MktDataLakeSrcKeyQualifier configured in
                the field.</td>

            </tr>

          </tbody>

        </table>

## MktDataLakeFieldAttributes

Represents the Data 360 data lake field attributes for a custom field. This type is a subtype of CustomField. Available in API version 50.0 or later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d50443e2087">Field Name</th>

              <th class="featureTableHeader  " id="d50443e2090">Field Type</th>

              <th class="featureTableHeader  " id="d50443e2093">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d50443e2087" data-title="Field Name"><span class="keyword parmname">definitionCreationType</span></td>

              <td class="entry" headers="d50443e2090" data-title="Field Type">DefinitionCreationType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e2093" data-title="Description">How the object was added. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Bridge</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom</samp></li>

                  <li class="li"><samp class="codeph nolang">Derived</samp></li>

                  <li class="li"><samp class="codeph nolang">Standard</samp></li>

                  <li class="li"><samp class="codeph nolang">System</samp></li>

                </ul>
                <p class="p">In API version 62.0 and later, additional valid values are:
                </p>
                <a name="ul_pvy_lzd_t2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_pvy_lzd_t2c">
                  <li class="li"><samp class="codeph nolang">ADG</samp></li>

                  <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                  <li class="li"><samp class="codeph nolang">CG_Audience</samp></li>

                  <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                  <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                  <li class="li"><samp class="codeph nolang">External</samp></li>

                  <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                  <li class="li"><samp class="codeph nolang">Vector_Embedding</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2087" data-title="Field Name"><span class="keyword parmname">dateFormat</span></td>

              <td class="entry" headers="d50443e2090" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e2093" data-title="Description">Optional date format of date and time fields. This field is
                available only in API version 55.0 and earlier.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2087" data-title="Field Name"><span class="keyword parmname">externalName</span></td>

              <td class="entry" headers="d50443e2090" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e2093" data-title="Description">External name of this field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2087" data-title="Field Name"><span class="keyword parmname">isEventDate</span></td>

              <td class="entry" headers="d50443e2090" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e2093" data-title="Description">Indicates whether this field contains the event date for
                behavioral model area objects that are used to partition data
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2087" data-title="Field Name"><span class="keyword parmname">primaryIndexOrder</span></td>

              <td class="entry" headers="d50443e2090" data-title="Field Type">int</td>

              <td class="entry" headers="d50443e2093" data-title="Description">Position of the field in the primary key, starting at
                <samp class="codeph nolang">1</samp>. If specified, the field is part of the
                primary key. For a compound primary key, the value specifies the
                field’s position in the key.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2087" data-title="Field Name"><span class="keyword parmname">isInternalOrganization</span></td>

              <td class="entry" headers="d50443e2090" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e2093" data-title="Description">Indicates whether this field contains the value for internal
                organization (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). The value of the
                field is the name of the internal organization. Landing objects
                don't have access to the Salesforce ID and use the developer name
                instead.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2087" data-title="Field Name"><span class="keyword parmname">isRecordModified</span></td>

              <td class="entry" headers="d50443e2090" data-title="Field Type">boolean</td>

              <td class="entry" headers="d50443e2093" data-title="Description">Indicates whether the field is the record modified field used to
                calibrate latest record version (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2087" data-title="Field Name"><span class="keyword parmname">mktDatalakeSrcKeyQualifier</span></td>

              <td class="entry" headers="d50443e2090" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e2093" data-title="Description">Developer name of the MktDataLakeSrcKeyQualifier configured in
                the field. This field is available in API version 55.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2087" data-title="Field Name"><span class="keyword parmname">keyQualifierName</span></td>

              <td class="entry" headers="d50443e2090" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e2093" data-title="Description">Developer name of key qualifier field. This field is available in
                API version 55.0 and later.</td>

            </tr>

          </tbody>

        </table>

## LookupFilter

Represents the metadata associated with a lookup filter. Replaces the NamedFilter component, which was removed as of API version 30.0. LookupFilter is available in API version 30.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| active | boolean | Required. Indicates whether the lookup filter is active (true) or not (false). |
| booleanFilter | string | Advanced filter conditions. |
| description | string | Description of what this filter does. |
| errorMessage | string | Error message that appears if the lookup filter fails. |
| filterItems | [FilterItem\[\]](#filteritem) | Required. Set of filter conditions. You can have up to 10 FilterItems per lookup filter. |
| infoMessage | string | Information message displayed on the page. Use this field describe things the user possibly doesn't understand, such as why certain items are excluded in the lookup filter. |
| isOptional | boolean | Required. Indicates whether the lookup filter is optional (true) or not (false). |

Lookup filters use additional data types. For more information, see [Metadata Field Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm "These field types extend the field types described in the Salesforce Object Reference.").

## FilterItem

Represents one entry in a set of filter criteria.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d50443e2491">Field</th>

              <th class="featureTableHeader  " id="d50443e2494">Field Type</th>

              <th class="featureTableHeader  " id="d50443e2497">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d50443e2491" data-title="Field"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d50443e2494" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e2497" data-title="Description">Name of the field specified in the filter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2491" data-title="Field"><span class="keyword parmname">operation</span></td>

              <td class="entry" headers="d50443e2494" data-title="Field Type">FilterOperation (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d50443e2497" data-title="Description">
                <span class="ph" id="field_operation_desc"><a name="field_operation_desc"><!-- --></a>Filter operation for this filter
                  item. Valid values are:</span><a name="filteroperation_enum"><!-- --></a>
                <ul class="ul bulletList" id="filteroperation_enum">
                  <li class="li"><samp class="codeph soql">equals</samp></li>

                  <li class="li"><samp class="codeph soql">notEqual</samp></li>

                  <li class="li"><samp class="codeph soql">lessThan</samp></li>

                  <li class="li"><samp class="codeph soql">greaterThan</samp></li>

                  <li class="li"><samp class="codeph soql">lessOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">greaterOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">contains</samp></li>

                  <li class="li"><samp class="codeph soql">notContain</samp></li>

                  <li class="li"><samp class="codeph soql">startsWith</samp></li>

                  <li class="li"><samp class="codeph soql">includes</samp></li>

                  <li class="li"><samp class="codeph soql">excludes</samp></li>

                  <li class="li">
                    <samp class="codeph soql">within</samp> (<samp class="codeph nolang">DISTANCE</samp> criteria
                    only)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2491" data-title="Field"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d50443e2494" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e2497" data-title="Description">Value of the filter item being operated on, for example, if the
                filter is <samp class="codeph nolang">my_number_field__c &gt;
                  1</samp>, the value of <samp class="codeph nolang">value</samp> is <samp class="codeph nolang">1</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d50443e2491" data-title="Field"><span class="keyword parmname" id="valueField_name"><a name="valueField_name"><!-- --></a>valueField</span></td>

              <td class="entry" headers="d50443e2494" data-title="Field Type">string</td>

              <td class="entry" headers="d50443e2497" data-title="Description">Final column in the filter contains a field or a field value.
                Approval processes don’t support <span class="keyword parmname">valueField</span>
                entries in filter criteria.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following example shows a field definition for a custom field that’s named Comments\_\_c.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
....
<fields\>
        <fullName\>Comments\_\_c</fullName\>
        <description\>Add your comments about this object here</description\>
        <inlineHelpText\>This field contains help text for this object</inlineHelpText\>
        <label\>Comments</label\>
        <length\>32000</length\>
        <type\>LongTextArea</type\>
        <visibleLines\>30</visibleLines\>
</fields\>
....
</CustomObject\>

This XML is the definition for two fields on the Account standard object—a custom field (MyCustomAccountField\_\_c), and a standard field (Phone) that has history tracking enabled.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <fields\>
        <fullName\>MyCustomAccountField\_\_c</fullName\>
        <description\>A custom field on the Account standard object.</description\>
        <externalId\>false</externalId\>
        <inlineHelpText\>Some help text.</inlineHelpText\>
        <label\>MyCustomAccountField</label\>
        <length\>100</length\>
        <required\>false</required\>
        <trackFeedHistory\>false</trackFeedHistory\>
        <trackHistory\>false</trackHistory\>
        <type\>Text</type\>
        <unique\>false</unique\>
    </fields\>
    <fields\>
        <fullName\>Phone</fullName\>
        <trackFeedHistory\>false</trackFeedHistory\>
        <trackHistory\>true</trackHistory\>
    </fields\>
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_compactlayout.htm "CompactLayout")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fieldset.htm "FieldSet")

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")
- [Picklist (Including Dependent Picklist)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm "Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.")
- [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.")
- [NamedFilter](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/namedfilter.htm "Represents the metadata associated with a lookup filter. This metadata type is used to create, update, or delete lookup filter definitions. This component has been removed as of API version 30.0 and is only available in previous API versions. The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField component.")

<!-- document id=83518f6c42ec8e3e9c033c12d6ee2c9f4f4907dc4b6cdbc30007351aa2f84205 url=/legacydeveloper/current/en-us/api_meta/meta_customfielddisplay.md -->

# CustomFieldDisplay

Represents the view type assigned to product attribute custom fields. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

CustomFieldDisplay components have the suffix .customFieldDisplay.

## Version

CustomFieldDisplay components are available in API version 63.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d311430e89">Field Name</th>

              <th class="featureTableHeader  " id="d311430e92">Field Type</th>

              <th class="featureTableHeader  " id="d311430e95">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d311430e89" data-title="Field Name">
                <span class="keyword parmname">displayType</span>
              </td>

              <td class="entry" headers="d311430e92" data-title="Field Type">CustomFieldDisplayType​ (enumeration of type string)</td>

              <td class="entry" headers="d311430e95" data-title="Description">
                <p class="p">Required. The view type of the product attribute custom fields. Values are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ColorSwatch</samp>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Dropdown</samp>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Pill</samp>
                  </li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d311430e89" data-title="Field Name">
                <span class="keyword parmname">fieldApiName</span>
              </td>

              <td class="entry" headers="d311430e92" data-title="Field Type">string</td>

              <td class="entry" headers="d311430e95" data-title="Description">Required. The unique name of the product attribute, for example,
                color_c.</td>

            </tr>

            <tr>
              <td class="entry" headers="d311430e89" data-title="Field Name">
                <span class="keyword parmname">isProtected</span>
              </td>

              <td class="entry" headers="d311430e92" data-title="Field Type">boolean</td>

              <td class="entry" headers="d311430e95" data-title="Description">Optional. An auto-generated value that doesn’t
                impact the behavior of the metadata
                type. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d311430e89" data-title="Field Name">
                <span class="keyword parmname">masterLabel</span>
              </td>

              <td class="entry" headers="d311430e92" data-title="Field Type">string</td>

              <td class="entry" headers="d311430e95" data-title="Description">Required. The primary label for this object.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a CustomFieldDisplay component.

<?xml version="1.0" encoding="UTF-8"?>
<CustomFieldDisplay xmlns="http://soap.sforce.com/2006/04/metadata">
	<masterLabel\>cfd1</masterLabel\>
	<fieldApiName\>Color\_\_c</fieldApiName\>
	<displayType\>Pill</displayType\>
	<isProtected\>false</isProtected\>
</CustomFieldDisplay\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
	<members\>\*</members\>
	<name\>CustomFieldDisplay</name\>
	</types\>
	<version\>63.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=7784d4e731f57cc937eef808db8230cdf48be946f5f2f9dbfefe28c78c700451 url=/legacydeveloper/current/en-us/api_meta/meta_customhelpmenusection.md -->

# CustomHelpMenuSection

Represents the section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources for the org. The custom section contains help resources added by the admin. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

CustomHelpMenuSection components have the suffix .customHelpMenuSection and are stored in the customHelpMenuSections folder.

## Version

CustomHelpMenuSection components are available in API version 45.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| customHelpMenuItems | CustomHelpMenuItems\[\] | Items included in the custom section. Specify up to 15 items. |
| masterLabel | string | Required. Name of the custom section. Only one custom section can be added to the Lightning Experience help menu. Specify up to 80 characters. |

## CustomHelpMenuItems

Items included in the custom section. Specify up to 15 items.

| Field Name | Field Type | Description |
| --- | --- | --- |
| linkURL | string | Required. The URL for the resource. |
| masterLabel | string | Required. The name of the resource. Specify up to 100 characters. |
| sortOrder | int | Required. The order of the item within the custom section. Valid values are 1 through 15. |

## Declarative Metadata Sample Definition

The following is an example of a CustomHelpMenuSection component.

<?xml version="1.0" encoding="UTF-8"?>
<CustomHelpMenuSection xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>MyOrgCustomHelp</masterLabel\>
    <customHelpMenuItems\>
        <linkUrl\>https://www.yourcompanyhelp.com/gettingstarted</linkUrl\>
        <masterLabel\>Getting Started</masterLabel\>
        <sortOrder\>1</sortOrder\>
    </customHelpMenuItems\>
    <customHelpMenuItems\>
        <linkUrl\>https://www.yourcompanyhelp.com/features</linkUrl\>
        <masterLabel\>Feature to Start Using Right Away</masterLabel\>
        <sortOrder\>2</sortOrder\>
    </customHelpMenuItems\>
    <customHelpMenuItems\>
        <linkUrl\>https://www.yourcompanyhelp.com/salestips</linkUrl\>
        <masterLabel\>Tips for Sales Team Members</masterLabel\>
        <sortOrder\>3</sortOrder\>
    </customHelpMenuItems\>
</CustomHelpMenuSection\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyOrgCustomHelp</members\>
        <name\>CustomHelpMenuSection</name\>
    </types\>
    <version\>45.0</version\>
</Package\>

<!-- document id=9879a897beed770309fdc02342ce658db0430e32d51921e933f8ab415d725d02 url=/legacydeveloper/current/en-us/api_meta/meta_customindex.md -->

# CustomIndex

Represents an index used to increase the speed of queries.This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

CustomIndex components have the suffix .indx-meta and are stored in the customindexfolder.

## Version

CustomIndex is available in API versions 50.0 and later.

## Special Access Rules

To use this metadata and create a custom index, review [Indexes](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_large_data_volumes_bp.meta/salesforce_large_data_volumes_bp/ldv_deployments_infrastructure_indexes.htm) in Best Practices for Deployments with Large Data Volumes, and then contact Salesforce Customer Support.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| allowNullValues | boolean | Indicates whether null values are allowed in the index (true) or not (false). The default value is false. |
| booleanIndexedValue | boolean | Indicates whether boolean fields are indexed (true) or not (false). Available in API version 61.0 and later. |

## Declarative Metadata Sample Definition

The following is an example of a CustomIndex component.

<?xml version="1.0" encoding="UTF-8" ?>
<CustomIndex xmlns="http://soap.sforce.com/2006/04/metadata">
    <allowNullValues\>false</allowNullValues\>
    <booleanIndexedValue\>true</booleanIndexedValue\>
</CustomIndex\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=8a79af371de017612f82a8ef53d53e7f0234881eb20d1d15807fde5f6a0eebf0 url=/legacydeveloper/current/en-us/api_meta/meta_customlabels.md -->

# CustomLabels

The CustomLabels metadata type allows you to create custom labels that can be localized for use in different languages, countries, and currencies.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. Custom labels are custom text values, up to 1,000 characters in length that can be accessed from Apex classes or Visualforce pages. For more information, see “Custom Labels” in Salesforce Help.

## Declarative Metadata File Suffix and Directory Location

Master custom label values are stored in the CustomLabels.labels file. Translations for custom labels can be retrieved through [Translations](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm "Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.") in Metadata API. Translations are stored in files under the translations folder with the name format of localeCode.translation, where localeCode is the locale code of the translation language. The supported locale codes are listed in [Language](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm#translation_languages).

## Version

CustomLabels components are available in API version 14.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d312843e122">Field</th>

              <th class="featureTableHeader  " id="d312843e125">Field Type</th>

              <th class="featureTableHeader  " id="d312843e128">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d312843e122" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d312843e125" data-title="Field Type">string</td>

              <td class="entry" headers="d312843e128" data-title="Description">Required. The name of the custom label bundle. <p class="p">Inherited from
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for this
                  metadata type. It must be specified when creating, updating, or
                  deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a> to see an example of
                  this field specified for a call.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d312843e122" data-title="Field"><span class="keyword parmname">labels</span></td>

              <td class="entry" headers="d312843e125" data-title="Field Type">CustomLabel[]</td>

              <td class="entry" headers="d312843e128" data-title="Description">A list of custom labels.</td>

            </tr>

          </tbody>

        </table>

## CustomLabel

This metadata type represents a custom label. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d312843e217">Field</th>

              <th class="featureTableHeader  " id="d312843e220">Field Type</th>

              <th class="featureTableHeader  " id="d312843e223">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d312843e217" data-title="Field"><span class="keyword parmname">categories</span></td>

              <td class="entry" headers="d312843e220" data-title="Field Type">string</td>

              <td class="entry" headers="d312843e223" data-title="Description">A comma-separated list of categories for the label. This field
                can be used in filter criteria when creating custom label list
                views. Maximum of 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d312843e217" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d312843e220" data-title="Field Type">string</td>

              <td class="entry" headers="d312843e223" data-title="Description">Required. The name of the custom label.<p class="p">Inherited from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>,
                  this field is defined in the WSDL for this metadata type. It
                  must be specified when creating, updating, or deleting. See
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a> to
                  see an example of this field specified for a call.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d312843e217" data-title="Field"><span class="keyword parmname">language</span></td>

              <td class="entry" headers="d312843e220" data-title="Field Type">string</td>

              <td class="entry" headers="d312843e223" data-title="Description">Required. The language of the translated custom label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d312843e217" data-title="Field"><span class="keyword parmname">protected</span></td>

              <td class="entry" headers="d312843e220" data-title="Field Type">boolean</td>

              <td class="entry" headers="d312843e223" data-title="Description">Required. Indicates whether this component is protected (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Protected components can’t be
                linked to or referenced by components created in the installing
                organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d312843e217" data-title="Field"><span class="keyword parmname">shortDescription</span></td>

              <td class="entry" headers="d312843e220" data-title="Field Type">string</td>

              <td class="entry" headers="d312843e223" data-title="Description">Required. An easily recognizable term to identify this custom
                label. This description is used in merge fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d312843e217" data-title="Field"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d312843e220" data-title="Field Type">string</td>

              <td class="entry" headers="d312843e223" data-title="Description">Required. The translated custom label. Maximum of 1000
                characters.</td>

            </tr>

          </tbody>

        </table>

## Usage

Use CustomLabels with the wildcard character (\*) for members in the package.xml manifest file to retrieve all custom labels that are defined in your organization. CustomLabels doesn’t support retrieving one or more custom labels by name. To retrieve specific labels by name, use CustomLabel and specify the label names as members.

## Declarative Metadata Sample Definition

This is a sample XML definition of a custom label component.

<?xml version="1.0" encoding="UTF-8"?>
<CustomLabels xmlns="http://soap.sforce.com/2006/04/metadata">
    <labels\>
        <fullName\>quoteManual</fullName\>
        <value\>This is a manual quote.</value\>
        <language\>en\_US</language\>
        <protected\>false</protected\>
        <shortDescription\>Manual Quote</shortDescription\>
    </labels\>
    <labels\>
        <fullName\>quoteAuto</fullName\>
        <value\>This is an automatically generated quote.</value\>
        <language\>en\_US</language\>
        <protected\>false</protected\>
        <shortDescription\>Automatic Quote</shortDescription\>
    </labels\>
</CustomLabels\>

This is a sample manifest file for retrieving all custom labels in the organization by using the CustomLabels type.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>MyPkg</fullName\>
    <types\>
      <members\>\*</members\>
      <name\>CustomLabels</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

This is a sample manifest file for retrieving two custom labels by name. Notice it uses the CustomLabel singular type.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>MyPkg</fullName\>
    <types\>
      <members\>quoteManual</members\>
      <members\>quoteAuto</members\>
      <name\>CustomLabel</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

## CustomLabels Limitation

Before you use the CustomLabels metadata type, understand the limitations of this feature. You can’t retrieve the CustomLabels metadata type with a namespace.

#### See Also

- [Translations](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm "Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.")

<!-- document id=9c5c7969e771248adaff8d2507fe071a089b37ffb2d10cc25475e0a259428461 url=/legacydeveloper/current/en-us/api_meta/meta_custommetadata.md -->

# CustomMetadata

Represents a record of a custom metadata type.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CustomMetadata components have the suffix .md and are stored in the customMetadata folder. Unlike custom metadata types, custom metadata records don’t have a double-underscore suffix. Custom metadata record names are prepended with their custom metadata type name, excluding the \_\_mdt suffix but including the namespace of any types in an installed managed package.

## Version

CustomMetadata components are available in API version 31.0 and later.

## Special Access Rules

To create custom metadata records, you must have the “Customize Application” permission.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d313857e110">Field Name</th>

              <th class="featureTableHeader  " id="d313857e113">Field Type</th>

              <th class="featureTableHeader  " id="d313857e116">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d313857e110" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d313857e113" data-title="Field Type">string</td>

              <td class="entry" headers="d313857e116" data-title="Description">A description of the custom metadata record. This field can contain a maximum
                of 1,000 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d313857e110" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d313857e113" data-title="Field Type">string</td>

              <td class="entry" headers="d313857e116" data-title="Description">A label that represents the object throughout the Salesforce Setup user
                interface. Custom metadata records are currently visible only through the packaging
                user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d313857e110" data-title="Field Name"><span class="keyword parmname">protected</span></td>

              <td class="entry" headers="d313857e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d313857e116" data-title="Description">
                <div class="p">Boolean. Indicates whether the record is protected (true) or not (false). When a
                  custom metadata type is released in a managed package, access is limited in
                  specific ways.<ul class="ul bulletList">
                    <li class="li">Code that’s in the same managed package as custom metadata records can read
                      the records.</li>

                    <li class="li">Code that’s in the same managed package as custom metadata types can read
                      the records that belong to that type.</li>

                    <li class="li">Code that’s in a managed package that doesn’t contain either the type or the
                      protected record can’t read the protected records.</li>

                    <li class="li">Code that the subscriber creates and code that’s in an unmanaged package
                      can’t read the protected records.</li>

                    <li class="li">The developer can modify protected records with a package upgrade or by
                      using the Metadata Apex classes (if the Apex code is in the same namespace as
                      either the records or their type). The subscriber can’t read or modify
                      protected records. The developer name of a protected record can’t be changed
                      after release.</li>

                    <li class="li">The subscriber can’t create records of a protected type.</li>

                  </ul>
                  Records that are hidden by these access rules are also unavailable to REST,
                  SOAP, SOQL, and Setup.</div>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313857e110" data-title="Field Name"><span class="keyword parmname">values</span></td>

              <td class="entry" headers="d313857e113" data-title="Field Type">
                <a class="xref" href="#CustomMetadataValues_title">CustomMetadataValue</a>[]
              </td>

              <td class="entry" headers="d313857e116" data-title="Description">Represents one or more values for custom fields on the custom metadata
                record.</td>

            </tr>

          </tbody>

        </table>

## CustomMetadataValue

Represents a value for a custom field on the custom metadata record.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Required. The non-object-qualified name of a custom field in the custom metadata type. This value corresponds to the name of a field on the custom metadata record’s custom metadata type. Include the namespace (if the type is from a managed package) and the \_\_c suffix. The name of the custom metadata type isn’t required. For example, picklist1234\_\_AlphaSort\_\_c. |
| value | Any type | The value on a custom metadata record. Where fields are EntityDefinition and FieldDefinition, the qualified API names of the entity and the field it points to. This value can be null. |

## Declarative Metadata Sample Definitions

The following is an example of a CustomMetadata component. In this example, the sample app TravelApp deploys a Planets picklist, specifies its sort order, and adds picklist items to it.

Assuming Picklists R Us’s namespace is picklist1234, to define the Planets picklist, TravelApp deploys a file in the customMetadata folder, named picklist1234\_\_ReusablePicklist.Planets.md, with these contents. The xsi:type attribute specifies the type for the value of the AlphaSort\_\_c checkbox field.

<?xml version="1.0" encoding="UTF-8"?>
<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata" 
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <description\>All the planets in the solar system. Does not 
                 include asteroids.</description\>
    <label\>Planets</label\>
    <values\>
        <field\>picklist1234\_\_AlphaSort\_\_c</field\>
        <value xsi:type="xsd:boolean">false</value\>
    </values\>
</CustomMetadata\>

Picklists R Us creates its Reusable Picklist Option custom metadata type by deploying a file in the objects folder, named ReusablePicklist\_\_mdt.object, with these contents.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <fields\>
        <fullName\>Picklist\_\_c</fullName\>
        <externalId\>false</externalId\>
        <label\>Picklist</label\>
        <length\>40</length\>
        <required\>true</required\>
        <type\>Text</type\>
        <unique\>false</unique\>
    </fields\>
    <fields\>
        <fullName\>SortOrder\_\_c</fullName\>
        <externalId\>false</externalId\>
        <label\>Non-Alphabetical Sort Order</label\>
        <precision\>3</precision\>
        <scale\>0</scale\>
        <required\>false</required\>
        <type\>Number</type\>
        <unique\>false</unique\>
    </fields\>
    <label\>Reusable Picklist Option</label\>
    <pluralLabel\>Reusable Picklist Options</pluralLabel\>
</CustomObject\>

To define the Mars picklist item, TravelApp deploys a file, named picklist1234\_\_ReusablePicklistOption.Mars.md, with these contents. This component file specifies types that apply to the ReusablePicklistOption\_\_mdt custom fields.

<?xml version="1.0" encoding="UTF-8"?>
<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <label\>Mars</label\>
    <values\>
        <field\>picklist1234\_\_Picklist\_\_c</field\>
        <value xsi:type="xsd:string">Planets</value\>
    </values\>
    <values\>
        <field\>picklist1234\_\_SortOrder\_\_c</field\>
        <value xsi:type="xsd:int">4</value\>
    </values\>
</CustomMetadata\>

To define the Motel6 picklist item, TravelApp deploys a file, named picklist1234\_\_ReusablePicklistOption.Motel6.md, with these contents.

<?xml version="1.0" encoding="UTF-8"?>
<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <label\>Motel 6</label\>
    <values\>
        <field\>picklist1234\_\_Picklist\_\_c</field\>
        <value xsi:type="xsd:string">Hotels</value\>
    </values\>
</CustomMetadata\>

Because the SortOrder\_\_c field isn’t required, this file doesn’t require a value for SortOrder\_\_c. Alternatively, the file could have explicitly specified a value with xsi:nil to ensure that SortOrder\_\_c was cleared of any previous value.

<?xml version="1.0" encoding="UTF-8"?>
<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <label\>Motel 6</label\>
    <values\>
        <field\>picklist1234\_\_Picklist\_\_c</field\>
        <value xsi:type="xsd:string">Hotels</value\>
    </values\>
    <values\>
        <field\>picklist1234\_\_SortOrder\_\_c</field\>
        <value xsi:nil="true" />
    </values\>
</CustomMetadata\>

This excerpt from a package.xml file illustrates the inclusion of custom metadata types and their namespaces in custom metadata records’ names. Assume that Picklists R Us’s namespace is picklist1234.

<?xml version="1.0" encoding="UTF-8"?>
<package xmlns="http://soap.sforce.com/2006/04/metadata">
…
   <types\>
      <members\>picklist1234\_\_ReusablePicklist.Hotels</members\>
      <members\>picklist1234\_\_ReusablePicklist.Planets</members\>
      <members\>picklist1234\_\_ReusablePicklistOption.Bellagio</members\>
      <members\>picklist1234\_\_ReusablePicklistOption.Motel6</members\>
      <members\>picklist1234\_\_ReusablePicklistOption.Mercury</members\>
      <members\>picklist1234\_\_ReusablePicklistOption.Venus</members\>
      <members\>picklist1234\_\_ReusablePicklistOption.Earth</members\>
      <members\>picklist1234\_\_PicklistUsage.BookedHotel</members\>
      <members\>
         picklist1234\_\_PicklistUsage.DestinationPlanetPL
      </members\>
      <members\>picklist1234\_\_PicklistUsage.PlanetVisitedPl</members\>
      <name\>CustomMetadata</name\>
   </types\>
… 
</package\>

TravelApp, Inc.’s package.xml file uses a wildcard to install custom metadata, as is shown in this excerpt from their package.xml file. Unless you want to deploy or retrieve specific records, using a wildcard is easier than listing all of your custom metadata records in your package.xml file.

<types\>
   <members\>\*</​members>
   <name\>Custom​Metadata</name\>
</types\>

If the custom metadata is from a managed package, the name after the dot in the package.xml file—between the two dots in the file name—is qualified by the managed package’s namespace. For example, assuming TravelApp uses the namespace travelApp1234, the first member element in the TravelApp package.xml file appears to Galactic Tours as:

<members\>picklist1234\_\_ReusablePicklist.travelApp1234\_\_Hotels</members\>

Here’s another example. In this case, we have an instance of custom metadata record, whose EntityDefinition field points to a custom object named SalesAgreement\_\_c. The FieldDefinition field points to the custom field CustomerReference\_\_c on SalesAgreement\_\_c. You can deploy new custom metadata records and retrieve existing ones with EntityDefinition and FieldDefinition fields using qualified API names of custom and standard entities and their fields.

<?xml version="1.0" encoding="UTF-8"?><values\>
<field\>EntityDefintionField\_\_c</field\>
<value xsi:type="xsd:string">v1\_\_SalesAgreement\_\_c</value\>
</values\>
<values\>
<field\>FieldDefinitionField\_\_c</field\>
<value xsi:type="xsd:string">v1\_\_CustomerReference\_\_c</value\>
</values\>

## Usage

When specifying the value field in the CustomMetadataValue subtype, specify an appropriately typed object that’s based on your field type definition. In declarative metadata definitions for CustomMetadataValue, use the xsi:type attribute of the value element. For example, to specify a boolean value: <value xsi:type="xsd:boolean">true</value\>. Valid xsi:type attributes are:

| Custom metadata value | Custom field definition |
| --- | --- |
| xsi:type="xsd:boolean" | Checkbox |
| xsi:type="xsd:date" | Date |
| xsi:type="xsd:dateTime" | Date/Time |
| xsi:type="xsd:picklist" | Picklist |
| xsi:type="xsd:string" | Text |
| xsi:type="xsd:string" | Phone |
| xsi:type="xsd:string" | TextArea |
| xsi:type="xsd:string" | URL |
| xsi:type="xsd:string" | Email |
| xsi:type="xsd:int" | Number/Percent, with scale equal to 0 |
| xsi:type="xsd:double" | Number/Percent, with scale not equal to 0 |

You can also omit the xsi:type attribute. For example, <value\>true</value\>.

Although this attribute must be specified for any CustomMetadataValue, you can use an element with the xsi:nil attribute set to true to explicitly set the field’s value to null. For example, <value xsi:nil="true"/>.

Using null field values differs from leaving out the for a particular field entirely. If you leave out the , the value of the field doesn’t change. The field’s value is null for newly deployed custom metadata records and left at its previous value for updated custom metadata records.

When you retrieve CustomMetadataValue objects, the value field of the returned object holds a value of the correct type, specified by xsi:type in the case of declarative metadata definitions.

Custom number fields are stored as double values. When you retrieve a value from a Number type field with a scale 0, you will see a decimal number. For example, if the value in UI is 1234567, a query through the API returns 1234567.0.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=88fc0949b090b5b8ecc5b240732589a959aa60e2bab3ddfed33f3c4e179e5656 url=/legacydeveloper/current/en-us/api_meta/meta_customnotificationtype.md -->

# CustomNotificationType

Represents the metadata associated with a custom notification type.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

For more information about custom notifications, see Custom Notification Actions. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Declarative Metadata File Suffix and Directory Location

The file suffix is .notiftype for the notification type definition. Notification types are stored in the notificationtypes directory of the corresponding package directory.

## Version

CustomNotificationType components are available in API version 46.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| actionGroups (Beta) | [CustomNotificationActionGroup\[\]](#CustomNotificationActionGroup) | Optional. Indicates whether mobile action groups are enabled, allowing users to take actions directly from mobile notifications. |
| customNotifTypeName | string | Required. Specifies a notification type name. Maximum number of characters: 80. |
| description | string | Specifies a general description of the notification type, which is displayed with the notification type name. Maximum number of characters: 255. |
| desktop | boolean | Required. Indicates whether the desktop delivery channel is enabled (true) or not (false). |
| masterLabel | string | Required. Specifies the label for the notification type. |
| mobile | boolean | Required. Indicates whether the mobile delivery channel is enabled (true) or not (false). |
| slack | boolean | Reserved for future use. |

## CustomNotificationActionGroup

CustomNotificationActionGroup represents the action group.

| Field Name | Description |
| --- | --- |
| actions | 
Field Type

[CustomNotificationActionDefinition\[\]](#CustomNotificationActionDefinition)

Description

Represents the actions within a mobile action group.



 |
| groupName | 

Field Type

string

Description

Required.

Unique name of the mobile action group.



 |

## CustomNotificationActionDefinition

CustomNotificationActionDefinition represents the metadata that define an actionable notification.

| Field Name | Description |
| --- | --- |
| actionLabel | 
Field Type

string

Description

Required.

The name of the action seen in the push notification.



 |
| actionName | 

Field Type

string

Description

Required.

Unique identifier of the action in an action group.



 |
| actionTarget | 

Field Type

string

Description

The name of the Apex class where the action is implemented.



 |
| actionType | 

Field Type

NotificationActionType (enumeration of type string)

Description

Type of action.

Required.

Values are:

- NotificationApiAction: Server-side action where client needs to make action API call.
- Share: Client-side action where the app shares notification content to any channel.





 |

## Declarative Metadata Sample Definition

The following is a definition of a custom notification type that is enabled for desktop and mobile.

<CustomNotificationType xmlns="http://soap.sforce.com/2006/04/metadata">
    <customNotifTypeName\>Custom Notification</customNotifTypeName\>
    <desktop\>true</desktop\>
    <masterLabel\>Custom Notification</masterLabel\>
    <mobile\>true</mobile\>
</CustomNotificationType\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=02bcd259106f6b243066003d43d555307cbfd4c5dcce9590158ecf2a6280c6e3 url=/legacydeveloper/current/en-us/api_meta/customobject.md -->

# CustomObject

Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

Specify all relevant fields when you create or update a custom object. You can’t update a single field on the object. For more information about custom objects, see [Store Information That’s Unique to Your Organization](https://help.salesforce.com/s/articleView?id=platform.dev_object_def.htm&type=5&language=en_US).

You can also use this metadata type to work with customizations of standard objects, such as accounts. For an example, see the section on Standard Objects in [Sample package.xml Manifest Files](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/manifest_samples.htm "HTML (New Window)").

All metadata components have a [fullName](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm#meta_fullname) field, which must be fully specified for any custom object.

For example, the following are fully specified names for a standard object and a custom object respectively:

Account
MyCustomObject\_\_c

And the following is a fully specified name for an external object:

MyExternalObject\_\_x

For sample Java code that creates a custom object, see [Step 3: Walk Through the Java Sample Code](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_java_sample.htm).

## Declarative Metadata File Suffix and Directory Location

Custom object names are automatically appended with \_\_c. The file suffix is .object for the custom object or standard object file.

External object names are automatically appended with \_\_x. The file suffix is .object for the external object file.

Custom, standard, and external objects are stored in the objects folder in the corresponding package directory.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet components that are retrieved in the same package.

## Version

Custom objects are available in API version 10.0 and later. External objects are available in API version 32.0 and later.

1. [ActionOverride](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm)  
    Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can access ActionOverride only by accessing its encompassing CustomObject.
2. [BusinessProcess](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_businessprocess.htm)  
    The BusinessProcess metadata type enables you to display different picklist values for users based on their profile.
3. [CompactLayout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_compactlayout.htm)  
    Represents the metadata associated with a compact layout. This type extends the Metadata metadata type and inherits its fullName field.
4. [CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm)  
    Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.
5. [FieldSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fieldset.htm)  
    Represents a field set. A field set is a grouping of fields. For example, you could have a field set that contains fields describing a user's first name, middle name, last name, and business title.
6. [HistoryRetentionPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_historyretentionpolicy.htm)  
    Represents the policy for archiving field history data. When you set a policy, you specify the number of months that you want to keep field history in Salesforce before archiving it. By default, when Field Audit Trail is enabled, all field history is retained.
7. [Index](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_index.htm)  
    Represents an index defined within a custom [big object](https://developer.salesforce.com/docs/atlas.en-us.264.0.bigobjects.meta/bigobjects/big_object.htm). Use this metadata type to define the composite primary key (index) for a custom big object. This type extends the Metadata metadata type and inherits its fullName field.
8. [ListView](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listview.htm)  
    ListView allows you to see a filtered list of records, such as contacts, accounts, or custom objects.
9. [MarketingObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_marketingobject.htm)  
    A marketing object is a high-volume, low-latency custom object that stores data for personalizing content in your marketing campaigns. A marketing object supports a subset of CustomObject fields and uses the \_\_mo suffix instead of \_\_c.
10. [NamedFilter](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/namedfilter.htm)  
    Represents the metadata associated with a lookup filter. This metadata type is used to create, update, or delete lookup filter definitions. This component has been removed as of API version 30.0 and is only available in previous API versions. The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField component.
11. [Picklist (Including Dependent Picklist)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm)  
    Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.
12. [ProfileSearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profilesearchlayouts.htm)  
    Represents a user profile’s search results layouts for an object. ProfileSearchLayouts are similar to SearchLayouts. However, with profile-specific layouts, each user profile can have a different search results layout for an object.
13. [RecordType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordtype.htm)  
    Represents the metadata associated with a record type. Record types let you offer different business processes, picklist values, and page layouts to different users. Use this metadata type to create, update, or delete record type definitions for a custom object.
14. [SearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_searchlayouts.htm)  
    Represents the metadata associated with the search layouts for an object. You can customize which fields to display for users in search results, search filter fields, lookup dialogs, and recent record lists on tab home pages. You can access SearchLayouts only by accessing its encompassing CustomObject.
15. [SharingReason](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsharingreason.htm)  
    Represents an Apex sharing reason, which is used to indicate why sharing was implemented for a standard or custom object. Apex managed sharing allows developers to use Apex to programmatically share custom objects. When you use Apex managed sharing to share an object, only users with the “Modify All Data” permission can add or change the sharing on the object's record, and the sharing access is maintained when the record owner changes or is deactivated. Sharing reasons for standard objects are available for objects that have a corresponding share object (for example, AccountShare, OpportunityShare) and whose org-wide default can be set to Private or Public Read-Only. Objects on the detail side of a master-detail relationship, which have no share object of their own, aren't supported.
16. [SharingRecalculation](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsharingrecalculation.htm)  
    Represents Apex classes that recalculate the Apex managed sharing for a specific custom object.
17. [ValidationRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_validationformulas.htm)  
    Represents a validation rule, which is used to verify that the data a user enters in a record is valid and can be saved. A validation rule contains a formula or expression that evaluates the data in one or more fields and returns a value of true or false. Validation rules also include an error message that your client application can display to the user when the rule returns a value of true due to invalid data.
18. [WebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm)  
    Represents a custom button or link defined in a custom object.
19. [Metadata Field Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm)  
    These field types extend the field types described in the _Salesforce Object Reference_.

#### See Also

- [CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm "Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.")
- [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.")
- [Picklist (Including Dependent Picklist)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm "Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.")
- [SearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_searchlayouts.htm "Represents the metadata associated with the search layouts for an object. You can customize which fields to display for users in search results, search filter fields, lookup dialogs, and recent record lists on tab home pages. You can access SearchLayouts only by accessing its encompassing CustomObject.")
- [WebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm "Represents a custom button or link defined in a custom object.")
- [CustomObjectTranslation](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customobjecttranslation.htm "This metadata type allows you to translate custom objects for a variety of languages.")
- [ListView](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listview.htm "ListView allows you to see a filtered list of records, such as contacts, accounts, or custom objects.")
- [CompactLayout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_compactlayout.htm "Represents the metadata associated with a compact layout. This type extends the Metadata metadata type and inherits its fullName field.")

## Fields

Unless otherwise noted, all fields are creatable, filterable, and nillable.

### actionOverrides

- **Field Type**: [ActionOverride](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/actionoverride.htm)\[\]
- **Description**: List of action overrides on the object. This field is available in API version 18.0 and later.

### allowInChatterGroups

- **Field Type**: boolean
- **Description**: Indicates whether records of this custom object type can be added to Chatter groups (true) or not (false). This field is available in API version 34.0 and later.

### businessProcesses

- **Field Type**: [BusinessProcess](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_businessprocess.htm)\[\]
- **Description**: List of business processes associated with the object. This field is available in API version 17.0 and later.

### compactLayoutAssignment

- **Field Type**: string
- **Description**: Compact layout assigned to the object. This field is available in API version 29.0 and later. This field is available for external objects in API version 42.0 and later.

### compactLayouts

- **Field Type**: [CompactLayout](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_compactlayout.htm)\[\]
- **Description**: List of compact layouts associated with the object. This field is available in API version 29.0 and later. This field is available for external objects in API version 42.0 and later.

### customHelp

- **Field Type**: string
- **Description**: S-control that contains the help content if the object has customized help content. This field is available in API version 14.0 and later.

### customHelpPage

- **Field Type**: string
- **Description**: Visualforce page that contains the help content if the object has customized help content. This field is available in API version 16.0 and later.

### customSettingsType

- **Field Type**: CustomSettingsType (enumeration of type string)
- **Description**: When this field is present, this component isn’t a custom object, but a custom setting. This field returns the type of custom setting. This field is available in API version 17.0 and later.
- **Possible values**:
    - List—static data stored in cache, accessed as part of your app, and available org-wide.
    - Hierarchy—static data stored in cache, accessed as part of your app, and available based on a hierarchy of user, profile, or org. This value is the default.

### customSettingsVisibility

- **Field Type**: CustomSettingsVisibility (enumeration of type string)
- **Description**: When this field is present, this component isn’t a custom object, but a custom setting. This field returns the visibility of the custom setting. This field is available in API versions 17.0 through 33.0. In versions 34.0 and later, use the visibility field instead of this field.
- **Possible values**:
    - Public—if the custom setting is packaged, it’s accessible to all subscribing orgs.
    - Protected—if the custom setting is in a managed package, it’s accessible only to the developer org. Subscribing orgs can’t access it. This value is the default.

### dataStewardGroup

- **Field Type**: string
- **Description**: Removed in API version 47.0.

### dataStewardUser

- **Field Type**: string
- **Description**: Removed in API version 47.0.

### deploymentStatus

- **Field Type**: DeploymentStatus ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: Indicates the deployment status of the object.

### deprecated

- **Field Type**: boolean
- **Description**: Reserved for future use. Indicates whether a developer deprecated a custom object in a package (true) or not (false).

### description

- **Field Type**: string
- **Description**: Description of the object. Maximum length is 1000 characters.

### enableActivities

- **Field Type**: boolean
- **Description**: Indicates whether the object is enabled for activities (true) or not (false). Not available for external objects.

### enableBulkApi

- **Field Type**: boolean
- **Description**: When enabled, the object is classified as an Enterprise Application object for usage tracking. When enabled, enableSharing and enableStreamingApi must also be enabled.
    
    This field is available in API version 31.0 and later.

### enableDivisions

- **Field Type**: boolean
- **Description**: Indicates whether the object is enabled for divisions (true) or not (false). For more information on this field, see [Division](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_division.htm).

### enableEnhancedLookup

- **Field Type**: boolean
- **Description**: Indicates whether the object is enabled for enhanced lookups (true) or not (false). The custom object must be searchable for enableEnhancedLookup to work. Set enableSearch as true before setting enableEnhancedLookup as true. In API version 28.0 and later, this field can also be used for the Account, Contact, and User objects. Enhanced lookups provide an updated lookup dialog interface that lets users filter, sort, and page through search results and customize search result columns. For more information about enhanced lookups, see [Enable Enhanced Lookups](https://help.salesforce.com/s/articleView?id=ai.search_enhanced_lookup_enable.htm&type=5&language=en_US).

### enableFeeds

- **Field Type**: boolean
- **Description**: Indicates whether the object is enabled for feed tracking (true) or not (false). For more information, see [Customize Chatter Feed Tracking](https://help.salesforce.com/s/articleView?id=experience.collab_feed_tracking.htm&type=5&language=en_US). This field is available in API version 18.0 and later.

### enableHistory

- **Field Type**: boolean
- **Description**: Indicates whether the object is enabled for history tracking (true) or not (false). Also available for standard objects in API version 29.0 and later. History tracking on the Account object includes person account history tracking.

### enableLicensing

- **Field Type**: boolean
- **Description**: Indicates whether this object is licensed by Salesforce and users require a permission set license for it (true) or not (false). This field is available in API version 45.0 and later.

### enableReports

- **Field Type**: boolean
- **Description**: Indicates whether the object is enabled for reports (true) or not (false). Support for external objects is available in API version 38.0 and later.

### enableSearch

- **Field Type**: boolean
- **Description**: Indicates whether the object’s records can be found via Salesforce Object Search Language and Salesforce searches (true) or not (false). Corresponds to Allow Search in the user interface. By default, search is turned off for new custom objects. This field is available for custom objects in API version 35.0 and later.
    
    To enhance Einstein Search performance, searchability is turned off for custom objects that haven't been searched for more than 120 days. To enable object and field searchability, contact your admin.
    
    By default, search is turned off for new external objects. However, you can validate and sync an external data source to automatically create external objects. Syncing always enables search on the external object when search is enabled on the external data source, and vice versa. This field is available for external objects in API version 37.0 and later.

### enableSharing

- **Field Type**: boolean
- **Description**: Indicates whether the object is classified as an Enterprise Application object for usage tracking (true) or not (false). When enabled, enableBulkApi and enableStreamingApi must also be enabled.
    
    This field is available in API version 31.0 and later.

### enableStreamingApi

- **Field Type**: boolean
- **Description**: Indicates whether the object is classified as an Enterprise Application object for usage tracking (true) or not (false). When enabled, enableBulkApi and enableSharing must also be enabled.
    
    This field is available in API version 31.0 and later.

### eventType

- **Field Type**: PlatformEventType ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: This field applies only to platform events. Type of event. This field is available in API version 41.0 and later.
- **Possible values**:
    - HighVolume—For a high-volume platform event.
    - StandardVolume—Deprecated. Creating a platform event with this event type is supported and returns an error.

### externalDataSource

- **Field Type**: string
- **Description**: Required and available only for external objects. The name of the external data source that stores the data for the external object. The data source is represented by the ExternalDataSource component. This field is available in API version 32.0 and later.

### externalName

- **Field Type**: string
- **Description**: Required and available only for external objects. The name of the table in the external data source that contains the data for the external object. This field is available in API version 32.0 and later.

### externalRepository

- **Field Type**: string
- **Description**: Available only for Salesforce Connect external objects. Corresponds to the Display URL Reference Field in the user interface. The external object’s Display URL standard field values are automatically generated from the external system. For example, with the OData 2.0 adapter for Salesforce Connect, the value is based on the link href that’s defined on the OData producer. You can override the default values with the values of a custom field on the same external object. Select the field name, and ensure the custom field’s values are valid URLs.
    
    This field is available in API version 32.0 and later.

### externalSharingModel

- **Field Type**: SharingModel ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**:
    
    External org-wide defaults for the object, which determines the access level for external users.
    
    This field is available in API version 31.0 and later.

### fields

- **Field Type**: [CustomField\[\]](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/customfield.htm)
- **Description**: One or more field names in the object.

### fieldSets

- **Field Type**: [FieldSet](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_fieldset.htm)
- **Description**: Field set that exists on the object.

### fullName

- **Field Type**: string
- **Description**: Full name of the object. It must be specified when creating, updating, or deleting the object. See [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") to see an example of this field specified for a call. This value can't be null.

### gender

- **Field Type**: Gender
- **Description**: Gender of the noun that represents the object. This is used for languages where words need different treatment depending on their gender.

### household

- **Field Type**: boolean
- **Description**: Support for relationship groups, a feature available only with Salesforce for Wealth Management.

### historyRetentionPolicy

- **Field Type**: [HistoryRetentionPolicy](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_historyretentionpolicy.htm)
- **Description**: Reserved for future use.

### indexes

- **Field Type**: [Index\[\]](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_index.htm)
- **Description**: Index for a custom big object.

### label

- **Field Type**: string
- **Description**: Label that represents the object throughout the Salesforce user interface. We recommend that you make object labels unique across all standard, custom, and external objects in the org.

### listViews

- **Field Type**: [ListView](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_listview.htm)\[\]
- **Description**: One or more list views associated with the object.

### namedFilter

- **Field Type**: [NamedFilter](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/namedfilter.htm)\[\]
- **Description**: Represents the metadata associated with a lookup filter. This metadata type is used to create, update, or delete lookup filter definitions. This component has been removed as of API version 30.0 and is only available in previous API versions. The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField component. This field is available in API version 17.0 and later.
    
    This field has been removed as of API version 30.0 and is only available in prior versions. The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField component.

### nameField

- **Field Type**: [CustomField](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/customfield.htm)
- **Description**: Required for custom objects. On external objects, the name field can instead be specified by setting isNameField to true in the CustomField component. The field that this object's name is stored in. Every custom object must have a name, usually a string or auto number.
    
    Identifier for the custom object record. This name appears in page layouts, related lists, lookup dialogs, search results, and key lists on tab home pages. By default, this field is added to the custom object page layout as a required field.

### pluralLabel

- **Field Type**: string
- **Description**: Plural version of the label value. Custom objects require a plural version of the label to ensure object names are localizable.

### profileSearchLayouts

- **Field Type**: [ProfileSearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_profilesearchlayouts.htm)
- **Description**: Represents a user profile’s search results layouts for an object. With profile-specific layouts, each user profile can have a different search results layout for an object. Available in API version 47.0 and later.

### publishBehavior

- **Field Type**: PlatformEventPublishBehavior ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: This field applies only to platform events. Indicates when platform event messages are published in a Lightning Platform transaction. This field applies to event messages published through the Lightning Platform, such as Apex, Process Builder, and Flow Builder, but not through Salesforce APIs. If you don’t specify this field, the default value used is PublishImmediately.
    
    This field is available in API version 46.0 and later.
- **Possible values**:
    - PublishAfterCommit—The event message is published only after a transaction commits successfully. If the transaction fails, the event message isn't published.
    - PublishImmediately—The event message is published when the publish call executes, regardless of whether the transaction succeeds.

### recordTypes

- **Field Type**: [RecordType](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_recordtype.htm)\[\]
- **Description**: Array of one or more record types defined for this object.

### recordTypeTrackFeedHistory

- **Field Type**: boolean
- **Description**: Indicates whether the record type is enabled for feed tracking (true) or not (false). To set this field to true, the enableFeeds field on the associated CustomObject must also be true. For more information, see [Customize Chatter Feed Tracking](https://help.salesforce.com/s/articleView?id=experience.collab_feed_tracking.htm&type=5&language=en_US). This field is available in API version 19.0 and later.

### recordTypeTrackHistory

- **Field Type**: boolean
- **Description**: Indicates whether history tracking is enabled for this record type (true) or not (false). To set recordTypeTrackHistory to true, the enableHistory field on the associated custom object must also be true. This field is available in API version 19.0 and later.

### searchLayouts

- **Field Type**: [SearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_searchlayouts.htm)
- **Description**: Search Layouts related list information for the object.

### sharingModel

- **Field Type**: SharingModel([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: Indicates the org-wide defaults for the object. **Note:** In API version 29.0 and earlier, this field is read only and can’t be set using the Metadata API; you must use the Salesforce user interface. In API version 30.0 and later, you can set this field for internal users using the API and the Salesforce user interface.

### sharingReasons

- **Field Type**: [SharingReason](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_apexsharingreason.htm)\[\]
- **Description**: Reasons why the object is being shared.

### sharingRecalculations

- **Field Type**: [SharingRecalculation](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_apexsharingrecalculation.htm)\[\]
- **Description**: List of custom sharing recalculations associated with the object.

### startsWith

- **Field Type**: StartsWith ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: Indicates whether the noun starts with a vowel, consonant, or is a special character (true) or not (false). This is used for languages where words need different treatment depending on the first character. Valid values are listed in [StartsWith](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_field_types.htm#startsWith_ul).

### validationRules

- **Field Type**: [ValidationRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_validationformulas.htm)\[\]
- **Description**: Array of one or more validation rules on the object.

### visibility

- **Field Type**: SetupObjectVisibility (enumeration of type string)
- **Description**: Visibility of the custom object, custom setting, or custom metadata type.
    
    This field is available in API version 34.0 and later. For custom settings, this field replaces the customSettingsVisibility field.
- **Default value**: Public
- **Possible values**:
    - Public—If the custom object, custom setting, or custom metadata type is packaged, it’s accessible to all subscribing orgs.
    - Protected—If the custom object, custom setting, or custom metadata type is in a managed package, it’s accessible only to the developer org. Subscribing orgs can’t access it.
    - PackageProtected— (Custom metadata type only) It’s only accessible by the custom Apex code in the package. Use this value to secure secrets such as API access keys and security tokens. Available in API version 47.0 and later.

### webLinks

- **Field Type**: [WebLink](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_weblink.htm)\[\]
- **Description**: Array of one or more weblinks defined for the object.

## MktDataModelAttributes

Represents the Data 360 data model object (DMO) attributes for a custom object. This is a Data 360 subtype of CustomObject.

### creationType

- **Field Type**: DefinitionCreationType [enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title)
- **Description**: Indicates how the object was added. In API version 62.0 and later,
- **Possible values**:
    
    - Activation\_Audience
    - Ad\_Audience\_Insights
    - ADG
    - Calculated\_Insight
    - CG\_Audience
    - Chunk
    - Directory\_Table
    - External
    - Problem\_Records
    - Segment\_Membership
    - Semantic
    - Transform
    - Vector\_Embedding
    
    In API version 67.0 and later, additional valid values are:
    
    - Auxiliary
    - Clean\_Room
    - Deletion\_Records

### dataModelTaxonomy

- **Field Type**: string
- **Description**:
    
    Reference to the data model on which the object is based. For a standard Data 360 model, the value must be Reference when creationType is Standard, or View when creationType is Custom.

### description

- **Field Type**: string
- **Description**: Description of the object. Maximum length is 521 characters. This field is available in API version 55.0 and later.

### isEnabled

- **Field Type**: boolean
- **Description**: Indicates whether the DMO is enabled (true) or not (false).

### isSegmentable

- **Field Type**: boolean
- **Description**: Indicates whether you can use the DMO as a target for segmentation (true) or not (false).

### isUsedForMetrics

- **Field Type**: boolean
- **Description**: Indicates whether the DMO is used for metrics (true) or not (false). This field includes additional object attributes that aren't present in the DMO POJO. This field is available in API version 55.0 and later.

### labelOverride

- **Field Type**: string
- **Description**: Custom label that overrides the object’s default display label in the data model. If unspecified, the default label is used. Maximum length is 255 characters. This field is available in API version 66.0 and later.

### masterLabel

- **Field Type**: string
- **Description**: Master label for this component. Maximum length is 40 characters. This field is available in API version 66.0 and later.

### objectCategory

- **Field Type**: string
- **Description**: Object category used for modeling. Valid values are Engagement, Profile, and Other.

### referenceEntityGroup

- **Field Type**: string
- **Description**: Entity group of the object in the reference model. Applied to standard objects.

### referenceEntityName

- **Field Type**: string
- **Description**: Name of the object in the reference model. Applies to standard objects.

### referenceEntitySubjectArea

- **Field Type**: string
- **Description**: Subject area of the object in the reference model. Applies only to standard objects.

## MktDataLakeAttributes

Represents the Data 360 data lake object (DLO) attributes for a custom object. This is a Data 360 subtype of CustomObject. Its components are available in API version 50.0 and later.

### Special Access Rules

You need an org with a Data Cloud license to access this object.

## MktDataLakeAttributes Fields

### creationType

- **Field Type**: DefinitionCreationType [enumeration of type string](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title)
- **Description**: How this object was added.
- **Possible values**:
    
    - Activation\_Audience
    - Bridge
    - Curated
    - Custom
    - Derived
    - Ml\_Prediction
    - Segment\_Membership
    - Standard
    - System
    
    In API version 62.0 and later, additional valid values are:
    
    - Activation\_Audience
    - Ad\_Audience\_Insights
    - ADG
    - Calculated\_Insight
    - CG\_Audience
    - Chunk
    - Directory\_Table
    - External
    - Problem\_Records
    - Segment\_Membership
    - Semantic
    - Transform
    - Vector\_Embedding
    
    In API version 67.0 and later, additional valid values are:
    - Ad\_Audience\_Insights
    - Auxiliary
    - Clean\_Room
    - Deletion\_Records
    - Problem\_Records

### isEnabled

- **Field Type**: boolean
- **Description**: Indicates whether the landing object is enabled (true) or not (false).

### objectCategory

- **Field Type**: string
- **Description**: Object category used for modeling. Valid values are Behavioral, Profile, and Other.

## Declarative Metadata Additional Components

CustomObject definitions can include additional components defined in the custom object for declarative metadata. The following components are defined in the CustomObject:

- [ActionOverride](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/actionoverride.htm)
- [BusinessProcess](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_businessprocess.htm)
- [CompactLayout](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_compactlayout.htm)
- [CustomField](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/customfield.htm)
- [FieldSet](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_fieldset.htm)
- [HistoryRetentionPolicy](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_historyretentionpolicy.htm)
- [ListView](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_listview.htm)
- [RecordType](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_recordtype.htm)
- [SearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_searchlayouts.htm)
- [SharingReason](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_apexsharingreason.htm)
- [SharingRecalculation](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_apexsharingrecalculation.htm)
- [ValidationRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_validationformulas.htm)
- [WebLink](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_weblink.htm)

## Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <deploymentStatus\>Deployed</deploymentStatus\>
    <description\>test object with one field for eclipse ide testing</description\>
    <fields\>
        <fullName\>Comments\_\_c</fullName\>
        <description\>add your comments about this object here</description\>
        <inlineHelpText\>This field contains comments made about this object</inlineHelpText\>
        <label\>Comments</label\>
        <length\>32000</length\>
        <type\>LongTextArea</type\>
        <visibleLines\>30</visibleLines\>
    </fields\>
    <label\>MyFirstObject</label\>
    <nameField\>
        <label\>MyFirstObject Name</label\>
        <type\>Text</type\>
    </nameField\>
    <pluralLabel\>MyFirstObjects</pluralLabel\>
    <sharingModel\>ReadWrite</sharingModel\>
</CustomObject\>

The following is the metadata definition of an external object for Salesforce Connect.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides\>
        <actionName\>CancelEdit</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>Delete</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>Edit</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>Follow</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>List</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>New</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>SaveEdit</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>Tab</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <actionOverrides\>
        <actionName\>View</actionName\>
        <type\>Default</type\>
    </actionOverrides\>
    <deploymentStatus\>InDevelopment</deploymentStatus\>
    <description\>Products</description\>
    <enableFeeds\>false</enableFeeds\>
    <externalDataSource\>OData</externalDataSource\>
    <externalIndexAvailable\>false</externalIndexAvailable\>
    <externalName\>Products</externalName\>
    <fields\>
        <fullName\>DiscontinuedDate\_\_c</fullName\>
        <description\>DiscontinuedDate</description\>
        <externalDeveloperName\>DiscontinuedDate</externalDeveloperName\>
        <externalId\>false</externalId\>
        <isFilteringDisabled\>false</isFilteringDisabled\>
        <isNameField\>false</isNameField\>
        <isSortingDisabled\>false</isSortingDisabled\>
        <label\>DiscontinuedDate</label\>
        <required\>false</required\>
        <type\>DateTime</type\>
    </fields\>
    <fields\>
        <fullName\>ID\_\_c</fullName\>
        <description\>ID</description\>
        <externalDeveloperName\>ID</externalDeveloperName\>
        <externalId\>false</externalId\>
        <isFilteringDisabled\>false</isFilteringDisabled\>
        <isNameField\>false</isNameField\>
        <isSortingDisabled\>false</isSortingDisabled\>
        <label\>ID</label\>
        <precision\>18</precision\>
        <required\>false</required\>
        <scale\>0</scale\>
        <type\>Number</type\>
        <unique\>false</unique\>
    </fields\>
    <fields\>
        <fullName\>Name\_\_c</fullName\>
        <description\>Name</description\>
        <externalDeveloperName\>Name</externalDeveloperName\>
        <externalId\>false</externalId\>
        <isFilteringDisabled\>false</isFilteringDisabled\>
        <isNameField\>false</isNameField\>
        <isSortingDisabled\>false</isSortingDisabled\>
        <label\>Name</label\>
        <length\>128</length\>
        <required\>false</required\>
        <type\>Text</type\>
        <unique\>false</unique\>
    </fields\>
    <fields\>
        <fullName\>Price\_\_c</fullName\>
        <description\>Price</description\>
        <externalDeveloperName\>Price</externalDeveloperName\>
        <externalId\>false</externalId\>
        <isFilteringDisabled\>false</isFilteringDisabled\>
        <isNameField\>false</isNameField\>
        <isSortingDisabled\>false</isSortingDisabled\>
        <label\>Price</label\>
        <precision\>16</precision\>
        <required\>false</required\>
        <scale\>2</scale\>
        <type\>Number</type\>
        <unique\>false</unique\>
    </fields\>
    <fields\>
        <fullName\>Products\_\_c</fullName\>
        <externalDeveloperName\>Products</externalDeveloperName\>
        <externalId\>false</externalId\>
        <isFilteringDisabled\>false</isFilteringDisabled\>
        <isNameField\>false</isNameField\>
        <isSortingDisabled\>false</isSortingDisabled\>
        <label\>Products</label\>
        <length\>20</length\>
        <referenceTo\>Products\_\_x</referenceTo\>
        <relationshipLabel\>Products</relationshipLabel\>
        <relationshipName\>Products</relationshipName\>
        <type\>ExternalLookup</type\>
    </fields\>
    <fields\>
        <fullName\>Rating\_\_c</fullName\>
        <description\>Rating</description\>
        <externalDeveloperName\>Rating</externalDeveloperName\>
        <externalId\>false</externalId\>
        <isFilteringDisabled\>false</isFilteringDisabled\>
        <isNameField\>false</isNameField\>
        <isSortingDisabled\>false</isSortingDisabled\>
        <label\>Rating</label\>
        <precision\>18</precision\>
        <required\>false</required\>
        <scale\>0</scale\>
        <type\>Number</type\>
        <unique\>false</unique\>
    </fields\>
    <fields\>
        <fullName\>ReleaseDate\_\_c</fullName\>
        <description\>ReleaseDate</description\>
        <externalDeveloperName\>ReleaseDate</externalDeveloperName\>
        <externalId\>false</externalId\>
        <isFilteringDisabled\>false</isFilteringDisabled\>
        <isNameField\>false</isNameField\>
        <isSortingDisabled\>false</isSortingDisabled\>
        <label\>ReleaseDate</label\>
        <required\>false</required\>
        <type\>DateTime</type\>
    </fields\>
    <label\>Products</label\>
    <pluralLabel\>Products</pluralLabel\>
    <searchLayouts\>
        <customTabListAdditionalFields\>ExternalId</customTabListAdditionalFields\>
        <lookupDialogsAdditionalFields\>ExternalId</lookupDialogsAdditionalFields\>
        <lookupPhoneDialogsAdditionalFields\>ExternalId</lookupPhoneDialogsAdditionalFields\>
        <searchResultsAdditionalFields\>ExternalId</searchResultsAdditionalFields\>
        <searchResultsAdditionalFields\>DisplayUrl</searchResultsAdditionalFields\>
        <searchResultsAdditionalFields\>ID\_\_c</searchResultsAdditionalFields\>
    </searchLayouts\>
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file for field sets and record types but not for other components. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=71546d956abe0ddc62600adaf272d3ce701cd0c2cc0bc57b02bebfb946ad66cd url=/legacydeveloper/current/en-us/api_meta/meta_customobjecttranslation.md -->

# CustomObjectTranslation

This metadata type allows you to translate custom objects for a variety of languages.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. The ability to translate component labels is part of the Translation Workbench.

## Declarative Metadata File Suffix and Directory Location

Local translations are stored in a file with a format of customObjectName\_\_c\-lang.objectTranslation, where customObjectName\_\_c is the custom object name, and lang is the translation language. A sample file name for German translations is myCustomObject\_\_c-de.objectTranslation.

Similarly, packaged translations are stored in a file with a format of customObjectName-pkgNamespace\_\_c\-lang.objectTranslation, where customObjectName-pkgNamespace\_\_c is the custom object and package namespace, and lang is the translation language. A sample file name for German translations in a package with the namespace of Acme is myCustomObject-Acme\_\_c-de.objectTranslation. Custom object translations are stored in the objectTranslations folder in the corresponding package directory.

Custom object translations are stored in the objectTranslations folder in the corresponding package directory.

## Version

CustomObjectTranslation components are available in API version 14.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d317496e137">Field</th>

              <th class="featureTableHeader  " id="d317496e140">Field Type</th>

              <th class="featureTableHeader  " id="d317496e143">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">caseValues</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#objectNameCaseValue">ObjectNameCaseValue</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description"><span class="ph" id="case_values_desc"><a name="case_values_desc"><!-- --></a>Different combinations of the custom
                  object with regard to article, plural, possessive, and
                  case.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#customFieldTranslation">CustomFieldTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description">A list of translations for the custom fields associated with the
                custom object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">fieldSets</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#fieldSetTranslation">FieldSetTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description">A list of field set translations. Available in API version 41.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">string</td>

              <td class="entry" headers="d317496e143" data-title="Description">The name of the custom object and the translation language with a
                format of
                <var class="keyword varname">customObjectName</var>-<var class="keyword varname">lang</var>,
                where <var class="keyword varname">customObjectName</var> is the custom object name,
                and <var class="keyword varname">lang</var> is the translation language.<p class="p">Inherited
                  from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for this
                  metadata type. It must be specified when creating, updating, or
                  deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a> to see an example of
                  this field specified for a call.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">gender</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">Gender</td>

              <td class="entry" headers="d317496e143" data-title="Description">Indicates the gender of the noun that represents the object. Used
                for languages where words need different treatment depending on
                their gender.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">layouts</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#layoutTranslation">LayoutTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description">A list of page layout translations.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">nameFieldLabel</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">string</td>

              <td class="entry" headers="d317496e143" data-title="Description">The label for the name field. Maximum of 80 characters. When you
                deploy a change to <span class="keyword parmname">nameFieldLabel</span>, also include
                at least one top-level <span class="keyword parmname">caseValues</span> entry with a
                nonempty value. Otherwise, the deployment succeeds but doesn’t apply
                the <span class="keyword parmname">nameFieldLabel </span>change.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname" id="field_namedFilters"><a name="field_namedFilters"><!-- --></a>namedFilters</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#namedFilterTranslation">NamedFilterTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description">A list of translations for lookup filter error messages
                associated with the custom object.<p class="p">This field has been removed as
                  of API version 30.0 and is only available in prior versions. The
                  translation metadata associated with a lookup filter is now
                  represented by the <span class="keyword parmname">lookupFilter</span> field in
                  the <a class="xref" href="#customFieldTranslation">CustomFieldTranslation</a> subtype.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">quickActions</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#quickActionTranslation">QuickActionTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description">A list of translations for actions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">recordTypes</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#recordTypeTranslation">RecordTypeTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description">A list of record type translations.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">sharingReasons</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#sharingReasonTranslation">SharingReasonTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description">A list of sharing reason translations.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">startsWith</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">StartsWith (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d317496e143" data-title="Description">Indicates whether the noun starts with a vowel, consonant, or is
                a special character. This is used for languages where words need
                different treatment depending on the first character.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">validationRules</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#validationRuleTranslation">ValidationRuleTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description">A list of validation rule translations.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname">webLinks</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#webLinkTranslation">WebLinkTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description">A list of web link translations.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e137" data-title="Field"><span class="keyword parmname" id="field_workflowTasks"><a name="field_workflowTasks"><!-- --></a>workflowTasks</span></td>

              <td class="entry" headers="d317496e140" data-title="Field Type">
                <a class="xref" href="#workflowTaskTranslation">WorkflowTaskTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e143" data-title="Description"><span class="ph" id="field_workflowTasks_desc"><a name="field_workflowTasks_desc"><!-- --></a>A list of workflow task
                  translations.</span></td>

            </tr>

          </tbody>

        </table>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

When you retrieve or deploy translations from a package, the translations from the package might override existing translations. The overridden translations appear in the Rename Tabs and Labels UI until you click **Reset** to restore the translations installed by the latest package.

## CustomFieldTranslation

CustomFieldTranslation contains details for a custom field translation. In API versions 37.0 and earlier standard picklist values could be translated with CustomFieldTranslation. In API version 38.0, use StandardValueSetTranslation instead. For more details, see [CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm "Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.").

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Not every language supports all the possible values for the fields in CustomFieldTranslation. For language-specific supported values, see the [fully supported languages](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobjectranslation_language_support_standard.htm) and [end-user languages](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobjectranslation_language_support_enduser.htm) appendices.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d317496e486">Field</th>

              <th class="featureTableHeader  " id="d317496e489">Field Type</th>

              <th class="featureTableHeader  " id="d317496e492">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname">caseValues</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type">
                <a class="xref" href="#objectNameCaseValue">ObjectNameCaseValue</a>[]
              </td>

              <td class="entry" headers="d317496e492" data-title="Description">Different combinations of the custom object with regard to
                article, plural, possessive, and case. Available in API version
                29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type">string</td>

              <td class="entry" headers="d317496e492" data-title="Description">Translation for the custom field description.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname">gender</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type">Gender</td>

              <td class="entry" headers="d317496e492" data-title="Description">
                Available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname">help</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type">string</td>

              <td class="entry" headers="d317496e492" data-title="Description">Translation for the text that displays in the field-level help
                hover text for this field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type">string</td>

              <td class="entry" headers="d317496e492" data-title="Description">Translation for the label. Maximum of 40 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname" id="field_lookupFilter"><a name="field_lookupFilter"><!-- --></a>lookupFilter</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type"><a class="xref" href="#lookupFilterTranslation">LookupFilterTranslation</a></td>

              <td class="entry" headers="d317496e492" data-title="Description">
                <span class="ph" id="field_lookupFilter_desc"><a name="field_lookupFilter_desc"><!-- --></a>Represents the translation
                  metadata associated with a lookup filter.</span>
                <p class="p">This field is
                  available in API version 30.0 and later.</p>
                <p class="p">LookupFilter
                  isn’t supported on the article type object.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type">string</td>

              <td class="entry" headers="d317496e492" data-title="Description">Required. The name of the field relative to the custom object;
                for example, <samp class="codeph nolang">MyField__c</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname">picklistValues</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type">
                <a class="xref" href="#pickListValueTranslation">PicklistValueTranslation</a>[]
              </td>

              <td class="entry" headers="d317496e492" data-title="Description">List of translations for picklist values. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalpicklistvalue.htm#picklistvalue">PicklistValue</a>. <p class="p">Note: “Subject” on the Task object is
                  a text field, not a picklist value. It can’t be retrieved via
                  Metadata API. Translations can be provided via the Translation
                  Workbench.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname">relationshipLabel</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type">string</td>

              <td class="entry" headers="d317496e492" data-title="Description">Translation for a lookup relationship label. A lookup
                relationship allows a field to be associated with another field. The
                relationship field allows users to select an option from a list of
                values defined by the other field. Maximum of 80 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e486" data-title="Field"><span class="keyword parmname">startsWith</span></td>

              <td class="entry" headers="d317496e489" data-title="Field Type">StartsWith (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d317496e492" data-title="Description">Indicates whether the noun starts with a vowel, consonant, or is
                a special character. Used for languages where words need different
                treatment depending on the first character. Available in API
                version 29.0 and later.</td>

            </tr>

          </tbody>

        </table>

## FieldSetTranslation

FieldSetTranslation contains details for a field set translation. For more details, see [FieldSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fieldset.htm "Represents a field set. A field set is a grouping of fields. For example, you could have a field set that contains fields describing a user's first name, middle name, last name, and business title."). Available in API 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. Translation for the field set label. Maximum of 80 characters. |
| name | string | Required. The field set name. |

## LayoutTranslation

LayoutTranslation contains details for a page layout translation. For more details, see [Fields](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_layouts.htm#Layout).

| Field | Field Type | Description |
| --- | --- | --- |
| layout | string | Required. The layout name. |
| layoutType | string |  |
| sections | [LayoutSectionTranslation](#layoutSectionTranslation)\[\] | An array of layout section translations. |

## LayoutSectionTranslation

LayoutSectionTranslation contains details for a page layout section translation. For more details, see [LayoutSection](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_layouts.htm#LayoutSection).

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. Translation for the label. Maximum of 765 characters. |
| section | string | Required. The section name. |

## LookupFilterTranslation

LookupFilterTranslation shows a translation for a lookup filter error message associated with the custom object. Replaces NamedFilterTranslation.

LookupFilterTranslation is available in API version 30.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| errorMessage | string | The error message that appears if the lookup filter fails. |
| informationalMessage | string | The information message displayed on the page. Use to describe things some users don't understand, such as why certain items are excluded in the lookup filter. |

## NamedFilterTranslation

NamedFilterTranslation has been removed as of API version 30.0 and is only available in previous API versions.

NamedFilterTranslation shows a list of translations for lookup filter error messages associated with the custom object. See [NamedFilter](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/namedfilter.htm "Represents the metadata associated with a lookup filter. This metadata type is used to create, update, or delete lookup filter definitions. This component has been removed as of API version 30.0 and is only available in previous API versions. The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField component.") for more information.

| Field | Field Type | Description |
| --- | --- | --- |
| errorMessage | string | The error message that appears if the lookup filter fails. |
| informationalMessage | string | The information message displayed on the page. Use to describe things the user doesn’t understand, such as why certain items are excluded in the lookup filter. |
| name | string | Required. The name of the lookup filter. If you create this field in the user interface, a name is automatically assigned. If you create this field through Metadata API, you must include the name field. |

## ObjectNameCaseValue

ObjectNameCaseValue supports multiple cases and definitions of the custom object name to allow usage in various grammatical contexts.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Not every language supports all the possible values for the fields in ObjectNameCaseValue. For language-specific supported values, see the [fully supported languages](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobjectranslation_language_support_standard.htm) and [end-user languages](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobjectranslation_language_support_enduser.htm) appendices.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d317496e1091">Field</th>

              <th class="featureTableHeader  " id="d317496e1094">Field Type</th>

              <th class="featureTableHeader  " id="d317496e1097">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d317496e1091" data-title="Field"><span class="keyword parmname">article</span></td>

              <td class="entry" headers="d317496e1094" data-title="Field Type">Article (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d317496e1097" data-title="Description">English has two types of articles: definite
                (<var class="keyword varname">the</var>) and indefinite (<var class="keyword varname">a</var>,
                <var class="keyword varname">an</var>). The usage of these articles depends
                mainly on whether you're referring to any member of a group, or to a
                specific member of a group. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Definite</samp></li>

                  <li class="li"><samp class="codeph nolang">Indefinite</samp></li>

                  <li class="li"><samp class="codeph nolang">None</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e1091" data-title="Field"><span class="keyword parmname">caseType</span></td>

              <td class="entry" headers="d317496e1094" data-title="Field Type">CaseType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d317496e1097" data-title="Description">The case of the custom object name. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Ablative</samp></li>

                  <li class="li"><samp class="codeph nolang">Accusative</samp></li>

                  <li class="li"><samp class="codeph nolang">Adessive</samp></li>

                  <li class="li"><samp class="codeph nolang">Allative</samp></li>

                  <li class="li"><samp class="codeph nolang">Causalfinal</samp></li>

                  <li class="li"><samp class="codeph nolang">Dative</samp></li>

                  <li class="li"><samp class="codeph nolang">Delative</samp></li>

                  <li class="li"><samp class="codeph nolang">Distributive</samp></li>

                  <li class="li"><samp class="codeph nolang">Elative</samp></li>

                  <li class="li"><samp class="codeph nolang">Essive</samp></li>

                  <li class="li"><samp class="codeph nolang">Essiveformal</samp></li>

                  <li class="li"><samp class="codeph nolang">Genitive</samp></li>

                  <li class="li"><samp class="codeph nolang">Illative</samp></li>

                  <li class="li"><samp class="codeph nolang">Inessive</samp></li>

                  <li class="li"><samp class="codeph nolang">Instrumental</samp></li>

                  <li class="li"><samp class="codeph nolang">Lative</samp></li>

                  <li class="li"><samp class="codeph nolang">Locative</samp></li>

                  <li class="li"><samp class="codeph nolang">Nominative</samp></li>

                  <li class="li"><samp class="codeph nolang">Objective</samp></li>

                  <li class="li"><samp class="codeph nolang">Partitive</samp></li>

                  <li class="li"><samp class="codeph nolang">Prepositional</samp></li>

                  <li class="li"><samp class="codeph nolang">Subjective</samp></li>

                  <li class="li"><samp class="codeph nolang">Sublative</samp></li>

                  <li class="li"><samp class="codeph nolang">Superessive</samp></li>

                  <li class="li"><samp class="codeph nolang">Termanative</samp></li>

                  <li class="li"><samp class="codeph nolang">Translative</samp></li>

                  <li class="li"><samp class="codeph nolang">Vocative</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e1091" data-title="Field"><span class="keyword parmname">plural</span></td>

              <td class="entry" headers="d317496e1094" data-title="Field Type">boolean</td>

              <td class="entry" headers="d317496e1097" data-title="Description">Indicates whether the <a class="xref" href="#objectNameCaseValue_value"><span class="keyword parmname">value</span></a> field is
                plural (<samp class="codeph java">true</samp>) or singular
                (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e1091" data-title="Field"><span class="keyword parmname">possessive</span></td>

              <td class="entry" headers="d317496e1094" data-title="Field Type">Possessive (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d317496e1097" data-title="Description">The possessive case of
                a language is a grammatical case used to indicate a relationship of
                possession. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">First</samp></li>

                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Second</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d317496e1091" data-title="Field"><span class="keyword parmname" id="objectNameCaseValue_value"><a name="objectNameCaseValue_value"><!-- --></a>value</span></td>

              <td class="entry" headers="d317496e1094" data-title="Field Type">string</td>

              <td class="entry" headers="d317496e1097" data-title="Description">Required. The value or label in this grammatical context.</td>

            </tr>

          </tbody>

        </table>

## PicklistValueTranslation

PicklistValueTranslation contains details for translation of a picklist value from a local, custom picklist field. For more details, see [Picklist (Including Dependent Picklist)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm "Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.").

| Field | Field Type | Description |
| --- | --- | --- |
| masterLabel | string | Required. The picklist value defined on the setup page in the application. Displayed wherever a translated label isn't available. |
| translation | string | Required. Translation for the value. |

## QuickActionTranslation

QuickActionTranslation contains details for an action label in the user interface. For more information, see [QuickAction](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickaction.htm "Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields.").

| Field | Field Type | Description |
| --- | --- | --- |
| aspect | string | Identifies which quick action label the translated text belongs to. Use this field only when you want to use different strings for the quick action's field label and informational message. Valid values are Master and InfoMessage. Available in API version 53.0 and later. |
| label | string | Required. Translation for the label. Maximum of 765 characters. |
| name | string | Required. The quick action name. |

## RecordTypeTranslation

RecordTypeTranslation contains details for a record type name translation. For more details, see [RecordType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordtype.htm "Represents the metadata associated with a record type. Record types let you offer different business processes, picklist values, and page layouts to different users. Use this metadata type to create, update, or delete record type definitions for a custom object.").

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. Translation for the label. Maximum of 765 characters. |
| name | string | Required. The record type name. |
| description | string | Translation for the record type description. Available in API version 42.0 and later. |

## SharingReasonTranslation

SharingReasonTranslation contains details for a sharing reason translation. For more details, see [SharingReason](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsharingreason.htm "Represents an Apex sharing reason, which is used to indicate why sharing was implemented for a standard or custom object. Apex managed sharing allows developers to use Apex to programmatically share custom objects. When you use Apex managed sharing to share an object, only users with the “Modify All Data” permission can add or change the sharing on the object's record, and the sharing access is maintained when the record owner changes or is deactivated. Sharing reasons for standard objects are available for objects that have a corresponding share object (for example, AccountShare, OpportunityShare) and whose org-wide default can be set to Private or Public Read-Only. Objects on the detail side of a master-detail relationship, which have no share object of their own, aren't supported.").

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. Translation for the sharing reason. |
| name | string | Required. The sharing reason name. |

## ValidationRuleTranslation

ValidationRuleTranslation contains details for a validation rule translation. For more details, see [ValidationRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_validationformulas.htm "Represents a validation rule, which is used to verify that the data a user enters in a record is valid and can be saved. A validation rule contains a formula or expression that evaluates the data in one or more fields and returns a value of true or false. Validation rules also include an error message that your client application can display to the user when the rule returns a value of true due to invalid data.").

| Field | Field Type | Description |
| --- | --- | --- |
| errorMessage | string | Required. Translation for the error message associated with the validation rule failure. |
| name | string | Required. The validation rule name. |

## WebLinkTranslation

WebLinkTranslation contains details for a web link translation. For more details, see [WebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm "Represents a custom button or link defined in a custom object.").

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. Translation for the web link label. Maximum of 765 characters. |
| name | string | Required. The web link name. |

## WorkflowTaskTranslation

WorkflowTaskTranslation contains details for a workflow task translation. For more details, see [Workflow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_workflow.htm "Represents the metadata associated with a workflow rule. A workflow rule sets workflow actions into motion when its designated conditions are met. You can configure workflow actions to execute immediately when a record meets the conditions in your workflow rule, or set time triggers that execute the workflow actions on a specific day. Use this metadata type to create, update, or delete workflow rule definitions.").

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | Translation for the workflow task description. |
| name | string | Required. The workflow task name. |
| subject | string | Translation for the workflow task subject. |

## Declarative Metadata Sample Definitions

This sample XML definition shows a CustomObjectTranslation for the Description\_\_c object in German, with one custom field, Summary\_\_c. The name and location of the file containing this definition would be objectTranslations/Description\_\_c-de.objectTranslation.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObjectTranslation xmlns="http://soap.sforce.com/2006/04/metadata">
    <caseValues\>
        <caseType\>Nominative</caseType\>
        <plural\>false</plural\>
        <value\>Beschreibung</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Nominative</caseType\>
        <plural\>true</plural\>
        <value\>Beschreibungen</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Accusative</caseType\>
        <plural\>false</plural\>
        <value\>Beschreibung</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Accusative</caseType\>
        <plural\>true</plural\>
        <value\>Beschreibungen</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Genitive</caseType\>
        <plural\>false</plural\>
        <value\>Beschreibung</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Genitive</caseType\>
        <plural\>true</plural\>
        <value\>Beschreibungen</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Dative</caseType\>
        <plural\>false</plural\>
        <value\>Beschreibung</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Dative</caseType\>
        <plural\>true</plural\>
        <value\>Beschreibungen</value\>
    </caseValues\>
    <fields\>
        <label\>Zusammenfassung</label\>
        <name\>Summary\_\_c</name\>
    </fields\>
    <gender\>Feminine</gender\>
    <nameFieldLabel\>Beschreibungen</nameFieldLabel\>
</CustomObjectTranslation\>

This sample XML definition shows a CustomObjectTranslation for the Account object, renaming Account to Client (Kunde) in German. The Account object has one standard field, account\_number, and one custom field, Account\_Code\_\_c. The name and location of the file containing this definition would be objectTranslations/Account-de.objectTranslation.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObjectTranslation xmlns="http://soap.sforce.com/2006/04/metadata">
    <caseValues\>
        <caseType\>Nominative</caseType\>
        <plural\>false</plural\>
        <value\>Kunde</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Nominative</caseType\>
        <plural\>true</plural\>
        <value\>Kunden</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Accusative</caseType\>
        <plural\>false</plural\>
        <value\>Kunden</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Accusative</caseType\>
        <plural\>true</plural\>
        <value\>Kunden</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Genitive</caseType\>
        <plural\>false</plural\>
        <value\>Kunden</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Genitive</caseType\>
        <plural\>true</plural\>
        <value\>Kunden</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Dative</caseType\>
        <plural\>false</plural\>
        <value\>Kunden</value\>
    </caseValues\>
    <caseValues\>
        <caseType\>Dative</caseType\>
        <plural\>true</plural\>
        <value\>Kunden</value\>
    </caseValues\>
    <fields\>
        <caseValues\>
            <caseType\>Nominative</caseType\>
            <plural\>false</plural\>
            <value\>Kundennummer</value\>
        </caseValues\>
        <caseValues\>
            <caseType\>Nominative</caseType\>
            <plural\>true</plural\>
            <value\>Kundennummern</value\>
        </caseValues\>
        <gender\>Feminine</gender\>
        <name\>account\_number</name\>
    </fields\>
    <fields\>
        <label\>Kunden-Code</label\>
        <name\>Account\_Code\_\_c</name\>
    </fields\>
    <gender\>Masculine</gender\>
</CustomObjectTranslation\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")
- [Translations](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm "Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.")

<!-- document id=23d244ac6e46c2d8ef0ffde573f31843da619d75017c3b905959cca338158b87 url=/legacydeveloper/current/en-us/api_meta/customobjectranslation_language_support_enduser.md -->

# CustomObjectTranslation Language Support: End-User Languages

Not every language supports all the possible values for the fields in [CustomObjectTranslation](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_customobjecttranslation.htm). Use this appendix to determine which field values a language supports.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Salesforce offers three levels of language support: fully supported languages, end-user languages, and platform-only languages. This appendix provides information only for end-user languages.

## Arabic

article

Definite

None

gender

Masculine

Feminine

plural

true

false

possessive

None

First

Second

## Bulgarian

gender

Masculine

Feminine

Neuter

plural

true

false

## Croatian

caseType

Accusative

Dative

Genitive

Instrumental

Locative

Nominative

gender

Feminine

Masculine

Neuter

plural

true

false

## Czech

caseType

Accusative

Dative

Genitive

Instrumental

Locative

Nominative

gender

Masculine

Feminine

Neuter

AnimateMasculine

plural

true

false

## English (UK)

plural

false

true

startsWith

Consonant

Vowel

## Greek

caseType

Accusative

Genitive

Nominative

gender

Masculine

Feminine

Neuter

plural

true

false

## Hebrew

article

Definite

None

gender

Masculine

Feminine

plural

true

false

## Hungarian

caseType

Ablative

Accusative

Allative

Causalfinal

Dative

Delative

Distributive

Elative

Essiveformal

Illative

Inessive

Instrumental

Nominative

Sublative

Termanative

Translative

Superessive

plural

true

false

possessive

None

First

Second

startsWith

Consonant

Vowel

## Indonesian

plural

false

true

## Polish

caseType

Nominative

Accusative

Dative

Genitive

Instrumental

Locative

gender

Masculine

Feminine

Neuter

AnimateMasculine

plural

true

false

## Portuguese (Portugal)

gender

Feminine

Masculine

plural

true

false

## Romanian

article

Definite

None

gender

Masculine

Feminine

Neuter

plural

true

false

## Slovak

caseType

Accusative

Dative

Genitive

Instrumental

Nominative

Locative

gender

Feminine

Masculine

Neuter

AnimateMasculine

plural

true

false

## Slovenian

caseType

Accusative

Dative

Genitive

Instrumental

Nominative

Locative

gender

Feminine

Masculine

Neuter

AnimateMasculine

plural

true

false

## Turkish

caseType

Ablative

Accusative

Dative

Genitive

Nominative

Locative

possessive

None

First

Second

plural

true

false

## Ukrainian

caseType

Accusative

Dative

Genitive

Instrumental

Nominative

Locative

gender

Masculine

Feminine

Neuter

AnimateMasculine

plural

true

false

## Vietnamese

plural

true

false

<!-- document id=d259d68985aae73b81c12c7ddedd117f1be3fd597e4335ec72c12e1756b4312a url=/legacydeveloper/current/en-us/api_meta/customobjectranslation_language_support_standard.md -->

# CustomObjectTranslation Language Support: Fully Supported Languages

Not every language supports all the possible values for the fields in [CustomObjectTranslation](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_customobjecttranslation.htm). Use this appendix to determine which field values a language supports.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Salesforce offers three levels of language support: fully supported languages, end-user languages, and platform-only languages. This appendix provides information only for fully supported languages.

## Chinese (Simplified)

plural

false

## Chinese (Traditional)

plural

false

## Danish

article

None

Definite

Indefinite

gender

Feminine

Neuter

plural

true

false

## Dutch

gender

Feminine

Neuter

plural

true

false

## Finnish

caseType

Ablative

Adessive

Allative

Elative

Essive

Genitive

Illative

Inessive

Nominative

Partitive

Translative

plural

true

false

possessive

None

First

Second

## French

gender

Masculine

Feminine

startsWith

Consonant

Vowel

plural

true

false

## German

caseType

Accusative

Dative

Genitive

Nominative

gender

Masculine

Feminine

Neuter

plural

true

false

## Italian

gender

Masculine

Feminine

startsWith

Consonant

Special

Vowel

plural

true

false

## Japanese

plural

false

## Korean

plural

false

## Norwegian

article

Definite

Indefinite

None

gender

Masculine

Feminine

Neuter

plural

true

false

## Portuguese (Brazil)

gender

Masculine

Feminine

plural

true

false

## Russian

caseType

Accusative

Dative

Genitive

Instrumental

Nominative

Prepositional

gender

Masculine

Feminine

Neuter

AnimateMasculine

plural

true

false

## Spanish

gender

Masculine

Feminine

plural

true

false

## Spanish (Mexico)

gender

Masculine

Feminine

plural

true

false

## Swedish

article

None

Definite

Indefinite

gender

Feminine

Neuter

plural

true

false

## Thai

plural

false

<!-- document id=76952b62760752703a2847e83ca440de309dd49427ebc8d70da659d03eec0f91 url=/legacydeveloper/current/en-us/api_meta/custompageweblink.md -->

# CustomPageWebLink

Represents a custom link defined in a home page component.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

All other custom links are stored as a [WebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm "Represents a custom button or link defined in a custom object.") in a [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.").

## Declarative Metadata File Suffix and Directory Location

There is one file per custom link definition, stored in the weblinks folder in the corresponding package directory. The file suffix is .weblink.

## Version

CustomPageWebLinks are available in API version 13.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d63912e125">Field Name</th>

              <th class="featureTableHeader  " id="d63912e128">Field Type </th>

              <th class="featureTableHeader  " id="d63912e131">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">availability</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">WebLinkAvailability (enumeration of type string)</td>

              <td class="entry" headers="d63912e131" data-title="Description">Required. Indicates whether the link is only available online
                (<samp class="codeph nolang">online</samp>, or if it is also
                available offline (<samp class="codeph nolang">offline</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">string</td>

              <td class="entry" headers="d63912e131" data-title="Description">A description of the link.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname" id="displaytype"><a name="displaytype"><!-- --></a>displayType</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">WebLinkDisplayType (enumeration of type string)</td>

              <td class="entry" headers="d63912e131" data-title="Description">Represents how this link is rendered.<p class="p">Valid values:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">link</samp> for a
                    hyperlink
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">button</samp> for a
                    button
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">massActionButton</samp> for a
                    button attached to a related list
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">encodingKey</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">Encoding (enumeration of type string)</td>

              <td class="entry" headers="d63912e131" data-title="Description">Required. The default encoding setting is Unicode: <samp class="codeph xml">UTF-8</samp>. Change it if your template
                requires data in a different format. This is available if your
                content source is URL. Valid values include:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">UTF-8</samp>—Unicode
                    (UTF-8)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ISO-8859-1</samp>—General US &amp; Western Europe
                    (ISO-8859–1, ISO-LATIN-1)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Shift_JIS</samp>—Japanese (Shift-JIS)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ISO-2022-JP</samp>—Japanese (JIS)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EUC-JP</samp>—Japanese
                    (EUC-JP)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">x-SJIS_0213</samp>—Japanese (Shift-JIS_2004)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ks_c_5601-1987</samp>—Korean (ks_c_5601-1987)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Big5</samp>—Traditional
                    Chinese (Big5)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">GB2312</samp>—Simplified Chinese (GB2312)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Big5-HKSCS</samp>—Traditional Chinese Hong Kong
                    (Big5–HKSCS)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">string</td>

              <td class="entry" headers="d63912e131" data-title="Description">The name used as a unique identifier for API access. The
                <span class="keyword parmname">fullName</span> can contain only underscores and
                alphanumeric characters. It must be unique, begin with a letter, not
                include spaces, not end with an underscore, and not contain two
                consecutive underscores.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">hasMenubar</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">boolean</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">newWindow</samp>, this field indicates
                whether to show the browser menu bar for the window (<samp class="codeph java">true</samp> or not (<samp class="codeph java">false</samp>). Otherwise, leave this field
                empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">hasScrollbars</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">boolean</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">newWindow</samp>, this field indicates
                whether to show the scroll bars for the window (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Otherwise, leave this field
                empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">hasToolbar</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">boolean</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">newWindow</samp>, this field indicates
                whether to show the browser toolbar for the window (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Otherwise, leave this field
                empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">int</td>

              <td class="entry" headers="d63912e131" data-title="Description">Height in pixels of the window opened by the link. Required if
                the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">newWindow</samp>. Otherwise, leave this field empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">isResizable</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">boolean</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">newWindow</samp>, this field indicates
                whether to allow resizing of the window (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Otherwise, leave this field empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname" id="linktype"><a name="linktype"><!-- --></a>linkType</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">WebLinkType (enumeration of type string)</td>

              <td class="entry" headers="d63912e131" data-title="Description">Required. Represents whether the content of the button or link is
                specified by a URL, an sControl, a JavaScript code block, or a
                Visualforce page.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">url</samp></li>

                  <li class="li"><samp class="codeph nolang">sControl</samp></li>

                  <li class="li"><samp class="codeph nolang">javascript</samp></li>

                  <li class="li"><samp class="codeph nolang">page</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">flow</samp>—Reserved
                    for future use.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">string</td>

              <td class="entry" headers="d63912e131" data-title="Description">The
                label for the link.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname" id="opentype"><a name="opentype"><!-- --></a>openType</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">WebLinkWindowType (enumeration of type string)</td>

              <td class="entry" headers="d63912e131" data-title="Description">Required. When the link is clicked, this field specifies the
                window style used to display the content.<p class="p">Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">newWindow</samp></li>

                  <li class="li"><samp class="codeph nolang">sidebar</samp></li>

                  <li class="li"><samp class="codeph nolang">noSidebar</samp></li>

                  <li class="li"><samp class="codeph nolang">replace</samp></li>

                  <li class="li"><samp class="codeph nolang">onClickJavaScript</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">string</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the value of <span class="keyword parmname">linkType</span> is <samp class="codeph nolang">page</samp>, this field represents the
                Visualforce page. Otherwise, leave this field empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">position</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">WebLinkPosition (enumeration of type string)</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">newWindow</samp>, this field indicates how
                the new window should be displayed. Otherwise, leave this field
                empty.<p class="p">Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">fullScreen</samp></li>

                  <li class="li"><samp class="codeph nolang">none</samp></li>

                  <li class="li"><samp class="codeph nolang">topLeft</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">protected</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">boolean</td>

              <td class="entry" headers="d63912e131" data-title="Description">Required. <span class="ph" id="field_protected_desc"><a name="field_protected_desc"><!-- --></a>Indicates whether this
                  component is protected (<samp class="codeph java">true</samp>)
                  or not (<samp class="codeph java">false</samp>). Protected
                  components cannot be linked to or referenced by components
                  created in the installing organization.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">requireRowSelection</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">boolean</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">massAction</samp>, this field indicates
                whether to require individual row selection to execute the action
                for this button (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). Otherwise, leave
                this field empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">scontrol</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">string</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the value of <span class="keyword parmname">linkType</span> is <samp class="codeph nolang">sControl</samp>, this field represents the
                name of the sControl. Otherwise, leave this field empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">showsLocation</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">boolean</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">newWindow</samp>, this field indicates
                whether or not to show the browser location bar for the window.
                Otherwise, leave this field empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">showsStatus</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">boolean</td>

              <td class="entry" headers="d63912e131" data-title="Description">If the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">newWindow</samp>, this field indicates
                whether or not to show the browser status bar for the window.
                Otherwise, leave this field empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">url</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">string</td>

              <td class="entry" headers="d63912e131" data-title="Description">
                <p class="p">If the value of <span class="keyword parmname">linkType</span> is <samp class="codeph nolang">url</samp>, this field represents the
                  URL value. If the value of <span class="keyword parmname">linkType</span> is
                  <samp class="codeph nolang">javascript</samp>, this field
                  represents the JavaScript content. If the value is neither of
                  these, leave this field empty.
                </p>

                <p class="p">Content must be escaped in a manner consistent with XML parsing
                  rules.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d63912e125" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d63912e128" data-title="Field Type">int</td>

              <td class="entry" headers="d63912e131" data-title="Description">Width in pixels of the window opened by the link. <p class="p">Required if
                  the <span class="keyword parmname">openType</span> is <samp class="codeph nolang">newWindow</samp>. Otherwise, leave this field
                  empty.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of a Weblink. For related samples, see [HomePageComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm#HomePageCompenent_example) and [HomePageLayout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm#HomePageLayout_meta_example).

<?xml version="1.0" encoding="UTF-8"?>
<CustomPageWebLink xmlns="http://soap.sforce.com/2006/04/metadata">
    <availability\>online</availability\>
    <displayType\>button</displayType\>
    <encodingKey\>UTF-8</encodingKey
    <hasMenubar\>false</hasMenubar\>
    <hasScrollbars\>true</hasScrollbars\>
    <hasToolbar\>false</hasToolbar\>
    <height\>600</height\>
    <isResizable\>true</isResizable\>
    <linkType\>url</linkType\>
    <masterLabel\>detailPageButon</masterLabel\>
    <openType\>newWindow</openType\>
    <position\>none</position\>
    <protected\>false</protected\>
    <showsLocation\>false</showsLocation\>
    <showsStatus\>false</showsStatus\>
    <url\>http://google.com</url\>
</CustomPageWebLink\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

#### See Also

- [HomePageComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm "Represents the metadata associated with a home page component. You can customize the Home tab in Salesforce Classic to include components such as sidebar links, a company logo, a dashboard snapshot, or custom components that you create. Use to create, update, or delete home page component definitions.")
- [HomePageLayout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm "Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile.")
- [WebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm "Represents a custom button or link defined in a custom object.")

<!-- document id=376f3455769dc7db66278c3ccf0fdd1f994eed922cd2aebe8c69d0aaedae2099 url=/legacydeveloper/current/en-us/api_meta/meta_custompermission.md -->

# CustomPermission

Represents a permission that grants access to a custom feature. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

CustomPermission components have the suffix .customPermission and are stored in the customPermissions folder.

## Version

CustomPermission components are available in API version 31.0 and later.

## Special Access Rules

As of Summer ’20 and later, only users who have one of these permissions can access this object:

- View Setup and Configuration
- Manage Session Permission Set Activations
- Assign Permission Sets

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| connectedApp | string | The name of the connected app that’s associated with this permission. Limit: 80 characters. |
| description | string | The custom permission description. Limit: 255 characters. |
| isLicensed | boolean | Required. Read-only. Indicates whether the appropriate Salesforce license is required before accessing the permission (true) or not (false). |
| label | string | Required. The custom permission label. Limit: 80 characters. |
| requiredPermission | [CustomPermissionDependencyRequired\[\]](#CustomPermissionDependencyRequired) | Indicates which custom permissions are required by the parent custom permission. This field is available in API version 32.0 and later. |

## CustomPermissionDependencyRequired

CustomPermissionDependencyRequired determines whether a custom permission is required by the parent custom permission. A required custom permission must be enabled when its parent is enabled.

| Field Name | Field Type | Description |
| --- | --- | --- |
| customPermission | string | Required. The custom permission name. |
| dependency | boolean | Required. Indicates whether this custom permission is required by the parent custom permission (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example of a CustomPermission component.

<?xml version="1.0" encoding="UTF-8"?>
<CustomPermission xmlns="http://soap.sforce.com/2006/04/metadata">
   <connectedApp\>Acme</connectedApp\>
   <description\>Read and edit access for Acme accounts.</description\>
   <label\>Acme Account Full Access</label\>
   <requiredPermission\>
      <customPermission\>Acme\_Account\_Read</customPermission\>
      <dependency\>true</dependency\>
   </requiredPermission\>
</CustomPermission\>

The following is an example package.xml that references the previous definition, as well as other custom permissions that are associated with a connected app.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>Acme</members\>
      <name\>ConnectedApp</name\>
   </types\>
   <types\>
      <members\>Acme\_Account\_Email\_Read</members\>
      <members\>Acme\_Account\_Phone\_Edit</members\>
      <members\>Acme\_Account\_Full\_Access</members\>
      <members\>Acme\_Account\_Read</members\>
      <name\>CustomPermission</name\>
   </types\>
   <types\>
      <members\>Acme\_Account\_Email\_Read</members\>
      <members\>Acme\_Account\_Phone\_Edit</members\>
      <members\>Acme\_Account\_Full\_Access</members\>
      <members\>Acme\_Account\_Read</members\>
      <name\>PermissionSet</name\>
   </types\>
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b77e6ec83ddff3e859d9f10b07d4aa41f00c3199c9c2012f0a56b0c753122dbe url=/legacydeveloper/current/en-us/api_meta/meta_sites.md -->

# CustomSite

Represents a Salesforce site. Create public websites and applications that are directly integrated with your Salesforce organization, but don't require users to log in with a username and password.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This Metadata API Type applies only to Salesforce sites and [Visualforce sites](https://help.salesforce.com/s/articleView?id=experience.exp_cloud_basics_glossary.htm&type=5&language=en_US). For Digital Experiences, also known as Experience Cloud sites, see [Network](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_network.htm).

For more information, see [Salesforce Sites](https://help.salesforce.com/s/articleView?id=platform.sites_overview.htm&type=5&language=en_US) in Salesforce Help. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

CustomSite doesn’t currently support syndication feeds.

## Declarative Metadata File Suffix and Directory Location

Lightning Platform CustomSite components are stored in the sites directory of the corresponding package directory. The file name matches the site name, and the extension is .site.

## Version

Lightning Platform CustomSite components are available in API version 14.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d871257e118">Field</th>

              <th class="featureTableHeader  " id="d871257e121">Field Type</th>

              <th class="featureTableHeader  " id="d871257e124">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. Determines whether the site is active.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">allowHomePage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. Determines whether the standard home page is visible to public users.
                This field is available in API version 15.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">allowStandardAnswersPages</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Determines whether the standard answer pages are visible to public users. This
                field is available in API version 19.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">allowStandardIdeasPages</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. Determines whether the standard Ideas pages are visible to public
                users. This field is available in API version 15.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">allowStandardLookups</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. Determines whether the standard lookup pages are visible to public
                users. This field is available in API version 15.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname" id="allowStandardPortalPages"><a name="allowStandardPortalPages"><!-- --></a>allowStandardPortalPages</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">
                <span class="ph" id="allowStandardPortalPages_descr"><a name="allowStandardPortalPages_descr"><!-- --></a>Required. When enabled, authenticated
                  users in this site can access standard Salesforce pages as allowed by their access
                  controls. When disabled, authenticated users in this site can't access standard
                  Salesforce pages, even if their access controls allow it. If your site serves only
                  Visualforce pages, disabling this setting helps add a layer of access protection
                  to your site.</span> This field is available in API version 39.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">allowStandardSearch</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. Determines whether the standard search pages are visible to public
                users. This field is available in API version 15.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname" id="AnalyticsTrackingCode"><a name="AnalyticsTrackingCode"><!-- --></a>analyticsTrackingCode</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The tracking code associated with your site. Services such as Google Analytics
                can use this code to track page request data for your site. This field is available
                in API version 17.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">authorizationRequiredPage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page to display when the guest user tries to access
                a page for which they aren’t authorized.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">bandwidthExceededPage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page to display when the site has exceeded its
                bandwidth quota.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">browserXssProtection</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. Determines whether protection against reflected cross-site scripting
                attacks is enabled. If a reflected cross-site scripting attack is detected, the
                browser shows a blank page with no content. Available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">cachePublicVisualforcePagesInProxyServers</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Indicates whether proxy servers cache this site’s publicly available pages only
                for unauthenticated guest users (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). When this field is <samp class="codeph nolang">false</samp>, this site’s cache-enabled Visualforce pages
                are cached in the web browser for both authenticated and unauthenticated users. The
                default is <samp class="codeph nolang">true</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=platform.sites_caching.htm&amp;type=5&amp;language=en_US" target="_blank">Configure Site Caching</a> in Salesforce Help
                for more information.<p class="p">This field is available in API version 52.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">changePasswordPage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page to display when the portal user attempts to
                change their password for either the portal or for Chatter Answers, when enabled. </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="ph" id="CAForgotPassword"><a name="CAForgotPassword"><!-- --></a><span class="keyword parmname" id="ChatterAnswersForgotPasswordConfirm-752B608F"><a name="ChatterAnswersForgotPasswordConfirm-752B608F"><!-- --></a>chatterAnswersForgotPasswordConfirmPage</span></span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">
                <span class="ph" id="CAForgotPassword_Descr"><a name="CAForgotPassword_Descr"><!-- --></a>The name of the Visualforce page that informs
                  the user that an email has been sent to them with a temporary password. This field
                  is available if Chatter Answers is enabled for your organization. </span>This field
                is available in API version 27.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="ph" id="CAForgotPasswrdPage"><a name="CAForgotPasswrdPage"><!-- --></a><span class="keyword parmname">chatterAnswersForgotPasswordPage</span></span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">
                <span class="ph" id="CAForgotPasswrdPage_Descr"><a name="CAForgotPasswrdPage_Descr"><!-- --></a>The name of the Visualforce page to display
                  when a user clicks the link to retrieve a forgotten password. This field is
                  available if Chatter Answers is enabled for your organization. </span>This field is
                available in API version 27.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="ph" id="CAHelp"><a name="CAHelp"><!-- --></a><span class="keyword parmname">chatterAnswersHelpPage</span></span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">
                <span class="ph" id="CAHelp_Descr"><a name="CAHelp_Descr"><!-- --></a>The name of the Visualforce page to display when the user
                  clicks the help link. This field is available if Chatter Answers is enabled for
                  your organization. </span>This field is available in API version 27.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="ph" id="CALogin"><a name="CALogin"><!-- --></a><span class="keyword parmname">chatterAnswersLoginPage</span></span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">
                <span class="ph" id="CALogin_Descr"><a name="CALogin_Descr"><!-- --></a>The name of the Visualforce page to display where users
                  can log in to the portal. This field is available if Chatter Answers is enabled
                  for your organization. </span>This field is available in API version 27.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="ph" id="CARegistration"><a name="CARegistration"><!-- --></a><span class="keyword parmname">chatterAnswersRegistrationPage</span></span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">
                <span class="ph" id="CARegistration_Descr"><a name="CARegistration_Descr"><!-- --></a>The name of the Visualforce page to display where
                  users can register themselves and access the portal. </span>This field is available
                in API version 27.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">clickjackProtectionLevel</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">SiteClickjackProtectionLevel (enumeration of type string)</td>

              <td class="entry" headers="d871257e124" data-title="Description">
                <span class="ph" id="clickjack_field_desc1"><a name="clickjack_field_desc1"><!-- --></a>Sets the clickjack protection level. The options
                  are:</span><a name="clickjack_field_desc2"><!-- --></a>
                <ul class="ul bulletList" id="clickjack_field_desc2">
                  <li class="li">
                    <samp class="codeph nolang">AllowAllFraming</samp> — Allow framing by any
                    page (no protection)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">External</samp> — Allow framing of site or
                    Experience Cloud site pages on external domains (good protection)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SameOriginOnly</samp> — Allow framing by the
                    same origin only (recommended)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NoFraming</samp> — Don’t allow framing by any
                    page (most protection)
                  </li>

                </ul>
                This field is available in API version 30.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">contentSniffingProtection</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. Determines whether the browser is prevented from inferring the MIME
                type from the document content. If enabled, it also prevents the browser from
                executing some malicious files (JavaScript, Stylesheet) as dynamic content. This
                field is available in API version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">cspUpgradeInsecureRequests</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">This field is removed in API version 52.0 and later. In API version 51.0 and
                earlier, the value in the field is ignored.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">customWebAddresses</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type"><a class="xref" href="#SiteWebAddress">SiteWebAddress[]</a></td>

              <td class="entry" headers="d871257e124" data-title="Description">The root custom URLs associated with the site. Saving or deploying a CustomSite
                replaces all root custom URLs in the site with the root custom URLs in this list.
                Custom URLs that use a non-root path prefix aren’t included in this list and aren’t
                affected when saving or deploying a CustomSite. This field is available in API
                version 21.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The site description.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">enableAuraRequests</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Determines whether guest users can view features available only in Lightning
                (<samp class="codeph nolang">true</samp>). If set to <samp class="codeph nolang">false</samp>, Lightning features don’t load. This field is available in API
                version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">favoriteIcon</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the static resource, without the extension, for the icon that
                appears in next to the site’s name in browser tabs, bookmarks, and search results.
                <p class="p">To update a site’s favorite icon, create a 16px by 16px ICO file. Then store
                  that images a static resource at the base path for the site. For example, if the
                  icon file name is favico.ico, <samp class="codeph nolang">https://<var class="keyword varname">myDomainName</var>.my.site.com/store/favicon.ico</samp>
                  is the required path for a site with the URL <samp class="codeph nolang">https://<var class="keyword varname">myDomainName</var>.my.site.com/store</samp>. To use
                  that icon, set <span class="keyword parmname">favoriteIcon</span> to <samp class="codeph nolang">favicon</samp>.</p>
                <p class="p">If the specified the ICO file doesn’t exist in the
                  required location, a 404 error is returned. Otherwise, if the file isn’t present,
                  no favorite icon is used.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">fileNotFoundPage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page to display when the guest user tries to access
                a non-existent page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">forgotPasswordPage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description"><span class="ph" id="forgotPasswordPageDesc"><a name="forgotPasswordPageDesc"><!-- --></a>The name of the Visualforce page to display
                  when a user clicks the Forgot Password link on the site’s login page. This field
                  is only applicable for Experience Cloud sites.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">genericErrorPage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page to display for errors not otherwise
                specified.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">guestProfile</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">Read only. The name of the profile associated with the guest user.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">inMaintenancePage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page to display when the site is down for
                maintenance.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">inactiveIndexPage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page set as the inactive site home page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname"><span class="ph" id="indexPage"><a name="indexPage"><!-- --></a>indexPage</span></span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description"><span class="ph" id="indexPageDescription"><a name="indexPageDescription"><!-- --></a>Required. The name of the Visualforce page set as
                  the active site home page.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. The name of the site label in the Salesforce user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">myProfilePage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page to display as the site user’s profile page,
                where users can update their contact information. This field is available in API
                version 20.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">portal</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the portal associated with this site for login access.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">redirectToCustomDomain</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Indicates whether requests for this site’s system-managed URLs are redirected
                to the HTTPS custom domain serving this site (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                System-managed site URLs end in <span class="ph filepath">*.my.salesforce-sites.com</span> or
                <span class="ph filepath">*.my.site.com</span>. In Experience Cloud sites, the default is
                <samp class="codeph nolang">false</samp>. In Salesforce Sites, the default is
                <samp class="codeph nolang">true</samp>.<p class="p">If multiple custom domains serve this
                  site and this field is set to <samp class="codeph nolang">true</samp>, requests
                  are routed to the site’s primary custom URL only if it’s an HTTPS custom domain.
                  Otherwise, requests are redirected to the first HTTPS custom domain associated
                  with this site, in alphanumeric order. If no HTTPS custom domain serves this site,
                  this option has no effect.</p>
                <p class="p">This field is available in API version 52.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">referrerPolicyOriginWhenCrossOrigin</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. Determines whether the referrer header shows only Salesforce.com
                rather than the entire URL when loading a page. This feature eliminates the
                potential for a referrer header to reveal sensitive information that could be
                present in a full URL, such as an org ID. This field is available in API version
                41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">requireHttps</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">This field is removed in API version 52.0 and later. In API version 51.0 and
                earlier, the value in the field is ignored.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">requireInsecurePortalAccess</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e124" data-title="Description">Determines whether to override your organization's security settings and
                exclusively use HTTP when logging in to the associated portal from your site.
                Removed in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">robotsTxtPage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page to display for the
                <span class="ph filepath">robots.txt</span> file used by web crawlers.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">selfRegPage</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">Visualforce page used for self-registration.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname" id="ServerIsDown"><a name="ServerIsDown"><!-- --></a>serverIsDown</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">
                <span class="ph" id="ServerIsDownDesc"><a name="ServerIsDownDesc"><!-- --></a>The name of the static resource to be displayed from
                  the cache server when Salesforce servers are down.</span> The static resource must
                be a public zip file 1 MB or smaller and must contain a page named
                <span class="ph filepath">maintenance.html</span> at the root level of the zip file. Other
                resources in the zip file, such as images or CSS files, can follow any directory
                structure. This field is available in API version 17.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">siteAdmin</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The username of the site administrator.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">siteGuestRecordDefaultOwner</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The username of the user who owns all new records that unauthenticated guest
                users create. This field is available in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">siteIframeWhiteListUrls</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type"><a class="xref" href="#SiteIframeWhiteListUrl">SiteIframeWhiteListUrl[]</a></td>

              <td class="entry" headers="d871257e124" data-title="Description">The list of external domains that you allow to frame your Salesforce site. This
                field is available in API 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">siteRedirectMappings</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type"><a class="xref" href="#api_meta_siteredirectmapping_title">SiteRedirectMapping[]</a></td>

              <td class="entry" headers="d871257e124" data-title="Description">
                <span class="ph" id="SiteRedirectMappings_desc"><a name="SiteRedirectMappings_desc"><!-- --></a>An array of all URL redirect rules set for
                  your site.</span> This field is available in API version 20.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">siteTemplate</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">The name of the Visualforce page to be used as the site template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="ph" id="site_type_field"><a name="site_type_field"><!-- --></a><span class="keyword parmname">siteType</span></span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">siteType</td>

              <td class="entry" headers="d871257e124" data-title="Description">Required. <span class="ph" id="site_type_field_desc"><a name="site_type_field_desc"><!-- --></a>Identifies whether the site is a
                  Visualforce (Salesforce Sites), Site.com site, or ChatterNetwork (Salesforce
                  Sites).</span>This field is available in API version 27.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">subdomain</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="Description">Read only. The previous custom subdomain prefix for the site. For example, if
                your site URL is <span class="ph filepath">mycompany.force.com/partners</span>,
                <span class="ph filepath">mycompany</span> is the <span class="keyword parmname">subdomain</span>.<p class="p">This field
                  is applicable and required only when the <span class="keyword parmname">myDomainSuffix</span>
                  MyDomainSettings field is set to <samp class="codeph nolang">MySalesforceLimited</samp>, <samp class="codeph nolang">CloudforceLimited</samp>, or <samp class="codeph nolang">DatabaseLimited</samp>.</p>
                <p class="p">If you enabled Salesforce Sites or Digital
                  Experiences when the <span class="keyword parmname">myDomainSuffix</span> MyDomainSettings field
                  was set to one of those values, this field returns this site’s previous subdomain.
                  Otherwise, this field returns a null value.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e118" data-title="Field"><span class="keyword parmname">urlPathPrefix</span></td>

              <td class="entry" headers="d871257e121" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e124" data-title="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
                <span class="ph filepath"><var class="keyword varname">MyDomainName</var>.my.salesforce-sites.com/partners</span>,
                <span class="ph filepath">partners</span> is the <span class="keyword parmname">urlPathPrefix</span>.
              </td>

            </tr>

          </tbody>

        </table>

## SiteIframeWhiteListUrl

Represents the external domains that you allow to frame your site or experience pages.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

| Field | Field Type | Description |
| --- | --- | --- |
| url | string | Required. The trusted domain that you allow to frame your site or Experience Cloud site pages. Accepts these formats: example, example.com, \*example.com, and https://example.com. |

## SiteRedirectMapping

SiteRedirectMapping represents a URL redirect rule on your Salesforce site.” in Salesforce Help.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d871257e1061">Field</th>

              <th class="featureTableHeader  " id="d871257e1064">Field Type</th>

              <th class="featureTableHeader  " id="d871257e1067">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d871257e1061" data-title="Field"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d871257e1064" data-title="Field Type">SiteRedirect (enumeration of type string)</td>

              <td class="entry" headers="d871257e1067" data-title="Description">Required. The type of the redirect. Available string values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Permanent</samp></li>

                  <li class="li"><samp class="codeph nolang">Temporary</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e1061" data-title="Field"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d871257e1064" data-title="Field Type">boolean</td>

              <td class="entry" headers="d871257e1067" data-title="Description">The status of the redirect: active or inactive.</td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e1061" data-title="Field"><span class="keyword parmname">source</span></td>

              <td class="entry" headers="d871257e1064" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e1067" data-title="Description">Required. The URL that you want to redirect. It must be a relative URL, but can
                have any valid extension type, such as <span class="ph filepath">.html</span> or
                <span class="ph filepath">.php</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d871257e1061" data-title="Field"><span class="keyword parmname">target</span></td>

              <td class="entry" headers="d871257e1064" data-title="Field Type">string</td>

              <td class="entry" headers="d871257e1067" data-title="Description">Required. The new URL you want users to visit. It can be a relative URL or a
                fully-qualified URL with an <span class="ph filepath">http://</span> or
                <span class="ph filepath">https://</span> prefix.
              </td>

            </tr>

          </tbody>

        </table>

## SiteWebAddress

Represents the web address of a Salesforce site.

| Field | Field Type | Description |
| --- | --- | --- |
| certificate | string | Identifies the certificate associated with the custom domain. If the custom domain is set up for Salesforce to serve HTTPS, this field indicates which certificate to use. |
| domainName | string | Required. The domain of the website, in the form of www.acme.com. |
| primary | boolean | Required. Indicates whether this is the primary domain (true). If false, this is not the primary domain. |

## Declarative Metadata Sample Definition

Here is a sample XML definition of a site.

<?xml version="1.0" encoding="UTF-8"?>
<CustomSite xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <allowHomePage\>true</allowHomePage\>
    <allowStandardAnswersPages\>true</allowStandardAnswersPages\>
    <allowStandardIdeasPages\>true</allowStandardIdeasPages\>
    <allowStandardLookups\>true</allowStandardLookups\>
    <allowStandardPortalPages\>true</allowStandardPortalPages\>
    <allowStandardSearch\>true</allowStandardSearch\>
    <analyticsTrackingCode\>UA-000000-2</analyticsTrackingCode\>
    <authorizationRequiredPage\>Unauthorized</authorizationRequiredPage\>
    <bandwidthExceededPage\>BandwidthExceeded</bandwidthExceededPage\>
    <browserXssProtection\>true</browserXssProtection\>
    <cachePublicVisualforcePagesInProxyServers\>false</cachePublicVisualforcePagesInProxyServers\>
    <changePasswordPage\>ChangePassword</changePasswordPage\>
    <chatterAnswersForgotPasswordConfirmPage\>ChatterAnswersForgotPasswordConfirm</chatterAnswersForgotPasswordConfirmPage\>
    <chatterAnswersForgotPasswordPage\>ChatterAnswersForgotPassword</chatterAnswersForgotPasswordPage\>
    <chatterAnswersHelpPage\>ChatterAnswersHelp</chatterAnswersHelpPage\>
    <chatterAnswersLoginPage\>ChatterAnswersLogin</chatterAnswersLoginPage\>
    <chatterAnswersRegistrationPage\>ChatterAnswersRegistration</chatterAnswersRegistrationPage\>
    <clickjackProtectionLevel\>SameOriginOnly</clickjackProtectionLevel\>
    <contentSniffingProtection\>true</contentSniffingProtection\>
    <customWebAddresses\>
      <domainName\>www.testing123.com</domainName\>
      <primary\>true</primary\>
    </customWebAddresses\>
    <description\>Partners portal for My Company</description\>
    <enableAuraRequests\>true</enableAuraRequests\>
    <favoriteIcon\>favicon</favoriteIcon\>
    <fileNotFoundPage\>FileNotFound</fileNotFoundPage\>
    <forgotPasswordPage\>ForgotPassword</forgotPasswordPage\>
    <genericErrorPage\>Exception</genericErrorPage\>
    <guestProfile\>Guest</guestProfile\>
    <inMaintenancePage\>InMaintenance</inMaintenancePage\>
    <inactiveIndexPage\>Inactive</inactiveIndexPage\>
    <indexPage\>UnderConstruction</indexPage\>
    <masterLabel\>customSite</masterLabel\>
    <myProfilePage\>UserProfile</myProfilePage\>
    <portal\>Customer Portal</portal\>
    <redirectToCustomDomain\>true</redirectToCustomDomain\>
    <referrerPolicyOriginWhenCrossOrigin\>true</referrerPolicyOriginWhenCrossOrigin\>
    <robotsTxtPage\>RobotsTxt</robotsTxtPage\>
    <selfRegPage\>SelfReg</selfRegPage\>
    <serverIsDown\>MyServerDownResource</serverIsDown\>
    <siteAdmin\>admin@myco.org</siteAdmin\>
    <siteGuestRecordDefaultOwner\>admin@myco.org</siteGuestRecordDefaultOwner\>
    <siteIframeWhiteListUrl\>
      <url\>example.com</url\>
    </siteIframeWhiteListUrl\>
    <siteTemplate\>SiteTemplate</siteTemplate\>
    <siteType\>Siteforce</siteType\>
    <subdomain\>myco</subdomain\>
    <urlPathPrefix\>partners</urlPathPrefix\>
</CustomSite\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Portal](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_portal.htm "The Portal metadata type represents a partner portal.")

<!-- document id=9efbc40e7d27467ced60a84ff0947471828336367208e28e58b232ef84770f70 url=/legacydeveloper/current/en-us/api_meta/meta_tab.md -->

# CustomTab

Represents a custom tab. Custom tabs let you display custom object data or other web content in Salesforce. When you add a custom tab to an app in Salesforce Classic, it appears as a tab. When you add a custom tab to an app in Lightning Experience, it appears as an item in the app’s navigation bar and in the App Launcher. When a tab displays a custom object, the tab name is the same as the custom object name. For page, s-control, or URL tabs, the name is arbitrary.

For more information, see Custom Tabs in Salesforce Help. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

The file suffix is .tab. There’s one file for each tab, stored in the tabs folder in the corresponding package directory.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet components that are retrieved in the same package.

## Version

Tabs are available in API version 10.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d890685e107">Field Name</th>

              <th class="featureTableHeader  " id="d890685e110">Field Type</th>

              <th class="featureTableHeader  " id="d890685e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="tab_actionOverrides"><a name="tab_actionOverrides"><!-- --></a>actionOverrides</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm#actionoverride" title="Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can access ActionOverride only by accessing its encompassing CustomObject.">ActionOverride</a>[]
              </td>

              <td class="entry" headers="d890685e113" data-title="Description">
                <span class="ph" id="tab_actionOverrides_desc"><a name="tab_actionOverrides_desc"><!-- --></a>A list of the action overrides
                  that are assigned to the tab.</span> Only one override is allowed
                per <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm#actionoverride_formfactor"><span class="keyword parmname">formFactor</span></a> for a given
                tab.<p class="p">This field is available in API version 37.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="tab_auraComponent"><a name="tab_auraComponent"><!-- --></a>auraComponent</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">
                <span class="ph" id="auraComponent"><a name="auraComponent"><!-- --></a>The name of the Aura component to display
                  in this tab.</span>
                <p class="p">Only one of these fields can have a value
                  set:</p>
                <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">auraComponent</span></li>

                  <li class="li"><span class="keyword parmname">customObject</span></li>

                  <li class="li"><span class="keyword parmname">flexiPage</span></li>

                  <li class="li"><span class="keyword parmname">lwcComponent</span></li>

                  <li class="li"><span class="keyword parmname">page</span></li>

                  <li class="li"><span class="keyword parmname">scontrol</span></li>

                  <li class="li"><span class="keyword parmname">url</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="tab_customobject"><a name="tab_customobject"><!-- --></a>customObject</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d890685e113" data-title="Description">Indicates whether this tab is for a custom object (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). If set to <samp class="codeph java">true</samp>, the name of the tab matches the
                name of the custom object.<p class="p" id="only_one_tab"><a name="only_one_tab"><!-- --></a>Only one of these
                  fields can have a value set:</p>
                <a name="tab_ul_only_one"><!-- --></a>
                <ul class="ul bulletList" id="tab_ul_only_one">
                  <li class="li"><span class="keyword parmname">auraComponent</span></li>

                  <li class="li"><span class="keyword parmname">customObject</span></li>

                  <li class="li"><span class="keyword parmname">flexiPage</span></li>

                  <li class="li"><span class="keyword parmname">lwcComponent</span></li>

                  <li class="li"><span class="keyword parmname">page</span></li>

                  <li class="li"><span class="keyword parmname">scontrol</span></li>

                  <li class="li"><span class="keyword parmname">url</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">The optional description text for the tab.</td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="tab_flexipage"><a name="tab_flexipage"><!-- --></a>flexiPage</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">
                <span class="ph" id="flexipage_field_desc"><a name="flexipage_field_desc"><!-- --></a>The name of the Lightning page to
                  display in this tab.</span>
                <p class="p">Only one of these fields can have a
                  value set:</p>
                <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">auraComponent</span></li>

                  <li class="li"><span class="keyword parmname">customObject</span></li>

                  <li class="li"><span class="keyword parmname">flexiPage</span></li>

                  <li class="li"><span class="keyword parmname">lwcComponent</span></li>

                  <li class="li"><span class="keyword parmname">page</span></li>

                  <li class="li"><span class="keyword parmname">scontrol</span></li>

                  <li class="li"><span class="keyword parmname">url</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname">frameHeight</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">int</td>

              <td class="entry" headers="d890685e113" data-title="Description">The height, in pixels of the tab frame. Required for s-control
                and page tabs.</td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="fullName"><a name="fullName"><!-- --></a>fullName</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">The name of the tab. The value of this field depends on the type
                of tab, and the API version.<ul class="ul bulletList">
                  <li class="li">For custom object tabs, the <span class="keyword parmname">fullName</span> is
                    the developer-assigned name of the custom object
                    (MyCustomObject__c, for example). For custom object tabs,
                    this name must be the same as the custom object name, and
                    <a class="xref" href="#tab_customobject"><span class="keyword parmname">customObject</span></a> must be set to
                    <samp class="codeph java">true</samp>.
                  </li>

                  <li class="li">For web tabs, the <span class="keyword parmname">fullName</span> is the
                    developer-assigned name of the tab (MyWebTab, for
                    example).</li>

                </ul>
                <p class="p">The <span class="keyword parmname">fullName</span> can contain only
                  underscores and alphanumeric characters. It must be unique,
                  begin with a letter, not include spaces, not end with an
                  underscore, and not contain two consecutive underscores. This
                  field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname">hasSidebar</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d890685e113" data-title="Description">Indicates if the tab displays the sidebar panel.</td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="field_icon"><a name="field_icon"><!-- --></a>icon</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">The optional reference to the image document for the tab if the
                tab isn’t using one of the standard tab styles. This field is
                available in API version 14.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">The label of the tab, for web tabs only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="tab_lwccomponent"><a name="tab_lwccomponent"><!-- --></a>lwcComponent</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">The name of the Lightning web component to display in this
                tab.<p class="p">Only one of these fields can have a value set:</p>
                <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">auraComponent</span></li>

                  <li class="li"><span class="keyword parmname">customObject</span></li>

                  <li class="li"><span class="keyword parmname">flexiPage</span></li>

                  <li class="li"><span class="keyword parmname">lwcComponent</span></li>

                  <li class="li"><span class="keyword parmname">page</span></li>

                  <li class="li"><span class="keyword parmname">scontrol</span></li>

                  <li class="li"><span class="keyword parmname">url</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname">motif</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">Required. The tab style for the color scheme and icon for the
                custom tab. <p class="p">For example, “'Custom70: Handsaw,” is
                  the handsaw icon.</p>

                <p class="p">Valid Values for this field are: Custom1:Heart, Custom2:Fan,
                  Custom3:Sun, Custom4:Hexagon, Custom5:Leaf, Custom6:Triangle,
                  Custom7:Square, Custom8:Diamond, Custom9:Lightning,
                  Custom10:Moon, Custom11:Star, Custom12:Circle, Custom13:Box,
                  Custom14:Hands, Custom15:People, Custom16:Bank, Custom17:Sack,
                  Custom18:Form, Custom19:Wrench, Custom20:Airplane,
                  Custom21:Computer, Custom22:Telephone, Custom23:Envelope,
                  Custom24:Building, Custom25:Alarmclock, Custom26:Flag,
                  Custom27:Laptop, Custom28:Cellphone, Custom29:PDA,
                  Custom30:Radardish, Custom31:Car, Custom32:Factory,
                  Custom33:Desk, Custom34:Insect, Custom35:Microphone,
                  Custom36:Train, Custom37:Bridge, Custom38:Camera,
                  Custom39:Telescope, Custom40:Creditcard, Custom41:Cash,
                  Custom42:Treasurechest, Custom43:Jewel, Custom44:Hammer,
                  Custom45:Ticket, Custom46:Stamp, Custom47:Knight,
                  Custom48:Trophy, Custom49:CD/DVD, Custom50:Bigtop,
                  Custom51:Apple, Custom52:Balls, Custom53:Bell, Custom54:Boat,
                  Custom55:Books, Custom56:Bottle, Custom57:BuildingBlock,
                  Custom58:Caduceus, Custom59:Can, Custom60:Umbrella,
                  Custom61:Castle, Custom62:Chalkboard, Custom63:Chip,
                  Custom64:Compass, Custom65:Cup, Custom66:Dice, Custom67:Gears,
                  Custom68:Globe, Custom69:Guitar, Custom70:Handsaw,
                  Custom71:Headset, Custom72:Helicopter, Custom73:HighwaySign,
                  Custom74:HotAirBalloon, Custom75:IPPhone, Custom76:Keys,
                  Custom77:Locked, Custom78:Map, Custom79:MeasuringTape,
                  Custom80:Motorcycle, Custom81:MusicalNote, Custom82:Whistle,
                  Custom83:Pencil, Custom84:Presenter, Custom85:RealEstateSign,
                  Custom86:RedCross, Custom87:Safe, Custom88:Sailboat,
                  Custom89:Saxophone, Custom90:Scales, Custom91:Shield,
                  Custom92:Ship, Custom93:ShoppingCart, Custom94:Stethoscope,
                  Custom95:Stopwatch, Custom96:StreetSign, Custom97:Thermometer,
                  Custom98:Truck, Custom99:TVCRT,
                  Custom100:TVWidescreen.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="tab_page"><a name="tab_page"><!-- --></a>page</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">The name of the Visualforce page to display in this tab.<p class="p">Only
                  one of these fields can have a value set:</p>
                <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">auraComponent</span></li>

                  <li class="li"><span class="keyword parmname">customObject</span></li>

                  <li class="li"><span class="keyword parmname">flexiPage</span></li>

                  <li class="li"><span class="keyword parmname">lwcComponent</span></li>

                  <li class="li"><span class="keyword parmname">page</span></li>

                  <li class="li"><span class="keyword parmname">scontrol</span></li>

                  <li class="li"><span class="keyword parmname">url</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="tab_scontrol"><a name="tab_scontrol"><!-- --></a>scontrol</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">The name of the s-control to display in this tab.<p class="p">Only one of
                  these fields can have a value set:</p>
                <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">auraComponent</span></li>

                  <li class="li"><span class="keyword parmname">customObject</span></li>

                  <li class="li"><span class="keyword parmname">flexiPage</span></li>

                  <li class="li"><span class="keyword parmname">lwcComponent</span></li>

                  <li class="li"><span class="keyword parmname">page</span></li>

                  <li class="li"><span class="keyword parmname">scontrol</span></li>

                  <li class="li"><span class="keyword parmname">url</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname">splashPageLink</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">The custom link used as the introductory splash page when users
                click the tab. References a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm" title="Represents the metadata associated with a home page component. You can customize the Home tab in Salesforce Classic to include components such as sidebar links, a company logo, a dashboard snapshot, or custom components that you create. Use to create, update, or delete home page component definitions.">HomePageComponent</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname" id="tab_url"><a name="tab_url"><!-- --></a>url</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">string</td>

              <td class="entry" headers="d890685e113" data-title="Description">The URL for the external web-page to embed in this tab.<p class="p">Only
                  one of these fields can have a value set:</p>
                <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">auraComponent</span></li>

                  <li class="li"><span class="keyword parmname">customObject</span></li>

                  <li class="li"><span class="keyword parmname">flexiPage</span></li>

                  <li class="li"><span class="keyword parmname">lwcComponent</span></li>

                  <li class="li"><span class="keyword parmname">page</span></li>

                  <li class="li"><span class="keyword parmname">scontrol</span></li>

                  <li class="li"><span class="keyword parmname">url</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d890685e107" data-title="Field Name"><span class="keyword parmname">urlEncodingKey</span></td>

              <td class="entry" headers="d890685e110" data-title="Field Type">Encoding
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d890685e113" data-title="Description">The default encoding setting is Unicode: <samp class="codeph xml">UTF-8</samp>. Change it if you’re passing information to a
                URL that requires data in a different format. This option is
                available when the value <samp class="codeph nolang">URL</samp> is
                selected in the tab type.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of a tab:

<?xml version="1.0" encoding="UTF-8"?>
<CustomTab xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Myriad Publishing</description\>
    <frameHeight\>600</frameHeight\>
    <motif\>Custom53: Bell</motif\>
    <url\>https://www.example.com</url\>
    <urlEncodingKey\>UTF-8</urlEncodingKey\>
</CustomTab\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customapplication.htm "CustomApplication represents a custom or standard application. In API version 29.0 and earlier, CustomApplication represents only a custom application. An application is a list of tab references, with a description and a logo. This type extends the Metadata metadata type and inherits its fullName field.")

<!-- document id=79a850af18ffa1d2267c8339df9a834acce8d4b5dc404197fb585cad29709708 url=/legacydeveloper/current/en-us/api_meta/meta_customvalue.md -->

# CustomValue

Represents the definition of a value used in a global value set or local custom picklist. Custom picklist fields can be local and unique, or can inherit their values from a global picklist (called a global value set in API version 38.0). This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

To deactivate a global picklist value, you can invoke an update() call on GlobalPicklist (API version 37.0) or GlobalValueSet (API version 38.0 and later) with the value omitted, or with the value’s isActive field set to false. Or, you can invoke an update() call directly on GlobalPicklistValue (API version 37.0) or CustomValue (API version 38.0 and later) with the isActive field set to false.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If picklist values are missing from a component definition, they get deactivated when deployed. Deactivation occurs for picklist values of both standard and custom fields.

CustomValue doesn’t support file-based operations and only supports CRUD-based calls. CustomValue is retrieved or deployed together with a GlobalValueSet or CustomObject component.

## File Suffix and Directory Location

CustomValue components have the suffix .customValue. A CustomValue component is returned with either a GlobalValueSet or CustomObject component.

## Version

CustomValue components are available in API version 38.0 and later. CustomValue replaces GlobalPicklistValue from API version 37.0.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| color | string | The color assigned to the picklist value when it’s used in charts on reports and dashboards. The color is in hexadecimal format; for example, #FF6600. If a color isn’t specified, it’s assigned dynamically upon chart generation. |
| default | boolean | Required. Indicates whether this value is the default selection for the global picklist and the custom picklists that share its picklist value set. This field is set to true by default. |
| description | string | A picklist value’s description. It’s useful to include a description for a picklist value so the reason for creating it can be tracked. Limit: 255 characters. |
| isActive | boolean | Indicates whether this value is active or inactive. The default value is true. Users can select only active values from a picklist. An API retrieve operation for global picklist values returns all active and inactive values in the picklist. But retrieving the values of a non-global, unrestricted picklist returns only the active values. |
| label | string | The value’s display label. If you don’t specify the label when creating a value it defaults to the API name. Available in API version 39.0 and later. |

## StandardValue

This metadata type defines a value in a value set for a standard picklist and specifies whether this value is the default value. This type extends the CustomValue metadata type and inherits all its fields.

When you deploy changes to standard picklist fields, picklist values are added as needed.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d323909e242">Field Name</th>

              <th class="featureTableHeader  " id="d323909e245">Field Type</th>

              <th class="featureTableHeader  " id="d323909e248">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="AllowEmail"><a name="AllowEmail"><!-- --></a>allowEmail</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">boolean</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="AllowEmailDesc"><a name="AllowEmailDesc"><!-- --></a>Indicates whether this value lets users email a quote
                  PDF (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the
                  <span class="keyword parmname">Status</span> field in quotes.</span>
                This field is available in API version 18.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="field_closed"><a name="field_closed"><!-- --></a>closed</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">boolean</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="field_closed_desc"><a name="field_closed_desc"><!-- --></a>Indicates whether this value is associated with a
                  closed status (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Status</span> field in cases and tasks.</span> This field is
                available in API version 16.0 and up to version 36.0. In version 37.0, this field is
                in GlobalPicklistValue.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="field_converted"><a name="field_converted"><!-- --></a>converted</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">boolean</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="field_converted_desc"><a name="field_converted_desc"><!-- --></a>Indicates whether this value is associated with a
                  converted status (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is relevant for only the standard
                  <span class="keyword parmname">Lead Status</span> field in leads.</span>
                <span class="ph">Your organization can set its own guidelines for
                  determining when a lead is qualified, but typically, you want to convert a lead as
                  soon as it becomes a real opportunity that you want to forecast.</span> For more
                information, see Convert Qualified Leads in Salesforce Help. This field is available
                in API version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="field_cssExposed"><a name="field_cssExposed"><!-- --></a>cssExposed</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">boolean</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="field_cssExposed_desc"><a name="field_cssExposed_desc"><!-- --></a>Indicates whether this value is available in
                  your Self-Service Portal (<samp class="codeph java">true</samp>), or not
                  (<samp class="codeph java">false</samp>). This field is only relevant for the
                  standard <span class="keyword parmname">Case Reason</span> field in cases.</span>
                <p class="p">Self-Service
                  provides an online support channel for your customers - allowing them to resolve
                  their inquiries without contacting a customer service representative. For more
                  information about Self-Service, see Setting Up Your Self-Service Portal in
                  Salesforce Help. </p>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Starting with Spring ’12, the Self-Service
                            portal isn’t available for new Salesforce orgs. Existing orgs continue to
                            have access to the Self-Service portal.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
                <p class="p">This field is available in API
                  version 16.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="field_forecastCategory"><a name="field_forecastCategory"><!-- --></a>forecastCategory</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">ForecastCategories (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="field_forecastCategory_desc"><a name="field_forecastCategory_desc"><!-- --></a>Indicates whether this value is associated
                  with a forecast category (<samp class="codeph java">true</samp>), or not
                  (<samp class="codeph java">false</samp>). This field is only relevant for the
                  standard <span class="keyword parmname">Stage</span> field in opportunities.</span>
                <ul class="ul bulletList">
                  <li class="li">Omitted</li>

                  <li class="li">Pipeline</li>

                  <li class="li">BestCase</li>

                  <li class="li">Forecast</li>

                  <li class="li">Closed</li>

                </ul>
                <p class="p">This field is available in API version 16.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="field_highPriority"><a name="field_highPriority"><!-- --></a>highPriority</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">boolean</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="field_highPriority_desc"><a name="field_highPriority_desc"><!-- --></a>Indicates whether this value is a high
                  priority item (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Priority</span> field in tasks.</span> For more information about
                tasks, see Start Using Tasks in Salesforce Help. This field is available in API
                version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="field_probability"><a name="field_probability"><!-- --></a>probability</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">int</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="field_probability_desc"><a name="field_probability_desc"><!-- --></a>Indicates whether this value is a probability
                  percentage (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Stage</span> field in opportunities.</span> This field is available
                in API version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="field_reverseRole"><a name="field_reverseRole"><!-- --></a>reverseRole</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">string</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="field_reverseRole_desc"><a name="field_reverseRole_desc"><!-- --></a>A picklist value corresponding to a reverse
                  role name for a partner. If the role is subcontractor, then the reverse role might
                  be general contractor. Assigning a partner role to an account in Salesforce
                  creates a reverse partner relationship so that both accounts list the other as a
                  partner. This field is only relevant for partner roles.</span>
                <p class="p">For more
                  information, see Partner Fields in Salesforce Help.</p>
                This field is available in
                API version 18.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="field_reviewed"><a name="field_reviewed"><!-- --></a>reviewed</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">boolean</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="field_reviewed_desc"><a name="field_reviewed_desc"><!-- --></a>Indicates whether this value is associated with a
                  reviewed status (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Status</span> field in solutions.</span> For more information about
                opportunities, see Creating Solutions in Salesforce Help. This field is available in
                API version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d323909e242" data-title="Field Name"><span class="keyword parmname" id="field_won"><a name="field_won"><!-- --></a>won</span></td>

              <td class="entry" headers="d323909e245" data-title="Field Type">boolean</td>

              <td class="entry" headers="d323909e248" data-title="Description">
                <span class="ph" id="field_won_desc"><a name="field_won_desc"><!-- --></a>Indicates whether this value is associated with a
                  closed or won status (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Stage</span> field in opportunities.</span> This field is available
                in API version 16.0 and later.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

For an example of CustomValue components within a GlobalValueSet component that’s referenced by a package.xml, see [GlobalValueSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalvalueset.htm "Represents the metadata for a global picklist value set, which is the set of shared values that custom picklist fields can use. A global value set isn’t a field itself. In contrast, the custom picklist fields that are based on a global picklist are of type ValueSet. This type extends the Metadata metadata type and inherits its fullName field.").

<!-- document id=e59d13e89efc8ddd2d9b05d6e7ee1e989ae9654ded585c6e150c07569342decc url=/legacydeveloper/current/en-us/api_meta/meta_dashboard.md -->

# Dashboard

Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. For more information, see “Edit Dashboards in Accessibility Mode in Salesforce Classic” in the Salesforce online help.

Redeploying a dashboard with the same fullName as a previously deleted dashboard via Metadata API restores the deleted dashboard instead of creating a new one, even if the dashboard was removed from the Recycle Bin. The restored dashboard keeps its original Id, CreatedDate, and CreatedById.

## Declarative Metadata File Suffix and Directory Location

Dashboards are stored in the dashboards directory of the corresponding package directory. The file name matches the dashboard title and the extension is .dashboard.

## Retrieving Dashboards

You can’t use the wildcard (\*) symbol with dashboards in package.xml. To retrieve the list of dashboards for populating package.xml with explicit names, call listMetadata() and pass in DashboardFolder as the type. Note that DashboardFolder is not returned as a type in describeMetadata(). Dashboard is returned from describeMetadata() with an associated attribute of inFolder set to true. If that attribute is set to true, you can construct the type by using the component name with the word Folder, such as DashboardFolder.

The following example shows folders in package.xml. The names used in package.xml must be developer names, not dashboard titles.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyDBFolder/MyDBName</members\>
        <name\>Dashboard</name\>
    </types\>
    <types\>
        <members\>MyDocumentFolder/MyDocumentName</members\>
        <name\>Document</name\>
    </types\>
    <types\>
        <members\>unfiled$public/MarketingProductInquiryResponse</members\>
        <members\>unfiled$public/SalesNewCustomerEmail</members\>
        <name\>EmailTemplate</name\>
    </types\>
    <types\>
        <members\>MyReportFolder/MyReportName</members\>
        <name\>Report</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

## Version

Dashboard components are available in API version 14.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e161">Field</th>

              <th class="featureTableHeader  " id="d325411e164">Field Type</th>

              <th class="featureTableHeader  " id="d325411e167">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_backgroundEnd"><a name="dashboard_backgroundEnd"><!-- --></a>backgroundEndColor</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. A dashboard can have a gradient color change on its
                charts. This field defines the second color for the gradient and
                <span class="keyword parmname">backgroundStartColor</span> defines the first
                color. If you prefer your background to be all one color or do not
                want a gradient color change, select the same color for this field
                and <span class="keyword parmname">backgroundStartColor</span>. The color is in
                hexadecimal format; for example #FF6600.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">backgroundFadeDirection</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartBackgroundDirection (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The direction of the gradient color change, defined by
                the <span class="keyword parmname">backgroundStartColor</span> and
                <span class="keyword parmname">backgroundEndColor</span> fields. The valid values
                are:<a name="ChartBackgroundDirection_values"><!-- --></a>
                <ul class="ul bulletList" id="ChartBackgroundDirection_values">
                  <li class="li"><samp class="codeph nolang">Diagonal</samp></li>

                  <li class="li"><samp class="codeph nolang">LeftToRight</samp></li>

                  <li class="li"><samp class="codeph nolang">TopToBottom</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_backgroundStart"><a name="dashboard_backgroundStart"><!-- --></a>backgroundStartColor</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The starting color for the gradient color change on the
                dashboard's charts. See <span class="keyword parmname">backgroundEndColor</span> for
                more information. The color is in hexadecimal format; for example
                #FF6600.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">chartTheme</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartTheme (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Determines the default theme for all dashboard charts. Replaces
                <span class="keyword parmname">dashboardChartTheme</span> for API v42.0 and
                later.<ul class="ul bulletList"></ul>
                <a name="chartTheme"><!-- --></a>
                <ul class="ul bulletList" id="chartTheme">
                  <li class="li">
                    <samp class="codeph nolang">light</samp>—Light-colored theme.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">dark</samp>—Dark-colored theme.
                  </li>

                </ul>
                <p class="p">This field is available in API version 42.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">colorPalette</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartColorPalettes (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Determines the default palette for all dashboard charts. Replaces
                <span class="keyword parmname">dashboardColorPalette</span> for API v42.0 and later.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">accessible</samp></li>

                  <li class="li"><samp class="codeph nolang">bluegrass</samp></li>

                  <li class="li"><span class="keyword parmname">branding</span></li>

                  <li class="li"><samp class="codeph nolang">colorSafe</samp></li>

                  <li class="li"><samp class="codeph nolang">Default</samp></li>

                  <li class="li"><samp class="codeph nolang">dusk</samp></li>

                  <li class="li"><samp class="codeph nolang">earth</samp></li>

                  <li class="li"><samp class="codeph nolang">fire</samp></li>

                  <li class="li"><samp class="codeph nolang">gray</samp></li>

                  <li class="li"><samp class="codeph nolang">heat</samp></li>

                  <li class="li"><samp class="codeph nolang">justice</samp></li>

                  <li class="li"><samp class="codeph nolang">nightfall</samp></li>

                  <li class="li"><samp class="codeph nolang">pond</samp></li>

                  <li class="li"><samp class="codeph nolang">sunrise</samp></li>

                  <li class="li"><samp class="codeph nolang">tropic</samp></li>

                  <li class="li"><samp class="codeph nolang">unity</samp></li>

                  <li class="li"><samp class="codeph nolang">water</samp></li>

                  <li class="li"><samp class="codeph nolang">watermelon</samp></li>

                </ul>
                <p class="p">This field is available in API version 42.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">dashboardChartTheme</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartTheme (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Determines the default theme for all dashboard charts. <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">light</samp>—Light-colored theme.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">dark</samp>—Dark-colored theme.
                  </li>

                </ul>
                <p class="p">This field is available to maintain backward compatibility
                  with versions prior to API version 42.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">dashboardColorPalette</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartColorPalettes (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Determines the default palette for all dashboard charts. <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">accessible</samp></li>

                  <li class="li"><samp class="codeph nolang">bluegrass</samp></li>

                  <li class="li"><samp class="codeph nolang">colorSafe</samp></li>

                  <li class="li"><samp class="codeph nolang">Default</samp></li>

                  <li class="li"><samp class="codeph nolang">dusk</samp></li>

                  <li class="li"><samp class="codeph nolang">earth</samp></li>

                  <li class="li"><samp class="codeph nolang">fire</samp></li>

                  <li class="li"><samp class="codeph nolang">gray</samp></li>

                  <li class="li"><samp class="codeph nolang">heat</samp></li>

                  <li class="li"><samp class="codeph nolang">justice</samp></li>

                  <li class="li"><samp class="codeph nolang">nightfall</samp></li>

                  <li class="li"><samp class="codeph nolang">pond</samp></li>

                  <li class="li"><samp class="codeph nolang">sunrise</samp></li>

                  <li class="li"><samp class="codeph nolang">tropic</samp></li>

                  <li class="li"><samp class="codeph nolang">unity</samp></li>

                  <li class="li"><samp class="codeph nolang">water</samp></li>

                  <li class="li"><samp class="codeph nolang">watermelon</samp></li>

                </ul>
                <p class="p">This field is available to maintain backward compatibility
                  with versions prior to API version 42.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="field_dashboardfilter"><a name="field_dashboardfilter"><!-- --></a>dashboardFilters</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">
                <a class="xref" href="#dashboardFilter">DashboardFilter</a>[]
              </td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_dashboardFilter_desc"><a name="dashboard_dashboardFilter_desc"><!-- --></a>The list of filters in a
                  dashboard.</span>
                <p class="p">This field is available in API version 23.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_dashboardGridLayout"><a name="dashboard_dashboardGridLayout"><!-- --></a>dashboardGridLayout</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><a class="xref" href="#dashboardGridLayout">DashboardGridLayout</a></td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_dashboardGridLayout_desc"><a name="dashboard_dashboardGridLayout_desc"><!-- --></a>Lists the included
                  <a class="xref" href="#dashboardGridComponent">DashboardGridComponent</a> objects, specifies the number
                  of dashboard columns, and sets each dashboard row’s height in
                  pixels.</span>
                <p class="p">This field is available in API version 35.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_dashboardType"><a name="dashboard_dashboardType"><!-- --></a>dashboardType</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><span class="ph" id="DashboardType"><a name="DashboardType"><!-- --></a>DashboardType (enumeration of type
                  string)</span></td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_dashboardType_desc"><a name="dashboard_dashboardType_desc"><!-- --></a>Determines the way
                  visibility settings are set for a dashboard.</span> The valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">SpecifiedUser</samp>—All users see data at the
                    access level of one specific running user, specified in the
                    <span class="keyword parmname">runningUser</span> field, regardless of
                    their own security settings.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LoggedInUser</samp>—Each logged-in user sees data
                    according to his or her own access level.
                  </li>

                  <li class="li">
                    <span class="ph" id="MyTeamUserEnum"><a name="MyTeamUserEnum"><!-- --></a><samp class="codeph nolang">MyTeamUser</samp>—Managers can choose to
                      view the dashboard from the point of view of their
                      subordinates in the role hierarchy.</span> This value is
                    available in API version 20.0 and later.
                  </li>

                </ul>
                <p class="p">This field is available in API version 19.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Description for the dashboard. Maximum of 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_folderName"><a name="dashboard_folderName"><!-- --></a>folderName</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_folderName_desc"><a name="dashboard_folderName_desc"><!-- --></a>Name of the folder that houses
                  the dashboard.</span>
                <p class="p">This field is available in API version
                  35.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Inherited from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for this
                metadata type. It must be specified when creating, updating, or
                deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a>
                to see an example of this field specified for a call.<p class="p">This field
                  specifies the folder and dashboard title; for example
                  <span class="ph filepath">folderSales/California</span>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_isGridLayout"><a name="dashboard_isGridLayout"><!-- --></a>isGridLayout</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_isGridLayout_desc"><a name="dashboard_isGridLayout_desc"><!-- --></a>Specifies whether a
                  dashboard uses the Lightning Experience layout (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</span>
                <p class="p">Lightning
                  Experience allows dashboards with more than three columns with
                  components that span multiple columns and multiple rows in
                  size.</p>
                <p class="p">This field is available in API version 35.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">dashboardResultRefreshedDate</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. Date that the dashboard was last refreshed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">dashboardResultRunningUser</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. User currently accessing the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">leftSection</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><a class="xref" href="#dashboardComponentSection">DashboardComponentSection</a></td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The left section or column of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">middleSection</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><a class="xref" href="#dashboardComponentSection">DashboardComponentSection</a></td>

              <td class="entry" headers="d325411e167" data-title="Description">The middle section or column of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">numSubscriptions</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e167" data-title="Description">Number of subscriptions reported on the dashboard. This field is
                available in API version 42.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">owner</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">The creator of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">rightSection</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><a class="xref" href="#dashboardComponentSection">DashboardComponentSection</a></td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The right section or column of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="field_runningUser"><a name="field_runningUser"><!-- --></a>runningUser</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="field_runningUser_desc"><a name="field_runningUser_desc"><!-- --></a>The username of the user whose
                  role and sharing settings are used to determine the data shown
                  in the dashboard.</span>
                <p class="p"><span class="ph" id="runningUser_auto_pop"><a name="runningUser_auto_pop"><!-- --></a>When you deploy a dashboard and the
                    value in this field is not defined or does not correspond to
                    a valid user, the field is populated with the username of
                    the user performing the deployment.</span></p>
                <p class="p"><span class="ph" id="runningUser_visibility"><a name="runningUser_visibility"><!-- --></a>Regardless of their security
                    settings, all users viewing a dashboard see exactly the same
                    data, because dashboards are always run using the security
                    settings of a particular user.</span></p>
                <div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_tip.png" alt="Tip">
                        <div class="mediaBd">
                          <h4 class="mbs">Tip</h4>
                          <p>To
                            avoid inappropriate exposure of sensitive data, save the
                            dashboard to a folder that is visible only to appropriate
                            users.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">textColor</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. Color of the text on each chart in the dashboard. The
                color is in hexadecimal format; for example #FF6600.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">title</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The dashboard title.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">titleColor</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. Color of the titles on each dashboard component. The
                color is in hexadecimal format; for example #FF6600.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">titleSize</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. Size of characters in title text. For example, a value
                of 12 indicates 12pt text.</td>

            </tr>

          </tbody>

        </table>

## DashboardFilter

DashboardFilter represents a filter in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| dashboardFilterOptions | [DashboardFilterOption](#dashboardFilterOption)\[\] | The list of items you can select in the **Filter Options** section of the Add Filter dialog. |
| name | string | Required. The filter label. |

## DashboardFilterOption

DashboardFilterOption represents a filter option in a dashboard.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e925">Field</th>

              <th class="featureTableHeader  " id="d325411e928">Field Type</th>

              <th class="featureTableHeader  " id="d325411e931">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e925" data-title="Field"><span class="keyword parmname" id="DashboardFilterOptionOperator"><a name="DashboardFilterOptionOperator"><!-- --></a>operator</span></td>

              <td class="entry" headers="d325411e928" data-title="Field Type">DashboardFilterOperation <p class="p">(enumeration of type
                  string)</p>
              </td>

              <td class="entry" headers="d325411e931" data-title="Description">Required. Represents the filter operation for this filter item.
                Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph soql">equals</samp></li>

                  <li class="li"><samp class="codeph soql">notEqual</samp></li>

                  <li class="li"><samp class="codeph soql">lessThan</samp></li>

                  <li class="li"><samp class="codeph soql">greaterThan</samp></li>

                  <li class="li"><samp class="codeph soql">lessOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">greaterOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">contains</samp></li>

                  <li class="li"><samp class="codeph soql">notContain</samp></li>

                  <li class="li"><samp class="codeph soql">startsWith</samp></li>

                  <li class="li"><samp class="codeph soql">includes</samp></li>

                  <li class="li"><samp class="codeph soql">excludes</samp></li>

                  <li class="li">
                    <samp class="codeph soql">between</samp>
                    <div class="p">
                      <div class="box message info">
                        <div class="inner">
                          <div class="bd">
                            <div class="media">
                              <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                              <div class="mediaBd">
                                <h4 class="mbs">Note</h4>
                                <p>The “between” operator takes two
                                  operands (for example, “between MinimumValue,
                                  MaximumValue”). Note also that the minimum
                                  value is inclusive, while the maximum value is
                                  exclusive. All other dashboard filter operations
                                  take a single operand only.</p>
                              </div>
                            </div>
                          </div>
                        </div>
                      </div>

                    </div>
                  </li>

                </ul>
                This field is available in API version 24.0 and later. <p class="p">With
                  API version 23.0, valid values are enumerated in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm" title="Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.">CustomField</a>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e925" data-title="Field"><span class="keyword parmname" id="DashboardFilterOptionValues"><a name="DashboardFilterOptionValues"><!-- --></a>values</span></td>

              <td class="entry" headers="d325411e928" data-title="Field Type">string[]</td>

              <td class="entry" headers="d325411e931" data-title="Description">Required. One or more values in the <strong class="ph uicontrol">Filter
                  Options</strong> area of the Add Filter dialog. This field is
                available in API version 24.0 and later.</td>

            </tr>

          </tbody>

        </table>

## DashboardGridLayout

Lightning Experience features dashboards with more than three columns and components that span multiple columns and multiple rows in size. DashboardGridLayout lists the included dashboard components, specifies the number of dashboard columns, and sets each dashboard row’s height in pixels.

| Field | Field Type | Description |
| --- | --- | --- |
| dashboardGridComponents | DashboardGridComponent\[\] | List of [DashboardGridComponent](#dashboardGridComponent) objects in the dashboard. |
| numberOfColumns | int | Required. Total number of columns in the dashboard. |
| rowHeight | int | Required. Height of each row in pixels. |

## DashboardGridComponent

Lightning Experience features dashboards with more than three columns and components that span multiple columns and multiple rows in size. DashboardGridComponent specifies location and size of a given dashboard component.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e1145">Field</th>

              <th class="featureTableHeader  " id="d325411e1148">Field Type</th>

              <th class="featureTableHeader  " id="d325411e1151">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">colSpan</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The width of the dashboard component in columns.<p class="p">For
                  example, if <span class="keyword parmname">colSpan</span> is 5, then the
                  dashboard component spans five columns.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">columnIndex</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The left-most column that is occupied by the dashboard
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">dashboardComponent</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type"><a class="xref" href="#DashboardComponent">DashboardComponent</a></td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The dashboard component that is being sized and
                placed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">rowIndex</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The top-most row that is occupied by the dashboard
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">rowSpan</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The height of the dashboard component in rows.</td>

            </tr>

          </tbody>

        </table>

## DashboardComponent

A dashboard consists of a group of different components or elements that display data. Each component can use a custom report or a custom s-control as their data source to display corporate metrics or key performance indicators. You can create several dashboard components and display them all in one dashboard aligned in up to three columns.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e1256">Field</th>

              <th class="featureTableHeader  " id="d325411e1259">Field Type</th>

              <th class="featureTableHeader  " id="d325411e1262">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_chartAxisRange"><a name="component_chartAxisRange"><!-- --></a>chartAxisRange</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">ChartRangeType (enumeration of type string)</td>

              <td class="entry" headers="d325411e1262" data-title="Description">A manual or automatic axis range for bar or line charts. The
                valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">auto</samp></li>

                  <li class="li"><samp class="codeph nolang">manual</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">chartAxisRangeMax</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The maximum axis range to be displayed. This only applies to bar
                and line charts in which the <samp class="codeph nolang">manual</samp> axis range is selected for the
                <span class="keyword parmname">chartAxisRange</span> field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">chartAxisRangeMin</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The minimum axis range to be displayed. This only applies to bar
                and line charts in which the <samp class="codeph nolang">manual</samp> axis range is selected for the
                <span class="keyword parmname">chartAxisRange</span> field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="chart_summary"><a name="chart_summary"><!-- --></a>chartSummary</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm#ChartSummary">ChartSummary</a></td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="chart_summary_description"><a name="chart_summary_description"><!-- --></a>Specifies the summary field
                  for the chart data. Required if
                  <span class="keyword parmname">isAutoSelectFromReport</span> is set to
                  <samp class="codeph nolang">false</samp>.</span>
                <p class="p">This
                  field is available in API version 25.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_type"><a name="component_type"><!-- --></a><span class="ph" id="componentType"><a name="componentType"><!-- --></a>componentType</span></span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">DashboardComponentType (enumeration of type string)</td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="componentTypeDescription1"><a name="componentTypeDescription1"><!-- --></a>Required. Dashboard component
                  type. The valid values are:</span><a name="componentTypeDescription2"><!-- --></a>
                <ul class="ul bulletList" id="componentTypeDescription2">
                  <li class="li"><samp class="codeph nolang">Bar</samp></li>

                  <li class="li"><samp class="codeph nolang">BarGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">BarStacked</samp></li>

                  <li class="li"><samp class="codeph nolang">BarStacked100</samp></li>

                  <li class="li"><samp class="codeph nolang">Column</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnLine</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnLineGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnLineStacked</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnLineStacked100</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnStacked</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnStacked100</samp></li>

                  <li class="li"><samp class="codeph nolang">Donut</samp></li>

                  <li class="li"><samp class="codeph nolang">FlexTable</samp></li>

                  <li class="li"><samp class="codeph nolang">Funnel</samp></li>

                  <li class="li"><samp class="codeph nolang">Gauge</samp></li>

                  <li class="li"><span class="keyword parmname">Image</span></li>

                  <li class="li"><span class="keyword parmname">LightningWebComponent</span></li>

                  <li class="li"><samp class="codeph nolang">Line</samp></li>

                  <li class="li"><samp class="codeph nolang">LineCumulative</samp></li>

                  <li class="li"><samp class="codeph nolang">LineGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">LineGroupedCumulative</samp></li>

                  <li class="li"><samp class="codeph nolang">Metric</samp></li>

                  <li class="li"><samp class="codeph nolang">Pie</samp></li>

                  <li class="li"><span class="keyword parmname">PulseMetricCard</span></li>

                  <li class="li"><span class="keyword parmname">RichText</span></li>

                  <li class="li"><samp class="codeph nolang">Scatter</samp></li>

                  <li class="li"><samp class="codeph nolang">ScatterGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">SControl</samp></li>

                  <li class="li"><samp class="codeph nolang">Table</samp></li>

                  <li class="li"><span class="keyword parmname">VisualforcePage</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="dashboardComponentContents"><a name="dashboardComponentContents"><!-- --></a>dashboardComponentContents</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardComponentContentsTitle">DashboardComponentContent</a>[]
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description">A list of dashboard component contents.<p class="p">This field is available
                  in API version 58.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="dashboardDynamicValuesField"><a name="dashboardDynamicValuesField"><!-- --></a>dashboardDynamicValues</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardDynamicValueTitle">DashboardDynamicValue</a>[]
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="dashboardDynamicValuesDesc"><a name="dashboardDynamicValuesDesc"><!-- --></a>A list of dashboard dynamic
                  values. </span>
                <p class="p">This field is available in API version 36.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="dashboardFilterColumn"><a name="dashboardFilterColumn"><!-- --></a>dashboardFilterColumns</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardFilterColumnTitle">DashboardFilterColumn</a>[]
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="dashboardFilterColumnDesc"><a name="dashboardFilterColumnDesc"><!-- --></a>A list of dashboard filter
                  columns. Each report-based component must have a dashboard
                  filter column that defines the column that the filter applies
                  to.</span>
                <p class="p">This field is available in API version 23.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="dashboardTableColumnField"><a name="dashboardTableColumnField"><!-- --></a>dashboardTableColumn</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardTableColumn">DashboardTableColumn</a>[]
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description"><span class="ph" id="dashboardTableColumnDesc"><a name="dashboardTableColumnDesc"><!-- --></a>Represents a list of columns on
                  a customized dashboard table component.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">displayUnits</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">ChartUnits (enumeration of type string)</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Chart Units. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Auto</samp></li>

                  <li class="li"><samp class="codeph nolang">Integer</samp></li>

                  <li class="li"><samp class="codeph nolang">Hundreds</samp></li>

                  <li class="li"><samp class="codeph nolang">Thousands</samp></li>

                  <li class="li"><samp class="codeph nolang">Millions</samp></li>

                  <li class="li"><samp class="codeph nolang">Billions</samp></li>

                  <li class="li"><samp class="codeph nolang">Trillions</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="DrillDownUrl"><a name="DrillDownUrl"><!-- --></a>drillDownUrl</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">For charts, specifies a URL that users go to when they click the
                dashboard component. Use this option to send users to another
                dashboard, report, record detail page, or other system that uses a
                Web interface. This field overrides the
                <span class="keyword parmname">drillEnabled</span> and
                <span class="keyword parmname">drillToDetailEnabled</span> fields.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="DrillEnabled"><a name="DrillEnabled"><!-- --></a>drillEnabled</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="DrillEnabledDesc"><a name="DrillEnabledDesc"><!-- --></a>Specifies whether to take users to the
                  full or filtered source report when they click the dashboard
                  component. Set to <samp class="codeph java">false</samp> to
                  drill to the full source report; set to <samp class="codeph java">true</samp> to drill to the source
                  report filtered by what they clicked. If set to <samp class="codeph java">true</samp>, users can click individual
                  groups, axis values, or legend entries.</span>
                <p class="p">This overrides
                  the <span class="keyword parmname">drillToDetailEnabled</span> field. This field
                  is available in API version 17.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="DrillToDetailEnabled"><a name="DrillToDetailEnabled"><!-- --></a>drillToDetailEnabled</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="DrillDetailEnabledDesc"><a name="DrillDetailEnabledDesc"><!-- --></a>When enabled, users are taken to
                  the record detail page when they click a record name, record
                  owner, or feed post in a table or chart. When set to <samp class="codeph java">true</samp> users can click axis and
                  legend values, chart elements, and table entries. The
                  <span class="keyword parmname">drillDownUrl</span> and
                  <span class="keyword parmname">drillEnabled</span> fields override this
                  field.</span> This field is available in API version 20.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="EnableHover"><a name="EnableHover"><!-- --></a>enableHover</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Specifies whether to display values, labels, and percentages when
                hovering over charts. Hover details depend on chart type.
                Percentages apply to pie, donut, and funnel charts only. This field
                is available in API version 17.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="ExpandOthers"><a name="ExpandOthers"><!-- --></a>expandOthers</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Specifies whether to combine all groups less than or equal to 3%
                of the total into a single 'Others' wedge or segment. This only
                applies to pie, donut, and funnel charts. Set to <samp class="codeph java">true</samp> to show all values individually
                on the chart; set to <samp class="codeph java">false</samp> to
                combine small groups into 'Others.' This field is available in API
                version 17.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="flexComponentProperties"><a name="flexComponentProperties"><!-- --></a>flexComponentProperties</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type"><a class="xref" href="#DashboardFlexTableComponent">DashboardFlexTableComponentProperties</a></td>

              <td class="entry" headers="d325411e1262" data-title="Description">Defines metadata for Lightning Experience table columns and
                sorting. This field is available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">footer</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Footer displayed at the bottom of the dashboard component.
                Maximum of 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">gaugeMax</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The maximum value on a gauge. A gauge is used to see how far you
                are from reaching a goal. It looks like a speedometer in a
                car.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">gaugeMin</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The minimum value on a gauge.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">groupingColumn</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Specifies the field by which to group data. This data is
                displayed on the X-axis for vertical column charts and on the Y-axis
                for horizontal bar charts.<p class="p"> This field is available in API version
                  25.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">GroupingSortProperties</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type"><a class="xref" href="#DashboardComponentGroupingSortProperties">DashboardComponentGroupingSortProperties</a></td>

              <td class="entry" headers="d325411e1262" data-title="Description">This field captures sort properties of the dashboard component.
                If the component has one or more groupings, sort information is
                stored here; otherwise, it is stored in the <samp class="codeph nolang">sortBy</samp> field. This field is
                available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">header</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Header displayed at the top of the dashboard component. Maximum
                of 80 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">indicatorBreakpoint1</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The value that separates the
                <span class="keyword parmname">indicatorLowColor</span> from the
                <span class="keyword parmname">indicatorMiddleColor</span> on the
                dashboard.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">indicatorBreakpoint2</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The value that separates the
                <span class="keyword parmname">indicatorMiddleColor</span> from the
                <span class="keyword parmname">indicatorHighColor</span> on the
                dashboard.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_indicatorHighColor"><a name="component_indicatorHighColor"><!-- --></a>indicatorHighColor</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The color representing a high number range on the gauge.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_indicatorLowColor"><a name="component_indicatorLowColor"><!-- --></a>indicatorLowColor</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The color representing a low number range on the gauge.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_indicatorMiddleColor"><a name="component_indicatorMiddleColor"><!-- --></a>indicatorMiddleColor</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The color representing a medium number range on the
                gauge.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname"><span class="ph" id="legendPosition"><a name="legendPosition"><!-- --></a>legendPosition</span></span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type"><span class="ph" id="ChartLegendPosition_fieldtype"><a name="ChartLegendPosition_fieldtype"><!-- --></a>ChartLegendPosition
                  (enumeration of type string)</span></td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <div class="p" id="ChartLegendPosition_description">
                  <a name="ChartLegendPosition_description"><!-- --></a>The location of the legend
                  with respect to the chart. The valid values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">Bottom</samp></li>

                    <li class="li"><samp class="codeph nolang">OnChart</samp></li>

                    <li class="li"><samp class="codeph nolang">Right</samp></li>

                  </ul>
                </div>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">maxValuesDisplayed</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The maximum number of elements to include in the top-level
                grouping of the horizontal axis of a horizontal chart, vertical axis
                of a vertical chart, or selected axis of a stacked bar chart. For
                example, if you want to list only your top five salespeople, create
                an opportunity report that lists total opportunity amounts by owner
                and enter <samp class="codeph nolang">5</samp> in this
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">metricLabel</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Descriptive label for the metric. This is relevant if <samp class="codeph nolang">metric</samp> is the value of the
                <span class="keyword parmname">componentType</span> field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname"><span class="ph" id="page"><a name="page"><!-- --></a>page</span></span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description"><span class="ph" id="pageDescription"><a name="pageDescription"><!-- --></a>Visualforce page associated with the
                  component.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname"><span class="ph" id="pageHeightInPixels"><a name="pageHeightInPixels"><!-- --></a>pageHeightInPixels</span></span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1262" data-title="Description"><span class="ph" id="pageHeightInPixelsDescription"><a name="pageHeightInPixelsDescription"><!-- --></a>Display height of the
                  Visualforce page in pixels.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">report</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Name of the report associated with the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">scontrol</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">S-control associated with component if <samp class="codeph nolang">scontrol</samp> is the value of the
                <span class="keyword parmname">componentType</span> field. For more information,
                see “Defining Custom S-Controls” in the Salesforce
                online help.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">scontrolHeightInPixels</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Display height of the s-control in pixels.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">showPercentage</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Indicates if percentages are displayed for regions of gauges and
                wedges and segments of pie, donut, and funnel charts (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="showPicturesOnCharts"><a name="showPicturesOnCharts"><!-- --></a>showPicturesOnCharts</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Display Chatter photos for up to 20 records in a horizontal bar
                chart component whose source report is grouped by a user or group
                name field. If there are more than 20 records with photos, record
                names are shown instead of photos. Set <span class="keyword parmname">Grouping
                  Display</span> to <kbd class="ph userinput">None</kbd> to show
                photos. Set the <span class="keyword parmname">Drill Down to</span> option to
                <kbd class="ph userinput">Record Detail Page</kbd> to take users directly
                to user profile or group pages when they click photos. Chatter must
                be enabled for photos to be displayed. Depending on your
                organization's setup, you may not see photos on tables and
                charts.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="showPicturesOnTables"><a name="showPicturesOnTables"><!-- --></a>showPicturesOnTables</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Display Chatter photos for up to 20 records in a horizontal bar
                chart component whose source report is grouped by a user or group
                name field. If there are more than 20 records with photos, record
                names are shown instead of photos. Set <span class="keyword parmname">Grouping
                  Display</span> to <kbd class="ph userinput">None</kbd> to show
                photos. Set the <span class="keyword parmname">Drill Down to</span> option to
                <kbd class="ph userinput">Record Detail Page</kbd> to take users directly
                to user profile or group pages when they click photos. Chatter must
                be enabled for photos to be displayed. Depending on your
                organization's setup, you may not see photos on tables and
                charts.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">showTotal</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Indicates if the total of all wedges is displayed for gauges and
                donut charts (<samp class="codeph java">true</samp>), or not
                (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">showValues</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Indicates if the values of individual records or groups are
                displayed for charts (<samp class="codeph java">true</samp>), or
                not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="field_sortBy"><a name="field_sortBy"><!-- --></a>sortBy</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardComponentFilter">DashboardComponentFilter</a> (enumeration
                of type string)
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description">The sort option for the dashboard component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">sortLegendValues</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Specifies whether to sort the legend values for the dashboard
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">title</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The title of the dashboard component. Maximum of 40
                characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="UseReportChart"><a name="UseReportChart"><!-- --></a>useReportChart</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description"><span class="ph" id="UseReportChartDesc"><a name="UseReportChartDesc"><!-- --></a>Specifies whether to use the chart
                  defined in the source report on this dashboard component. The
                  chart settings in the source report determine how the chart
                  displays in the dashboard, and any chart settings you define for
                  the dashboard are overridden. If you defined a combination chart
                  in the source report, use this option to use that combination
                  chart on this dashboard.</span></td>

            </tr>

          </tbody>

        </table>

## DashboardComponentContent

dashboardComponentContent represents the content of a dashboard’s components.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e2235">Field</th>

              <th class="featureTableHeader  " id="d325411e2238">Field Type</th>

              <th class="featureTableHeader  " id="d325411e2241">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">additionalInfo</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">Any additional metadata the user wants to include for the
                component contents.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">altText</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The component’s alternative text.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">fileName</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The name of the component file.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">fit</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">Fit (enumeration of type string)</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The image alignment type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FitHeight</samp></li>

                  <li class="li"><samp class="codeph nolang">FitWidth</samp></li>

                  <li class="li"><samp class="codeph nolang">Original</samp></li>

                  <li class="li"><samp class="codeph nolang">Stretch</samp></li>

                  <li class="li"><samp class="codeph nolang">Tile</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">horizontalAlignment</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">HorizontalAlignment (enumeration of type string)</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The horizontal alignment type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Left</samp></li>

                  <li class="li"><samp class="codeph nolang">Center</samp></li>

                  <li class="li"><samp class="codeph nolang">Right</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">componentParameters</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The parameters for the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">richTextContent</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The rich text content for the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">tooltip</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The dashboard component’s tooltip.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">verticalAlignment</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">VerticalAlignment (enumeration of type string)</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The vertical alignment type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Bottom</samp></li>

                  <li class="li"><samp class="codeph nolang">Center</samp></li>

                  <li class="li"><samp class="codeph nolang">Top</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## DashboardDynamicValue

DashboardDynamicValue represents a dynamic value in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| additionalInfo | string | Any additional metadata the user wants to include for the dynamic value. |
| fieldName | string | Required. The name of the field for the dynamic value. |
| isDynamicUser | boolean | Indicates whether the value should be retrieved as the user running the dashboard (true) or not (false). |

## DashboardFilterColumn

DashboardFilterColumn represents a filter column in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| column | string | Required. The report column code for the filter. |

## DashboardTableColumn

DashboardTableColumn represents a column in a customized table component in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| aggregateType | [ReportSummaryType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm "Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.")\[\] (enumeration of type string) | Specifies the aggregation type for the table column. |
| column | string | Required. The label of the column to use in the table. |
| showTotal | boolean | Displays the totals for each summarizable column in the dashboard table. This field is available in API version 19.0 and later. |
| sortBy | [DashboardComponentSection](#dashboardComponentSection)(enumeration of type string) | The sort option for the dashboard table component. Sort on just one column per table. |

## DashboardFlexTableComponentProperties

DashboardFlexTableComponentProperties represents a column in a customized table component in a dashboard.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e2682">Field</th>

              <th class="featureTableHeader  " id="d325411e2685">Field Type</th>

              <th class="featureTableHeader  " id="d325411e2688">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname">flexTableColumn</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type"><a class="xref" href="#DashboardComponentColumn">DashboardComponentColumn</a></td>

              <td class="entry" headers="d325411e2688" data-title="Description">Represents a column in a Lightning Experience table component.
                This field is available in API version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname">flexTableSortInfo</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type"><a class="xref" href="#DashboardComponentSortInfo">DashboardComponentSortInfo</a></td>

              <td class="entry" headers="d325411e2688" data-title="Description">Represents sorting column and order in a Lightning Experience
                table component. This field is available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname" id="hideChatterPhotos"><a name="hideChatterPhotos"><!-- --></a>hideChatterPhotos</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e2688" data-title="Description">If <samp class="codeph nolang">true</samp>, hides any photos
                from Chatter feeds.<p class="p">This field is available in API version 41.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname" id="dashboardComponentDecimalPrecision"><a name="dashboardComponentDecimalPrecision"><!-- --></a>decimalPrecision</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type">integer</td>

              <td class="entry" headers="d325411e2688" data-title="Description">For columns with numeric values, indicates the number of
                significant digits.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname">useReportTableSetting</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e2688" data-title="Description">If <samp class="codeph nolang">true</samp>, users can import report table settings
                to this component. <p class="p">This field is available in API version 65.0
                  and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## DashboardComponentGroupingSortProperties

DashboardComponentGroupingSortProperties is composed of multiple elements of the type DashboardComponentGroupingSort.

| Field | Field Type | Description |
| --- | --- | --- |
| groupingSorts | [DashboardComponentGroupingSort](#DashboardComponentGroupingSort) | This field stores sort information for a dashboard at each grouping level of granularity. This field is available in API version 46.0 and later. |

## DashboardComponentGroupingSort

DashboardComponentGroupingSort specifies properties for sorting on a dashboard component group.

| Field | Field Type | Description |
| --- | --- | --- |
| groupingLevel | String | Grouping at which this sort configuration is applied. |
| inheritedReportGroupingSort | String | true if the sort order is picked up from an underlying report for this grouping level. |
| sortColumn | String | If grouping is sorted by an aggregate, this value is the aggregate value (such as sortColumn). If the grouping is sorted by its own value, this field is null. |
| sortOrder | String | Ascending or Descending to reflect the sort order. |

## DashboardComponentColumn

DashboardComponentColumn represents a component column in a dashboard. Available in API version 41.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e2956">Field</th>

              <th class="featureTableHeader  " id="d325411e2959">Field Type</th>

              <th class="featureTableHeader  " id="d325411e2962">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">breakPoint1</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The value that separates the <span class="keyword parmname">lowRangeColor</span>
                from the <span class="keyword parmname">midRangeColor</span> on the
                dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">breakPoint2</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The value that separates the <span class="keyword parmname">midRangeColor</span>
                from the <span class="keyword parmname">highRangeColor</span> on the
                dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">breakPointOrder</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e2962" data-title="Description">Conditional highlighting&nbsp;can be applied to multiple columns. This
                field stores the order of conditional highlights.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">highRangeColor</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The color representing a high number range on the&nbsp;column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">lowRangeColor</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The color representing a low number range on the column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">midRangeColor</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The color representing a mid number range on the column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">reportColumn</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2962" data-title="Description">Required. The report column code for the filter. </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">showTotal</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e2962" data-title="Description">If <samp class="codeph nolang">true</samp>, the column total is
                displayed. </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">DashboardComponentColumnType (enumeration of type string)</td>

              <td class="entry" headers="d325411e2962" data-title="Description">Represents the type of Lightning Experience table column:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Details</samp></li>

                  <li class="li"><samp class="codeph nolang">Aggregates</samp></li>

                  <li class="li"><samp class="codeph nolang">Grouping</samp></li>

                </ul>
                <p class="p">This field is available in API version 41.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## DashboardComponentSortInfo

DashboardFilterColumns represents a filter column in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| sortColumn | string | Indicates the column on which the table is sorted. This field is available in API version 41.0 and later. |
| sortOrder | string | Indicates whether column sorting is ascending or descending. This field is available in API version 41.0 and later. |

## DashboardComponentSection

DashboardComponentSection represents one of the sections or columns in a dashboard.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e3209">Field</th>

              <th class="featureTableHeader  " id="d325411e3212">Field Type</th>

              <th class="featureTableHeader  " id="d325411e3215">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e3209" data-title="Field"><span class="keyword parmname">columnSize</span></td>

              <td class="entry" headers="d325411e3212" data-title="Field Type"><span class="ph" id="DashboardComponentSection"><a name="DashboardComponentSection"><!-- --></a>DashboardComponentSize
                  (enumeration of type string)</span></td>

              <td class="entry" headers="d325411e3215" data-title="Description">Required. The size of the column in the dashboard:<ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">Medium</span></li>

                  <li class="li"><span class="keyword parmname">Narrow</span></li>

                  <li class="li"><span class="keyword parmname">Wide</span></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e3209" data-title="Field"><span class="keyword parmname">components</span></td>

              <td class="entry" headers="d325411e3212" data-title="Field Type">DashboardComponent[]</td>

              <td class="entry" headers="d325411e3215" data-title="Description">The list of <a class="xref" href="#DashboardComponent">DashboardComponent</a> objects in the
                dashboard column.</td>

            </tr>

          </tbody>

        </table>

## DashboardComponentFilter

DashboardComponentFilter is an enumeration of type string that lists the sort values for dashboard components. The valid values are:

| Enumeration Value | Description |
| --- | --- |
| RowLabelAscending | Sorts in alphabetical order by the label. |
| RowLabelDescending | Sorts in reverse alphabetical order by the label. |
| RowValueAscending | Sorts lowest to highest by the value. |
| RowValueDescending | Sorts highest to lowest by the value. |

## Declarative Metadata Sample Definition — Filtered Dashboard

A sample XML definition of a filtered dashboard is shown below. Note that this example is supported in API version 24.0 and later. The file name matches the dashboard title and the extension is .dashboard.

<?xml version="1.0" encoding="UTF-8"?>
<Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">
    <backgroundEndColor\>#FFFFFF</backgroundEndColor\>
    <backgroundFadeDirection\>Diagonal</backgroundFadeDirection\>
    <backgroundStartColor\>#FFFFFF</backgroundStartColor\>
    <dashboardFilters\>
        <dashboardFilterOptions\>
            <operator\>equals</operator\>
            <values\>Media</values\>
        </dashboardFilterOptions\>
        <dashboardFilterOptions\>
            <operator\>lessThan</operator\>
            <values\>Working</values\>
        </dashboardFilterOptions\>
        <dashboardFilterOptions\>
            <operator\>between</operator\>
            <values\>ABC</values\>
            <values\>XYZ</values\>
        </dashboardFilterOptions\>
        <name\>Industry</name\>
    </dashboardFilters\>
    <dashboardFilters\>
        <dashboardFilterOptions\>
            <operator\>equals</operator\>
            <values\>Analyst,Partner</values\>
        </dashboardFilterOptions\>
        <dashboardFilterOptions\>
            <operator\>startsWith</operator\>
            <values\>Integrator</values\>
        </dashboardFilterOptions\>
        <name\>Account Type</name\>
    </dashboardFilters\>
    <dashboardType\>SpecifiedUser</dashboardType\>
    <leftSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Bar</componentType\>
            <dashboardFilterColumns\>
                <column\>INDUSTRY</column\>
            </dashboardFilterColumns\>
            <dashboardFilterColumns\>
                <column\>TYPE</column\>
            </dashboardFilterColumns\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>false</drillEnabled\>
            <drillToDetailEnabled\>false</drillToDetailEnabled\>
            <enableHover\>false</enableHover\>
            <expandOthers\>false</expandOthers\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>unfiled$public/SampleReportofAccounts</report\>
            <showPercentage\>false</showPercentage\>
            <showPicturesOnCharts\>false</showPicturesOnCharts\>
            <showValues\>false</showValues\>
            <sortBy\>RowLabelAscending</sortBy\>
            <useReportChart\>false</useReportChart\>
        </components\>
    </leftSection\>
    <middleSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Funnel</componentType\>
            <dashboardFilterColumns\>
                <column\>ACCOUNT\_INDUSTRY</column\>
            </dashboardFilterColumns\>
            <dashboardFilterColumns\>
                <column\>ACCOUNT.TYPE</column\>
            </dashboardFilterColumns\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>false</drillEnabled\>
            <drillToDetailEnabled\>false</drillToDetailEnabled\>
            <enableHover\>false</enableHover\>
            <expandOthers\>false</expandOthers\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>unfiled$public/SampleReportofCases</report\>
            <showPercentage\>false</showPercentage\>
            <showValues\>true</showValues\>
            <sortBy\>RowLabelAscending</sortBy\>
            <useReportChart\>false</useReportChart\>
        </components\>
    </middleSection\>
    <rightSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Column</componentType\>
            <dashboardFilterColumns\>
                <column\>INDUSTRY</column\>
            </dashboardFilterColumns\>
            <dashboardFilterColumns\>
                <column\>ACCOUNT\_TYPE</column\>
            </dashboardFilterColumns\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>false</drillEnabled\>
            <drillToDetailEnabled\>false</drillToDetailEnabled\>
            <enableHover\>false</enableHover\>
            <expandOthers\>false</expandOthers\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>unfiled$public/SampleReportofOpportunities</report\>
            <showPercentage\>false</showPercentage\>
            <showValues\>false</showValues\>
            <sortBy\>RowLabelAscending</sortBy\>
            <useReportChart\>false</useReportChart\>
        </components\>
    </rightSection\>
    <runningUser\>admin@TESTORGNUM</runningUser\>
    <textColor\>#000000</textColor\>
    <title\>My Dashboard</title\>
    <titleColor\>#000000</titleColor\>
    <titleSize\>12</titleSize\>
</Dashboard\>

## Declarative Metadata Sample Definition — Unfiltered Dashboard

A sample XML definition of a dashboard is shown below. The file name matches the dashboard title and the extension is .dashboard.

<?xml version="1.0" encoding="UTF-8"?>
<Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">
    <backgroundEndColor\>#FFFFFF</backgroundEndColor\>
    <backgroundFadeDirection\>LeftToRight</backgroundFadeDirection\>
    <backgroundStartColor\>#FFFFFF</backgroundStartColor\>
    <description\>Dashboard with all possible chart types</description\>
    <leftSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>BarStacked100</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <componentType\>Table</componentType\>
            <dashboardTableColumn\>
                <column\>CLOSE\_DATE</column\>
                <sortBy\>RowLabelAscending</sortBy\>
            </dashboardTableColumn\>
            <dashboardTableColumn\>
                <aggregateType\>Sum</aggregateType\>
                <column\>AMOUNT</column\>
                <showTotal\>true</showTotal\>
            </dashboardTableColumn\>
            <dashboardTableColumn\>
                <column\>STAGE\_NAME</column\>
            </dashboardTableColumn\>
            <dashboardTableColumn\>
                <column\>PROBABILITY</column\>
                <aggregateType\>Maximum</aggregateType\>
            </dashboardTableColumn\>
            <displayUnits\>Integer</displayUnits\>
            <header\>Opportunities Table</header\>
            <indicatorHighColor\>#54C254</indicatorHighColor\>
            <indicatorLowColor\>#C25454</indicatorLowColor\>
            <indicatorMiddleColor\>#C2C254</indicatorMiddleColor\>
            <maxValuesDisplayed\>10</maxValuesDisplayed\>
            <report\>testFolder/sourceRep</report\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Bar</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Column</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
            <useReportChart\>true</useReportChart\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Funnel</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <expandOthers\>true</expandOthers\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
    </leftSection\>
    <middleSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>ColumnStacked100</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>ColumnStacked</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>ColumnStacked</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>ColumnGrouped</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Column</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
    </middleSection\>
    <rightSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Bar</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Pie</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <expandOthers\>true</expandOthers\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>LineGroupedCumulative</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>LineGrouped</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>LineCumulative</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Donut</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <expandOthers\>true</expandOthers\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
    </rightSection\>
    <runningUser\>admin@TESTORGNUM</runningUser\>
    <textColor\>#000000</textColor\>
    <title\>Db Title</title\>
    <titleColor\>#000000</titleColor\>
    <titleSize\>12</titleSize\>
</Dashboard\>

## Declarative Metadata Sample Definition — Lightning Experience Dashboard with isGridLayout Equals true

A sample XML definition of a Lightning Experience dashboard with isGridLayout equals true is shown below. Note that this example is supported in API version 35.0 and later. The file name matches the dashboard title and the extension is .dashboard.

<?xml version="1.0" encoding="UTF-8"?>
<Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">
    <backgroundEndColor\>#FFFFFF</backgroundEndColor\>
    <backgroundFadeDirection\>Diagonal</backgroundFadeDirection\>
    <backgroundStartColor\>#FFFFFF</backgroundStartColor\>
    <dashboardType\>SpecifiedUser</dashboardType\>
    <gridLayout\>
        <dashboardGridComponents\>
            <colSpan\>3</colSpan\>
            <columnIndex\>0</columnIndex\>
            <dashboardComponent\>
                <autoselectColumnsFromReport\>false</autoselectColumnsFromReport\>
                <chartAxisRange\>Auto</chartAxisRange\>
                <chartSummary\>
                    <axisBinding\>y</axisBinding\>
                    <column\>RowCount</column\>
                </chartSummary\>
                <componentType\>Donut</componentType\>
                <drillEnabled\>false</drillEnabled\>
                <drillToDetailEnabled\>false</drillToDetailEnabled\>
                <enableHover\>false</enableHover\>
                <expandOthers\>false</expandOthers\>
                <groupingColumn\>TITLE</groupingColumn\>
                <legendPosition\>Bottom</legendPosition\>
                <report\>unfiled$public/lead\_rpt</report\>
                <showPercentage\>false</showPercentage\>
                <showTotal\>false</showTotal\>
                <showValues\>true</showValues\>
                <sortBy\>RowLabelAscending</sortBy\>
                <useReportChart\>false</useReportChart\>
            </dashboardComponent\>
            <rowIndex\>0</rowIndex\>
            <rowSpan\>3</rowSpan\>
        </dashboardGridComponents\>
        <dashboardGridComponents\>
            <colSpan\>3</colSpan\>
            <columnIndex\>0</columnIndex\>
            <dashboardComponent\>
                <autoselectColumnsFromReport\>false</autoselectColumnsFromReport\>
                <chartAxisRange\>Auto</chartAxisRange\>
                <chartSummary\>
                    <axisBinding\>y</axisBinding\>
                    <column\>RowCount</column\>
                </chartSummary\>
                <componentType\>Pie</componentType\>
                <drillEnabled\>false</drillEnabled\>
                <drillToDetailEnabled\>false</drillToDetailEnabled\>
                <enableHover\>false</enableHover\>
                <expandOthers\>false</expandOthers\>
                <groupingColumn\>TITLE</groupingColumn\>
                <legendPosition\>Bottom</legendPosition\>
                <report\>unfiled$public/lead\_rpt</report\>
                <showPercentage\>false</showPercentage\>
                <showValues\>true</showValues\>
                <sortBy\>RowLabelAscending</sortBy\>
                <useReportChart\>false</useReportChart\>
            </dashboardComponent\>
            <rowIndex\>3</rowIndex\>
            <rowSpan\>3</rowSpan\>
        </dashboardGridComponents\>
        <dashboardGridComponents\>
            <colSpan\>3</colSpan\>
            <columnIndex\>0</columnIndex\>
            <dashboardComponent\>
                <autoselectColumnsFromReport\>false</autoselectColumnsFromReport\>
                <chartAxisRange\>Auto</chartAxisRange\>
                <chartSummary\>
                    <axisBinding\>y</axisBinding\>
                    <column\>RowCount</column\>
                </chartSummary\>
                <componentType\>Column</componentType\>
                <drillEnabled\>false</drillEnabled\>
                <drillToDetailEnabled\>false</drillToDetailEnabled\>
                <enableHover\>false</enableHover\>
                <expandOthers\>false</expandOthers\>
                <groupingColumn\>TITLE</groupingColumn\>
                <legendPosition\>Bottom</legendPosition\>
                <report\>unfiled$public/lead\_rpt</report\>
                <showPercentage\>false</showPercentage\>
                <showValues\>false</showValues\>
                <sortBy\>RowLabelAscending</sortBy\>
                <useReportChart\>false</useReportChart\>
            </dashboardComponent\>
            <rowIndex\>9</rowIndex\>
            <rowSpan\>3</rowSpan\>
        </dashboardGridComponents\>
        <numberOfColumns\>9</numberOfColumns\>
        <rowHeight\>90</rowHeight\>
    </gridLayout\>
    <isGridLayout\>true</isGridLayout\>
    <runningUser\>admin@s1.com</runningUser\>
    <textColor\>#000000</textColor\>
    <title\>sfx</title\>
    <titleColor\>#000000</titleColor\>
    <titleSize\>12</titleSize\>
</Dashboard\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

#### See Also

- [Folder](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_folder.htm "Represents a folder. This type extends the Metadata metadata type and inherits its fullName field.")
- [Report](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm "Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.")

<!-- document id=6eb67404d30a93a07477ba1b324c9f7c60977f5ffe5088482816867a58e08d19 url=/legacydeveloper/current/en-us/api_meta/meta_data_cloud_types.md -->

# Data 360 Metadata Types

Check out the metadata types that are used for development in Data 360.

- **[ActivationPlatform](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_activationplatform.htm)**  
    Represents the ActivationPlatform configuration, such as platform name, delivery schedule, output format, and destination folder.
- **[ActivationPlatformActvAttr](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_activationplatformactvattr.htm)**  
    Represents the information about activation attributes. Reserved for future use.
- **[ActivationPlatformField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_activationplatformfield.htm)**  
    Represents the information about the fields used in ActivationPlatform.
- **[ActvPfrmDataConnectorS3](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_actvpfrmdataconnectors3.htm)**  
    Represents the Amazon S3 bucket name and export directory.
- **[ActvPlatformAdncIdentifier](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_actvplatformadncidentifier.htm)**  
    Represents the information about the identifiers to be activated, such as Email, Phone, Mobile Advertiser (MAID) ID, and Over-the-top (OTT) ID.
- **[ActvPlatformFieldValue](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_actvplatformfieldvalue.htm)**  
    Represents the field values for the ActivationPlatformFields.
- **[AiPluginUtteranceDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aipluginutterancedef.htm)**  
    Represents an utterance that can be used to pick a topic during runtime.
- **[CustomerDataPlatformSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customerdataplatformsettings.htm)**  
    Represents an org's Data 360 settings.
- **[DataConnector](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dataconnector.htm)**  
    Represents the white-labeled metadata configuration for an external connector in Data 360.
- **[DataConnectorIngestApi](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dataconnectoringestapi.htm)**  
    Represents the connection information specific to Ingestion API.
- **[DataConnectorS3](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dataconnectors3.htm)**  
    Represents the connection information specific to Amazon S3.
- **[DataKitObjectTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datakitobjecttemplate.htm)**  
    Represents the object in Data Kit Object Template. These object templates are added inside the data kit.
- **[DataKitObjectDependency](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datakitobjectdependency.htm)**  
    Represents the dependency between two data kit objects. The object templates are added inside the data kit.
- **[DataObjectBuildOrgTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dataobjectbuildorgtemplate.htm)**  
    Represents the derived object template used to define the structure and configuration of data objects in a build organization. The object templates are added inside the data kit to deploy metadata.
- **[DataPackageKitDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datapackagekitdefinition.htm)**  
    Represents the top-level data kit container definition. Content objects can be added after the data kit is defined.
- **[DataPackageKitObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datapackagekitobject.htm)**  
    Represents the object in Data Kit Content Object. These objects are added inside the data kit.
- **[DataSource](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datasource.htm)**  
    Used to represent the system where the data was sourced. This object is always needed when creating a Data Stream Definition.
- **[DataSourceBundleDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datasourcebundledefinition.htm)**  
    Represents the bundle of streams that a user adds to a data kit.
- **[DataSourceField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datasourcefield.htm)**  
    Represents the details of a data source field.
- **[DataSourceObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datasourceobject.htm)**  
    Represents the object from where the data was sourced.
- **[DataSourceTenant](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datasourcetenant.htm)**  
    For internal use only.
- **[DataSrcDataModelFieldMap](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datasrcdatamodelfieldmap.htm)**  
    Represents the mappings between source data lake object (DLO) fields and target data model object (DMO) fields.
- **[DataStreamDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datastreamdefinition.htm)**  
    Contains data ingestion information such as connection, API, and file retrieval settings.
- **[DataStreamTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datastreamtemplate.htm)**  
    Represents the data stream that a user adds to a data kit.
- **[DebugLevel](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_debuglevel.htm)**  
    Represents a set of log category levels to assign to a TraceFlag object. Multiple trace flags can use a debug level.
- **[ExternalDataConnector](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externaldataconnector.htm)**  
    Used to represent the object where the data was sourced.
- **[ExternalDataSource](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externaldatasource.htm)**  
    Represents the metadata associated with an external data source. Create external data sources to manage connection details for integration with data and content that are stored outside your Salesforce org.
- **[ExternalDataTransportFieldTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externaldatatransportfieldtemplate.htm)**  
    For internal use only.
- **[ExternalDataTranObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externaldatatranobject.htm)**  
    Represents a definition of a Data 360 schema object. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.
- **[ExternalDataTransportObjectTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externaldatatransportobjecttemplate.htm)**  
    For internal use only.
- **[FieldSrcTrgtRelationship](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fieldsrctrgtrelationship.htm)**  
    Stores the relationships between a data model object (DMO) and its fields. For example, the Individual.Id field has a one-to-many relationship (1:M) with the ContactPointEmail.PartyId field.
- **[InternalDataConnector](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_internaldataconnector.htm)**  
    For internal use only.
- **[MarketSegmentDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_marketsegmentdefinition.htm)**  
    Represents the field values for MarketSegmentDefinition. MarketSegmentDefinition is used to store the exportable metadata of a segment, such as segment criteria and other attributes. Developers can create segment definition packages, pass segment definition in the form of data build tool (DBT), and publish it on AppExchange for subscriber organizations to install and instantiate these segments.
- **[MktCalcInsightObjectDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mktcalcinsightobjectdef.htm)**  
    Represents Calculated Insight definition such as expression.
- **[MktDataTranObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mktdatatranobject.htm)**  
    An entity that is used to deliver (aka transport) information from the source to a target (target will be called a landing entity).This can be the schema of a file, API, Event, or other means of transporting data, such as SubscriberFile1.csv, or SubscriberCDCEvent.
- **[ObjectSourceTargetMap](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objectsourcetargetmap.htm)**  
    Contains the object-level mappings between the source and the target objects. The source and target objects can be an MktDataLakeObject or an MktDataModelObject. For example, an Email source object can be mapped to the ContactPointEmail object.
- **[StreamingAppDataConnector](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_streamingappdataconnector.htm)**  
    Represents the connection information specific to Web and Mobile Connectors.

#### See Also

- [_Developer Center_: Data Cloud](https://developer.salesforce.com/developer-centers/data-cloud "Developer Center: Data Cloud - HTML (New Window)")

<!-- document id=e838d102b5ecf95abed3033ba23c182a970cc35fde5af3a42efb19c659f1153e url=/legacydeveloper/current/en-us/api_meta/meta_datacategorygroup.md -->

# DataCategoryGroup

Represents a data category group.

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

![Warning](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_warning.png)

#### Warning

Using Metadata API to deploy category changes from one organization to another permanently removes categories and record categorizations that are not specified in your XML file. Salesforce recommends that you manually create data categories and record associations in an organization from Setup by entering Data Categories in the Quick Find box, then selecting **Data Categories** rather than deploying changes from a sandbox to a production organization. For more information, see Usage.

Data category groups are provided to:

- Classify and filter data.
- Share data among users.

Every data category group contains items or data categories that can be organized hierarchically.

The example below shows the Geography data category group and its data categories.

Geography
    Worldwide
        North America
            United States of America
            Canada
            Mexico
        Europe
        Asia

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

See "Work with Data Categories" in the Salesforce online help for more information on data category groups, data categories, parent and sub categories.

## File Suffix and Directory Location

The file suffix is .datacategorygroup. There is one file for each data category group stored in the datacategorygroups folder in the corresponding package directory.

## Version

Data category groups are available in API version 18.0 and later.

## Fields

This metadata type contains the following fields:

| Field Name | Field Type | Description |
| --- | --- | --- |
| active | boolean | Required. The status of the category group. Indicates whether this category group is active, (true), or not active (false). |
| dataCategory | DataCategory | Required. The top-level category within the data category group. |
| description | string | The description of the data category group. |
| fullName | string | Required. The unique name of the data category group. When creating a data category group, the fullName field and the file name (without its suffix) must match.The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the Metadata component. |
| label | string | Required. Label that represents the object in Salesforce. |
| objectUsage | ObjectUsage | The objects that are associated with the data category group. |

## DataCategory

Represents an item (or data category) in the data category group. A data category can recursively contain a list of other data categories.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d336830e254">Field Name</th>

              <th class="featureTableHeader  " id="d336830e257">Field Type</th>

              <th class="featureTableHeader  " id="d336830e260">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d336830e254" data-title="Field Name"><span class="keyword parmname">dataCategory</span></td>

              <td class="entry" headers="d336830e257" data-title="Field Type">DataCategory[]</td>

              <td class="entry" headers="d336830e260" data-title="Description">A recursive list of sub data categories. For example, a list of countries within a
                continent. You can create up to 100 categories in a data category group and have up to 5
                levels in a data category group hierarchy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d336830e254" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d336830e257" data-title="Field Type">string</td>

              <td class="entry" headers="d336830e260" data-title="Description">Required. Label for the data category throughout the Salesforce user
                interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d336830e254" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d336830e257" data-title="Field Type">string</td>

              <td class="entry" headers="d336830e260" data-title="Description">Required. The developer name of the data category used as a unique identifier for API
                access. The name can only contain characters, letters, and the underscore (_) character,
                must start with a letter, and cannot end with an underscore or contain two consecutive
                underscore characters.<div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                        <div class="mediaBd">
                          <h4 class="mbs">Important</h4>
                          <p><span class="ph" id="devname_cant_change"><a name="devname_cant_change"><!-- --></a>The value for this
                              field is defined once and cannot be changed later.</span></p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
                <div class="box message warn">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_warning.png" alt="Warning">
                        <div class="mediaBd">
                          <h4 class="mbs">Warning</h4>
                          <p>If you
                            deploy a category group that already exists in an organization, any category that is not
                            defined in the XML file is permanently removed from your organization. For more information
                            see Usage.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## ObjectUsage

Represents the objects that can be associated with the data category group. This association allows the object to be classified and filtered using the data categories.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d336830e338">Field Name</th>

              <th class="featureTableHeader  " id="d336830e341">Field Type</th>

              <th class="featureTableHeader  " id="d336830e344">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d336830e338" data-title="Field Name"><span class="keyword parmname">object</span></td>

              <td class="entry" headers="d336830e341" data-title="Field Type">string[]</td>

              <td class="entry" headers="d336830e344" data-title="Description">A list of the object names that can be associated with the data category group. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph java" id="objectType_article"><a name="objectType_article"><!-- --></a>KnowledgeArticleVersion</samp>—to
                    associate articles. See "Modify Default Category Group Assignments for Articles" in the
                    Salesforce online help for more information on data category groups association to
                    articles.
                  </li>

                  <li class="li">
                    <samp class="codeph java" id="objectType_question"><a name="objectType_question"><!-- --></a>Question</samp>—to associate
                    questions. You can associate the <samp class="codeph java">Question</samp> object with
                    at most one category group.
                  </li>

                </ul>
                <p class="p">If you deploy a category group that already exists in an organization, any object
                  association that is not defined in the XML file is permanently removed from your
                  organization. Ensure that your XML file specifies all the records associated with your
                  category group in the organization. For more information see Usage.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This sample is the definition of the Geography data category group and its data categories:

<?xml version="1.0" encoding="UTF-8"?>
<DataCategoryGroup xmlns="http://soap.sforce.com/2006/04/metadata">
   <label\>Geography</label\>
   <description\>Geography structure of service center locations</description\>
   <fullName\>geo</fullName\>

   <dataCategory\> <name\>WW</name\> <label\>Worldwide</label\>
      <dataCategory\> <name\>AMER</name\> <label\>North America</label\>
         <dataCategory\>
             <name\>USA</name\>
             <label\>United States of America</label\>
         </dataCategory\> 
         <dataCategory\>
             <name\>CAN</name\>
             <label\>Canada</label\>
         </dataCategory\>
         <dataCategory\>
             <name\>MEX</name\>
             <label\>Mexico</label\>
         </dataCategory\>
      </dataCategory\> 
      <dataCategory\> <name\>EMEA</name\> <label\>Europe, Middle East, Africa</label\> 
         <dataCategory\>
             <name\>FR</name\>
             <label\>France</label\>
         </dataCategory\> 
         <dataCategory\>
             <name\>SP</name\>
             <label\>Spain</label\>
        </dataCategory\>
         <dataCategory\>
            <name\>UK</name\>
            <label\>United-Kingdom</label\>
         </dataCategory\>
      </dataCategory\>
      <dataCategory\>
          <name\>APAC</name\>
          <label\>Asia</label\>
      </dataCategory\>
   </dataCategory\>

   <objectUsage\>
      <object\>KnowledgeArticleVersion </object\>
   <objectUsage\>
</DataCategoryGroup\>

## Usage

When you deploy a category group XML file, Metadata API checks whether the category group exists in the target organization. If the category group does not exist, it is created. If the category group already exists, then Metadata API:

- Adds any new category or object defined in the XML file.
- Deletes any category that is not defined in the XML file. Records associated with the deleted categories are re-associated with the parent category.
- Deletes any object association that is not defined in the XML file.
- Moves any category if its hierarchical position differs from the position specified in the XML file.
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    When a category moves to a new parent category, users that have no visibility on the new parent category lose their visibility to the repositioned category.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

For more information about category deletion, category repositioning and its impact on record categorization and visibility see "Delete a Data Category" and "Modify and Arrange Data Categories" in the Salesforce online help.

Using Metadata API to deploy category changes from one organization to another permanently removes categories and record categorizations that are not specified in your XML file. Salesforce recommends that you manually create data categories and record associations in an organization from Setup by entering Data Categories in the Quick Find box, then selecting **Data Categories** rather than deploying changes from a sandbox to a production organization.

The following example illustrates what happens if you deploy an XML representation of a Geography data category group hierarchy to an organization that already has this data category group defined. Note that the organization contains a US category, while the XML file includes a USA category in the same hierarchical position. The Metadata API deployment process deletes the US category from the organization and moves associations for any records from US to the parent AMER category. It also adds the USA category under AMER. Note that all records that were previously categorized with US are now associated with the AMER category.

![The Geography category group with the category US in the organization and the category USA in the XML file](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/category_remove.png)

The next example illustrates what can happen when you delete or move a category in a data category group and deploy its XML representation from a sandbox to a production organization that already has this data category group defined. Hierarchy 1 shows the initial data category group in the sandbox organization. In hierarchy 2, we add an EU category under EMEA and move FR, SP and UK below EU. In hierarchy 3, we delete FR and associate its records with its new parent, EU. Finally, we deploy the changes from the sandbox to the production organization.

![Moving and deleting "FR" in the Geography category group](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/category_miscategorization.png)

Metadata API has no concept of the order of the changes made to the sandbox organization. It just deploys the changes from one organization to another. During the deployment, it first notices the deletion of the FR category and removes it from the production organization. Consequently, it moves associations for any records from FR to its parent on the production organization, EMEA. Metadata API then adds the EU category and moves SP and UK below it. Although the category group hierarchy looks the same in both organizations, record categorization in production is different from the sandbox organization. The records that were originally associated with FR in hierarchy 1 are associated with EU in the sandbox organization, but are associated with EMEA in the production organization.

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=4b25268e4d6b1f20f5b440bbe03c3f26679f93cdeec32f810c64f5e7bc126e10 url=/legacydeveloper/current/en-us/api_meta/meta_dataconnector.md -->

# DataConnector

Represents the white-labeled metadata configuration for an external connector in Data 360.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataConnector components have the suffix .dataconnector and are stored in the dataconnectors folder.

## Version

DataConnector components are available in API version 64.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| attributes | 
Field Type

[DataConnectorAttribute\[\]](#DataConnectorAttribute)

Description

A list of configurable attributes for the data connector.



 |
| description | 

Field Type

string

Description

Required.

The description of the data connector.



 |
| errors | 

Field Type

[DataConnectorError\[\]](#DataConnectorError)

Description

A list of error messages or codes related to the connector’s behavior or configuration validation.



 |
| features | 

Field Type

DataConnectorFeature\[\] (enumeration of type string)

Description

A list of features supported by the data connector.

Values are:

Override





 |
| icon | 

Field Type

string

Description

A static resource in SVG format with dimensions of 100x100 pixels and a file size not exceeding 100 KB.



 |
| licenseAgreement | 

Field Type

string

Description

Text of the license agreement associated with the data connector.



 |
| masterLabel | 

Field Type

string

Description

Required.

The display label of the connector used in user interface (UI).



 |
| ownerLocation | 

Field Type

string

Description

A description or URL that specifies where the connector is maintained or hosted.



 |
| ownerLogo | 

Field Type

string

Description

A static resource in SVG format with dimensions of 100x100 pixels and a file size not exceeding 100 KB.



 |
| ownerName | 

Field Type

string

Description

The name of the organization that owns the connector.



 |
| parentConnector | 

Field Type

string

Description

The API name of the connector. For example, AwsS3, SNOWFLAKE, ICEBERG, and so on.



 |
| releaseLevel | 

Field Type

DataConnectorReleaseLevel (enumeration of type string)

Description

Required.

Indicates the connector’s lifecycle stage.

Values are:

- BETA
- GA
- IN\_DEV
- PILOT





 |
| supportEmail | 

Field Type

string

Description

The support email address users can contact for help with the connector.



 |
| supportMessage | 

Field Type

string

Description

A support-related message or instruction displayed.



 |
| supportPhone | 

Field Type

string

Description

The support phone number users can call for help with the connector.



 |
| translations | 

Field Type

LocalizedValue\[\]

Description

A list of localized labels and descriptions to support multiple languages in the UI.



 |

## DataConnectorAttribute

| Field Name | Description |
| --- | --- |
| capabilities | 
Field Type

DataConnectorCapability\[\] (enumeration of type string)

Description

A list of supported capabilities for the data connector.

Values are:

- DataIn
- DataInDelete
- DataInHeader
- DataInIncremental
- DataInSelector
- DataInStructured
- DataInUnstructured
- DataOut
- Hidden
- UniqueGroup
- ZeroCopyIn





 |
| command | 

Field Type

string

Description

The command string executed during data operations, such as import or sync.



 |
| commandAttributes | 

Field Type

string

Description

A list of attributes passed with the command.



 |
| dataType | 

Field Type

DataConnectorDataType (enumeration of type string)

Description

Required.

Specifies the type of data input expected.

Values are:

- CHECKBOX
- COMBOBOX
- DATE
- DATETIME
- EMAIL
- IDP
- NAMED\_CREDENTIAL
- NUMBER
- PASSWORD
- PASSWORD\_FILE
- PRIVATE\_NETWORK\_ROUTE
- RADIO
- RADIO\_BUTTONS
- TEXT
- TEXTAREA
- TIME
- TOGGLE





 |
| defaultValue | 

Field Type

string

Description

The default value assigned to the field if no user input is provided.



 |
| editable | 

Field Type

boolean

Description

Indicates whether the field value can be modified by the user.



 |
| externalName | 

Field Type

string

Description

Required.

The unique name used to reference the connector externally, such as in API calls.



 |
| masterLabel | 

Field Type

string

Description

Required.

The label used for display in the UI.



 |
| max | 

Field Type

string

Description

The maximum allowable value or length for the field.



 |
| min | 

Field Type

string

Description

The minimum allowable value or length for the field.



 |
| options | 

Field Type

[DataConnectorAttributeOpt\[\]](#DataConnectorAttributeOpt)

Description

A list of selectable options available for the field.



 |
| order | 

Field Type

int

Description

Required.

The display order or evaluation order of the field.



 |
| pattern | 

Field Type

string

Description

The validation pattern used to ensure input follows a defined format.



 |
| placeholder | 

Field Type

string

Description

The placeholder text displayed in the input field when empty.



 |
| readonly | 

Field Type

boolean

Description

Indicates whether the field is read-only.



 |
| required | 

Field Type

boolean

Description

Indicates whether the field must have a value.



 |
| secure | 

Field Type

boolean

Description

Indicates whether the field contains sensitive data and should be masked.



 |
| tooltip | 

Field Type

string

Description

The tooltip text shown to users for additional guidance.



 |
| translations | 

Field Type

LocalizedValue\[\]

Description

A list of localized labels and descriptions for use in different languages.



 |
| validationMessageError | 

Field Type

string

Description

The error message shown when input validation fails for this field.



 |

## DataConnectorAttributeOpt

| Field Name | Description |
| --- | --- |
| capabilities | 
Field Type

DataConnectorCapability\[\] (enumeration of type string)

Description

A list of capabilities supported by the data connector.

Values are:

- DataIn
- DataInDelete
- DataInHeader
- DataInIncremental
- DataInSelector
- DataInStructured
- DataInUnstructured
- DataOut
- Hidden
- UniqueGroup
- ZeroCopyIn





 |
| conditionAttributes | 

Field Type

string

Description

A list of attributes used to define conditions in the connector configuration.



 |
| externalName | 

Field Type

string

Description

Required.

The unique name used to reference the connector externally, such as in API calls.



 |
| masterLabel | 

Field Type

string

Description

Required.

The display label for the connector used in the UI.



 |
| order | 

Field Type

int

Description

Required.

The order or priority of the connector in processing context.



 |
| translations | 

Field Type

LocalizedValue\[\]

Description

A list of localized labels and descriptions for use in different languages.



 |

## DataConnectorError

| Field Name | Description |
| --- | --- |
| externalName | 
Field Type

string

Description

Required.

The unique name used to reference the object externally, such as in API calls. Must be unique across the namespace.



 |
| masterLabel | 

Field Type

string

Description

Required.

The label displayed in the UI.



 |
| translations | 

Field Type

LocalizedValue\[\]

Description

A list of localized labels and descriptions for use in different languages.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataConnector component.

<?xml version="1.0" encoding="UTF-8"?>
<DataConnector xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>Iceberg Override</masterLabel\>
    <icon\>Salesforce</icon\>
    <parentConnector\>ICEBERG</parentConnector\>
    <releaseLevel\>BETA</releaseLevel\>
    <description\>Connect to Apache Iceberg tables</description\>
    <features\>Override</features\>
    <ownerName\>Slack</ownerName\>
    <ownerLogo\>Salesforce</ownerLogo\>
    <ownerLocation\>Settle, USA</ownerLocation\>
    <supportMessage\>Click download logs before reachout</supportMessage\>
    <supportPhone\>+15788467513</supportPhone\>
    <licenseAgreement\>https://www.salesforce.com/company/legal</licenseAgreement\>
    <attributes\>
        <fullName\>IcebergOverride\_storageSourceType</fullName\>
        <externalName\>storageSourceType</externalName\>
        <masterLabel\>Storage Type</masterLabel\>
        <dataType\>COMBOBOX</dataType\>
        <defaultValue\>CATALOG\_PROVIDED</defaultValue\>
        <capabilities\>DataIn</capabilities\>
        <capabilities\>Hidden</capabilities\>
        <order\>20</order\>
        <editable\>true</editable\>
        <required\>true</required\>
        <secure\>true</secure\>
    </attributes\>
</DataConnector\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>DataConnector</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>StaticResource</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=89ff69c0ae743dd26fc88ea411710c3f7b0bca470ca5d70ae3b9c3b4f370bb72 url=/legacydeveloper/current/en-us/api_meta/meta_dataconnectoringestapi.md -->

# DataConnectorIngestApi

Represents the connection information specific to Ingestion API.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataConnectorIngestApi components have the suffix .dataConnectorIngestApi and are stored in the dataConnectorIngestApis folder.

## Version

DataConnectorIngestApi components are available in API version 54.0 and later.

## Special Access Rules

You must have the CustomizeApplication user permissions to access the DataConnectorIngestApi type.

## Fields

| Field Name | Description |
| --- | --- |
| masterLabel | 
Field Type

string

Description

Required.

UI label of the Ingestion API Connector.



 |
| sourceName | 

Field Type

string

Description

Required.

Name of the Ingestion API Connector.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataConnectorIngestApi component.

<?xml version="1.0" encoding="UTF-8"?>
<DataConnectorIngestApi xmlns="http://soap.sforce.com/2006/04/metadata">
    <sourceName\>CONNECTOR NAME</sourceName\>
    <masterLabel\>CONNECTOR NAME</masterLabel\>
</DataConnectorIngestApi\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<DataConnectorIngestApi xmlns="http://soap.sforce.com/2006/04/metadata">
    <sourceName\>MyConnector</sourceName\>
    <masterLabel\>MyConnector</masterLabel\>
</DataConnectorIngestApi\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=dfb39b0446b34d31b8a26ae54148aa22185f271789dcd70a3c17b946be0f1f28 url=/legacydeveloper/current/en-us/api_meta/meta_dataconnectors3.md -->

# DataConnectorS3

Represents the connection information specific to Amazon S3.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

DataConnectorS3 components have the suffix s3DataConnector and are stored in the s3DataConnectors folder.

## Version

DataConnectorS3 components are available in API version 50.0 and later.

## Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| fileNameWildcard | string | Optional. File or Wildcard (\*) to be used when finding files. |
| importFromDirectory | string | Required. Path from the directory to where files are located. |
| masterLabel | string | Required. The UI name for the S3 data connector. |
| s3BucketName | string | Optional. The Amazon S3 Name of the Bucket. |

## Declarative Metadata Sample Definition

The following is an example of a DataConnectorS3 component.

    <?xml version="1.0" encoding="UTF-8"?>
    <DataConnectorS3 xmlns="http://soap.sforce.com/2006/04/metadata">
    <fileNameWildcard\>\*.csv</fileNameWildcard\>
    <importFromDirectory\>c360-subset-lheader/</importFromDirectory\>
    <masterLabel\>Person</masterLabel\>
    <s3BucketName\>bucketeer-aa32faea-8431-4635-8a1d-b323a2d66c7c</s3BucketName\>
    </DataConnectorS3\>

<!-- document id=1067a13c6acfd3531fd75d9018387de227d8ed5d0780009464f8e33026b1a1bb url=/legacydeveloper/current/en-us/api_meta/meta_datadotcomsettings.md -->

# DataDotComSettings

Represents the org's Data.com settings. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataDotComSettings values are stored in the DataDotCom.settings file in the settings folder.

## Version

DataDotComSettings components are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableAccountExportButtonOff | boolean | Indicates whether Account Export to Excel is enabled for Prospector (true) or not (false). Default value is false. |
| enableAccountImportButtonOff | boolean | Indicates whether Account Import to CRM is enabled for Prospector (true) or not (false). Default value is false. |
| enableAllowDupeContactFromLead | boolean | Indicates whether Prospector Lead Import Duplicate Check is enabled (true) or not (false). Default value is false. |
| enableAllowDupeLeadFromContact | boolean | Indicates whether Prospector Contact Import Duplicate Check is enabled (true) or not (false). Default value is false. |
| enableCleanUpgradeRequested | boolean | This field is no longer in use. |
| enableContactExportButtonOff | boolean | Indicates whether Contact Export to Excel is enabled for Prospector (true) or not (false). Default value is false. |
| enableContactImportButtonOff | boolean | Indicates whether Contact Import to CRM is enabled for Prospector (true) or not (false). Default value is false. |

## Declarative Metadata Sample Definition

The following is an example of a DataDotComSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<DataDotComSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableAccountExportButtonOff\>true</enableAccountExportButtonOff\>
	<enableAccountImportButtonOff\>true</enableAccountImportButtonOff\>
	<enableAllowDupeContactFromLead\>true</enableAllowDupeContactFromLead\>
	<enableAllowDupeLeadFromContact\>true</enableAllowDupeLeadFromContact\>
	<enableContactExportButtonOff\>true</enableContactExportButtonOff\>
	<enableContactImportButtonOff\>true</enableContactImportButtonOff\>
</DataDotComSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>DataDotCom</members\>
		<name\>Settings</name\>
	</types\>
	<version\>29.0</version\>
</Package\>

<!-- document id=68c01e8d76de218f13845c7d750cb9b2a153b5dab2b45cad8b590b03376c1eb0 url=/legacydeveloper/current/en-us/api_meta/meta_dataimportmanagementsettings.md -->

# DataImportManagementSettings

Represents an org's contact and leads import settings.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

DataImportManagementSettings values are stored in the DataImportManagement.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

DataImportManagementSettings components are available in API version 57.0 and later.

## Special Access Rules

DataImportManagementSettings is available when your org enables the DataImportManagement permission, which is only available for particular editions.

## Fields

| Field Name | Description |
| --- | --- |
| enableEasyImport | 
Field Type

boolean

Description

Indicates whether Basic Data Import is enabled (true) or not (false). When true, users are guided step by step to select how they want to import contacts and leads to Salesforce.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataImportManagementSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<DataImportManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
          <enableEasyImport\>true</enableEasyImport\>
</DataImportManagementSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
          <types\>
               <members\>DataImportManagement</members\>
               <name\>Settings</name\>
          </types\>
          <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=6ed5d9c7436ab52a9bdad7d6efa75e9dfba5e5cbb89c64b2666d9c1bd0f96b62 url=/legacydeveloper/current/en-us/api_meta/meta_datakitobjectdependency.md -->

# DataKitObjectDependency

Represents the dependency between two data kit objects. The object templates are added inside the data kit.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataKitObjectDependency components have the suffix .DataKitObjectDependency and are stored in the DataKitObjectDependency folder.

## Version

DataKitObjectDependency components are available in API version 65.0 and later.

## Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

## Fields

| Field Name | Description |
| --- | --- |
| dataPackageKitDef | 
Field Type

string

Description

Required. The ID of the linked DataPackageKitDefinition.



 |
| developerName | 

Field Type

string

Description

Required. The name of the DataKitObjectDependency. This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| masterLabel | 

Field Type

string

Description

Required. Label that identifies the data kit object dependency.



 |
| sourceObject | 

Field Type

string

Description

The source data kit object template that the target object depends on.



 |
| sourceObjectType | 

Field Type

string

Description

Required. The type of the source object referenced in the data kit. Valid values are:

- DataKitObjectTemplate
- DataSourceObject
- DataStreamTemplate
- DataSourceBundleDefinition
- MKtDataModelObject





 |
| targetObject | 

Field Type

string

Description

Required. The target data kit object template that depends on the source object.



 |

<!-- document id=303803d9abf96da2ee5782dcdcd4f5a3671b801fc8abd549fe5df375ba45e074 url=/legacydeveloper/current/en-us/api_meta/meta_datakitobjecttemplate.md -->

# DataKitObjectTemplate

Represents the object in Data Kit Object Template. These object templates are added inside the data kit.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataKitObjectTemplate components have the suffix .DataKitObjectTemplate and are stored in the DataKitObjectTemplate folder.

## Version

DataKitObjectTemplate components are available in API version 63.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| developerName | 
Field Type

string

Description

Required. Name of the data kit object template. This can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| entityPayload | 

Field Type

string

Description

A string-based JSON payload containing the metadata of a data kit component. The payload is templatized to enable variable substitution during the deployment process. Keep the compressed JSON payload under 100 KB. Data 360 automatically compresses the payload before storage. but, compression results vary depending on the structure of the data. A payload that’s under 100 KB before compression can exceed the limit after compression. If the compressed payload exceeds 100 KB, reduce the payload size or split the component.



 |
| masterLabel | 

Field Type

string

Description

Required. The label of the data kit object template.



 |
| parentDataPackageKitDefinitionName | 

Field Type

string

Description

Required. The linked data kit package definition in the data kit.



 |
| sourceObject | 

Field Type

string

Description

The developer name of the source object for the data kit object template.



 |
| sourceObjectType | 

Field Type

string

Description

Required. The object type of the metadata component in the data kit. Valid values are:

- MKT\_DATA\_TRANSFORM
- MKT\_DATA\_CONNECTION
- IDENTITY\_RESOLUTION
- DATA\_GRAPH
- EXT\_DATA\_SHARE
- SEMANTIC\_SEARCH
- DATA\_ACTION
- DATA\_ACTION\_TARGET
- MARKET\_SEGMENT
- DATA\_SPACE\_MEMBER
- INTERNAL\_DATA\_CONNECTOR
- MARKET\_SEGMENT\_ACTIVATION
- STREAMING\_APP\_AND\_INGESTION\_CONNECTOR
- ML\_CONFIGURED\_MODEL
- ACTIVATION\_TARGET
- SEMANTIC\_MODEL
- PERSONALIZATION\_RECOMMENDER
- PERSONALIZATION\_POINT
- PERSONALIZATION\_SCHEMA
- PERSONALIZATION\_OBJECTIVE
- ENGAGEMENT\_SIGNAL
- PERSONALIZATION\_BATCH\_DECISION
- MC\_CONNECTOR
- ML\_PREDICTION\_JOB
- ML\_RETRIEVER
- TUA\_TEMPLATED\_OBJECT
- IR\_RELATED\_LIST\_ENRICHMENT
- TAG\_METADATA
- DATA\_CLEAN\_ROOM\_PROVIDER
- IDP\_CONFIGURATION
- COPY\_FIELD\_ENRICHMENT
- DATA\_CUSTOM\_CODE
- ANALYTICS\_VISUALIZATION
- ANALYTICS\_DASHBOARD
- ANALYTICS\_WORKSPACE
- SECONDARY\_INDEX
- POLICY\_RULE\_DEFINITION\_METADATA
- POLICY\_RULE\_DEFINITION\_SET\_METADATA





 |
| templateVersion | 

Field Type

string

Description

The version number of the template.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataKitObjectTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<DataKitObjectTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
   <developerName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <entityPayload\>
      {
         "dataSpaceName": "default",
         "type": "DLO",
         "developerName": "DLO\_StaticCurrencyRates\_Home"
      }
   </entityPayload\>
   <masterLabel\>StaticCurrencyRates\_Home\_\_dll</masterLabel\>
   <parentDataPackageKitDefinitionName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <sourceObject\>0viSB00000JzG05YAF</sourceObject\>
   <sourceObjectType\>DataSpaceMember</sourceObjectType\>
   <templateVersion\>1</templateVersion\>
</DataKitObjectTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>StaticCurrencyRates\_Home</members\>
        <members\>StaticCurrencyRates\_Home1</members\>
        <name\>DataKitObjectTemplate</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=18f5d9539b044e8c54231e0892f57ce5710460a002b6d4c35ab54f4c929644ea url=/legacydeveloper/current/en-us/api_meta/meta_datamaskpolicy.md -->

# DataMaskPolicy

Represents a masking policy for use with Data Mask & Seed.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

Use this metadata type to deploy and manage masking policies as org metadata, enabling programmatic configuration without the Setup UI. Use this metadata type when:

- You want to version-control your policies, promote them through a release pipeline, or consistently copy the same set of policies across many orgs or sandboxes.
- You're running automated operations, such as CI or CD pipelines or agentic AI tools, that create and manage masking policies without the Setup UI.

Use the Data Mask & Seed Setup UI to set the scheduled start time (ScheduledStart), view when a policy last ran (LastRunDate), run masking jobs, and monitor masking jobs. These tasks aren't available by using Metadata API. The API manages the policy definition and run frequency. Use the Setup UI for scheduling, execution, and run history.

## Prerequisites

Before deploying DataMaskPolicy components, confirm these prerequisites.

- Salesforce CLI installed and authenticated to your org
- Familiarity with Metadata API, the sf deploy metadata CLI command, or both
- A target sandbox for testing
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    The Data Mask & Seed app is available for production orgs and sandboxes. Run masking jobs on sandboxes only, not in production orgs.
- The required permissions described in Special Access Rules
- API version 68.0 or later

## File Suffix and Directory Location

DataMaskPolicy components have the suffix .dataMaskPolicy and are stored in the dataMaskPolicies folder.

## Version

DataMaskPolicy components are available in API version 61.0 and later.

## Special Access Rules

Before deploying DataMaskPolicy components, your Salesforce admin must configure these permissions. If you don't have admin access, work with your admin.

**Production org requirements:**

- The org must have the Salesforce Data Mask license.

**User requirements:**

- The user must be assigned the DataMaskAndSeedUserPsl permission set license (PSL).
- The user must be assigned the DataMaskAndSeedUser permission set.
    - Assign the DataMaskAndSeedUserPsl PSL before assigning the DataMaskAndSeedUser permission set. The permission set requires the PSL to be in place first.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Server-side validation and access controls enforce all business rules across all access paths, including Metadata API.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Optional. A description of the masking policy.



 |
| label | 

Field Type

string

Description

Required. The master label for the masking policy.



 |
| locale | 

Field Type

DataMaskLocale (enumeration of type string)

Description

Optional. The locale to apply for generating locale-specific masking data. If a value is omitted, the policy’s default locale value is en\_US (U.S. English).

Valid values are:

- bg\_BG
- cs\_CZ
- da\_DK
- de\_DE
- el\_GR
- en\_AU
- en\_CA
- en\_GB
- en\_US
- es\_ES
- es\_MX
- et\_EE
- fa\_IR
- fi\_FI
- fr\_FR
- hi\_IN
- hr\_HR
- hu\_HU
- it\_IT
- ja\_JP
- ko\_KR
- lt\_LT
- lv\_LV
- ne\_NP
- nl\_NL
- no\_NO
- pl\_PL
- pt\_BR
- pt\_PT
- ro\_RO
- ru\_RU
- sl\_SI
- sv\_SE
- th\_TH
- tr\_TR
- uk\_UA
- zh\_CN
- zh\_TW





 |
| runFrequency | 

Field Type

DataMaskRunFrequency (enumeration of type string)

Description

Optional. The frequency at which the masking job runs. If a value is omitted, the policy has no scheduled run frequency and must be triggered manually from Setup or the Connect API.

Valid values are:

- once
- daily
- weekly
- monthly





 |
| runOnRefresh | 

Field Type

boolean

Description

Optional. Indicates whether or not the masking policy runs automatically when a sandbox is either created or refreshed.

Valid values are:

- true - masking policy runs automatically
- false - masking policy doesn't run automatically

The default value is false.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataMaskPolicy component.

<?xml version="1.0" encoding="UTF-8"?>
<DataMaskPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>Sample Data Mask Policy</label\>
    <description\>This policy executes weekly to mask standard fields.</description\>
    <runFrequency\>weekly</runFrequency\>
    <runOnRefresh\>true</runOnRefresh\>
</DataMaskPolicy\>

This example runs the masking policy automatically on sandbox refresh, so sandbox data is masked and free of personally identifiable information (PII) as soon as the sandbox is created or refreshed.

Include DataMaskPolicy components in your package.xml manifest file when deploying with the Salesforce CLI. This package.xml manifest deploys the Sample\_Data\_Mask\_Policy component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Sample\_Data\_Mask\_Policy</members\>
        <name\>DataMaskPolicy</name\>
    </types\>
    <version\>61.0</version\>
</Package\>

## Troubleshooting

Deploying a runOnRefresh policy to a production org

DataMaskPolicy components with runOnRefresh set to true deploy successfully to production orgs, but the masking job never runs in production. Masking executes only when a sandbox is created or refreshed. Production data is never masked. To run a masking job or set a recurring schedule, use a sandbox.

Missing permissions

If required permissions are missing, you'll receive an insufficient-access error, or the Data Mask management screens won't be available. Confirm that both the org and the user have the permissions listed in Special Access Rules.

Run frequency and scheduled start time

Valid values for runFrequency are once, daily, weekly, and monthly. A recurring frequency requires a scheduled start time to execute. Set the scheduled start time in the Data Mask & Seed Setup UI. The ScheduledStart field isn't configurable by using Metadata API. A recurring schedule runs only in a sandbox, not in a production org.

## Versioning and Compatibility

- DataMaskPolicy is available starting in API version 61.0. DataMaskSettings is available starting in API version 67.0. If your client uses an API version below the minimum required version for either type, that metadata type isn't visible. You can neither retrieve it nor deploy it.
- The two metadata types were introduced in different releases and work independently. If your use case requires masking policies that generate locale-specific masking data, API version 68.0 is required.
- If the production org's release doesn't include the metadata type, the deployment is rejected as an unknown or unsupported metadata type. Target an API version at or above the minimum required version, and confirm the org is on a release that supports the type.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [DataMaskSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datamasksettings.htm "Represents org-level setup (features and preferences) for use with Data Mask & Seed.")
- [Data Mask & Seed Release Notes](https://help.salesforce.com/s/articleView?id=release-notes.rn_data_mask_and_seed.htm&release=262&type=5&language=en_US)
- [_Salesforce Help_: Protect Sensitive Data with Data Mask & Seed](https://help.salesforce.com/s/articleView?id=platform.data_mask_and_seed.htm&type=5&language=en_US)

<!-- document id=aa61e6a4c020c09f39d9f1f47e2cf6759d9a08a8569f0e3703572f0e61197f46 url=/legacydeveloper/current/en-us/api_meta/meta_datamasksettings.md -->

# DataMaskSettings

Represents org-level setup (features and preferences) for use with Data Mask & Seed.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details.

Use DataMaskSettings to configure and deploy these settings and preferences as part of an automated org setup.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Each of the available Data Mask & Seed metadata types, DataMaskSettings and DataMaskPolicy, serves a different purpose and can be deployed independently of each other.

## Prerequisites

Before deploying DataMaskSettings components, confirm these prerequisites.

- Salesforce CLI installed and authenticated to your org
- Familiarity with Metadata API, the sf deploy metadata CLI command, or both
- A target sandbox for testing
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    The Data Mask & Seed app is available for production orgs and sandboxes. Run masking jobs on sandboxes only, not in production orgs.
- The required permissions described in Special Access Rules
- API version 67.0 or later

## File Suffix and Directory Location

DataMaskSettings values are stored in the DataMask.settings file in the settings folder. Unlike other metadata components, each settings type has exactly one .settings file.

## Version

DataMaskSettings components are available in API version 67.0 and later.

## Special Access Rules

Before deploying DataMaskSettings components, your Salesforce admin must configure these permissions. If you don't have admin access, work with your admin.

**Production org requirements:**

- The org must be licensed for Data Mask & Seed with the Salesforce Data Mask license.

**User requirements:**

- The user must be assigned the DataMaskAndSeedUserPsl permission set license (PSL).
- The user must be assigned the DataMaskAndSeedUser permission set.
    - Assign the DataMaskAndSeedUserPsl PSL before assigning the DataMaskAndSeedUser permission set. The permission set requires the PSL to be in place first.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Server-side validation and access controls enforce all business rules across all access paths, including Metadata API.

## Fields

| Field Name | Description |
| --- | --- |
| enableDataMaskGPTEnabled | 
Field Type

boolean

Description

Optional. Indicates whether the ability to use the Einstein tool to generate values for Data Mask & Seed custom libraries is turned on (true) or turned off (false) for the admin/developer. The default value is false. To turn on the user's ability to use the Einstein tool, set this field to true.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataMaskSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<DataMaskSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableDataMaskGPTEnabled\>true</enableDataMaskGPTEnabled\>
</DataMaskSettings\>

This example turns on the ability of the admin/developer to use the Einstein tool to generate values for Data Mask & Seed custom libraries.

Include DataMaskSettings components in your package.xml manifest file when deploying with the Salesforce CLI. This package.xml manifest deploys the DataMask component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>DataMask</members\>
        <name\>Settings</name\>
    </types\>
    <version\>67.0</version\>
</Package\>

## Troubleshooting

API version below 67.0

DataMaskSettings is invisible. Retrieve and deploy operations fail silently or return an unknown-type error.

Missing permissions

If required permissions are missing, you receive an insufficient-access error, or the Data Mask management screens aren't available. Confirm that both the org and the user have the permissions listed in Special Access Rules.

Permission set assigned before the PSL

Assigning the DataMaskAndSeedUser permission set fails without the required PSL already in place.

## Versioning and Compatibility

- DataMaskSettings is available starting in API version 67.0. DataMaskPolicy is available starting in API version 61.0. If your client uses an API version below the minimum required version for either type, that metadata type isn't visible. You can't retrieve it or deploy it.
- The two metadata types were introduced in different releases and work independently. If your use case requires only org-level feature settings and preferences for masking, API version 67.0 is sufficient.
- If the production org's release doesn't include the metadata type, the deployment is rejected as an unknown or unsupported metadata type. Target an API version at or above the minimum required version, and confirm that the org is on a release that supports the type.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [DataMaskPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datamaskpolicy.htm "Represents a masking policy for use with Data Mask & Seed.")
- [Data Mask & Seed Release Notes](https://help.salesforce.com/s/articleView?id=release-notes.rn_data_mask_and_seed.htm&release=262&type=5&language=en_US)
- [_Salesforce Help_: Protect Sensitive Data with Data Mask & Seed](https://help.salesforce.com/s/articleView?id=platform.data_mask_and_seed.htm&type=5&language=en_US)

<!-- document id=d56e053eb38a266d7b045cd92ba9473e892346e4ab55c7b90b0d8bb55298694c url=/legacydeveloper/current/en-us/api_meta/meta_dataobjectbuildorgtemplate.md -->

# DataObjectBuildOrgTemplate

Represents the derived object template used to define the structure and configuration of data objects in a build organization. The object templates are added inside the data kit to deploy metadata.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataObjectBuildOrgTemplate components have the suffix .DataObjectBuildOrgTemplate and are stored in the DataObjectBuildOrgTemplate folder.

## Version

DataObjectBuildOrgTemplate components are available in API version 63.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| developerName | 
Field Type

string

Description

Required. Name of the data object build org template. This name can contain only underscores and alphanumeric characters and must be unique in your org.



 |
| masterLabel | 

Field Type

string

Description

Required. The label of the data object build org template.



 |
| objectDevName | 

Field Type

string

Description

Required. The developer name of the object created from the objectPayload entity in the build org.



 |
| objectPayload | 

Field Type

string

Description

Required. The serialized metadata for the entity. The build organization deserializes this payload to create the underlying metadata components.



 |
| objectType | 

Field Type

string

Description

Required. The type of metadata entity associated with the template. Valid values are:

- DataGraph
- MktCalculatedInsightObject
- MktDataModelObject
- MktDataLakeObject





 |
| templateObject | 

Field Type

string

Description

Required. The name of the template associated with the data object build org template.



 |
| templateVersion | 

Field Type

string

Description

The version number of the data object build org template.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataObjectBuildOrgTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<DataKitObjectTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
   <developerName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <entityPayload\>
      {
         "dataSpaceName": "default",
         "type": "DLO",
         "developerName": "DLO\_StaticCurrencyRates\_Home"
      }
   </entityPayload\>
   <masterLabel\>StaticCurrencyRates\_Home\_\_dll</masterLabel\>
   <parentDataPackageKitDefinitionName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <sourceObject\>0viSB00000JzG05YAF</sourceObject\>
   <sourceObjectType\>DataSpaceMember</sourceObjectType\>
   <templateVersion\>1</templateVersion\>
</DataKitObjectTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>StaticCurrencyRates\_Home</members\>
        <members\>StaticCurrencyRates\_Home1</members\>
        <name\>DataKitObjectTemplate</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=f2e48d5c174d3e6b058bf22442a406504b34e88c47f52cb3c7104a7170545166 url=/legacydeveloper/current/en-us/api_meta/meta_dataobjectsearchindexconf.md -->

# DataObjectSearchIndexConf

Represents the source Data 360 data model object (DMO) for Search Answers and holds the search index that Search Answers uses when searching DMO records.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataObjectSearchIndexConf components have the suffix .dataObjectSearchIndexConf and are stored in the dataObjectSearchIndexConfs folder.

## Version

DataObjectSearchIndexConf components are available in API version 63.0 and later.

## Special Access Rules

To access this metadata type, you must have the Customize Application user permission. The Salesforce org must have a Data 360 license.

## Fields

| Field Name | Description |
| --- | --- |
| application | 
Field Type

string

Description

Required.

The name of the app that the Search Answers index is associated with.





 |
| channel | 

Field Type

string

Description

The search channel that the Search Answers configuration applies to.



 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the Search Answers configuration.





 |
| nameFieldReference | 

Field Type

string

Description

Required.

The name field of the DMO selected as a source for Search Answers.





 |
| objectReference | 

Field Type

string

Description

Required.

The DMO that the Search Answers configuration applies to.





 |
| retriever | 

Field Type

string

Description

The retriever that accesses the Search Answers indexed data.



 |
| searchIndex | 

Field Type

string

Description

Required.

The name of the search index mapped to the DMO.





 |

## Declarative Metadata Sample Definition

The following is an example of a DataObjectSearchIndexConf component.

<?xml version="1.0" encoding="UTF-8"?>
<DataObjectSearchIndexConf xmlns="http://soap.sforce.com/2006/04/metadata">
	<application\>SearchAnswers</application\>
	<channel\>SharedIndex</channel\>
	<masterLabel\>SearchAnswers</masterLabel\>
	<nameFieldReference\>Name\_\_c</nameFieldReference\>
	<objectReference\>Account\_\_dlm</objectReference\>
	<searchIndex\>searchAnswersIndex</searchIndex\>
</DataObjectSearchIndexConf\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
       <members\>\*</members\>
       <name\>DataObjectSearchIndexConf</name\>
   </types\>
   <version\>63.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=150419bf1eba37803b37042956867c5de487ff0cca1ce6b68febe7f5b2f03e20 url=/legacydeveloper/current/en-us/api_meta/meta_datapackagekitdefinition.md -->

# DataPackageKitDefinition

Represents the top-level data kit container definition. Content objects can be added after the data kit is defined.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataPackageKitDefinition components have the suffix .dataPackageKitDefinition and are stored in the dataPackageKitDefinitions folder.

## Version

DataPackageKitDefinition components are available in API version 53.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| dataKitType | 
Field Type

string

Description

The type of data kit created. Available in API version 63.0 and later. Valid values are:

- Default
- Sandbox





 |
| dataKitSource | 

Field Type

string

Description

The data source in the updated data kit. Available in API version 63.0 and later.



 |
| description | 

Field Type

string

Description

The description of the data kit.



 |
| developerName | 

Field Type

string

Description

Required. The name of the application. This name contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| isDeployed | 

Field Type

boolean

Description

Indicates whether the data kit content is deployed.



 |
| isEnabled | 

Field Type

boolean

Description

Indicates whether the data kit is enabled.



 |
| masterLabel | 

Field Type

string

Description

Required. Label that identifies the AI application throughout the Salesforce user interface.



 |
| **useDeterministicNaming** | 

Field Type

boolean

Description

Required. Indicates whether the data kit should use the deterministic naming feature. Available in API version 65.0 and later. Valid values are:

- True
- False





 |
| versionNumber | 

Field Type

double

Description

Auto incremented version number.



 |
| dataSpaceDefinitionDevName | 

Field Type

string

Description

Data space name used to create the data kit. Available in API version 61.0 and later.



 |
| deploymentOrder | 

Field Type

string

Description

Deployment order of components that are added to the data kit. Available in API version 61.0 and later.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataPackageKitDefinition component.

<DataPackageKitDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <developerName\>SalesforceCRM</developerName\>
    <isDeployed\>false</isDeployed\>
    <isEnabled\>false</isEnabled\>
    <masterLabel\>SalesforceCRM</masterLabel\>
    <versionNumber\>1.0</versionNumber\>
</DataPackageKitDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>SalesforceDataKit</fullName\>
    <types\>
        <members\>SalesforceCRM</members\>
        <name\>DataPackageKitDefinition</name\>
    </types\>
    <types\>
        <members\>Admin</members\>
        <name\>Profile</name\>
    </types\>
    <version\>53.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=fa21e2982426883eb4da8448025f283f9585a8d9fd0e4ed01b83bfeca019733e url=/legacydeveloper/current/en-us/api_meta/meta_datapackagekitobject.md -->

# DataPackageKitObject

Represents the object in Data Kit Content Object. These objects are added inside the data kit.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataPackageKitObject components have the suffix .DataPackageKitObject and are stored in the DataPackageKitObjects folder.

## Version

DataPackageKitDefinition components are available in API version 53.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| masterLabel | 
Field Type

string

Description

Required. Label that identifies the AI application throughout the Salesforce user interface.



 |
| parentDataPackageKitDefinitionName | 

Field Type

string

Description

Required. Name of the data kit definition



 |
| referenceObjectName | 

Field Type

string

Description

Required. The name of the data kit content.



 |
| referenceObjectType | 

Field Type

string

Description

Required. The type of the content object in the data kit.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataPackageKitDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<DataPackageKitObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>CRM</masterLabel\>
    <parentDataPackageKitDefinitionName\>CRM</parentDataPackageKitDefinitionName\>
    <referenceObjectName\>CRM</referenceObjectName\>
    <referenceObjectType\>DLO</referenceObjectType\>
</DataPackageKitObject\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>SalesforceDataKit</fullName\>
    <types\>
        <members\>CRM</members\>
        <name\>DataPackageKitObject</name\>
    </types\>
    <types\>
        <members\>Admin</members\>
        <name\>Profile</name\>
    </types\>
    <version\>53.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=1d80bad5814e663834f8fcd0433aba6f0e2b84ecffd7a57818c66bd5257ab063 url=/legacydeveloper/current/en-us/api_meta/meta_datasource.md -->

# DataSource

Used to represent the system where the data was sourced. This object is always needed when creating a Data Stream Definition.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

DataSource components have the suffix dataSource and are stored in the mktDataSources folder.

## Version

DataSource components are available in API version 50.0 and later.

## Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| masterLabel | string | Required. The UI name for the Data Source. |
| prefix | string | Required. Prefix for the Data Source to make Data Source Object records unique. |

<!-- document id=1d310784a286fd03b7f9bc192dd11f0014f4f168a156cbb9c18bd972d4b41e63 url=/legacydeveloper/current/en-us/api_meta/meta_datasourcebundledefinition.md -->

# DataSourceBundleDefinition

Represents the bundle of streams that a user adds to a data kit.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataSourceBundleDefinition components have the suffix .dataSourceBundleDefinition and are stored in the dataSourceBundleDefinitions folder.

## Version

DataSourceBundleDefinition components are available in API version 52.0 and later.

## Special Access Rules

You need Data 360 permission to access this object.

## Fields

| Field Name | Description |
| --- | --- |
| dataPlatform | 
Field Type

string

Description

Required. Indicates the connector type that the streams in the bundle belong to.



 |
| description | 

Field Type

string

Description

A description of the associated data source bundle. This field is available in API version 53.0 and later.



 |
| icon | 

Field Type

string

Description

The icon used in the deployment flow. This field is available in API version 53.0 and later.



 |
| isMultiDeploymentSupported | 

Field Type

boolean

Description

Indicates if the bundle can be deployed multiple times or not. Default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. Indicates the name of the bundle.



 |
| bundleVersion | 

Field Type

int

Description

Indicates the version of the bundle. This field is available in API version 63.0 and later.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataSourceBundleDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<DataSourceBundleDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataPlatform\>Salesforce\_Sales\_and\_Service\_Cloud</dataPlatform\>
    <isMultiDeploymentSupported\>true</isMultiDeploymentSupported\>
    <bundleVersion\>1</bundleVersion\> 
    <masterLabel\>b2</masterLabel\>
</DataSourceBundleDefinition\>

The following is an example package.xml that references the previous definition.

<types\>
      <members\>b2</members\>
      <name\>DataSourceBundleDefinition</name\>
</types\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=07ee93b47d06fb3dee2ead984c05490a32450226ccc3d4619e2de02ee1699da9 url=/legacydeveloper/current/en-us/api_meta/meta_datasourcefield.md -->

# DataSourceField

Represents the details of a data source field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataSourceField components have the suffix .dataSourceField and are stored in the dataSourceFields folder.

## Version

DataSourceField components are available in API version 52.0 and later.

## Special Access Rules

You need the Salesforce Customize Application permission to access this metadata type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d351181e116">Field Name</th>

              <th class="featureTableHeader  " id="d351181e119">Field Type</th>

              <th class="featureTableHeader  " id="d351181e122">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">datatype</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">string</td>

              <td class="entry" headers="d351181e122" data-title="Description">Required. Indicates the data type of the field: text, number, or date.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">dateFormat</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">string</td>

              <td class="entry" headers="d351181e122" data-title="Description">The date format of date, time, date/time fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname"><samp class="codeph nolang">definitionCreationType</samp></span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">DefinitionCreationType (enumeration of type string)</td>

              <td class="entry" headers="d351181e122" data-title="Description">Describes whether this object was added by the user or as part of a standard
                taxonomy. Available in API version 62.0 and later. Valid values are: <a name="ul_c2f_12c_t2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_c2f_12c_t2c">
                  <li class="li">
                    <samp class="codeph nolang">Activation_Audience</samp> (Reserved for
                    internal use only)
                  </li>

                  <li class="li"><samp class="codeph nolang">ADG</samp></li>

                  <li class="li">Activation_Audience. Available in API version 63.0 and later.</li>

                  <li class="li"><samp class="codeph nolang">Bridge</samp></li>

                  <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                  <li class="li"><samp class="codeph nolang">CG_Audience</samp></li>

                  <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                  <li class="li"><samp class="codeph nolang">Curated</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom</samp></li>

                  <li class="li"><samp class="codeph nolang">Derived</samp></li>

                  <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                  <li class="li"><samp class="codeph nolang">External</samp></li>

                  <li class="li"><samp class="codeph nolang">Ml_Prediction</samp></li>

                  <li class="li"><samp class="codeph nolang">Segment_Membership</samp></li>

                  <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                  <li class="li"><samp class="codeph nolang">Standard</samp></li>

                  <li class="li"><samp class="codeph nolang">System</samp></li>

                  <li class="li"><samp class="codeph nolang">Transform</samp></li>

                  <li class="li"><samp class="codeph nolang">Vector_Embedding </samp></li>

                </ul>
                <p class="p">Valid values available in API version 67.0 and later are: </p>
                <a name="ul_dsf_67_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_dsf_67_tjc">
                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                  <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                  <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">externalDataType</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">string</td>

              <td class="entry" headers="d351181e122" data-title="Description">The type of data in the external system. Available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">externalName</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">string</td>

              <td class="entry" headers="d351181e122" data-title="Description">Required. Name of the object in the external system. This is different from the
                developer name.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">fieldFormula</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">string</td>

              <td class="entry" headers="d351181e122" data-title="Description">Used for formulas.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">isDataRequired</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d351181e122" data-title="Description">If <samp class="codeph nolang">true</samp>, data is required. Default value
                is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">isEventDate</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d351181e122" data-title="Description">If <samp class="codeph nolang">true</samp>, an event date is required.
                Default value is <samp class="codeph nolang">false</samp>. Available in API
                version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">isFormula</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d351181e122" data-title="Description">If <samp class="codeph nolang">true</samp>, a formula is required. Default
                value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">isRecordModified</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d351181e122" data-title="Description">If <samp class="codeph nolang">true</samp>, the system tracks the
                modification date of the record. Default value is <samp class="codeph nolang">false</samp>. Available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">keyQualifierName</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">string</td>

              <td class="entry" headers="d351181e122" data-title="Description">
                <p dir="ltr" class="p">Contains the developer name of the <samp class="codeph nolang">keyQualifier</samp> field. Available in API version 62.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">length</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">int</td>

              <td class="entry" headers="d351181e122" data-title="Description">Length of a string column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">string</td>

              <td class="entry" headers="d351181e122" data-title="Description">Required. Field label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">precision</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">int</td>

              <td class="entry" headers="d351181e122" data-title="Description">The total number of digits in a number including decimal points. Used for
                currency and for numeric accuracy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">primaryIndexOrder</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">int</td>

              <td class="entry" headers="d351181e122" data-title="Description">If supplied, indicates that this field is part of the primary key. The number
                value indicates the order of attributes if it’s a compound primary key. A missing
                value means that this field isn’t part of the primary key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">scale</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">int</td>

              <td class="entry" headers="d351181e122" data-title="Description">The number of digits to the right of the decimal point. Used for currency and
                for numeric accuracy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">sequence</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">int</td>

              <td class="entry" headers="d351181e122" data-title="Description">Required. The sequence of this source schema.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">srcKeyQualifier</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">string</td>

              <td class="entry" headers="d351181e122" data-title="Description">Contains a reference to the source key qualifier record. The source key is the
                MktDataLakeSrcKeyQualifer metadata type. Available in API version 55.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">usageTag</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">usageTag (enumeration of type string)</td>

              <td class="entry" headers="d351181e122" data-title="Description">Indicates if the field is a key qualifier field. Available in API version 55.0
                and later.<p class="p">Values are:</p>
                <a name="ul_drn_mzg_ncc"><!-- --></a>
                <ul class="ul bulletList" id="ul_drn_mzg_ncc">
                  <li class="li">
                    <samp class="codeph nolang">KEY_QUALIFIER</samp>—The field is used as a key
                    qualifier field.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NONE</samp>—The field isn’t used as a key
                    qualifier field.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d351181e116" data-title="Field Name"><span class="keyword parmname">versionNumber</span></td>

              <td class="entry" headers="d351181e119" data-title="Field Type">double</td>

              <td class="entry" headers="d351181e122" data-title="Description">Required. The version of the data source object.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This is an example of a DataSourceObject component and its fields. You can retrieve the DataSourceField component only through its parent object, DataSourceObject.

<DataSourceObject xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <dataSource\>test1108</dataSource\>
    <dataSourceFields\>
        <fullName\>DOB</fullName\>
        <datatype\>D</datatype\>
        <externalName\>DOB</externalName\>
        <isDataRequired\>false</isDataRequired\>
        <masterLabel\>DOB</masterLabel\>
        <sequence xsi:nil="true"/>
        <versionNumber xsi:nil="true"/>
    </dataSourceFields\>
    <externalRecordIdentifier\>individuals\_20200125\_000000\_csv</externalRecordIdentifier\>
    <masterLabel\>test1108</masterLabel\>
    <objectType\>Object</objectType\>
</DataSourceObject\>

The following is an example package.xml that references the previous definition.

<types\>
        <members\>test1108</members\>
        <name\>DataSource</name\>
    </types\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=6cfab3babd62631fa15ec1e91ec55c294d2627ce115d402162bdd9b89df8a669 url=/legacydeveloper/current/en-us/api_meta/meta_datasourceobject.md -->

# DataSourceObject

Represents the object from where the data was sourced.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataSourceObject components have the suffix dataSourceObject and are stored in the mktDataSourceObjects folder.

## Version

DataSourceObject components are available in API version 50.0 and later.

## Special Access Rules

You need the Salesforce Customize Application permission to access this metadata type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d352986e117">Field Name</th>

              <th class="featureTableHeader  " id="d352986e120">Field Type</th>

              <th class="featureTableHeader  " id="d352986e123">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">accelerationEnabled</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">AccelerationEnabled (enumeration of type string)</td>

              <td class="entry" headers="d352986e123" data-title="Description">Acceleration of data stream processing. Available in API version 63.0 and
                later. Possible values are: <a name="ul_rfg_qw4_lfc"><!-- --></a>
                <ul class="ul bulletList" id="ul_rfg_qw4_lfc">
                  <li class="li"><samp class="codeph nolang">Yes</samp></li>

                  <li class="li"><samp class="codeph nolang">No</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">additionalDLOInfoJson</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">Additional information about the Directory Table data lake object (DLO), such
                as the directory path and file pattern.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">creationType</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">Indicates whether this object was added by the user or as part of a standard
                taxonomy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">dataConnection</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">The source data connector for the Directory Table DLO.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">dataSource</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">Required. The system where the data was sourced.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">dataSourceFields</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datasourcefield.htm" title="Represents the details of a data source field.">DataSourceField[]</a></td>

              <td class="entry" headers="d352986e123" data-title="Description">An array of data source fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">dmoDeveloperName</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">The developer name of the Directory Table data model object (DMO).</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">dmoLabel</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">The UI name of the Directory Table DMO.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">externalDatabaseName</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">The name of the external database for the data source object. Available in API
                version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">externalObjectName</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">The external data source object. Available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">externalRecordIdentifier</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">The identifier for the data source.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">externalSchemaName</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">The name of the schema within the external database. Available in API version
                63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">Required. The UI name for the data source object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">objectCategory</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">The category of the data source object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">objectType</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">DataObjectType (enumeration of type string)</td>

              <td class="entry" headers="d352986e123" data-title="Description">The object type. Possible values are: <a name="ul_z5h_djs_lfc"><!-- --></a>
                <ul class="ul bulletList" id="ul_z5h_djs_lfc">
                  <li class="li">API</li>

                  <li class="li">Object</li>

                  <li class="li">Table</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">sourceObject</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">string</td>

              <td class="entry" headers="d352986e123" data-title="Description">The developer name of the source object for the data source object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">storageType </span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">StorageType (enumeration of type string)</td>

              <td class="entry" headers="d352986e123" data-title="Description">The type of storage used for data source object. Available in API version 63.0
                and later. Possible values are: <a name="ul_ind_y3s_lfc"><!-- --></a>
                <ul class="ul bulletList" id="ul_ind_y3s_lfc">
                  <li class="li">External</li>

                  <li class="li">Local</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d352986e117" data-title="Field Name"><span class="keyword parmname">templateVersion</span></td>

              <td class="entry" headers="d352986e120" data-title="Field Type">int</td>

              <td class="entry" headers="d352986e123" data-title="Description">The version number of the data source object.</td>

            </tr>

          </tbody>

        </table>

<!-- document id=428de46f631c2d9eb21217953e97d7d3da8aaedeeff3afeb59afc93e9c546ed7 url=/legacydeveloper/current/en-us/api_meta/meta_datasourcetenant.md -->

# DataSourceTenant

For internal use only.

<!-- document id=3f28fe336f0302780c588631a3ad85ba131804d26be5cec01361614cd90ca4d9 url=/legacydeveloper/current/en-us/api_meta/meta_datasrcdatamodelfieldmap.md -->

# DataSrcDataModelFieldMap

Represents the mappings between source data lake object (DLO) fields and target data model object (DMO) fields.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataSrcDataModelFieldMap components have the suffix .dataSrcDataModelFieldMap and are stored in the dataSrcDataModelFieldMaps folder.

## Version

DataSrcDataModelFieldMap components are available in API version 53.0 and later.

## Special Access Rules

You need Data 360 permissions to access this object.

## Fields

| Field Name | Description |
| --- | --- |
| filterApplied | 
Field Type

boolean

Description

Indicates whether a filter is applied to a DLO-to-DMO field mapping (true) or not (false).

This field corresponds to whether [a DLO filter is applied in the Data Spaces tab](https://help.salesforce.com/s/articleView?id=data.c360_a_add_filters_to_a_data_object.htm&type=5&language=en_US) in the UI. Available in API version 60.0 and later.



 |
| filterOperationType | 

Field Type

string

Description

Required when filterApplied is true. The comparison operator used when filtering the DLO-to-DMO field mapping.

This field corresponds to the operation type of [a DLO filter applied in the Data Spaces tab](https://help.salesforce.com/s/articleView?id=data.c360_a_add_filters_to_a_data_object.htm&type=5&language=en_US) in the UI. Available in API version 60.0 and later.



 |
| filterValue | 

Field Type

string

Description

Required when filterApplied is true. The value used for filtering the DLO-to-DMO field mapping.

This field corresponds to the value of [a DLO filter applied in the Data Spaces tab](https://help.salesforce.com/s/articleView?id=data.c360_a_add_filters_to_a_data_object.htm&type=5&language=en_US) in the UI. Available in API version 60.0 and later.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for DataSrcDataModelFieldMap, which is defined when the DataSrcDataModelFieldMap is created.



 |
| sourceField | 

Field Type

string

Description

Required. The developer name of the DLO field.



 |
| targetField | 

Field Type

string

Description

Required. The developer name of the DMO field.



 |
| templateVersion | 

Field Type

int

Description

The version number of the field mapping template. Available in API version 61.0 and later.



 |
| versionNumber | 

Field Type

double

Description

Required. The version number of the DataSrcDataModelFieldMap.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataSrcDataModelFieldMap component.

<?xml version="1.0" encoding="UTF-8"?>
<DataSrcDataModelFieldMap xmlns="http://soap.sforce.com/2006/04/metadata">
    <filterApplied\>true</filterApplied\>
    <filterOperationType\>equals</filterOperationType\>
    <filterValue\>Active</filtervalue\>
    <masterLabel\>DataSrcDataModel26</masterLabel\>
    <sourceField\>Account1.LastModifiedDate\_\_c</sourceField\>
    <targetField\>ssot\_\_Account\_\_dlm.ssot\_\_LastModifiedDate\_\_c</targetField\>
    <tepmlateVersion\>2</templateVersion\>
    <versionNumber\>1.0</versionNumber\>
</DataSrcDataModelFieldMap\>

The following is an example package.xml that references the previous definition.

<types\>
        <members\>DataSrcDataModel26</members\>
        <name\>DataSrcDataModelFieldMap</name\>
</types\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=f1e54187713f4b75b97e26f56b30b92c81f6cb11194e691919c4011f7c555c65 url=/legacydeveloper/current/en-us/api_meta/meta_datastreamdefinition.md -->

# DataStreamDefinition

Contains data ingestion information such as connection, API, and file retrieval settings.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

DataStreamDefinition components have the suffix dataStreamDefinition and are stored in the dataStreamDefinitions folder.

## Version

DataStreamDefinition components are available in API version 50.0 and later.

## Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d355156e96">Field Name</th>

              <th class="featureTableHeader  " id="d355156e99">Field Type</th>

              <th class="featureTableHeader  " id="d355156e102">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">areHeadersIncludedInFile</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">boolean</td>

              <td class="entry" headers="d355156e102" data-title="Description">If true, headers are included in the file if this is a single file stream.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">bulkIngest</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">boolean</td>

              <td class="entry" headers="d355156e102" data-title="Description">If true, files are aggregated before data is ingested if the file names contain a
                wildcard. For example, <span class="ph filepath">profiles*.csv</span>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">definitionCreationType</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Required. Enum tracks the source of an object or field creation. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Custom</samp></li>

                  <li class="li"><samp class="codeph nolang">Standard</samp></li>

                </ul>
                <p class="p">Valid values available in API version 62.0 and later are: </p>
                <a name="ul_qzm_5zd_t2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_qzm_5zd_t2c">
                  <li class="li">
                    <samp class="codeph nolang">ADG</samp>
                  </li>

                  <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                  <li class="li"><samp class="codeph nolang">CG_Audience</samp></li>

                  <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                  <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                  <li class="li"><samp class="codeph nolang">External</samp></li>

                  <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                  <li class="li"><samp class="codeph nolang">Transform</samp></li>

                  <li class="li"><samp class="codeph nolang">Vector_Embedding </samp></li>

                </ul>
                <p class="p">Valid values available in API version 67.0 and later are: </p>
                <a name="ul_tbp_ls3_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_tbp_ls3_tjc">
                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                  <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                  <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">dataConnector</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Required. Describe whether this data stream definition was created by a customer or by
                an internal system.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">dataConnectorType</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">DataConnectorType (enumeration of type string)</td>

              <td class="entry" headers="d355156e102" data-title="Description">The ingestion data source. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ACCOUNTENGAGEMENT</samp></li>

                  <li class="li"><samp class="codeph nolang">AwsS3</samp></li>

                  <li class="li"><samp class="codeph nolang">AzureBlob</samp></li>

                  <li class="li"><samp class="codeph nolang">BIG_QUERY</samp></li>

                  <li class="li"><samp class="codeph nolang">CuratedEntity</samp></li>

                  <li class="li"><samp class="codeph nolang">DataCloud</samp></li>

                  <li class="li"><samp class="codeph nolang">ExternalPlatform</samp></li>

                  <li class="li"><samp class="codeph nolang">GoogleCloudStorage</samp></li>

                  <li class="li"><samp class="codeph nolang">IngestApi</samp></li>

                  <li class="li"><samp class="codeph nolang">REDSHIFT</samp></li>

                  <li class="li"><samp class="codeph nolang">SalesforceCommerceCloud</samp></li>

                  <li class="li"><samp class="codeph nolang">SalesforceDotCom</samp></li>

                  <li class="li"><samp class="codeph nolang">SalesforceInteractionStudio</samp></li>

                  <li class="li"><samp class="codeph nolang">SalesforceMarketingCloud</samp></li>

                  <li class="li"><samp class="codeph nolang">SFTP</samp></li>

                  <li class="li"><samp class="codeph nolang">Snowflake</samp></li>

                  <li class="li"><samp class="codeph nolang">StreamingApp</samp></li>

                  <li class="li"><samp class="codeph nolang">UPLOAD</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">dataExtensionIdentifier</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">For a Marketing Cloud data extension, the unique identifier.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">dataExtractField</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Name of the transport field that’s used when the extract method is CDC.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">dataExtractMethods</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">DataImportDataExtractMethods (enumeration of type string)</td>

              <td class="entry" headers="d355156e102" data-title="Description">Describes how to identify the data to be extracted. Valid values include: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">DATETIME_CDC</samp></li>

                  <li class="li"><samp class="codeph nolang">FULL_REFRESH</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMERIC_CDC</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">BINARY_CDC</samp> (reserved for future use)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">dataPlatDataSetBundle</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Identifies which data set bundle this definition was created from. Useful in cases
                where the same item can be configured across data connections.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">dataPlatformDataSet</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">The description is provided by the developer.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">dataPlatformDataSetItemName</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Name of the Data Platform Set Item.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">dataSource</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Required. A reference to the data source from which the data originated. This is
                usually the API name or a unique system identifier, such as the enterprise ID (EID) of the
                customer in the format <samp class="codeph nolang">MC_&lt;EID&gt;</samp>. Example: <samp class="codeph nolang">MCEnterprise</samp> or <samp class="codeph nolang">MC_12345</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Required. A description of the data stream definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">fileNameWildcard</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">File or wildcard (*) used when finding files.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">internalOrganization</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">The name of the internal organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">isLimitedToNewFiles</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">boolean</td>

              <td class="entry" headers="d355156e102" data-title="Description">If true, file retrieval is limited to new files.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">isMissingFileFailure</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">boolean</td>

              <td class="entry" headers="d355156e102" data-title="Description">If true, treat the case of missing files as a failure.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Required. UI label for this data stream definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">mktDataLakeObject</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Required. Reference to the landing entity (target) where data will be stored.</td>

            </tr>

            <tr>
              <td class="entry" headers="d355156e96" data-title="Field Name"><span class="keyword parmname">mktDataTranObject</span></td>

              <td class="entry" headers="d355156e99" data-title="Field Type">string</td>

              <td class="entry" headers="d355156e102" data-title="Description">Reference to the object that’s used to transport information from the source to a
                landing entity (target).</td>

            </tr>

          </tbody>

        </table>

<!-- document id=22237ba2c1760ba88b4dfdba3c97cee8364f4afea72b85f627029598c55dd41f url=/legacydeveloper/current/en-us/api_meta/meta_datastreamtemplate.md -->

# DataStreamTemplate

Represents the data stream that a user adds to a data kit.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

DataStreamTemplate components have the suffix .dataStreamTemplate and are stored in the dataStreamTemplates folder.

## Version

DataStreamTemplate components are available in API version 53.0 and later.

## Special Access Rules

You need the Salesforce Customize Application permission to access this metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| dataConnectionSourceParameters | 
Field Type

DataConnectionParamTmpl\[\]

Description

Input representation for the data connection source parameters.



 |
| dataSourceBundleDefinition | 

Field Type

string

Description

Required. Reference to the bundle to which this template belongs.



 |
| dataSourceObject | 

Field Type

string

Description

Required. Reference to the Data Source Objects (DSOs). A DSO represents the object from where the data was sourced.



 |
| filterCriteria | 

Field Type

string

Description

Filter applied to the data stream before the information is sent to Data Cloud.



 |
| fullRefreshIntervalDays | 

Field Type

FullRefreshIntervalDays (enumeration of type string)

Description

The interval when Data 360 performs a full refresh of the data stream. Available in API version 67.0 and later. Possible values are:

- NONE
- DAYS\_10
- DAYS\_25
- DAYS\_50





 |
| masterLabel | 

Field Type

string

Description

Required. Name assigned to the data stream template.



 |
| objectCategory | 

Field Type

string

Description

Required. Category of the Data Model Object (DMO).



 |
| refreshDayOfMonth | 

Field Type

int

Description

The duration of the day of the month after which the data stream must be refreshed.



 |
| refreshDayOfWeek | 

Field Type

int

Description

The duration of the day of the week after which the data stream must be refreshed.



 |
| refreshFrequency | 

Field Type

DataImportRefreshFrequency (enumeration of type string)

Description

The frequency with which the datastream must be refreshed. Possible values are:

- Batch
- NONE
- MINUTES\_15
- MINUTES\_30
- MINUTES\_5
- HOURLY
- DAILY
- WEEKLY
- MONTHLY
- NOT\_APPLICABLE
- STREAMING

Possible values available in API version 64.0 and later are:

- EVERY\_12\_HOURS
- EVERY\_4\_HOURS





 |
| refreshHours | 

Field Type

string

Description

The duration after which the datastream must be refreshed.



 |
| refreshMode | 

Field Type

DataImportRefreshMode (enumeration of type string)

Description

The mode of refresh. Possible values are:

- FULL\_REFRESH
- UPSERT
- INCREMENTAL
- REPLACE
- NEAR\_REAL\_TIME\_INCREMENTAL
- NOT\_APPLICABLE
- PARTIAL\_UPDATE
- STREAMING





 |
| refreshStartDate | 

Field Type

date

Description

The date to retrieve data based on the refresh frequency data. Available in API version 62.0 and later.



 |
| sourceObjectName | 

Field Type

string

Description

The name of the source object from which data is streamed. Available in API version 62.0 and later.



 |
| streamType | 

Field Type

StreamType (enumeration of type string)

Description

The type of data stream. Available in API version 62.0 and later. Possible values are:

- DIRECT\_ACCESS
- DIRECT\_ACCESS\_ACCELERATED
- INGEST





 |
| streamingAppDataConnectorType | 

Field Type

streamingAppDataConnectorType (enumeration of type string)

Description

The connector app for data streaming. Available in API version 63.0 and later. Possible values are:

- MobileApp
- WebApp





 |
| templateVersion | 

Field Type

int

Description

The version number of the template. Available in API version 62.0 and later.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataStreamTemplate component.

<DataStreamTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataSourceBundleDefinition\>b2</dataSourceBundleDefinition\>
    <dataSourceObject\>sd3ds</dataSourceObject\>
    <masterLabel\>b2</masterLabel\>
    <objectCategory\>Profile</objectCategory\>
</DataStreamTemplate\>

The following is an example package.xml that references the previous definition.

 <types\>
        <members\>ssd3s</members\>
        <name\>DataStreamTemplate</name\>
    </types\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ba37686be9254363e71e5dc890ac2816bb48a75f516bf34a81db6d982a4f625a url=/legacydeveloper/current/en-us/api_meta/meta_dataweaveresource.md -->

# DataWeaveResource

Represents the DataWeaveScriptResource class that is generated for all DataWeave scripts. DataWeave scripts can be directly invoked from Apex.

## Parent Type

This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

## File Suffix and Directory Location

DataWeaveResource components have the suffix .dwl and are stored in the dw folder.

## Version

DataWeaveResource components are available in API version 58.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| apiVersion | 
Field Type

double

Description

Required.

The API version for this component.



 |
| isGlobal | 

Field Type

boolean

Description

When set to true, the generated DataWeaveScriptResource class is global.



 |
| isProtected | 

Field Type

boolean

Description

Not used.



 |

## Declarative Metadata Sample Definition

The following is an example of a DataWeaveResource component.

csvToContacts.dwl

%dw 2.0
input records application/csv
output application/apex
---
records map(record) -> {
 FirstName: record.first\_name,
 LastName: record.last\_name,
 Email: record.email
} as Object {class: "Contact"}

csvToContacts.dwl-meta.xml

<?xml version="1.0" encoding="UTF-8"?>
<DataWeaveResource xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion\>58.0</apiVersion\>
    <isGlobal\>true</isGlobal\>
</DataWeaveResource\>

The following is an example package.xml that references the csvToContacts definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
      xmlns="http://soap.sforce.com/2006/04/metadata">
      <types\>
            <members\>csvToContacts</members\>
            <name\>DataWeaveResource</name\>
      </types\>
      <version\>58.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ad7b682da7e3c8c4026b5cc93a937c12d432ce34643e92e73a79aa5bda7dd287 url=/legacydeveloper/current/en-us/api_meta/meta_debuggingheader.md -->

# DebuggingHeader

Specifies that the deployment result contains the debug log output, and specifies the level of detail included in the log. The debug log contains the output of Apex tests that are executed as part of a deployment.

## Version

This header is available in all API versions.

## Supported Calls

[deploy()](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_deploy.htm)

## Fields

### categories

- **Type**: [LogInfo](#meta_debuggingheader_loginfo)\[\]
- **Description**: A list of log categories with their associated log levels.

### debugLevel

- **Type**: LogType ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: Deprecated. This field is provided only for backward compatibility. If you provide values for both debugLevel and categories, the categories value is used.
    
    The debugLevel field specifies the type of information returned in the debug log. The values are listed from the least amount of information returned to the most information returned. Valid values include:
    
    - None
    - Debugonly
    - Db
    - Profiling
    - Callout
    - Detail

## LogInfo

Specifies the type and amount of information to be returned in the debug log. The categories field takes a list of these objects. LogInfo is a mapping of category to level.

### category

- **Type**: LogCategory
- **Description**: Specify the type of information returned in the debug log. Valid values are:
    - Db
    - Workflow
    - Validation
    - Callout
    - Apex\_code
    - Apex\_profiling
    - Visualforce
    - System
    - All

### level

- **Type**: LogCategoryLevel
- **Description**: Specifies the level of detail returned in the debug log.
    
    Valid log levels are (listed from lowest to highest):
    
    - NONE ()
    - ERROR ()
    - WARN ()
    - INFO ()
    - DEBUG ()
    - FINE ()
    - FINER ()
    - FINEST ()

## Sample Code—Java

Add the DebuggingHeader to the metadata connection before you perform the deploy() call as follows.

LogInfo\[\] logs = new LogInfo\[1\];
logs\[0\] = new LogInfo();
logs\[0\].setCategory(LogCategory.Apex\_code);
logs\[0\].setLevel(LogCategoryLevel.Fine);
metadataConnection.setDebuggingHeader(logs);

The result of the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_deploy.htm) call is obtained by calling [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_checkdeploystatus.htm). After the deployment finishes, and if tests were run, the response of checkDeployStatus() contains the debug log output in the debugLog field of a DebuggingInfo output header.

<!-- document id=b021f6cebef6db2810ff75465a67ce9229eb94a9a5ac06ae993f89eec6ccd58d url=/legacydeveloper/current/en-us/api_meta/meta_debuglevel.md -->

# DebugLevel

Represents a set of log category levels to assign to a TraceFlag object. Multiple trace flags can use a debug level.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DebugLevel components have the suffix .debugLevel and are stored in the debugLevels folder.

## Version

The DebugLevel metadata type is available in API version 68.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <tbody class="tbody">
            <tr>
              <td class="entry"><strong class="ph b">Name</strong></td>

              <td class="entry"><strong class="ph b">Type</strong></td>

              <td class="entry"><strong class="ph b">Description</strong></td>

            </tr>

            <tr>
              <td class="entry">apexCode</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category level for Apex code. Includes information about Apex
                code. Can also include log messages generated by data manipulation language (DML)
                statements, inline SOQL or SOSL queries, the start and completion of triggers, the
                start and completion of test methods, and so on. The following are valid values. <ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">apexProfiling</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category level for profiling information. Includes cumulative
                profiling information, such as the limits for your namespace, the number of emails
                sent, and so on. The following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">callout</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category level for callouts. Includes the request-response
                XML that the server is sending and receiving from an external Web service. The
                request-response XML is useful when debugging issues related to SOAP API calls. The
                following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">database</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category for database activity. Includes information about
                database activity, including every DML statement or inline SOQL or SOSL query. The
                following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">dataAccess</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">The log category level for rules and policy information for objects accessed
                from the UI, which can be used to determine why an object isn’t accessible.The
                following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">label</td>

              <td class="entry"><samp class="codeph ">string</samp></td>

              <td class="entry">Required. The name for the debug level. Also displays in the Developer Console
                and in Setup. </td>

            </tr>

            <tr>
              <td class="entry">nba</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category level for Einstein Next Best Action activity,
                including strategy execution details from Strategy Builder. The following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">system</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category level for calls to all system methods, such as the
                <samp class="codeph ">System.debug</samp> method. The following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">validation</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category level for validation rules. Includes information
                about validation rules, such as the name of the rule, or whether the rule evaluated
                <samp class="codeph ">true</samp> or <samp class="codeph ">false</samp>. The following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">visualforce</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category level for Visualforce. Includes information about
                Visualforce events, including serialization and deserialization of the view state or
                the evaluation of a formula field in a Visualforce page. The following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">wave</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category level for CRM Analytics. Includes information such
                as template processing errors and rules execution summaries. The following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry">workflow</td>

              <td class="entry">
                <samp class="codeph ">ApexLogLevel </samp>(enumeration of type
                <samp class="codeph ">string</samp>)
              </td>

              <td class="entry">Required. The log category level for workflow rules. Includes information for
                workflow rules, such as the rule name and the actions taken. The following are valid values.<ul class="ul bulletList">
                  <li class="li">NONE</li>

                  <li class="li">ERROR</li>

                  <li class="li">WARN</li>

                  <li class="li">INFO</li>

                  <li class="li">DEBUG</li>

                  <li class="li">FINE</li>

                  <li class="li">FINER</li>

                  <li class="li">FINEST</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a DebugLevel component.

<?xml version="1.0" encoding="UTF-8"?>
<DebugLevel xmlns="http://soap.sforce.com/2006/04/metadata">
   <label\>DebugLevel</label\>
   <apexCode\>DEBUG</apexCode\>
   <apexProfiling\>INFO</apexProfiling\>
   <callout\>FINEST</callout\>
   <database\>INFO</database\>
   <dataAccess\>INFO</dataAccess\>
   <nba\>INFO</nba\>
   <system\>DEBUG</system\>
   <validation\>INFO</validation\>
   <visualforce\>INFO</visualforce\>
   <wave\>INFO</wave\>
   <workflow\>FINEST</workflow\>
</DebugLevel\>

The following is an example package.xml manifest that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
       <members\>\*</members\>
       <name\>DebugLevel</name\>
   </types\>
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=92ff35ac7eb5ddd211101c1d1983d4c4ebdf2b171c01a05abdac36bcf60977e8 url=/legacydeveloper/current/en-us/api_meta/meta_decisionmatrixdefinition.md -->

# DecisionMatrixDefinition

Represents a definition of a decision matrix.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Before deploying a decision matrix or a decision matrix version to a target org, review these [decision matrix migration considerations](https://help.salesforce.com/s/articleView?id=ind.decision_matrix_migration_considerations.htm&type=5&language=en_US "HTML (New Window)").

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DecisionMatrixDefinition components have the suffix .decisionMatrixDefinition and are stored in the decisionMatrixDefinition folder.

## Version

DecisionMatrixDefinition components are available in API version 55.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Describes a decision matrix definition.



 |
| groupKey | 

Field Type

string

Description

A key for grouping matrix rows in different versions, such as a geographic region or a product code.



 |
| label | 

Field Type

string

Description

Required.

The UI label of a decision matrix definition.



 |
| processType | 

Field Type

ExpsSetProcessType (enumeration of type string)

Description

The process type that uses the expression set rule.

Valid values are:

- Bre
- TransactionJournal—Available in API version 67.0 and later.
- GpaCalculation
- InsuranceClaimProcessing—Available in API version 65.0 and later.
- ItServiceManagement—Available in API version 65.0 and later.
- PlanCostCalculation
- RatingDiscovery
- StudentInformationSystem—Available in API version 65.0 and later.
- StudentSuccess

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

When Business Rules Engine is enabled for a Salesforce instance, the default value is 'Bre’. Other usage types may be available to you depending on your industry solution and permission sets.

Available in API version 59.0 and later.



 |
| subGroupKey | 

Field Type

string

Description

A subgroup key for grouping matrix rows in different versions, such as a geographic region or a product code. For example, if the groupKey is Country, the subGroupKey can be State or Province.



 |
| type | 

Field Type

DecisionMatrixType (enumeration of type string)

Description

The type of a decision matrix.

Valid values are:

- Grouped
- Standard





 |
| versions | 

Field Type

[DecisionMatrixDefinitionVersion](#DMDV)\[\]

Description

Represents an array of decision matrix version definitions in a decision matrix. This array must contain at least one version.



 |

## DecisionMatrixDefinitionVersion

Represents a definition of a decision matrix version.

| Field Name | Description |
| --- | --- |
| columns | 
Field Type

[DecisionMatrixDefinitionVersionColumn​​](#DMDVcolumn)\[\]

Description

Represents an array of columns in a decision matrix definition version.



 |
| decisionMatrixDefinition | 

Field Type

string

Description

The full name of a decision matrix version.



 |
| endDate | 

Field Type

dateTime

Description

The date until which a decision matrix definition version is available for use.



 |
| groupKeyValue | 

Field Type

string

Description

The value of the groupKey for a decision matrix definition version. For example, if the groupKey is Country, the groupKeyValue can be United States.



 |
| label | 

Field Type

string

Description

Required.

The UI label of a decision matrix definition version.



 |
| rank | 

Field Type

int

Description

The rank of the Decision Matrix Definition Version. When more than one enabled version matches a decision matrix call, and the start date time to end date time spans overlap, the version with the highest rank is chosen. Available in API version 64.0 and later.



 |
| startDate | 

Field Type

dateTime

Description

Required.

The date from when a decision matrix definition version is available for use.



 |
| status | 

Field Type

DecisionMatrixDefStatus (enumeration of type string)

Description

Required.

Specifies the status of a decision matrix definition version.

Valid values are:

- Active
- Draft
- Inactive
- InvalidDraft
- Obsolete





 |
| subGroupKeyValue | 

Field Type

string

Description

The value of the subgroup key for a decision matrix definition version. For example, if the subGroupKey is State or Province, the subGroupKeyValue can be California.



 |
| versionNumber | 

Field Type

int

Description

Required.

The version number of a decision matrix definition.



 |

## DecisionMatrixDefinitionVersionColumn​​

Represents a definition of a column in a decision matrix definition version.

| Field Name | Description |
| --- | --- |
| columnType | 
Field Type

DecisionMatrixColumnType (enumeration of type string)

Description

Required.

Specifies whether a column is for an input or output.

Valid values are:

- Input
- Output





 |
| dataType | 

Field Type

DecisionMatrixDataType (enumeration of type string)

Description

Required.

The type of data that’s stored in a column.

Valid values are:

- Boolean
- Currency
- Number
- NumberRange
- Percent
- Text
- TextRange





 |
| displaySequence | 

Field Type

int

Description

Required.

Represents the position of a column in the column order.



 |
| isWildcardColumn | 

Field Type

boolean

Description

Required.

Specifies whether a column stores a wildcard value (true) or not (false).

The default value is false.



 |
| name | 

Field Type

string

Description

Required.

The full name of a decision matrix definition version column.



 |
| rangeValue | 

Field Type

string

Description

A list of values that define range boundaries.



 |
| wildcardValue | 

Field Type

string

Description

The wildcard value such as ALL.



 |

## Declarative Metadata Sample Definition

The following is an example of a DecisionMatrixDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<DecisionMatrixDefinition
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<label>HealthCloudUM\_ValidRegions</label>
	<type>Standard</type>
	<versions>
		<fullName>HealthCloudUM\_ValidRegions\_V1</fullName>
		<columns>
			<columnType>Input</columnType>
			<dataType>Text</dataType>
			<displaySequence>2</displaySequence>
			<isWildcardColumn>false</isWildcardColumn>
			<name>State</name>
		</columns>
		<columns>
			<columnType>Input</columnType>
			<dataType>Text</dataType>
			<displaySequence>1</displaySequence>
			<isWildcardColumn>false</isWildcardColumn>
			<name>City</name>
		</columns>
		<columns>
			<columnType>Output</columnType>
			<dataType>Boolean</dataType>
			<displaySequence>3</displaySequence>
			<isWildcardColumn>false</isWildcardColumn>
			<name>IsValid</name>
		</columns>
		<decisionMatrixDefinition>HealthCloudUM\_ValidRegions</decisionMatrixDefinition>
		<label>HealthCloudUM\_ValidRegions V1</label>
		<startDate>2022-05-02T13:04:06.000Z</startDate>
		<status>Draft</status>
		<versionNumber>1</versionNumber>
	</versions>
</DecisionMatrixDefinition>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>\*</members\>
		<name\>DecisionMatrixDefinition</name\>
	</types\>
	<version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based.htm "HTML (New Window)").

<!-- document id=b21c5db53e46cadbde1fc1b4e3cd46c391d77dc0a5138f2bc28cf17d3e161929 url=/legacydeveloper/current/en-us/api_meta/meta_decisiontable.md -->

# DecisionTable

Represents the information about a decision table.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DecisionTable components have the suffix .decisionTable and are stored in the decisionTables folder.

## Version

DecisionTable components are available in API version 51.0 and later.

## Special Access Rules

To use this metadata type, your Salesforce org must have the Loyalty Management or the Rebate Management license.

## Fields

| Field Name | Description |
| --- | --- |
| collectOperator | 
Field Type

DecisionTable​CollectOperator (enumeration of type string)

Description

Specifies the operator that's used when the result is filtered by the Collect operator.

Valid values are:

- Count
- Maximum
- Minimum
- None
- Sum





 |
| condition​Criteria | 

Field Type

string

Description

Logic that's used to decide how the input fields are processed.



 |
| conditionType | 

Field Type

DecisionTable​ConditionType (enumeration of type string)

Description

Condition logic that's used for input fields.

Valid values are:

- All
- Any
- Custom





 |
| dataSource​Type | 

Field Type

DecisionTable​DataSourceType (enumeration of type string)

Description

Specifies the type of data source that's used to create a decision table.

Valid values are:

- ContextDefinition
- CsvUpload
- MultipleSobjects
- SingleSobject





 |
| decisionTable​FileImportVersions | 

Field Type

[DecisionTableFileImportVersion](#DecisionTableFileImportVersion)\[\]

Description

Versions of the decision table that were imported from a CSV file. Each version captures a separate import iteration with its own activation window, rank, and refresh status.

Available in API version 67.0 and later.



 |
| decisionTable​Parameters | 

Field Type

[DecisionTableParameter\[\]](#DecisionTableParameter)

Description

Parameters that you specify in a decision table.



 |
| decisionTable​SourceCriterias | 

Field Type

[DecisionTableSourceCriteria\[\]](#DecisionTableSourceCriteria)

Description

The fields and values from a data source that are used to define the condition logic of the data that's used in a decision table.



 |
| description | 

Field Type

string

Description

Description of the decision table.



 |
| doesConsider​NullValue | 

Field Type

boolean

Description

Indicates whether a column that has a null value is considered for lookup (true) or not (false). The default value is false.



 |
| downloadStatus | 

Field Type

DecisionTableDownloadStatus (enumeration of type string)

Description

Specifies the progress status of a CSV download from a CSV-based lookup table. Available in API version 64.0 and later.

Valid values are:

- Completed
- DownloadInProgress
- Failed





 |
| executionType | 

Field Type

DecisionTableExecutionType (enumeration of type string)

Description

Indicates the backing storage for the Decision Table.

Valid values are:

- DLO—Available in API version 67.0 and later. Replaces DMO.
- HBASE
- HBPO
- SOLR
- SOQL





 |
| filterResultBy | 

Field Type

DecisionTableHitPolicy (enumeration of type string)

Description

Specifies how the results of a decision table are filtered if a set of inputs returns multiple matching outputs.

Valid values are:

- AnyValue
- CollectOperator
- FirstMatch
- OutputOrder
- Priority
- RuleOrder
- UniqueValues





 |
| hasIncremental​SyncFailed | 

Field Type

boolean

Description

Indicates if the last incremental refresh failed.



 |
| isIncremental​SyncEnabled | 

Field Type

boolean

Description

Indicates if incremental refresh is enabled for the Decision Table.



 |
| isVersioned | 

Field Type

boolean

Description

Indicates whether the CSV based decision table supports multiple file-import versions (true) or not (false). When set to true, the decisionTableFileImportVersions collection captures each version. The default value is true.

Available in API version 67.0 and later.



 |
| lastIncremental​SyncDate | 

Field Type

string

Description

The date and time on which the last incremental refresh occured for the decision table.



 |
| lastSyncDate | 

Field Type

string

Description

Latest date on which the decision table was refreshed.



 |
| refresh​FailureReason | 

Field Type

string

Description

Reason why the refresh of the decision table data failed.



 |
| refreshStatus | 

Field Type

DecisionTableRefreshStatus (enumeration of type string)

Description

Specifies the refresh status of the cached data in the decision table.

Valid values are:

- Completed
- CompletedWithWarnings—Available in API version 67.0 and later.
- Failed
- InProgress
- Initiated





 |
| setupName | 

Field Type

string

Description

Required. Name of the decision table, which appears in Salesforce Setup.





 |
| sourceCondition​Logic | 

Field Type

string

Description

The condition logic that's used to define the decision table from the source data.



 |
| sourceObject | 

Field Type

string

Description

Required. Object that contains the rules based on which the decision table must provide outcomes.





 |
| status | 

Field Type

DecisionTableStatus (enumeration of type string)

Description

Required. Status of the decision table.

Valid values are:

- ActivationInProgress
- Active
- Draft
- Inactive





 |
| type | 

Field Type

DecisionTableType (enumeration of type string)

Description

Stores the type of decision table.

Valid values are:

- Advanced
- HighScaleExecution
- HighVolume
- LowVolume
- MediumVolume
- RealTime





 |
| uploadStatus | 

Field Type

DecisionTableUploadStatus (enumeration of type string)

Description

Specifies the progress status of the CSV upload for a CSV based Lookup table.

Valid values are:

- Completed
- CompletedWithErrors
- Failed
- UploadInProgress





 |
| usageType | 

Field Type

ExpsSetProcessType (enumeration of type string)

Description

Type of industry or the application within the industry that's using a decision table.

Valid values are:

- Bre
- ComplianceControl
- DecompositionEnrichmentMapping
- DefaultPricing
- DefaultRating
- EventOrchestration
- FinancialServicesCloud
- FulfillmentCondition
- GpaCalculation
- InsuranceClaimProcessing—Available in API version 65.0 and later.
- ItServiceManagement—Available in API version 65.0 and later.
- PlanCostCalculation
- PriceProtection
- PricingDiscovery
- ProductCategoryQualification
- ProductQualification
- RatingDiscovery
- RecordAlert
- ShipAndDebit
- StudentInformationSystem—Available in API version 65.0 and later.
- StudentSuccess
- TestProcess
- WarrantyClaim

When Business Rules Engine is enabled for a Salesforce instance, the default value is 'Bre’. Other usage types are available to you depending on your industry solution and permission sets.





 |

## DecisionTableFileImportVersion

Represents a version of a CSV file-import for a CSV-based decision table. Each version captures a separate import iteration with its own activation window, rank, and refresh status. Available in API version 67.0 and later.

| Field Name | Description |
| --- | --- |
| endDate | 
Field Type

string

Description

The date and time when the decision table version becomes inactive.



 |
| lastIncremental​SyncDate | 

Field Type

string

Description

The date and time on which the last incremental refresh occured for the decision table version.



 |
| lastSyncDate | 

Field Type

string

Description

The date and time on which the last refresh occured for the decision table version.



 |
| rank | 

Field Type

int

Description

Required.

The current rank of the decision table version that’s used to determine when it can get chosen for processing.



 |
| refresh​FailedReason | 

Field Type

string

Description

The reason the most recent refresh of the decision table version data failed.



 |
| refreshStatus | 

Field Type

DecisionTable​RefreshStatus (enumeration of type string)

Description

Specifies the refresh status of the cached data in the decision table version.

Valid values are:

- Completed
- CompletedWithWarnings
- Failed
- InProgress
- Initiated





 |
| startDate | 

Field Type

string

Description

Required.

The date and time when the decision table version becomes active.



 |
| uploadStatus | 

Field Type

DecisionTable​UploadStatus (enumeration of type string)

Description

Specifies the progress status of the CSV upload for the decision table version.

Valid values are:

- Completed
- CompletedWithErrors
- Failed
- UploadInProgress





 |
| versionName | 

Field Type

string

Description

Required.

The name of the decision table version. The maximum length is 120 characters.



 |
| versionNumber | 

Field Type

int

Description

Required.

The decision table version number. The combination of decisionTable and versionNumber must be unique.



 |
| versionStatus | 

Field Type

DecisionTableStatus (enumeration of type string)

Description

Required.

The status of the decision table version.

Valid values are:

- ActivationInProgress
- Active
- Inactive





 |

## DecisionTableParameter

Represents an input or output field of a decision table.

| Field Name | Description |
| --- | --- |
| dataType | 
Field Type

DTParameterDataType (enumeration of type string)

Description

The data type of the field used in a decision table.

Valid values are:

- Boolean
- Currency
- Date
- DateTime
- Number
- Percent
- String





 |
| decimalScale | 

Field Type

int

Description

The number of digits to the right of the decimal point.



 |
| domainObject | 

Field Type

string

Description

For polymorhpic fields, indicates the domain object in the field hierarchy.



 |
| fieldName | 

Field Type

string

Description

Required. API name of the fields that selected as an input or output for the decision table.





 |
| fieldPath | 

Field Type

string

Description

The path of the field used in a decision table in relation to the object that the field belongs to.



 |
| isGroup​ByField | 

Field Type

boolean

Description

Indicates whether an input field is used to group the business rules of the decision table.



 |
| isPriority​Field | 

Field Type

boolean

Description

Indicates whether a field is given priority.



 |
| isRequired | 

Field Type

boolean

Description

Indicates whether a field is required to be used for lookups.



 |
| length | 

Field Type

int

Description

The maximum number of characters supported for a field that's used in a decision table.



 |
| operator | 

Field Type

DecisionTableOperator (enumeration of type string)

Description

Operator used for the input field.

Valid values are:

- Contains
- DoesNotExistIn
- DoesNotMatch
- Equals
- ExistsIn
- GreaterOrEqual
- GreaterThan
- IsNotNull
- IsNull
- LessOrEqual
- LessThan
- Matches
- NotEquals





 |
| sequence | 

Field Type

int

Description

The sequence in which input fields are processed. This field is available in API version 52.0 and later.



 |
| sortType | 

Field Type

DecisionTableSortType (enumeration of type string)

Description

Sort outputs of a decision table based on the values of the input or output parameter field. This field is available in API version 56.0 and later.

Valid values are:

- AscNullFirst
- AscNullLast
- DescNullFirst
- DescNullLast
- None





 |
| usage | 

Field Type

DecisionTableParameterType (enumeration of type string)

Description

Required. Usage type of a field.

Valid values are:

- INPUT
- OUTPUT
- ROWCRITERIA





 |

## DecisionTableSourceCriteria

Represents the fields and values from a data source that are used to define the condition logic of the data that's used in a decision table.

| Field Name | Description |
| --- | --- |
| operator | 
Field Type

DTSourceCriteriaOperator (enumeration of type string)

Description

Required. The operator that’s applied to an associated decision table’s field to filter the data.

Valid values are:

- Contains
- DoesNotExistIn
- DoesNotMatch
- Equals
- ExistsIn
- GreaterOrEqual
- GreaterThan
- IsNotNull
- IsNull
- LessOrEqual
- LessThan
- Matches
- NotEquals





 |
| sequenceNumber | 

Field Type

int

Description

Required. The sequence number used in the associated decision table's source condition logic.





 |
| sourceField​Name | 

Field Type

string

Description

Required. The name of the field that's used in the decision table.





 |
| value | 

Field Type

string

Description

The value that’s expected in the source field used in the decision table.



 |
| valueType | 

Field Type

DTSourceCriteriaValueType (enumeration of type string)

Description

Required. The type of the value that’s used to filter the source data.

Valid values are:

- Formula
- Literal
- Lookup
- Parameter
- Picklist





 |

## Declarative Metadata Sample Definition

The following is an example of a DecisionTable component.

<?xml version="1.0" encoding="UTF-8"?>
<DecisionTable xmlns="http://soap.sforce.com/2006/04/metadata">
    <collectOperator\>None</collectOperator\>
    <conditionCriteria\>1 and 2 and 3 and 4</conditionCriteria\>
    <conditionType\>All</conditionType\>
    <dataSourceType\>SingleSobject</dataSourceType\>
    <decisionTableParameters\>
        <fieldName\>IsDeleted</fieldName\>
        <operator\>Equals</operator\>
        <usage\>INPUT</usage\>
        <sequence\>1</sequence\>
        <isGroupByField\>true</isGroupByField\>
        <sortType\>AscNullFirst</sortType\>
        <dataType\>Number</dataType\>
        <fieldPath\>AccountFeed.CommentsCount</fieldPath\>
        <domainObject\>AccountFeed</domainObject\>
        <isPriorityField\>false</isPriorityField\>
        <decimalScale\>2</decimalScale\>
        <length\>14</length\>
        <isRequired\>false</isRequired\>
    </decisionTableParameters\>
    <decisionTableParameters\>
        <fieldName\>IsActive</fieldName\>
        <usage\>OUTPUT</usage\>
    </decisionTableParameters\>
    <decisionTableParameters\>
        <fieldName\>LimitNumber</fieldName\>
        <operator\>Equals</operator\>
        <usage\>INPUT</usage\>
        <sequence\>2</sequence\>
        <isGroupByField\>false</isGroupByField\>
    </decisionTableParameters\>
    <decisionTableParameters\>
        <fieldName\>LimitStartDate</fieldName\>
        <usage\>OUTPUT</usage\>
    </decisionTableParameters\>
    <decisionTableParameters\>
        <fieldName\>GivenBadgeCount</fieldName\>
        <operator\>Equals</operator\>
        <usage\>INPUT</usage\>
        <sequence\>3</sequence\>
        <isGroupByField\>false</isGroupByField\>
    </decisionTableParameters\>
    <decisionTableParameters\>
        <fieldName\>Name</fieldName\>
        <operator\>Equals</operator\>
        <usage\>INPUT</usage\>
        <sequence\>4</sequence\>
        <isGroupByField\>false</isGroupByField\>
    </decisionTableParameters\>
    <decisionTableSourceCriterias\>
        <sourceFieldName\>IsDeleted</sourceFieldName\>
        <operator\>Equals</operator\>
        <value\>false</value\>
        <sequenceNumber\>1</sequenceNumber\>
        <valueType\>Literal</valueType\>
    </decisionTableSourceCriterias\>
    <description\>Sample DT created for md-common tests</description\>
    <filterResultBy\>UniqueValues</filterResultBy\>
    <setupName\>Sample DT</setupName\>
    <sourceObject\>WorkBadgeDefinition</sourceObject\>
    <sourceConditionLogic\>1</sourceConditionLogic\>
    <status\>Draft</status\>
    <type\>LowVolume</type\>
    <usageType\>Bre</usageType\>
    <doesConsiderNullValue\>false</doesConsiderNullValue\>
    <refreshStatus\>Failed</refreshStatus\>
    <refreshFailureReason\>Failed due to limit violation.</refreshFailureReason\>
    <executionType\>Hbpo</executionType\>
    <lastIncrementalSyncDate\>""</lastIncrementalSyncDate\>
    <uploadStatus\>Completed</uploadStatus\>
    <isIncrementalSyncEnabled\>false</isIncrementalSyncEnabled\>
    <hasIncrementalSyncFailed\>false</hasIncrementalSyncFailed\>
</DecisionTable\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <fullName\>Sample DT Package</fullName\>
   <description\>Package created for md-common tests</description\>
   <types\>
      <members\>Sample\_DT</members\>
      <name\>DecisionTable</name\>
   </types\>
   <types\>
      <members\>DSL\_Sample</members\>
      <members\>Sample\_DT\_Default</members\>
      <name\>DecisionTableDatasetLink</name\>
   </types\>
   <version\></version\>
</Package\>

<!-- document id=03138f006eabd22dc77ed5c5669d31bfc2966c4f447cb81b4036e41916af6834 url=/legacydeveloper/current/en-us/api_meta/meta_decisiontabledatasetlink.md -->

# DecisionTableDatasetLink

Represents the information about a dataset link associated with a decision table. In a dataset link, select an object for whose records, the decision table must provide an outcome. This type extends the Metadata metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Dataset links are supported only for Standard decision tables.

## File Suffix and Directory Location

DecisionTableDatasetLink components have the suffix .decisionTableDatasetLink and are stored in the decisionTableDatasetLinks folder.

## Version

DecisionTableDatasetLink components are available in API version 51.0 and later.

## Special Access Rules

To use this metadata type, your Salesforce org must have the Loyalty Management or the Rebate Management license.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| decisionTableName | string | Required. The name of the associated decision table. |
| decisionTblDatasetParameters | [DecisionTblDatasetParameters](#dtparametersID) | Mapping between a decision table parameter and a field of the object selected in the dataset link. |
| description | string | The description of the dataset link. |
| isDefault | boolean | Indicates whether a dataset link is the default dataset link for a decision table. |
| setupName | string | Required. The name of the decision table dataset link, which appears in Setup. |
| sourceObject | string | Required. The name of the object being evaluated. |

## DecisionTblDatasetParameters

Represents the mapping between a decision table parameter and a field of the object selected in the dataset link.

The mapping allows the decision table to know which object fields must be compared to the input-output fields of the decision table.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| datasetFieldName | string | Required. Name of the dataset field whose value must be compared against an Input type decision table parameter when providing the outcome. |
| fieldName | string | Required. The API name of the decision table field that is selected as an input or output for the decision table dataset link. |

## Declarative Metadata Sample Definition

The following is an example of a DecisionTableDatasetLink component.

<?xml version="1.0" encoding="UTF-8"?>
<DecisionTableDatasetLink xmlns="http://soap.sforce.com/2006/04/metadata">
   <decisionTableName\>Sample\_DT</decisionTableName\>
   <decisionTblDatasetParameters\>
      <fieldName\>IsDeleted</fieldName\>
      <datasetFieldName\>IsDeleted</datasetFieldName\>
   </decisionTblDatasetParameters\>
   <decisionTblDatasetParameters\>
      <fieldName\>LimitNumber</fieldName\>
      <datasetFieldName\>CallDurationInSeconds</datasetFieldName\>
   </decisionTblDatasetParameters\>
   <decisionTblDatasetParameters\>
      <fieldName\>Name</fieldName\>
      <datasetFieldName\>Subject</datasetFieldName\>
   </decisionTblDatasetParameters\>
   <description\>DSL created for md-common tests</description\>
   <isDefault\>false</isDefault\>
   <sourceObject\>Task</sourceObject\>
   <setupName\>DSL Sample</setupName\>
</DecisionTableDatasetLink\>

The following is an example of a default DecisionTableDatasetLink component.

<?xml version="1.0" encoding="UTF-8"?>
<DecisionTableDatasetLink xmlns="http://soap.sforce.com/2006/04/metadata">
   <decisionTableName\>Sample\_DT</decisionTableName\>
   <isDefault\>true</isDefault\>
   <sourceObject\>WorkBadgeDefinition</sourceObject\>
   <setupName\>Default DSL Sample</setupName\>
</DecisionTableDatasetLink\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <fullName\>Sample DT Package</fullName\>
   <description\>Package created for md-common tests</description\>
   <types\>
      <members\>Sample\_DT</members\>
      <name\>DecisionTable</name\>
   </types\>
   <types\>
      <members\>DSL\_Sample</members\>
      <members\>Sample\_DT\_Default</members\>
      <name\>DecisionTableDatasetLink</name\>
   </types\>
   <version\>51.0</version\>
</Package\>

<!-- document id=e9eedfaca0261bfeef84571cbc5187c7a0c79aa566d901978495bf3ec72df505 url=/legacydeveloper/current/en-us/api_meta/file_based.md -->

# Declarative (File-Based) Metadata API Calls

Use the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") and [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") calls to move metadata (XML files) between a Salesforce org and a local file system. After you retrieve your XML files into a file system, you can manage changes in a source-code control system, copy and paste code or setup configurations, diff changes to components, and perform many other file-based development operations. At any time you can deploy those changes to another Salesforce org.

Data in XML files is formatted using the English (United States) locale. This formatting ensures that fields that depend on locale, such as date fields, are interpreted consistently during data migrations between organizations using different languages. Organizations can support multiple languages for presentation to their users.

The [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") and [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") calls are used primarily for these development scenarios:

- Development of a custom application (or customization) in a sandbox organization. After development and testing are completed, the application or customization is then deployed into a production organization using Metadata API.
- Team development of an application in a Developer Edition organization. After development and testing are completed, you can then distribute the application via Lightning Platform AppExchange.

You receive an API notification each time you retrieve 90% or more of the maximum number of custom fields that you can deploy at once with Metadata API. The maximum number of custom fields for one deployment is 45,000. The custom fields retrieved in one package.xml file are: 1) the sum of the fields on each object in the CustomObjects section of package.xml and 2) the sum of the custom fields in the CustomFields section of package.xml.

You can still retrieve above the deployable maximum up to [the limit on total size of retrieved files](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). But you must use more than one deployment to deploy all of the custom fields.

**Example**: Warning: You’ve retrieved 47,000 instances of CustomField. You can’t redeploy all these instances at the same time; the maximum is 45,000.

Don’t use file-based metadata deployment, including package.xml, destructiveChanges.xml, or changesets, for these setup objects.

- [DataStreamDefinition](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_datastreamdefinition.htm)
- [DataSourceObject](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_datasourceobject.htm) or DataSourceObject fields
- MktDataLakeObject ([Data Lake Object](https://help.salesforce.com/s/articleView?id=data.c360_a_data_ingestion_and_modeling.htm&language=en_US))
- [ObjectSourceTargetMap](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objectsourcetargetmap.htm)
- [MktDataTranObject](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_mktdatatranobject.htm)

Deploying these unsupported objects creates orphaned metadata records. These records block future DataStream and DataKit deployments with errors such as "Data Lake Object ID cannot be empty."

#### See Also

- [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.")
- [Unsupported Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_unsupported_types.htm "Some Salesforce features have metadata types that aren’t available in Metadata API. These metadata types can’t be retrieved or deployed with Metadata API. To make changes to these types, you must do it manually in each of your organizations.")
- [Metadata Type Limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_metadata_type_limits.htm)

<!-- document id=16dfc01306f7a6894cee7c3ae9875eea0f8891a88004bb2f95a4026265c16655 url=/legacydeveloper/current/en-us/api_meta/meta_delegategroup.md -->

# DelegateGroup

Represents a group of users who have the same administrative privileges. These groups are different from public groups used for sharing.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DelegateGroup components have the suffix .delegateGroup and are stored in the delegateGroups folder. The file prefix must match the developer name of the delegate group. For example, a delegate group with a developer name of MyDelegateGroup would have a file name of MyDelegateGroup.delegateGroup.

## Version

DelegateGroup components are available in API version 36.0 and later.

## Special Access Rules

Only users with the “View Setup and Configuration” permission can be delegated administrators. As of Spring ’20 and later, only users with “View Setup” or “Configuration” permission can access this object.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| customObjects | string\[\] | The custom objects associated with the group. Delegated administrators can customize nearly every aspect of each of those custom objects, including creating a custom tab. However, they can’t create or modify relationships on the objects or set organization-wide sharing defaults. Delegated administrators must have access to custom objects to access the merge fields on those objects from formulas. |
| groups | string\[\] | The groups with users assigned by delegated administrators. |
| label | string | Required. The delegated group’s non-API name. |
| loginAccess | boolean | Required. Allows users in this group to log in as users in the role hierarchy that they administer (true) or not (false). Depending on your organization settings, individual users must grant login access to allow their administrators to log in as them. |
| permissionSetGroups | string\[\] | The permission set groups that can be assigned to users in specified roles and all subordinate roles by delegated administrators. |
| permissionSets | string\[\] | The permission sets that can be assigned to users in specified roles and all subordinate roles by delegated administrators. |
| profiles | string\[\] | The profiles that can be assigned to users by delegated administrators. |
| roles | string\[\] | The roles and subordinates for which delegated administrators of the group can create and edit users. |

## Declarative Metadata Sample Definition

The following is an example of a DelegateGroup component.

<?xml version="1.0" encoding="UTF-8"?>
<DelegateGroup xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>MyDelegateGroup</label\>
    <loginAccess\>true</loginAccess\>
    <name\>MyDelegateGroup</name\>
    <profiles\>Chatter Free User</profiles\>
    <profiles\>Chatter Moderator User</profiles\>
    <profiles\>Marketing User</profiles\>
    <permissionSetGroups\>My Permission Set Group</permissionSetGroups\>
    <permissionSets\>My Permset</permissionSets\>
    <roles\>LesserBossMan</roles\>
</DelegateGroup\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>DelegateGroup</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=95885f0515c6966b71460ff800800e8f6ba3f8d7271372059684bd79a909cbfe url=/legacydeveloper/current/en-us/api_meta/meta_delete.md -->

# delete()

Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead.

You can use this call to delete any of the objects that extend [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm). For more details, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

## Syntax

 [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")\[\] = metadataConnection.delete([Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\] metadata);

## Usage

Use this call to delete one or more components from your organization.

## Version

This call is available in API version 30.0 and earlier only. This call isn’t available in API version 31.0 and later. Use [deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm "Deletes one or more metadata components from your organization synchronously.") instead.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Rules and Guidelines

When deleting components, consider the following rules and guidelines:

- Your client application must be logged in with sufficient access rights to delete individual components within the specified component. For more information, see [Factors that Affect Data Access](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/obj_ref_data_access.htm "HTML (New Window)") in the Salesforce Object Reference.
- In addition, sometimes you also need permission to access this component’s parent component.
- To ensure referential integrity, this call supports cascading deletions. If you delete a parent component, you delete its children automatically, as long as each child component can be deleted.

## Basic Steps for Deleting Metadata Components

Use the following process to delete metadata components:

1. Determine the [fullName](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm#meta_fullname) of each component you want to delete. See [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) for more details on the [fullName](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm#meta_fullname) field. You can only delete components of the same type in a single call.
2. Invoke the delete() call, passing in the array of metadata components with [fullName](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm#meta_fullname) specified.
3. An [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is returned for each component you try to delete, and is updated with status information as the operation moves from a queue to completed or error state. Call [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") in a loop until the status values in [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") indicate that all the delete operations are completed. Start with a wait time of 1 second between iterations of [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") calls, and double the wait time each time you make a subsequent call.

## Sample Code—Java

public void deleteCustomObject() {
  try {
    CustomObject co = new CustomObject();
    co.setFullName("MyCustomObject\_\_c");
    AsyncResult\[\] ars = metadataConnection.create(new Metadata\[\]
       {co});
    AsyncResult asyncResult = ars\[0\];
    long waitTimeMilliSecs = 1000;
    while (!asyncResult.isDone()) {
      Thread.sleep(waitTimeMilliSecs);
      // double the wait time for the next iteration
      waitTimeMilliSecs \*= 2;
      asyncResult = mdConnection.checkStatus(
        new String\[\] {asyncResult.getId()})\[0\];
      System.out.println("Status is: " + asyncResult.getState());
    }
  } catch (ConnectionException ce) {
    ce.printStackTrace();
  } catch (InterruptedException ie) {
    ie.printStackTrace();
  }
}

#### See Also

- [deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm "Deletes one or more metadata components from your organization synchronously.")
- [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.")
- [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead.")
- [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.")

## Arguments

### metadata

- **Type**: [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\]
- **Description**: Array of one or more metadata components. Only set the [fullName](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm#meta_fullname) field in the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) object.
    
    Limit: 10.
    
    You must submit arrays of only one type of component. For example, you could submit an array of 10 custom objects or 10 profiles, but not a mix of both types.

## Response

[AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")\[\]

<!-- document id=c1755c828c0632b37f09569c2907f0aea6dda4dbb2b373666c8c92ccfcd05220 url=/legacydeveloper/current/en-us/api_meta/meta_deleteMetadata.md -->

# deleteMetadata()

Deletes one or more metadata components from your organization synchronously.

## Syntax

[DeleteResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteResult.htm#meta_deleteResult "Contains result information for the deleteMetadata call.")\[\] = metadataConnection.delete(string metadataType, string\[\] fullNames);

## Usage

Use the deleteMetadata() call to delete any component that extends [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm). All components must be of the same type in the same call. For more details, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

This call executes synchronously, which means that the call returns only when the operation completes.

Starting in API version 34.0, this call supports the [AllOrNoneHeader](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_allornoneheader.htm "Indicates whether to roll back all metadata changes when some of the records in a call result in failures.") header. By default, if the AllOrNoneHeader isn’t used in any API version, this call can delete a partial set of records for records with no errors (equivalent to AllOrNoneHeader=false). If AllOrNoneHeader is set to true, no records are deleted if one or more records cause a failure.

## Version

Available in API version 30.0 and later.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Rules and Guidelines

When deleting components, consider the following rules and guidelines:

- Your client application must be logged in with sufficient access rights to delete individual components within the specified component. For more information, see [Factors that Affect Data Access](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/obj_ref_data_access.htm "HTML (New Window)") in the Salesforce Object Reference.
- In addition, sometimes you also need permission to access this component’s parent component.
- To ensure referential integrity, this call supports cascading deletions. If you delete a parent component, you delete its children automatically, as long as each child component can be deleted.

## Basic Steps for Deleting Metadata Components

Use the following process to delete metadata components:

1. Determine the metadata type of the components you want to delete and the [fullName](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm#meta_fullname) of each component to delete. You can delete only components of the same type in a single call. The full names must match one or more full names returned by the listMetadata() call, which includes namespace prefixes. If you obtain the fullName from a package manifest file, and the component has a namespace prefix, prepend the namespace prefix to the fullName. Use this syntax: namespacePrefix\_\_ComponentName. For example, for the custom object component MyCustomObject\_\_c and the namespace MyNS, the fullName is MyNS\_\_MyCustomObject\_\_c. See [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) for more details on the [fullName](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm#meta_fullname) field.
2. Invoke the deleteMetadata() call. For the first argument, pass in the name of the metadata type. For the second argument, pass in an array of full names corresponding to the components you wish to delete.
    
    A DeleteResult object is returned for each component you try to delete. It contains information about whether the operation was successful, the name of the deleted component, and any errors returned if the operation wasn’t successful.

## Sample Code—Java

public void deleteCustomObjectSync() {
    try {
        DeleteResult\[\] results = metadataConnection.deleteMetadata(
                "CustomObject", new String\[\] { "MyCustomObject1\_\_c",
                        "MyCustomObject2\_\_c" });
        for (DeleteResult r : results) {
            if (r.isSuccess()) {
                System.out.println("Deleted component: " + r.getFullName());
            } else {
                System.out
                        .println("Errors were encountered while deleting "
                                + r.getFullName());
                for (Error e : r.getErrors()) {
                    System.out.println("Error message: " + e.getMessage());
                    System.out.println("Status code: " + e.getStatusCode());
                }
            }
        }
    } catch (ConnectionException ce) {
        ce.printStackTrace();
    }
}

## Arguments

### metadataType

- **Type**: string
- **Description**: The metadata type of the components to delete.

### fullNames

- **Type**: string\[\]
- **Description**: Array of full names of the components to delete.
    
    Limit: 10. (For [CustomMetadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_custommetadata.htm) and [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_customapplication.htm) only, the limit is 200.)
    
    Submit arrays of only one type of component. For example, you can submit an array of 10 custom objects or 10 profiles, but not a mix of both types.

## Response

[DeleteResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteResult.htm#meta_deleteResult "Contains result information for the deleteMetadata call.")\[\]

<!-- document id=b7555132808891c713e14c1a7ea61891ba6417141a8e3e6a8bc6033bf657ddb0 url=/legacydeveloper/current/en-us/api_meta/meta_deleteResult.md -->

# DeleteResult

Contains result information for the deleteMetadata call.

## Version

Available in API version 30.0 and later.

## errors

- **Type**: [Error](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_error.htm "Represents an error that occurred during a synchronous CRUD (createMetadata(), updateMetadata(), or deleteMetadata()) operation.")\[\]
- **Description**: An array of errors returned if the operation wasn’t successful.

## fullName

- **Type**: string
- **Description**: The full name of the deleted component.

## success

- **Type**: boolean
- **Description**: Indicates whether the deletion was successful (true) or not (false).

<!-- document id=9287b9b688e74e5828a0872c1f02c0ec41d4eb18720728046c4ed8b2fb708ef5 url=/legacydeveloper/current/en-us/api_meta/meta_deploy_deleting_files.md -->

# Deleting Components from an Organization

To delete components, perform a deployment with the deploy() call by using a destructive changes manifest file that lists the components to remove from your organization. You can perform a deployment that only deletes components, or a deployment that deletes and adds components. In API version 33.0 and later, you can specify components to delete before and after other components are added or updated. In earlier API versions, if deletions and additions are specified for the same deployment, the deploy() call performs the deletions first.

## Deleting Components in a Deployment

To delete components, use the same procedure as with deploying components, but also include a delete manifest file that’s named destructiveChanges.xml and list the components to delete in this manifest. The format of this manifest is the same as package.xml except that wildcards aren’t supported.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can’t use destructiveChanges.xml to delete items that are associated with an active Lightning page, such as a custom object, a component on the page, or the page itself. First, you must remove the page's action override by deactivating it in the Lightning App Builder.

The following sample destructiveChanges.xml file names a single custom object to be deleted:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyCustomObject\_\_c</members\>
        <name\>CustomObject</name\>
    </types\>
</Package\>

To deploy the destructive changes, you must also have a package.xml file that lists no components to deploy, includes the API version, and is in the same directory as destructiveChanges.xml:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <version\>68.0</version\>
</Package\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

- To bypass the Recycle Bin, set the [purgeOnDelete](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm#meta_deploy "Uses file representations of components to create, update, or delete those components in a Salesforce org.") option to true.
- When you delete a roll-up summary field using Metadata API, the field isn't saved in the Recycle Bin. The field is purged even if you don’t set the purgeOnDelete deployment option to true.
- If you try to delete some components that don’t exist in the organization, the rest of the deletions are still attempted.

## Adding and Deleting Components in a Single Deployment

You can perform a deployment that specifies components to delete in destructiveChanges.xml and components to add or update in package.xml. The process is the same as with performing a delete-only deployment except that package.xml contains the components to add or update.

By default, deletions are processed before component additions. In API version 33.0 and later, you can specify components to be deleted before and after component additions. The process is the same as with performing a delete-only deployment except that the name of the deletion manifest file is different.

- To delete components _before_ adding or updating other components, create a manifest file that’s named destructiveChangesPre.xml and include the components to delete.
- To delete components _after_ adding or updating other components, create a manifest file that’s named destructiveChangesPost.xml and include the components to delete.

The ability to specify when deletions are processed is useful when you’re deleting components with dependencies. For example, if a custom object is referenced in an Apex class, you can’t delete it unless you modify the Apex class first to remove the dependency on the custom object. In this example, you can perform a single deployment that updates the Apex class to clear the dependency and then deletes the custom object by using destructiveChangesPost.xml. The following are samples of the package.xml and destructiveChangesPost.xml manifests that would be used in this example.

Sample package.xml, which specifies the class to update:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>SampleClass</members\>
        <name\>ApexClass</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

Sample destructiveChangesPost.xml, which specifies the custom object to delete after the class update:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyCustomObject\_\_c</members\>
        <name\>CustomObject</name\>
    </types\>
</Package\>

Post destructive changes are processed before running any tests.

When deleting Apex classes or triggers, Salesforce recommends that as part of the deployment, you run all local tests from the namespace in order to detect any remaining references to the deleted class or trigger.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The API version that the deployment uses is the API version that’s specified in package.xml.

- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "checkDeployStatus()")

<!-- document id=673059d7882aabb26c396bb189cbdade0af4ce115919ca4a56c84bb81b3d1be3 url=/legacydeveloper/current/en-us/api_meta/meta_rest_deploy_recentvalidation.md -->

# Deploy a Recently Validated Component Set Without Tests

You can deploy components to production in less time by skipping the execution of Apex tests when testing requirements have already been met.

- The components have been validated successfully for the target environment within the last 10 days.
- As part of the validation, Apex tests in the target org have passed.
- Code coverage requirements are met.
    - If all tests in the org or all local tests are run, overall code coverage is at least 75%, and Apex triggers have some coverage.
    - If specific tests are run with the RunSpecifiedTests test level, each class and trigger to be deployed is covered by at least 75% individually.

This operation is equivalent to performing a quick deployment of a recent validation on the Deployment Status page in the Salesforce user interface.

To validate but not deploy a set of components when using the deployRequest resource, set the checkOnly parameter of deployOptions to true. Note the deployment request ID in the response. Use this ID (associated with a successful validation) later to deploy the component set without repeating the validation.

**URI**

https://host/services/data/vXX.0/metadata/deployRequest/validatedDeployRequestId

**Formats**

JSON

**HTTP Method**

POST

**Authentication**

Authorization: Bearer token

## Request Body: Deploy a Recently Validated Component Set Without Tests

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The HTTP method for deploying a recently validated component set is POST, not PATCH. Using PATCH would create a new deployment.

    { 
       "validatedDeployRequestId" : "0Afxx00000000lWCAQ"
    }

If there is no corresponding deployment package that meets the validation requirements, you receive an HTTP status code of 404 (Not Found). If the validated deployment package is found, the HTTP status code returned is 201 (Created).

## Response Body: Deploy a Recently Validated Component Set Without Tests

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The response body from the deployment without validation request includes a new request ID, because it is separate from the earlier request for a validation-only deployment.

    { 
       "validatedDeployRequestId" : "0Afxx00000000lWCAQ"
       "id" : "0Afxx00000000lWMEM"
       "url" : "https://host/services/data/vXX.0/metadata/deployRequest/0Afxx00000000lWMEM",
       "deployOptions" :
             {
             "allowMissingFiles" : false,
             "autoUpdatePackage" : false,
             "checkOnly" : true,
             "ignoreWarnings" : false,
             "performRetrieve" : false,
             "purgeOnDelete" : false,
             "rollbackOnError" : false,
             "runTests" : null,
             "singlePackage" : true,
             "testLevel" : "RunAllTestsInOrg"
}
     }

When an HTTP status code of 201 (Created) is returned, your request has succeeded and resulted in the creation of a deployment that is being processed. In the preceding example response body, the ID of the validation-only deployment request is 0Afxx00000000lWCAQ; the ID of the deployment without validation request is 0Afxx00000000lWMEM.

<!-- document id=2e3448db1df87a127130e0ac9fc7488cc1b2c9cc28bcf28654bdf2c59d615084 url=/legacydeveloper/current/en-us/api_meta/meta_use_cases_deploy_prod.md -->

# Deploy Metadata to Production

In the final step of the development cycle, move customizations from a source control system such as Git into production with Metadata API.

When your team finishes integration tests and is ready to deploy to production, move the completed customizations from a local environment to the repository. For the release, move metadata from the repository to production by pulling the updated repository back to the local environment with Git commands. Next, deploy metadata to production with Metadata API deploy call.

Moving metadata to production requires a deploy call instead of a push command because the deploy call deploys the entire metadata model and not just changes in the metadata.

**Deploy Recent Validation**

A regular deploy call executes automated Apex tests that can take a long time to complete. To skip tests for validated components and deploy components to production quickly, use the deploy recent validation option.

#### See Also

- [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.")
- [force:source:push Command](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_push)
- [Deploy a Recently Validated Component Set Without Tests](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_rest_deploy_recentvalidation.htm "You can deploy components to production in less time by skipping the execution of Apex tests when testing requirements have already been met.")

<!-- document id=520f2ca49eb241f9237fafdb8a11c2bfa8064cb5d68d65b314c1156093b7a831 url=/legacydeveloper/current/en-us/api_meta/meta_rest_deploy.md -->

# Deploy Metadata with Apex Testing Using REST

Deploy using the deployRequest REST resource to initiate a request that handles all operations for the deployment.

You can deploy or retrieve up to 10,000 files at once. The maximum size of the deployed or retrieved .zip file is 39 MB. If the files are uncompressed in an unzipped folder, the size limit is 600 MB or 629,145,600 bytes. The size limit in bytes is calculated as 600 x 1024 x 1024.

**URI**

https://host/services/data/vXX.0/metadata/deployRequest

**Formats**

JSON

**HTTP Method**

POST

**Authentication**

Authorization: Bearer token

## deployOptions Parameters

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

To review the default testing behavior for deployments and approaches that can save time while still enabling you to meet testing requirements, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm#meta_deploy_running_tests "Learn default test execution rules for Salesforce production deployments, including API version differences and Apex test requirements.") and [Run the Same Tests in Sandbox and Production Deployments](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_run_local_tests.htm#meta_deploy_run_local_tests "Starting in API version 34.0, you can choose which tests to run in your development environment, such as only local tests, to match the tests run in production. In earlier versions, if you enabled tests in your sandbox deployment, you couldn’t exclude managed package tests.").

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1057890e110">Parameter</th>

              <th class="featureTableHeader  " id="d1057890e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">allowMissingFiles</span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">Boolean. If files that are specified in <span class="ph filepath">package.xml</span> aren’t
                in the <span class="ph filepath">.zip</span> file, specifies whether a deployment can still
                succeed. Don’t set this argument for deployment to production orgs.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">autoUpdatePackage </span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">Reserved for future use. </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">checkOnly</span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">Boolean. Defaults to <samp class="codeph java">false</samp>. Set to <samp class="codeph java">true</samp> to perform a test deployment (validation) of
                components without saving the components in the target org. A validation enables you
                to verify the results of tests that would be generated in a deployment, but doesn’t
                commit any changes. After a validation finishes with passing tests, it can qualify
                for deployment without rerunning tests. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_rest_deploy_recentvalidation.htm#meta_rest_deploy_recentvalidation" title="You can deploy components to production in less time by skipping the execution of Apex tests when testing requirements have already been met.">Deploy a Recently Validated Component Set Without Tests</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">ignoreWarnings</span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">Boolean. <span class="ph" id="field_ignoreWarnings_desc"><a name="field_ignoreWarnings_desc"><!-- --></a>Indicates whether a deployment is
                  allowed to complete successfully despite one or more warnings (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Defaults to <samp class="codeph java">false</samp>.</span>
                <p class="p">The DeployMessage object for a warning contains the
                  following values:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <span class="keyword parmname">problemType</span>—<samp class="codeph nolang">Warning</samp>
                  </li>

                  <li class="li">
                    <span class="keyword parmname">problem</span>—The text of the warning.
                  </li>

                </ul>
                <p class="p">If a warning occurs and <span class="keyword parmname">ignoreWarnings</span> is set to
                  <samp class="codeph java">true</samp>, the <span class="keyword parmname">success</span> field
                  in DeployMessage is <samp class="codeph java">true</samp>. If
                  <span class="keyword parmname">ignoreWarnings</span> is set to <samp class="codeph java">false</samp>, <span class="keyword parmname">success</span> is set to <samp class="codeph java">false</samp> and the warning is treated like an
                  error.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">performRetrieve</span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">Reserved for future use. </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">purgeOnDelete</span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">Boolean. <span class="ph" id="option_purgeOnDelete_desc"><a name="option_purgeOnDelete_desc"><!-- --></a>If <samp class="codeph java">true</samp>, the deleted components in the
                  <span class="ph filepath">destructiveChanges.xml</span> manifest file aren't stored in the
                  Recycle Bin. Instead, they become immediately eligible for deletion.</span>
                <p class="p"><span class="ph" id="only_test_orgs"><a name="only_test_orgs"><!-- --></a>This option only works in Developer Edition or sandbox orgs.
                    It doesn't work in production orgs.</span></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">rollbackOnError</span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">Boolean. Indicates whether any failure causes a complete rollback (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). If <samp class="codeph java">false</samp>, whatever actions can
                be performed without errors are performed, and errors are returned for the remaining
                actions. This parameter must be set to <samp class="codeph java">true</samp> if
                you’re deploying to a production org. The default is <samp class="codeph java">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">runTests</span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">String[]. A list of Apex tests to run during deployment. Specify the class
                name, one name per instance. The class name can also specify a namespace with a dot
                notation. For more information, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_run_specific_tests.htm" title="Test levels enable you to have more control over which tests are run in a deployment. To shorten deployment time to production, run a subset of tests when deploying Apex components. The default test execution behavior in production has also changed. By default, if no test level is specified, no tests are executed, unless your deployment package contains Apex classes or triggers.">Running a Subset of Tests in a Deployment</a>.<p class="p">To use this option, set <span class="keyword parmname">testLevel</span> to
                  <samp class="codeph nolang">RunSpecifiedTests</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">singlePackage</span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">Boolean. Indicates whether the specified <samp class="codeph nolang">.zip</samp> file points to a directory structure with a single package (<samp class="codeph java">true</samp>) or a set of packages (<samp class="codeph java">false)</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e110" data-title="Parameter"><span class="keyword parmname">testLevel</span></td>

              <td class="entry" headers="d1057890e113" data-title="Description">TestLevel (enumeration of type string). Optional. Specifies which tests are run
                as part of a deployment. The test level is enforced regardless of the types of
                components that are present in the deployment package. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">NoTestRun</samp>—No tests are run. This
                    test level applies only to deployments to development environments, such as
                    sandbox, Developer Edition, or trial organizations. This test level is the
                    default for development environments.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="RunSpecifiedTests_name"><a name="RunSpecifiedTests_name"><!-- --></a>RunSpecifiedTests</samp>—Only the tests that you specify in the
                    <span class="keyword parmname">runTests</span> option are run. Code coverage requirements
                    differ from the default coverage requirements when using this test level. Each
                    class and trigger in the deployment package must be covered by the executed
                    tests for a minimum of 75% code coverage. This coverage is computed for each
                    class and triggers individually and is different than the overall coverage
                    percentage.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="RunRelevantTests"><a name="RunRelevantTests"><!-- --></a>RunRelevantTests</samp>
                    (beta)—Only tests relevant to the deployment payload are run. Salesforce
                    automatically identifies the relevant tests based on an analysis of the
                    deployment payload and the payload dependencies. For fine-grained control, you
                    can annotate test classes so that they either run regardless of the deployment
                    payload, or run when modified, referenced components are included in the
                    deployment. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm" target="_blank">@IsTest Annotation</a> in the <cite class="cite">Apex
                      Developer Guide</cite>. Each class and trigger in the deployment package must
                    be covered by the executed tests for a minimum of 75% code coverage. This
                    coverage is computed for each class and trigger individually and is different
                    from the overall coverage percentage.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="RunLocalTests_name"><a name="RunLocalTests_name"><!-- --></a>RunLocalTests</samp>—<span class="ph" id="RunLocalTests_desc"><a name="RunLocalTests_desc"><!-- --></a>All tests in your
                      org are run, except the ones that originate from installed managed and
                      unlocked packages.</span> This test level is the default for production
                    deployments that include Apex classes or triggers.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="RunAllTestsInOrg_name"><a name="RunAllTestsInOrg_name"><!-- --></a>RunAllTestsInOrg</samp>—<span class="ph" id="RunAllTestsInOrg_desc"><a name="RunAllTestsInOrg_desc"><!-- --></a>All tests are
                      run. The tests include all tests in your org, including tests of managed
                      packages.</span>
                  </li>

                </ul>
                <p class="p">If you don’t specify a test level, the default test execution behavior is
                  used. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm" title="Learn default test execution rules for Salesforce production deployments, including API version differences and Apex test requirements.">Running Tests in a Deployment</a>.</p>

                <p class="p">Apex tests that run as part of a deployment always run synchronously and
                  serially.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Request Body: Deploy Metadata

When you deploy metadata, your request includes both the deployment parameters and the .zip file containing the component directories and the manifest.

This example POST request creates a deployRequest object that initiates a deployment.

- The POST request header is set to Content-Type: multipart/form-data and defines a boundary delimiter to encapsulate different subparts of the request. In this example, the boundary delimiter is \--------------------------BOUNDARY.
- The boundary delimiter precedes each subpart, and the delimiter itself is preceded by two extra \--. In the first subpart, a JSON request creates a deployOptions child object for passing the deployment parameters.
- The second subpart specifies the .zip file that contains the manifest and the component directories.
- The second subpart ends with the boundary delimiter preceded by two \--. The delimiter is followed by another two \--, which indicate the end of the request body.

POST /services/data/v48.0/metadata/deployRequest
Authorization: Bearer 00D....
Content-Type: multipart/form-data; boundary=--------------------------BOUNDARY

----------------------------BOUNDARY
Content-Disposition: form-data; name="json"
Content-Type: application/json

{ 
    "deployOptions" :
        {
        "allowMissingFiles" : false,
        "autoUpdatePackage" : false,
        "checkOnly" : false,
        "ignoreWarnings" : false,
        "performRetrieve" : false,
        "purgeOnDelete" : false,
        "rollbackOnError" : false,
        "runTests" : null,
        "singlePackage" : true,
        "testLevel" : "RunAllTestsInOrg"
        }
    }

----------------------------BOUNDARY
Content-Disposition: form-data; name="file"; filename="deploy.zip"
Content-Type: application/zip

//Contents of deploy.zip
----------------------------BOUNDARY--

## Response Body: Deploy Metadata

When an HTTP status code of 201 (Created) is returned, your request has succeeded and resulted in the creation of a deployment that is being processed.

{ "id" : "0Afxx00000001VPCAY",
  "deployOptions" : 
   { "checkOnly" : false,
     "singlePackage" : false,
     "allowMissingFiles" : false,
     "performRetrieve" : false,
     "autoUpdatePackage" : false,
     "rollbackOnError" : true,
     "ignoreWarnings" : false,
     "purgeOnDelete" : false,
     "runAllTests" : false },
  "deployResult" : 
   { "id" : "0Afxx00000001VPCAY",
     "success" : false,
     "checkOnly" : false,
     "ignoreWarnings" : false,
     "rollbackOnError" : true,
     "status" : "Pending",
     "runTestsEnabled" : false,
     "done" : false } }

## deployResult Parameters

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1057890e493">Parameter</th>

              <th class="featureTableHeader  " id="d1057890e496"></th>

              <th class="featureTableHeader  " id="d1057890e498">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">ID. ID of the component being deployed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">canceledBy</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">ID. The ID of the user who canceled the deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">canceledByName</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">String. The full name of the user who canceled the deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">checkOnly</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Boolean. Indicates whether this deployment is used to check the validity of the
                deployed files without changing the org (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). A check-only deployment doesn’t
                deploy any components or change the organization in any way.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">completedDate</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">DateTime. Timestamp for when the deployment process ended.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">createdBy</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">ID. The ID of the user who created the deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">createdByName</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">String. The full name of the user who created the deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">createdDate</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">DateTime. Timestamp for when the deploy request was received.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">details</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">DeployDetails. Provides the details of a deployment that is in-progress or
                ended if <samp class="codeph nolang">?includeDetails=true</samp> is added as a
                query to the GET request.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">done</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Boolean. Indicates whether the server finished processing the deploy request
                for the specified <span class="keyword parmname">id</span>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">errorMessage</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">String. Message corresponding to the values in the
                <span class="keyword parmname">errorStatusCode</span> field, if any.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">errorStatusCode</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">String. If an error occurred during the deploy request, a status code is
                returned, and the message corresponding to the status code is returned in
                <span class="keyword parmname">errorMessagefield</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">ignoreWarnings</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Boolean. Optional. Defaults to <samp class="codeph nolang">false</samp>.
                Specifies whether a deployment continues even if the deployment generates warnings.
                Don’t set this argument to <samp class="codeph nolang">true</samp> for deployments
                to production organizations.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">lastModifiedDate</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">DateTime. Timestamp of the last update for the deployment process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">numberComponentErrors</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Int. The number of components deployed in the deployment process. Use this
                value with the <span class="keyword parmname">numberComponentsTotal</span> value to get an estimate
                of the deployment’s progress.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">numberComponentsTotal</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Int. The total number of components in the deployment. Use this value with the
                <span class="keyword parmname">numberComponentsDeployed</span> value to get an estimate of the
                deployment’s progress.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">numberTestErrors</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Int. The number of Apex tests that have generated errors during this
                deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">numberTestsCompleted</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">The number of completed Apex tests for this deployment. Use this value with the
                <span class="keyword parmname">numberTestsTotal</span> value to get an estimate of the deployment’s
                test progress.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">numberTestsTotal</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Int. The total number of Apex tests for this deployment. Use this value with
                the <span class="keyword parmname">numberTestsCompleted</span> value to get an estimate of the
                deployment’s test progress. The value in this field isn’t accurate until the
                deployment has started running tests for the components being deployed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">runTestsEnabled</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Boolean. Indicates whether Apex tests were run as part of this deployment
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Tests are either automatically run as part of a deployment or
                can be set to run in the deployOptions child object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">rollbackOnError</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Boolean. Defaults to <samp class="codeph nolang">true</samp>. Indicates
                whether any failure causes a complete rollback (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If <samp class="codeph nolang">false</samp>, whatever set of actions can be performed
                without errors are performed, and errors are returned for the remaining actions.
                This parameter must be set to <samp class="codeph nolang">true</samp> if you’re
                deploying to a production org.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">startDate</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">DateTime. Timestamp for when the deployment process began.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">stateDetail</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">String. Indicates which component is being deployed or which Apex test class is
                running.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Indicates the current state of the deployment. The valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Pending</samp></li>

                  <li class="li"><samp class="codeph nolang">InProgress</samp></li>

                  <li class="li"><samp class="codeph nolang">FinalizingDeploy</samp></li>

                  <li class="li"><samp class="codeph nolang">FinalizingDeployFailed</samp></li>

                  <li class="li"><samp class="codeph nolang">Succeeded</samp></li>

                  <li class="li"><samp class="codeph nolang">SucceededPartial</samp></li>

                  <li class="li"><samp class="codeph nolang">Failed</samp></li>

                  <li class="li"><samp class="codeph nolang">Canceling</samp></li>

                  <li class="li"><samp class="codeph nolang">Canceled</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1057890e493" data-title="Parameter"><span class="keyword parmname">success</span></td>

              <td class="entry" headers="d1057890e496" data-title=""></td>

              <td class="entry" headers="d1057890e498" data-title="Description">Boolean. Indicates whether the deployment was successful (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

          </tbody>

        </table>

<!-- document id=29c87d9aa368f74e00c251f994ccec92ba48a897e11a98132451e50969179f64 url=/legacydeveloper/current/en-us/api_meta/meta_rest_deploy_enable_cli.md -->

# Deploy Metadata with REST API in Salesforce CLI

By default, the Salesforce CLI project deploy start command uses the Metadata SOAP API to deploy source to your org. You can use the Metadata REST API instead by setting a CLI configuration value or environment variable. Compared with SOAP API, REST API offers faster deployment.

  
<table class="permTable sort_table" border="0" summary="Permissions needed for the documented functionality" width="100%">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="permTableHeader  " colspan="2" id="d1061107e51">User
                Permissions Needed</th>

              <th class="permTableHeader  " colspan="2" id="d1061107e54"></th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="permRowLeft" headers="d1061107e51" data-title="User Permissions Needed">To work with Metadata API from Salesforce CLI:</td>

              <td class="permRowRight" headers="d1061107e54" data-title="">
                <p class="p">Modify Metadata Through Metadata API Functions</p>

                <p class="p">Or</p>

                <p class="p">Modify All Data</p>

              </td>

            </tr>

          </tbody>

        </table>

Use the org-metadata-rest-deploy Salesforce CLI runtime configuration variable or SF\_ORG\_METADATA\_REST\_DEPLOY environment variable to set REST API as the default. For more information, see the Salesforce DX Setup Guide.

This example uses the configuration value to set the default for your current project:

sf config set org-metadata-rest-deploy true

To set the default globally for all your projects, use the \--global flag:

sf config set org-metadata-rest-deploy true --global

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Only commands that deploy source, such as **project deploy start**, support REST API. Commands that retrieve source, such as **project retrieve start**, always use SOAP API.

Here are the deploy limits. Limits can change without notice.

| Feature | Limit |
| --- | --- |
| Maximum compressed .zip folder size1 (SOAP API) | Approximately 39 MB |
| Maximum uncompressed folder size2 (SOAP API) | Approximately 600 MB |
| Maximum number of files in AppExchange packages (REST and SOAP API) | 35,000 |
| Maximum number of files in packages (REST and SOAP API) | 10,000 |

1 Metadata API base-64 encodes components after they’re compressed. The resulting .zip file can't exceed 50 MB. Base-64 encoding increases the size of the payload by approximately 22%, so your compressed payload can't exceed approximately 39 MB before encoding.

2 When deploying an unzipped project, all files in the project are compressed first. The maximum size of uncompressed components in an uncompressed project is 600 MB or less, depending on the files’ compression ratio. If the files have a high compression ratio, you can migrate a total of approximately 600 MB because the compressed size would be under 39 MB. However, if the components can't be compressed much, like binary static resources, you can migrate less than 600 MB.

<!-- document id=2d1893f573562d75482a76a3a878e5b8c22a5b8cc80eebcbe0d7ca5f44820b48 url=/legacydeveloper/current/en-us/api_meta/meta_deploy.md -->

# deploy()

Uses file representations of components to create, update, or delete those components in a Salesforce org.

## Syntax

 AsyncResult = metadatabinding.deploy(base64 zipFile, [DeployOptions](#meta_deploy "Uses file representations of components to create, update, or delete those components in a Salesforce org.") deployOptions)

## Usage

Use this call to take file representations of components and deploy them into an org by creating, updating, or deleting the components they represent.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

To migrate Data 360 metadata from a sandbox org to a parent sandbox or a production org, use [DevOps data kit](https://help.salesforce.com/s/articleView?language=en_US&id=data.c360_a_data_package_kits.htm&type=5) instead of this call.

Here are the deploy limits. Limits can change without notice.

| Feature | Limit |
| --- | --- |
| Maximum compressed .zip folder size1 | Approximately 39 MB |
| Maximum uncompressed folder size2 | Approximately 600 MB |
| Maximum number of files included in a first-generation managed package (1GP). Only 1GP packages that have passed AppExchange Security Review can contain this number of files. | 35,000 |
| Maximum number of files included in an unlocked or second-generation managed package | 10,000 |

1 Metadata API base-64 encodes components after they’re compressed. The resulting .zip file can't exceed 50 MB. Base-64 encoding increases the size of the payload by approximately 22%, so your compressed payload can't exceed approximately 39 MB before encoding.

2The maximum size of uncompressed components in an uncompressed project is 600 MB (629,145,600 bytes) or less, depending on the files’ compression ratio. The size limit in bytes is calculated as 600 x 1024 x 1024.

If the files have a high compression ratio, you can migrate a total of approximately 600 MB because the compressed size is under 39 MB. However, if the components can't be compressed much, like binary static resources, you can migrate less than 600 MB.

In API version 29.0, Salesforce improved the deployment status properties and removed the requirement to use checkStatus() after a deploy() call to get information about deployments. Salesforce continues to support the use of checkStatus() when using deploy() with API version 28.0 or earlier.

## Deploy Components to an Org

The package.xml file is a project manifest that lists all the components that you want to retrieve or deploy. You can use package.xml to add components. To delete components, add another manifest file. See [Deleting Components from an Organization](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm "To delete components, perform a deployment with the deploy() call by using a destructive changes manifest file that lists the components to remove from your organization. You can perform a deployment that only deletes components, or a deployment that deletes and adds components. In API version 33.0 and later, you can specify components to delete before and after other components are added or updated. In earlier API versions, if deletions and additions are specified for the same deployment, the deploy() call performs the deletions first.").

For API version 29.0 or later, here’s how to deploy (create or update) packaged or unpackaged components.

1. Issue a deploy() call to start the asynchronous deployment. An [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is returned. Note the value in the [id](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field, and use it for the next step.
2. Issue a [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy().") call in a loop until the [done](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field of the returned [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") contains true, which means that the call is completed. The [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") object contains information about an in-progress or completed deployment started using the deploy() call. When calling [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy()."), pass in the [id](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") value from the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object from the first step.

For API version 28.0 or earlier, here’s how to deploy (create or update) packaged or unpackaged components.

1. Issue a deploy() call to start the asynchronous deployment. An [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is returned. If the call is completed, the done field contains true. Most often, the call isn’t completed quickly enough to be noted in the first result. If it’s completed, note the value in the id field returned, and skip the next step.
2. If the call isn’t complete, issue a checkStatus() call in a loop. In the loop, use the value in the id field of the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object returned by the deploy() call in the previous step. Check the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object, which is returned until the done field contains true. The time taken to complete a deploy() call depends on the size of the zip file being deployed. Therefore, use a longer wait time between iterations as the size of the zip file increases.
3. Issue a checkDeployStatus() call to obtain the results of the deploy() call, using the id value returned in the first step.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The deployment process locks write-access to resources getting deployed until deployment completes. During deployment, changes made to locked resources or related items can result in errors. Salesforce recommends deployments during off-peak usage time and limiting or postponing changes to your org while deployment is in progress.

## Check the Status of a Deployment

Check the status of a deployment using Metadata API or from Setup. You can check the status of deployments that are in progress or completed in the last 30 days.

To check the status of a deployment using Metadata API, see [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy().").

To check the status of a deployment from Setup, enter Deployment Status in the Quick Find box, then select **Deployment Status**.

When running a deployment, the Deployment Status page shows you the real-time progress of your current deployment. This page contains charts that provide a visual representation of the overall deployment progress. The first chart shows how many components have been deployed out of the total and includes the number of components with errors. For example, this chart indicates that 302 components were processed successfully out of 450 and there were 45 components with errors.

![Chart for processed components](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/deploy_donut_chart_comp.png)

After all components have been deployed without errors, Apex tests start running, if necessary or enabled. A second chart shows how many Apex tests have run out of the total number of tests and the number of errors returned. In addition, the chart shows the name of the currently running test. For example, in this chart, 77 tests have completed execution out of a total of 120, and 1 test failed.

![Chart for processed components](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/deploy_donut_chart_tests.png)

You can initiate multiple deployments, but only one deployment can run at a time. The other deployments remain in the queue waiting to run after the current deployment finishes. Queued deployments are listed under Pending Deployments and are not necessarily executed in the order in which they were submitted. To execute deployments in a particular order, submit them one at a time after the previous deployment has completed successfully.

## Cancel a Deployment

Cancel a deployment using the Metadata API or from Setup. You can cancel a deployment while it’s in progress or in the queue. For API versions 65.0 and higher, you can't cancel deployments with a status of Finalizing Deploy. For API versions below 65.0, attempts to cancel a deployment may fail if the deployment has started committing data. Alternatively, it's possible that the cancellation will succeed, but data from the deployment is also committed.

To cancel a deployment using Metadata API, see [cancelDeploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_canceldeploy.htm "Cancels a deployment that hasn’t completed yet.").

To cancel a deployment from Setup, enter Deployment Status in the quick find box, then select **Deployment Status**. Click **Cancel** next to the deployment you want to cancel. The deployment has the status of Cancel Requested until the cancellation completes. A canceled deployment is listed in the Failed section.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the Modify Metadata Through Metadata API Functions permission. Otherwise, enable the Modify All Data permission.

1. [Deleting Components from an Organization](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm)  
    To delete components, perform a deployment with the deploy() call by using a destructive changes manifest file that lists the components to remove from your organization. You can perform a deployment that only deletes components, or a deployment that deletes and adds components. In API version 33.0 and later, you can specify components to delete before and after other components are added or updated. In earlier API versions, if deletions and additions are specified for the same deployment, the deploy() call performs the deletions first.
2. [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm)  
    Checks the status of declarative metadata call deploy().
3. [cancelDeploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_canceldeploy.htm)  
    Cancels a deployment that hasn’t completed yet.

#### See Also

- [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm "Learn default test execution rules for Salesforce production deployments, including API version differences and Apex test requirements.")
- [Run Relevant Apex Tests in a Deployment (Beta)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_run_relevant_tests.htm "Use the RunRelevantTests (beta) test level to run only the Apex tests that are relevant to your deployment. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies.")

## Arguments

### zipFile

- **Type**: base64
- **Description**: Base 64-encoded binary data. Client applications must encode the binary data as base64.

### deployOptions

- **Type**: [DeployOptions](#meta_deploy "Uses file representations of components to create, update, or delete those components in a Salesforce org.")
- **Description**: Encapsulates options for determining which packages or files are deployed.

## DeployOptions

The following deployment options can be selected for this call:

### allowMissingFiles

- **Type**: boolean
- **Description**: If files that are specified in package.xml aren’t in the .zip file, specifies whether a deployment can still succeed. Don’t set this argument for deployment to production orgs.

### autoUpdatePackage

- **Type**: boolean
- **Description**: If a file is in the .zip file but not specified in package.xml, specifies whether the file is automatically added to the package. A retrieve() is issued with the updated package.xml that includes the .zip file. Don’t set this argument for deployment to production orgs.

### checkOnly

- **Type**: boolean
- **Description**: Defaults to false. Set to true to perform a test deployment (validation) of components without saving the components in the target org. A validation enables you to verify the results of tests that would be generated in a deployment, but doesn’t commit any changes. After a validation finishes with passing tests, sometimes it can qualify for deployment without rerunning tests. See [deployRecentValidation()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployRecentValidation.htm "Deploys a recently validated component set without running Apex tests."). If you change a field type from Master-Detail to Lookup or vice versa, the change isn’t supported when using the checkOnly option to test a deployment. This change isn’t supported for test deployments to avoid permanently altering your data. If a change that isn’t supported for test deployments is included in a deployment package, the test deployment fails and issues an error.
    
    If your deployment package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes before you deploy to production. Perform a full deployment to another test sandbox. A full deployment includes a validation of the changes as part of the deployment process.
    
    A Metadata API deployment that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.
    
    1. For a deployment with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to deploy the Master-Detail field, or the deployment fails. During the deployment, detail records are permanently deleted from the Recycle Bin and can’t be recovered.
    2. For a deployment that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deployment to succeed. However, a successful deployment permanently deletes any detail records in the Recycle Bin.

### ignoreWarnings

- **Type**: boolean
- **Description**: Indicates whether deployments with warnings complete successfully (true) or not (false). Defaults to false. The DeployMessage object for a warning contains the following values:
    
    - problemType—Warning
    - problem—The text of the warning
    
    If a warning occurs and ignoreWarnings is set to true, the success field in DeployMessage is true. If ignoreWarnings is set to false, success is set to false and the warning is treated like an error.
    
    This field is available in API version 18.0 and later. Before version 18.0, there was no distinction between warnings and errors. All problems were treated as errors and prevented a successful deployment.

### performRetrieve

- **Type**: boolean
- **Description**: Indicates whether a retrieve() call is performed immediately after the deployment (true) or not (false). Set to true to retrieve whatever was deployed.

### purgeOnDelete

- **Type**: boolean
- **Description**: If true, the deleted components in the destructiveChanges.xml manifest file aren't stored in the Recycle Bin. Instead, they become immediately eligible for deletion. This field is available in API version 22.0 and later.
    
    This option only works in Developer Edition or sandbox orgs. It doesn’t work in production orgs.
    
    When you delete a roll-up summary field using Metadata API, the field isn't saved in the Recycle Bin. The field is purged even if you don’t set the purgeOnDelete deployment option to true.

### rollbackOnError

- **Type**: boolean
- **Description**: Indicates whether any failure causes a complete rollback (true) or not (false). If false, whatever actions can be performed without errors are performed, and errors are returned for the remaining actions. This parameter must be set to true if you’re deploying to a production org. The default is false.

### runAllTests

- **Type**: boolean
- **Description**: (Deprecated and only available in API version 33.0 and earlier.) This field defaults to false. Set to true to run all Apex tests after deployment, including tests that originate from installed managed packages. Apex tests that run as part of a deployment always run synchronously and serially.

### runTests

- **Type**: string\[\]
- **Description**: A list of Apex tests to run during deployment. Specify the class name, one name per instance. The class name can also specify a namespace with a dot notation. For more information, see [Running a Subset of Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_run_specific_tests.htm "Test levels enable you to have more control over which tests are run in a deployment. To shorten deployment time to production, run a subset of tests when deploying Apex components. The default test execution behavior in production has also changed. By default, if no test level is specified, no tests are executed, unless your deployment package contains Apex classes or triggers."). To use this option, set testLevel to RunSpecifiedTests.

### singlePackage

- **Type**: boolean
- **Description**: Indicates whether the specified .zip file points to a directory structure with a single package (true) or a set of packages (false).

### testLevel

- **Type**: TestLevel (enumeration of type string)
- **Description**: Optional. Specifies which tests are run as part of a deployment. The test level is enforced regardless of the types of components that are present in the deployment package. If you don’t specify a test level, the default test execution behavior is used. See [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm "Learn default test execution rules for Salesforce production deployments, including API version differences and Apex test requirements.").
    
    Apex tests that run as part of a deployment always run synchronously and serially.
    
    This field is available in API version 34.0 and later.
- **Possible values**:
    - NoTestRun—No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial organizations. This test level is the default for development environments.
    - RunSpecifiedTests—Only the tests that you specify in the runTests option are run. Code coverage requirements differ from the default coverage requirements when using this test level. Each class and trigger in the deployment package must be covered by the executed tests for a minimum of 75% code coverage. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.
    - RunRelevantTests (beta)—Only tests relevant to the deployment payload are run. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies. For fine-grained control, you can annotate test classes so that they either run regardless of the deployment payload, or run when modified, referenced components are included in the deployment. See [@IsTest Annotation](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm) in the Apex Developer Guide. Each class and trigger in the deployment package must be covered by the executed tests for a minimum of 75% code coverage. This coverage is computed for each class and trigger individually and is different from the overall coverage percentage.
    - RunLocalTests—All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.
    - RunAllTestsInOrg—All tests are run. The tests include all tests in your org, including tests of managed packages.

## Response

[AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")

## Sample Code—Java

This sample shows how to deploy components in a zip file. See the [retrieve() sample code](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve_sample_code_java) for details on how to retrieve a zip file.

package com.doc.samples;

import java.io.\*;

import java.rmi.RemoteException;

import com.sforce.soap.metadata.AsyncResult;
import com.sforce.soap.metadata.DeployDetails;
import com.sforce.soap.metadata.MetadataConnection;
import com.sforce.soap.metadata.DeployOptions;
import com.sforce.soap.metadata.DeployResult;
import com.sforce.soap.metadata.DeployMessage;
import com.sforce.soap.metadata.RunTestsResult;
import com.sforce.soap.metadata.RunTestFailure;
import com.sforce.soap.metadata.CodeCoverageWarning;
import com.sforce.soap.enterprise.LoginResult;
import com.sforce.soap.enterprise.EnterpriseConnection;
import com.sforce.ws.ConnectionException;
import com.sforce.ws.ConnectorConfig;

/\*\*
 \* Deploy a zip file of metadata components. 
 \* Prerequisite: Have a deploy.zip file that includes a package.xml manifest file that 
 \* details the contents of the zip file.
 \*/
public class DeploySample {
    // binding for the metadata WSDL used for making metadata API calls
    private MetadataConnection metadataConnection;

    static BufferedReader rdr = new BufferedReader(new InputStreamReader(System.in));

    private static final String ZIP\_FILE = "deploy.zip";

    // one second in milliseconds
    private static final long ONE\_SECOND = 1000;
    // maximum number of attempts to deploy the zip file
    private static final int MAX\_NUM\_POLL\_REQUESTS = 50; 

    public static void main(String\[\] args) throws Exception {
        final String USERNAME = "user@company.com";
        // This is only a sample. Hard coding passwords in source files is a bad practice.
        final String PASSWORD = "password"; 
        final String URL = "https://login.salesforce.com/services/Soap/c/29.0";
        
        DeploySample sample = new DeploySample(USERNAME, PASSWORD, URL);
        sample.deployZip();
    }
    
    public DeploySample(String username, String password, String loginUrl) 
            throws ConnectionException {
        createMetadataConnection(username, password, loginUrl);
    }

    public void deployZip()
        throws RemoteException, Exception
    {
        byte zipBytes\[\] = readZipFile();
        DeployOptions deployOptions = new DeployOptions();
        deployOptions.setPerformRetrieve(false);
        deployOptions.setRollbackOnError(true);
        AsyncResult asyncResult = metadataConnection.deploy(zipBytes, deployOptions);
        String asyncResultId = asyncResult.getId();
        
        // Wait for the deploy to complete
        int poll = 0;
        long waitTimeMilliSecs = ONE\_SECOND;
        DeployResult deployResult = null;
        boolean fetchDetails;
        do {
            Thread.sleep(waitTimeMilliSecs);
            // double the wait time for the next iteration
            waitTimeMilliSecs \*= 2;
            if (poll++ > MAX\_NUM\_POLL\_REQUESTS) {
                throw new Exception("Request timed out. If this is a large set " +
                        "of metadata components, check that the time allowed by " +
                        "MAX\_NUM\_POLL\_REQUESTS is sufficient.");
            }
            
            // Fetch in-progress details once for every 3 polls
            fetchDetails = (poll % 3 == 0);
            deployResult = metadataConnection.checkDeployStatus(asyncResultId, fetchDetails);
            System.out.println("Status is: " + deployResult.getStatus());
            if (!deployResult.isDone() && fetchDetails) {
                printErrors(deployResult, "Failures for deployment in progress:\\n");
            }
        }
        while (!deployResult.isDone());
        
        if (!deployResult.isSuccess() && deployResult.getErrorStatusCode() != null) {
            throw new Exception(deployResult.getErrorStatusCode() + " msg: " +
                    deployResult.getErrorMessage());
        }

        if (!fetchDetails) {
            // Get the final result with details if we didn't do it in the last attempt.
            deployResult = metadataConnection.checkDeployStatus(asyncResultId, true);
        }

        if (!deployResult.isSuccess()) {
            printErrors(deployResult, "Final list of failures:\\n");
            throw new Exception("The files were not successfully deployed");
        }
        
        System.out.println("The file " + ZIP\_FILE + " was successfully deployed");
    }
    
    /\*\*
     \* Read the zip file contents into a byte array.
     \* @return byte\[\]
     \* @throws Exception - if cannot find the zip file to deploy
     \*/
    private byte\[\] readZipFile()
        throws Exception
    {
        // We assume here that you have a deploy.zip file.
        // See the retrieve sample for how to retrieve a zip file.
        File deployZip = new File(ZIP\_FILE);
        if (!deployZip.exists() || !deployZip.isFile())
            throw new Exception("Cannot find the zip file to deploy. Looking for " +
                    deployZip.getAbsolutePath());
        
        FileInputStream fos = new FileInputStream(deployZip);
        ByteArrayOutputStream bos = new ByteArrayOutputStream();
        int readbyte = -1;
        while ((readbyte = fos.read()) != -1)  {
            bos.write(readbyte);
        }
        fos.close();
        bos.close();
        return bos.toByteArray();
    }
    
 
    /\*\*
     \* Print out any errors, if any, related to the deploy.
     \* @param result - DeployResult
     \*/
    private void printErrors(DeployResult result, String messageHeader)
    {
        DeployDetails deployDetails = result.getDetails();
        
        StringBuilder errorMessageBuilder = new StringBuilder();
        if (deployDetails != null) {
            DeployMessage\[\] componentFailures = deployDetails.getComponentFailures();
            for (DeployMessage message : componentFailures) {
                String loc = (message.getLineNumber() == 0 ? "" :
                    ("(" + message.getLineNumber() + "," +
                            message.getColumnNumber() + ")"));
                if (loc.length() == 0
                        && !message.getFileName().equals(message.getFullName())) {
                    loc = "(" + message.getFullName() + ")";
                }
                errorMessageBuilder.append(message.getFileName() + loc + ":" +
                        message.getProblem()).append('\\n');
            }
            RunTestsResult rtr = deployDetails.getRunTestResult();
            if (rtr.getFailures() != null) {
                for (RunTestFailure failure : rtr.getFailures()) {
                    String n = (failure.getNamespace() == null ? "" :
                        (failure.getNamespace() + ".")) + failure.getName();
                    errorMessageBuilder.append("Test failure, method: " + n + "." +
                            failure.getMethodName() + " -- " +
                            failure.getMessage() + " stack " +
                            failure.getStackTrace() + "\\n\\n");
                }
            }
            if (rtr.getCodeCoverageWarnings() != null) {
                for (CodeCoverageWarning ccw : rtr.getCodeCoverageWarnings()) {
                    errorMessageBuilder.append("Code coverage issue");
                    if (ccw.getName() != null) {
                        String n = (ccw.getNamespace() == null ? "" :
                            (ccw.getNamespace() + ".")) + ccw.getName();
                        errorMessageBuilder.append(", class: " + n);
                    }
                    errorMessageBuilder.append(" -- " + ccw.getMessage() + "\\n");
                }
            }
        }
        
        if (errorMessageBuilder.length() > 0) {
            errorMessageBuilder.insert(0, messageHeader);
            System.out.println(errorMessageBuilder.toString());
        }
    }
    
    private void createMetadataConnection( 
        final String username,
        final String password,
        final String loginUrl) throws ConnectionException {

        final ConnectorConfig loginConfig = new ConnectorConfig();
        loginConfig.setAuthEndpoint(loginUrl);
        loginConfig.setServiceEndpoint(loginUrl);
        loginConfig.setManualLogin(true);
        LoginResult loginResult = (new EnterpriseConnection(loginConfig)).login(
                username, password);
        
        final ConnectorConfig metadataConfig = new ConnectorConfig();
        metadataConfig.setServiceEndpoint(loginResult.getMetadataServerUrl());
        metadataConfig.setSessionId(loginResult.getSessionId());
        this.metadataConnection = new MetadataConnection(metadataConfig);
    }

}

<!-- document id=cb2e3550614650716f6284b1f0f57a1c6822833b088063f738366bc2ffef022b url=/legacydeveloper/current/en-us/api_meta/file_based_zip_file.md -->

# Deploying and Retrieving Metadata with the Zip File

The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.

A component is an instance of a metadata type. For example, CustomObject is a metadata type for custom objects, and the MyCustomObject\_\_c component is an instance of a custom object.

The files that are retrieved or deployed in a .zip file might be unpackaged components that reside in your org (such as standard objects) or packaged components that reside within named packages.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can deploy or retrieve up to 10,000 files at once. The maximum size of the deployed or retrieved .zip file is 39 MB. If the files are uncompressed in an unzipped folder, the size limit is 600 MB or 629,145,600 bytes. The size limit in bytes is calculated as 600 x 1024 x 1024.

Managed packages use different limits: First-generation managed packages that have passed AppExchange Security Review can contain up to 35,000 files. Second-generation managed packages can contain up to 10,000 files.

- Metadata API base-64 encodes components after they’re compressed. The resulting .zip file can't exceed 50 MB, which is the limit for SOAP messages. Base-64 encoding increases the size of the payload, so your compressed payload can't exceed approximately 39 MB before encoding.
- You can perform a retrieve() call for a big object only if its index is defined. If a big object is created in Setup and doesn’t yet have an index defined, you can’t retrieve it.
- Limits can change without notice.

Every .zip file contains a project manifest, a file that’s named package.xml, and a set of directories that contain the components. The manifest file defines the components that you're trying to retrieve or deploy in the .zip file. The manifest also defines the API version that's used for the deployment or retrieval.

You can edit the project manifest, but be careful if you modify the list of components it contains. When you deploy or retrieve components, Metadata API references the components listed in the manifest, not the directories in the .zip file.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If you’re retrieving any components that have dependencies by using the rootTypesWithDependencies parameter in the RetrieveRequest object, the dependent metadata components are added to the returned .zip file and package.xml file in the same directory as the root type that’s being retrieved. This directory has a JSON file for each component with dependencies in the format ComponentName.roottype.dependencies-meta.json.

The following is a sample package.xml file. You can retrieve an individual component for a metadata type by specifying its fullName field value in a members element. You can also retrieve all components of a metadata type by using <members\>\*</members\>.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyCustomObject\_\_c</members\>
        <name\>CustomObject</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>CustomTab</name\>
    </types\>
    <types\>
        <members\>Standard</members\>
        <name\>Profile</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

The following elements can be defined in package.xml.

- <fullName\> contains the name of the server-side package. If no <fullName\> exists, the package.xml defines a client-side unpackaged package.
- <types\> contains the name of the metadata type (for example, CustomObject) and the named members (for example, myCustomObject\_\_c) to be retrieved or deployed. You can add multiple <types\> elements in a manifest file.
- <members\> contains the fullName of the component, for example MyCustomObject\_\_c. The [listMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listmetadata.htm "This call retrieves property information about metadata components in your organization. Data is returned for the components that match the criteria specified in the queries parameter. The queries array can contain up to three ListMetadataQuery queries for each call. This call supports every metadata type: both top-level, such as CustomObject and ApexClass, and child types, such as CustomField and RecordType.") call is useful for determining the fullName for components of a particular metadata type if you want to retrieve an individual component. For many metadata types, you can replace the value in members with the wildcard character \* (asterisk) instead of listing each member separately. See the reference topic for a specific type to determine whether that type supports wildcards.
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    You specify Security in the <members\> element and Settings in the name element when retrieving the SecuritySettings component type.
- <name\> contains the metadata type, for example CustomObject or Profile. There is one name defined for each metadata type in the directory. Any metadata type that extends [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) is a valid value. The name that’s entered must match a metadata type that’s defined in the Metadata API WSDL. See [Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_types_list.htm "Metadata API enables you to access some entities and feature settings that you can customize in the user interface.") for a list.
- <version\> is the API version number that’s used when the .zip file is deployed or retrieved. Currently the valid value is 68.0.

For more sample package.xml manifest files that show you how to work with different subsets of metadata, see [Sample package.xml Manifest Files](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/manifest_samples.htm "This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if you want to work with all the metadata in one batch.").

To delete components, see [Deleting Components from an Organization](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm "To delete components, perform a deployment with the deploy() call by using a destructive changes manifest file that lists the components to remove from your organization. You can perform a deployment that only deletes components, or a deployment that deletes and adds components. In API version 33.0 and later, you can specify components to delete before and after other components are added or updated. In earlier API versions, if deletions and additions are specified for the same deployment, the deploy() call performs the deletions first.").

#### See Also

- [Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_types_list.htm "Metadata API enables you to access some entities and feature settings that you can customize in the user interface.")

<!-- document id=04065495a0d5803a47e8455ab46682a303c076a67274062a7c48a6f5146fa01b url=/legacydeveloper/current/en-us/api_meta/meta_deploymentsettings.md -->

# DeploymentSettings

Represents the settings affecting how deployments behave in the org. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

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

## Version

DeploymentSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">




          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d369490e104">Field Name</th>

              <th class="featureTableHeader  " id="d369490e107">Field Type</th>

              <th class="featureTableHeader  " id="d369490e110">Description</th>

              <th class="featureTableHeader  " id="d369490e113"></th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d369490e104" data-title="Field Name"><span class="keyword parmname">doesSkipAsyncApexValidation</span></td>

              <td class="entry" headers="d369490e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369490e110" data-title="Description">Indicates whether deployments from this org skip asynchronous Apex validations
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">true</samp>.<p class="p">Set this field to <samp class="codeph nolang">false</samp>
                  when an Apex class in the package you’re deploying is used by an Apex batch job
                  that could run during the deployment. The deployment of a package containing an
                  Apex class that is used by a running batch job fails without
                  validation.</p>
              </td>

              <td class="entry" headers="d369490e113" data-title=""></td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a DeploymentSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<DeploymentSettings xmlns="http://soap.sforce.com/2006/04/metadata">
   <doesSkipAsyncApexValidation\>true</doesSkipAsyncApexValidation\>
</DeploymentSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>Deployment</members\>
      <name\>Settings</name\>
   </types\>
   <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=4606a54bad2d9ec1406fe10b6d01d5b2cbe8019db9202fdc8e4d372c1f3ccc34 url=/legacydeveloper/current/en-us/api_meta/meta_deployRecentValidation.md -->

# deployRecentValidation()

Deploys a recently validated component set without running Apex tests.

## Syntax

string = metadatabinding.deployRecentValidation(ID validationID)

## Usage

Use deployRecentValidation() to deploy your components to production in less time by skipping the execution of Apex tests. Ensure that the following requirements are met before deploying a recent validation.

- The components have been validated successfully for the target environment within the last 10 days.
- As part of the validation, Apex tests in the target org have passed.
- Code coverage requirements are met.
    - If all tests in the org or all local tests are run, overall code coverage is at least 75%, and Apex triggers have some coverage.
    - If specific tests are run with the RunSpecifiedTests test level, each class and trigger that was deployed is covered by at least 75% individually.

This call is equivalent to performing a quick deployment of a recent validation on the Deployment Status page in the Salesforce user interface.

Before you call deployRecentValidation(), your organization must have a validation that was recently run. You can run a validation on a set of components by calling [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") with the checkOnly property of the deployOptions parameter set to true. Note the ID that you obtained from the deploy() call. You’ll use this ID for the deployRecentValidation() call in the next step.

After you’ve run a validation successfully, use these steps to quick-deploy the validation to the same target environment.

1. To start an asynchronous quick deployment, call deployRecentValidation() and pass it the ID of a recent validation. This ID is obtained from the previous [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call. The deployRecentValidation() call returns the ID of the quick deployment. Note this value. You’ll use it in the next step.
2. Check for the completion of the call. This process is similar to that of [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org."). Issue a [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy().") call in a loop until the [done](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") field of the returned [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") contains true, which means that the call is completed. The [DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm "Contains information about the success or failure of the associated deploy() call.") object contains information about an in-progress or completed deployment that was started by using the deployRecentValidation() call. When calling [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy()."), pass in the ID value that you obtained in the first step.

## Version

Available in API version 33.0 and later.

## Arguments

### validationID

- **Type**: string
- **Description**: The ID of a recent validation.

## Response

Type: string

The ID of the quick deployment.

## Sample Code—Java

package com.salesforce.test.metadata;

import java.rmi.RemoteException;

import com.sforce.soap.metadata.CodeCoverageWarning;
import com.sforce.soap.metadata.DeployDetails;
import com.sforce.soap.metadata.DeployMessage;
import com.sforce.soap.metadata.DeployResult;
import com.sforce.soap.metadata.MetadataConnection;
import com.sforce.soap.metadata.RunTestFailure;
import com.sforce.soap.metadata.RunTestsResult;
import com.sforce.soap.partner.Connector;
import com.sforce.ws.ConnectionException;
import com.sforce.ws.ConnectorConfig;

/\*\*
 \* Quick-deploy a recent validation. 
 \* Prerequisite: A successful validation (check-only deploy) has been done in the org recently. 
 \*/
public class DeployRecentValidationSample {
    // binding for the metadata WSDL used for making metadata API calls
    private MetadataConnection metadataConnection;

    // one second in milliseconds
    private static final long ONE\_SECOND = 1000;
    // maximum number of attempts to deploy the zip file
    private static final int MAX\_NUM\_POLL\_REQUESTS = 50; 

    public static void main(String\[\] args) throws Exception {
        final String USERNAME = args\[0\];
        final String PASSWORD = args\[1\]; 
        final String URL = args\[2\];
        
        final String recentValidationId = args\[3\];
        
        DeployRecentValidationSample sample = new DeployRecentValidationSample(
                          USERNAME, PASSWORD, URL);
        sample.deployRecentValidation(recentValidationId);
    }
    
    public DeployRecentValidationSample(String username, String password, String loginUrl) 
            throws ConnectionException {
        createMetadataConnection(username, password, loginUrl);
    }

    public void deployRecentValidation(String recentValidationId)
        throws RemoteException, Exception
    {
        String asyncResultId = metadataConnection.deployRecentValidation(recentValidationId);
        
        // Wait for the deploy to complete
        int poll = 0;
        long waitTimeMilliSecs = ONE\_SECOND;
        DeployResult deployResult = null;
        boolean fetchDetails;
        do {
            Thread.sleep(waitTimeMilliSecs);
            // double the wait time for the next iteration
            waitTimeMilliSecs \*= 2;
            if (poll++ > MAX\_NUM\_POLL\_REQUESTS) {
                throw new Exception("Request timed out. If this is a large set " +
                        "of metadata components, check that the time allowed by " +
                        "MAX\_NUM\_POLL\_REQUESTS is sufficient.");
            }
            
            // Fetch in-progress details once for every 3 polls
            fetchDetails = (poll % 3 == 0);
            deployResult = metadataConnection.checkDeployStatus(asyncResultId, fetchDetails);
            System.out.println("Status is: " + deployResult.getStatus());
            if (!deployResult.isDone() && fetchDetails) {
                printErrors(deployResult, "Failures for deployment in progress:\\n");
            }
        }
        while (!deployResult.isDone());
        
        if (!deployResult.isSuccess() && deployResult.getErrorStatusCode() != null) {
            throw new Exception(deployResult.getErrorStatusCode() + " msg: " +
                    deployResult.getErrorMessage());
        }

        if (!fetchDetails) {
            // Get the final result with details if we didn't do it in the last attempt.
            deployResult = metadataConnection.checkDeployStatus(asyncResultId, true);
        }

        if (!deployResult.isSuccess()) {
            printErrors(deployResult, "Final list of failures:\\n");
            throw new Exception("The files were not successfully deployed");
        }
        
        System.out.println("The recent validation " + recentValidationId + 
                            " was successfully deployed");
    }
    
    /\*\*
     \* Print out any errors, if any, related to the deploy.
     \* @param result - DeployResult
     \*/
    private void printErrors(DeployResult result, String messageHeader)
    {
        DeployDetails deployDetails = result.getDetails();
        
        StringBuilder errorMessageBuilder = new StringBuilder();
        if (deployDetails != null) {
            DeployMessage\[\] componentFailures = deployDetails.getComponentFailures();
            for (DeployMessage message : componentFailures) {
                String loc = (message.getLineNumber() == 0 ? "" :
                    ("(" + message.getLineNumber() + "," +
                            message.getColumnNumber() + ")"));
                if (loc.length() == 0
                        && !message.getFileName().equals(message.getFullName())) {
                    loc = "(" + message.getFullName() + ")";
                }
                errorMessageBuilder.append(message.getFileName() + loc + ":" +
                        message.getProblem()).append('\\n');
            }
            RunTestsResult rtr = deployDetails.getRunTestResult();
            if (rtr.getFailures() != null) {
                for (RunTestFailure failure : rtr.getFailures()) {
                    String n = (failure.getNamespace() == null ? "" :
                        (failure.getNamespace() + ".")) + failure.getName();
                    errorMessageBuilder.append("Test failure, method: " + n + "." +
                            failure.getMethodName() + " -- " +
                            failure.getMessage() + " stack " +
                            failure.getStackTrace() + "\\n\\n");
                }
            }
            if (rtr.getCodeCoverageWarnings() != null) {
                for (CodeCoverageWarning ccw : rtr.getCodeCoverageWarnings()) {
                    errorMessageBuilder.append("Code coverage issue");
                    if (ccw.getName() != null) {
                        String n = (ccw.getNamespace() == null ? "" :
                            (ccw.getNamespace() + ".")) + ccw.getName();
                        errorMessageBuilder.append(", class: " + n);
                    }
                    errorMessageBuilder.append(" -- " + ccw.getMessage() + "\\n");
                }
            }
        }
        
        if (errorMessageBuilder.length() > 0) {
            errorMessageBuilder.insert(0, messageHeader);
            System.out.println(errorMessageBuilder.toString());
        }
    }
    
    private void createMetadataConnection( 
        final String username,
        final String password,
        final String loginUrl) throws ConnectionException {

        final ConnectorConfig loginConfig = new ConnectorConfig();
        loginConfig.setUsername(username);
        loginConfig.setPassword(password);
        loginConfig.setAuthEndpoint(loginUrl);
        
        Connector.newConnection(loginConfig);
        
        
        final ConnectorConfig metadataConfig = new ConnectorConfig();
        metadataConfig.setServiceEndpoint(
            loginConfig.getServiceEndpoint().replace("/u/", "/m/"));
        metadataConfig.setSessionId(loginConfig.getSessionId());
        this.metadataConnection = com.sforce.soap.metadata.Connector.
            newConnection(metadataConfig);
    }

}

<!-- document id=0e659fda6c301ecdc356f11d8f00a50fce1f3bf2c47ea3620d6b8c09238baadd url=/legacydeveloper/current/en-us/api_meta/meta_deployresult.md -->

# DeployResult

Contains information about the success or failure of the associated deploy() call.

The asynchronous metadata call [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy().") returns a DeployResult object.

In API version 29.0, Salesforce moved several properties from the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object to the DeployResult object to improve the process for getting information about deployments. For more information about these changes, see [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.").

## Fields

For API version 29.0 and later, the DeployResult object has these properties.

### id

- **Type**: ID
- **Description**: ID of the component being deployed.

### canceledBy

- **Type**: ID
- **Description**: The ID of the user who canceled the deployment. This field is available in API version 30.0 and later.

### canceledByName

- **Type**: string
- **Description**: The full name of the user who canceled the deployment. This field is available in API version 30.0 and later.

### checkOnly

- **Type**: boolean
- **Description**: Indicates whether this deployment is used to check the validity of the deployed files without changing the organization (true) or not (false). A check-only deployment doesn’t deploy any components or change the organization in any way.

### completedDate

- **Type**: dateTime
- **Description**: Timestamp for when the deployment process ended.

### createdBy

- **Type**: ID
- **Description**: The ID of the user who created the deployment. This field is available in API version 30.0 and later.

### createdByName

- **Type**: string
- **Description**: The full name of the user who created the deployment. This field is available in API version 30.0 and later.

### createdDate

- **Type**: dateTime
- **Description**: Timestamp for when the deploy() call was received.

### deployExtensionResults

- **Type**: DeployExtensionResult\[\]
- **Description**: Provides the status of each deployment extension that ran as part of the deployment. Each entry represents one extension type. If no deployment extensions ran, this field is empty. This field is available in API version 67.0 and later.

### details

- **Type**: DeployDetails\[\]
- **Description**: Provides the details of a deployment that is in-progress or ended, if the includeDetails parameter is set to true in the [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy().") call.

### done

- **Type**: boolean
- **Description**: Indicates whether the server finished processing the deploy() call for the specified id.

### errorMessage

- **Type**: string
- **Description**: Message corresponding to the values in the errorStatusCode field, if any.

### errorStatusCode

- **Type**: string
- **Description**: If an error occurred during the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call, a status code is returned, and the message corresponding to the status code is returned in the errorMessage field. For a description of each StatusCode value, see [StatusCode](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_concepts_core_data_objects.htm#statuscode_topic) in the SOAP API Developer Guide.

### ignoreWarnings

- **Type**: boolean
- **Description**: Optional. Defaults to false. Specifies whether a deployment continues even if the deployment generates warnings. Don’t set this argument to true for deployments to production organizations.

### lastModifiedDate

- **Type**: dateTime
- **Description**: Timestamp of the last update for the deployment process.

### numberComponentErrors

- **Type**: int
- **Description**: The number of components that generated errors during this deployment.

### numberComponentsDeployed

- **Type**: int
- **Description**: The number of components deployed in the deployment process. Use this value with the [numberComponentsTotal](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") value to get an estimate of the deployment’s progress.

### numberComponentsTotal

- **Type**: int
- **Description**: The total number of components in the deployment. Use this value with the [numberComponentsDeployed](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") value to get an estimate of the deployment’s progress.

### numberTestErrors

- **Type**: int
- **Description**: The number of Apex tests that have generated errors during this deployment.

### numberTestsCompleted

- **Type**: int
- **Description**: The number of completed Apex tests for this deployment. Use this value with the [numberTestsTotal](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") value to get an estimate of the deployment’s test progress.

### numberTestsTotal

- **Type**: int
- **Description**: The total number of Apex tests for this deployment. Use this value with the [numberTestsCompleted](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm#meta_asyncresult "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") value to get an estimate of the deployment’s test progress. The value in this field isn’t accurate until the deployment has started running tests for the components being deployed.

### numFiles

- **Type**: int
- **Description**: The total number of files included in this deployment. This field is available in API version 64.0 and later.

### runTestsEnabled

- **Type**: boolean
- **Description**: Indicates whether Apex tests were run as part of this deployment (true) or not (false). Tests are either automatically run as part of a deployment or can be set to run in DeployOptions for the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call. For information on when tests are automatically run, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm "Learn default test execution rules for Salesforce production deployments, including API version differences and Apex test requirements."). This field is available in API version 30.0 and later.

### rollbackOnError

- **Type**: boolean
- **Description**: Optional. Defaults to true. Indicates whether any failure causes a complete rollback (true) or not (false). If false, whatever set of actions can be performed without errors are performed, and errors are returned for the remaining actions. This parameter must be set to true if you’re deploying to a production organization.

### startDate

- **Type**: dateTime
- **Description**: Timestamp for when the deployment process began.

### stateDetail

- **Type**: string
- **Description**: Indicates which component is being deployed or which Apex test class is running.

### status

- **Type**: DeployStatus ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: Indicates the current state of the deployment.
- **Possible values**:
    - Pending
    - InProgress
    - FinalizingDeploy
    - FinalizingDeployFailed
    - Succeeded
    - SucceededPartial
    - Failed
    - Canceling
    - Canceled

### success

- **Type**: boolean
- **Description**: Indicates whether the deployment was successful (true) or not (false).

### zipSize

- **Type**: long
- **Description**: The size of the unzipped deployment folder in bytes. This field is available in API version 64.0 and later.

## DeployDetails

These fields provide more information for the details field of the DeployResult object, if the includeDetails parameter is set to (true in the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

While a deployment is still in-progress, the DeployDetails object only contains componentFailures data. After the deployment process finishes, the other fields populate with the data for the entire deployment.

### componentFailures

- **Type**: DeployMessage\[\]
- **Description**: One or more DeployMessage objects containing deployment errors for each component.

### componentSuccesses

- **Type**: DeployMessage\[\]
- **Description**: One or more DeployMessage objects containing successful deployment details for each component.

### retrieveResult

- **Type**: [RetrieveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm "The retrieve() call returns an array of RetrieveResult objects.")
- **Description**: If the performRetrieve parameter was specified for the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call, a [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") call is performed immediately after the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") process completes.

### runTestResult

- **Type**: RunTestResult
- **Description**: If tests were run for the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call, this field contains the test results.

## DeployExtensionResult

Each DeployExtensionResult object contains the status of a single deployment extension returned by [checkDeployStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkdeploystatus.htm "Checks the status of declarative metadata call deploy()."). This object is available in API version 67.0 and later.

### message

- **Type**: string
- **Description**: Optional. An error message if the extension failed, or a progress update if the extension is in progress.

### status

- **Type**: DeployExtensionStatus
- **Description**: The status of the deployment extension. Valid values are:
    - New
    - InProgress
    - Succeeded
    - Failed

### type

- **Type**: string
- **Description**: The type identifier of the deployment extension.

## Properties

For API version 28.0 and earlier, the DeployResult object has the following properties.

### id

- **Type**: ID
- **Description**: ID of the component being deployed.

### messages

- **Type**: DeployMessage\[\]
- **Description**: Contains information about the success or failure of a [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call.

### retrieveResult

- **Type**: [RetrieveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm "The retrieve() call returns an array of RetrieveResult objects.")
- **Description**: If the [performRetrieve](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm#meta_deploy "Uses file representations of components to create, update, or delete those components in a Salesforce org.") parameter was specified for the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call, a [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") call is performed immediately after the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") process completes. This field contains the results of that retrieval.

### runTestResult

- **Type**: RunTestResult
- **Description**: If tests were run for the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call, this field contains the test results.

### success

- **Type**: boolean
- **Description**: Indicates whether the deployment was successful (true) or not (false).

## DeployMessage

Each DeployResult object contains one or more DeployMessage objects. Each DeployMessage object contains information about the deployment success or failure of a component in the deployment .zip file:

As of the Spring '20 release, only authenticated users can access DeployMessage objects.

### changed

- **Type**: boolean
- **Description**: If true, the component was changed as a result of this deployment. If false, the deployed component was the same as the corresponding component already in the organization.

### columnNumber

- **Type**: int
- **Description**: A text file represents each component. If an error occurred during deployment, this field represents the column of the text file where the error occurred.

### componentType

- **Type**: string
- **Description**: The metadata type of the component in this deployment. This field is available in API version 30.0 and later.

### created

- **Type**: boolean
- **Description**: If true, the component was created as a result of this deployment. If false, the component was either deleted or modified as a result of the deployment.

### createdDate

- **Type**: dateTime
- **Description**: The date and time when the component was created as a result of this deployment. This field is available in API version 30.0 and later.

### deleted

- **Type**: boolean
- **Description**: If true, the component was deleted as a result of this deployment. If false, the component was either new or modified as a result of the deployment.

### fileName

- **Type**: string
- **Description**: The name of the file in the .zip file used to deploy this component.

### fullName

- **Type**: string
- **Description**: The full name of the component. Inherited from [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm), this field is defined in the WSDL for this metadata type. It must be specified when creating, updating, or deleting. See [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") to see an example of this field specified for a call.

### id

- **Type**: ID
- **Description**: ID of the component being deployed.

### lineNumber

- **Type**: int
- **Description**: A text file represents each component. If an error occurred during deployment, this field represents the line number of the text file where the error occurred.

### problem

- **Type**: string
- **Description**: If an error or warning occurred, this field contains a description of the problem that caused the compile to fail.

### problemType

- **Type**: DeployProblemType (enumeration of type string)
- **Description**: Indicates the problem type. The problem details are tracked in the problem field. This field is available in API version 18.0 and later. Before version 18.0, there was no distinction between warnings and errors. All problems were treated as errors and prevented a successful deployment.
- **Possible values**:
    - Warning
    - Error

### success

- **Type**: boolean
- **Description**: Indicates whether the component was successfully deployed (true) or not (false).

## RunTestsResult

The RunTestsResult object contains this object. It contains information about whether or not the compile of the specified Apex and run of the unit tests was successful.

A RunTestsResult object has the following properties

### apexLogId

- **Type**: string
- **Description**: The ID of an ApexLog object that is created at the end of a test run. The ApexLog object is created if there is an active trace flag on the user running an Apex test, or on a class or trigger being executed.
    
    This field is available in API version 35.0 and later.

### codeCoverage

- **Type**: CodeCoverageResult\[\]
- **Description**: An array of one or more CodeCoverageResult objects that contains the details of the code coverage for the specified unit tests.

### codeCoverageWarnings

- **Type**: CodeCoverageWarning\[\]
- **Description**: An array of one or more code coverage warnings for the test run. The results include both the total number of lines that could have been executed, as well as the number, line, and column positions of code that was not executed.

### failures

- **Type**: RunTestFailure\[\]
- **Description**: An array of one or more RunTestFailure objects that contain information about the unit test failures, if there are any.

### flowCoverage

- **Type**: [FlowCoverageResult](#flowcoverageresult)\[\]
- **Description**: An array of results from test runs that executed flows. This field is available in API version 44.0 and later.

### flowCoverageWarnings

- **Type**: [FlowCoverageWarning](#flowcoveragewarning)\[\]
- **Description**: An array of warnings generated by test runs that executed flows. This field is available in API version 44.0 and later.

### numFailures

- **Type**: int
- **Description**: The number of failures for the unit tests.

### numTestsRun

- **Type**: int
- **Description**: The number of unit tests that were run.

### successes

- **Type**: RunTestSuccess\[\]
- **Description**: An array of one or more RunTestSuccess objects that contain information about successes, if there are any.

### totalTime

- **Type**: double
- **Description**: The total cumulative time spent running tests, in milliseconds. This can be helpful for performance monitoring.

## CodeCoverageResult

The RunTestResult object contains this object. It contains information about whether or not the compile of the specified Apex and run of the unit tests was successful.

### dmlInfo

- **Type**: CodeLocation\[\]
- **Description**: For each class or trigger tested, for each portion of code tested, this property contains the DML statement locations, the number of times the code was executed, and the total cumulative time spent in these calls. This can be helpful for performance monitoring.

### id

- **Type**: ID
- **Description**: The ID of the CodeLocation . The ID is unique within an organization.

### locationsCovered

- **Type**: CodeLocation\[\]
- **Description**: Identifies the code locations for each class or trigger tested. Includes the line and column of the code tested and the number of times the code was executed. This field is available in API version 68.0 and later.

### locationsNotCovered

- **Type**: CodeLocation\[\]
- **Description**: For each class or trigger tested, if any code is not covered, the line and column of the code not tested, and the number of times the code was executed.

### methodInfo

- **Type**: CodeLocation\[\]
- **Description**: For each class or trigger tested, the method invocation locations, the number of times the code was executed, and the total cumulative time spent in these calls. This can be helpful for performance monitoring.

### name

- **Type**: string
- **Description**: The name of the class or trigger covered.

### namespace

- **Type**: string
- **Description**: The namespace that contained the unit tests, if one is specified.

### numLocations

- **Type**: int
- **Description**: The total number of code locations.

### numLocationsNotCovered

- **Type**: int
- **Description**: The number of code locations not covered by any class or trigger.

### soqlInfo

- **Type**: CodeLocation\[\]
- **Description**: For each class or trigger tested, the location of SOQL statements in the code, the number of times this code was executed, and the total cumulative time spent in these calls. This can be helpful for performance monitoring.

### type

- **Type**: string
- **Description**: Do not use. In early, unsupported releases, used to specify class or package.

## CodeCoverageWarning

The RunTestsResult object contains this object. It contains information about the Apex class which generated warnings.

This object has the following properties.

### id

- **Type**: ID
- **Description**: The ID of the CodeLocation . The ID is unique within an organization.

### message

- **Type**: string
- **Description**: The message of the warning generated.

### name

- **Type**: string
- **Description**: The namespace that contained the unit tests, if one is specified.

### namespace

- **Type**: string
- **Description**: The namespace that contained the unit tests, if one is specified.

## RunTestFailure

The RunTestsResult object returns information about failures during the unit test run.

This object has these properties.

### id

- **Type**: ID
- **Description**: The ID of the class which generated failures.

### message

- **Type**: string
- **Description**: The failure message.

### methodName

- **Type**: string
- **Description**: The name of the method that failed.

### name

- **Type**: string
- **Description**: The name of the class that failed.

### namespace

- **Type**: string
- **Description**: The namespace that contained the class, if one was specified.

### seeAllData

- **Type**: boolean
- **Description**: Indicates whether the test method has access to organization data (true) or not (false). This field is available in API version 33.0 and later.

### stackTrace

- **Type**: string
- **Description**: The stack trace for the failure.

### time

- **Type**: double
- **Description**: The time spent running tests for this failed operation, in milliseconds. This can be helpful for performance monitoring.

### type

- **Type**: string
- **Description**: Do not use. In early, unsupported releases, used to specify class or package.

## FlowCoverageResult

This object contains information about the flow version and the number of elements executed by the test run. This object is available in API version 44.0 and later.

### elementsNotCovered

- **Type**: string
- **Description**: List of elements in the flow version that weren’t executed by the test run.

### flowId

- **Type**: string
- **Description**: The ID of the flow version. The ID is unique within an org.

### flowName

- **Type**: string
- **Description**: The name of the flow that was executed by the test run.

### flowNamespace

- **Type**: string
- **Description**: The namespace that contains the flow, if one is specified.

### numElements

- **Type**: int
- **Description**: The total number of elements in the flow version.

### numElementsNotCovered

- **Type**: int
- **Description**: The number of elements in the flow version that weren’t executed by the test run

### processType

- **Type**: FlowProcessType (enumeration of type string)
- **Description**: The process type of the flow version.

## FlowCoverageWarning

This object contains information about the flow version that generated warnings. This object is available in API version 44.0 and later.

### flowId

- **Type**: string
- **Description**: The ID of the flow version that generated the warning.

### flowName

- **Type**: string
- **Description**: The name of the flow that generated the warning. If the warning applies to the overall test coverage of flows within your org, this value is null.

### flowNamespace

- **Type**: string
- **Description**: The namespace that contains the flow, if one was specified.

### message

- **Type**: string
- **Description**: The message of the warning that was generated.

## RunTestSuccess

The RunTestsResult object returns information about successes during the unit test run.

This object has these properties.

### id

- **Type**: ID
- **Description**: The ID of the class which generated the success.

### methodName

- **Type**: string
- **Description**: The name of the method that succeeded.

### name

- **Type**: string
- **Description**: The name of the class that succeeded.

### namespace

- **Type**: string
- **Description**: The namespace that contained the unit tests, if one is specified.

### seeAllData

- **Type**: boolean
- **Description**: Indicates whether the test method has access to organization data (true) or not (false). This field is available in API version 33.0 and later.

### time

- **Type**: double
- **Description**: The time spent running tests for this operation. This can be helpful for performance monitoring.

## CodeLocation

The RunTestsResult object contains this object in a number of fields.

This object has these properties.

### column

- **Type**: int
- **Description**: The column location of the Apex tested.

### line

- **Type**: int
- **Description**: The line location of the Apex tested.

### numExecutions

- **Type**: int
- **Description**: The number of times the Apex was executed in the test run.

### time

- **Type**: double
- **Description**: The total cumulative time spent at this location. This can be helpful for performance monitoring.

<!-- document id=50aaf564450ad3213e1348158c524c4746ac53ff219912bf1f4dc025a8ebdcc1 url=/legacydeveloper/current/en-us/api_meta/meta_describe.md -->

# describeMetadata()

This call retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types.

## Syntax

 DescribeMetadataResult = metadataConnection.describeMetadata(double apiVersion);

## Arguments

### apiVersion

- **Type**: double
- **Description**: The API version for which you want metadata, for example, 68.0.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Sample Code—Java

public void describeMetadata() {
  try {
    double apiVersion = 21.0;
    // Assuming that the SOAP binding has already been established.
    DescribeMetadataResult res = 
        metadataConnection.describeMetadata(apiVersion);
    StringBuffer sb = new StringBuffer();
    if (res != null && res.getMetadataObjects().length > 0) {
      for (DescribeMetadataObject obj : res.getMetadataObjects()) {
        sb.append("\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\\n");
        sb.append("XMLName: " + obj.getXmlName() + "\\n");
        sb.append("DirName: " + obj.getDirectoryName() + "\\n");
        sb.append("Suffix: " + obj.getSuffix() + "\\n");
        sb.append("\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\\n");
      }
    } else {
      sb.append("Failed to obtain metadata types.");
    }
    System.out.println(sb.toString());
  } catch (ConnectionException ce) {
    ce.printStackTrace();
  }
}

## Response

[DescribeMetadataResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describemeta_result.htm "Contains information about the organization that is useful for developers working with declarative metadata.")

## When to Use describeMetadata() and describeValueType()?

Use the describeMetadata() call to get high-level information about all the metadata types that are available for your organization, such as type names and file suffixes. Use the describeValueType() call to get granular information about a specific metadata type, such as fields contained within the type.

<!-- document id=7c3914e0016c40c6c7a949eff3cd7f9bd5c8945cb24becfeacb52b501faa0ec3 url=/legacydeveloper/current/en-us/api_meta/meta_describemeta_result.md -->

# DescribeMetadataResult

Contains information about the organization that is useful for developers working with declarative metadata.

The [describeMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describe.htm "This call retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types.") call returns a DescribeMetadataResult object.

Each DescribeMetadataResult object has the following properties:

## Fields

### metadataObjects

- **Type**: [DescribeMetadataObject](#describemetadataobject)\[\]
- **Description**: One or more metadata components and their attributes.

### organizationNamespace

- **Type**: string
- **Description**: The namespace of the organization. Specify only for Developer Edition organizations that can contain a managed package. The managed package has a namespace specified when it is created.

### partialSaveAllowed

- **Type**: boolean
- **Description**: Indicates whether [rollbackOnError](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm#meta_deploy "Uses file representations of components to create, update, or delete those components in a Salesforce org.") is allowed (true) or not (false). This value is always :
    - false in production organizations.
    - the opposite of testRequired.

### testRequired

- **Type**: boolean
- **Description**: Indicates whether tests are required (true) or not (false). This value is always the opposite of partialSaveAllowed.

## DescribeMetadataObject

This object is returned as part of the DescribeMetadataResult. Each DescribeMetadataObject has the following properties:

### childXmlNames

- **Type**: string\[\]
- **Description**: List of child sub-components for this component.

### directoryName

- **Type**: string
- **Description**: The name of the directory in the .zip file that contains this component.

### inFolder

- **Type**: boolean
- **Description**: Indicates whether the component is in a folder (true) or not (false). For example, documents, email templates and reports are stored in folders.

### metaFile

- **Type**: boolean
- **Description**: Indicates whether the component requires an accompanying metadata file. For example, documents, classes, and s-controls are components that require an additional metadata file.

### suffix

- **Type**: string
- **Description**: The file suffix for this component.

### xmlName

- **Type**: string
- **Description**: The name of the root element in the metadata file for this component. This name also appears in the Packages > types > name field in the manifest file package.xml.

<!-- document id=57672422c7720c23212069c72de110032ee93f20faa818dfc6dd1f21b8cafef7 url=/legacydeveloper/current/en-us/api_meta/meta_describeValueType.md -->

# describeValueType()

Retrieves the metadata describing a given metadata type (value type).

describeValueType() accepts a namespace and a type name, and returns a DescribeValueTypeResult object. This call is available in API version 33.0 and later.

## Syntax

DescribeValueTypeResult = connection.describeValueType("{namespace}type\_name");

## Example

Describe Apex class metadata in the Metadata namespace:

DescribeValueTypeResult = metadataConnection.describeValueType("{http://soap.sforce.com/2006/04/metadata}ApexClass");

Describe Apex class metadata in the Tooling namespace:

DescribeValueTypeResult = toolingConnection.describeValueType("{urn:metadata.tooling.soap.sforce.com}ApexClass");

## Arguments

### type

- **Type**: string
- **Description**: The name of the metadata type for which you want metadata; for example, ApexClass. Include the namespace.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Sample Code—Java

The following example describes several metadata types by specifying the Metadata namespace. Each metadata type is described using the helper method, doDescribe(), which calls the describeValueType() Metadata API call. The sample retrieves information from the returned DescribeValueTypeResult: a property, the parent field (if any), and the fields. Next, the sample iterates through the fields and outputs information about each field.

public void describeValueType() throws ConnectionException {
    doDescribe("{http://soap.sforce.com/2006/04/metadata}CustomObject");
    doDescribe("{http://soap.sforce.com/2006/04/metadata}CustomField");
    doDescribe("{http://soap.sforce.com/2006/04/metadata}EmailTemplate");
}

public void doDescribe(String type) throws ConnectionException {
    DescribeValueTypeResult result = metadataConnection.describeValueType(type);
    StringBuffer sb = new StringBuffer();

    sb.append("Describing " + type + " ...\\n");

    if (result.getApiCreatable() == true) {
        sb.append("Is API creatable.\\n");
    } else {
        sb.append("Is not API creatable.\\n");
    }

    ValueTypeField parentField = result.getParentField();
    if (parentField != null) {
        sb.append("\*\* Parent type fields \*\*\\n");
        if (parentField.getIsForeignKey()) {
            sb.append("This field is a foreign key.\\n");
            for (String fkDomain : parentField.getForeignKeyDomain()) { 
                sb.append("Foreign key domain: " + fkDomain + "\\n");
            }
        }              
    }

    sb.append("\*\* Value type fields \*\*\\n");
    for(ValueTypeField field : result.getValueTypeFields()) {
        sb.append("\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\\n");
        sb.append("Name: " + field.getName() + "\\n");
        sb.append("SoapType: " + field.getSoapType() + "\\n");
        if (field.getIsForeignKey()) {
            sb.append("This field is a foreign key.\\n");
            for (String fkDomain : field.getForeignKeyDomain()) { 
                sb.append("Foreign key domain: " + fkDomain + "\\n");
            }
        }
        sb.append("\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\\n");
    }
    System.out.println(sb.toString());
}

To run the previous example with the Tooling WSDL, replace the namespace with the Tooling namespace in the helper function call as follows. Also, use the Tooling connection instead of the Metadata connection to make the describeValueType() call.

    doDescribe("{urn:metadata.tooling.soap.sforce.com}CustomObject");
    doDescribe("{urn:metadata.tooling.soap.sforce.com}CustomField");
    doDescribe("{urn:metadata.tooling.soap.sforce.com}EmailTemplate");

After you run the sample, the output looks similar to the following.

Describing {http://soap.sforce.com/2006/04/metadata}CustomObject ...
Is API creatable.
\*\* Value type fields \*\*
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
Name: actionOverrides
SoapType: ActionOverride
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
Name: allowInChatterGroups
SoapType: boolean
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
Name: articleTypeChannelDisplay
SoapType: ArticleTypeChannelDisplay
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
Name: businessProcesses
SoapType: BusinessProcess
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
Name: compactLayoutAssignment
SoapType: string
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
Name: compactLayouts
SoapType: CompactLayout
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
Name: customHelp
SoapType: string
This field is a foreign key.
Foreign key domain: ApexPage
Foreign key domain: Scontrol
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
<The rest of the output for CustomObject has been omitted for brevity.>

Describing {http://soap.sforce.com/2006/04/metadata}CustomField ...
Is API creatable.
\*\* Parent type fields \*\*
This field is a foreign key.
Foreign key domain: CustomObject
\*\* Value type fields \*\*
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
Name: caseSensitive
SoapType: boolean
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

Name: defaultValue
SoapType: string
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<The rest of the output has been omitted for brevity.>

## Response

[DescribeValueTypeResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describeValueTypeResult.htm "Contains information about a value type that’s useful for developers working with declarative metadata.")

<!-- document id=23d9ba38b72c6130ae7cedeb991d473226db344d1b36587c514a1c31f1b899e7 url=/legacydeveloper/current/en-us/api_meta/meta_describeValueTypeResult.md -->

# DescribeValueTypeResult

Contains information about a value type that’s useful for developers working with declarative metadata.

The [describeValueType()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describeValueType.htm "Retrieves the metadata describing a given metadata type (value type).") call returns a DescribeValueTypeResult object.

Each DescribeValueTypeResult object has these properties.

## Fields

### apiCreatable

- **Type**: boolean
- **Description**: Indicates whether this value type can be created through the [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") call (true) or not (false). This field is available in API version 36.0 and later.

### apiDeletable

- **Type**: boolean
- **Description**: Indicates whether this value type can be created through the [deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm "Deletes one or more metadata components from your organization synchronously.") call (true) or not (false). This field is available in API version 36.0 and later.

### apiReadable

- **Type**: boolean
- **Description**: Indicates whether this value type can be created through the [readMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_readMetadata.htm "Returns one or more metadata components from your organization synchronously.") call (true) or not (false). This field is available in API version 36.0 and later.

### apiUpdatable

- **Type**: boolean
- **Description**: Indicates whether this value type can be created through the [updateMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_updateMetadata.htm "Updates one or more metadata components in your organization synchronously.") call (true) or not (false). This field is available in API version 36.0 and later.

### parentField

- **Type**: [ValueTypeField](#describemetadataobject)
- **Description**: Information about the parent of this value type. Parent field information is useful for metadata types that are specified with the parent in their name, such as custom fields, email templates, workflow rules, and reports. For example, the full name of a custom field includes the sObject that contains it (for example, Account.field1\_\_c). Similarly, the full name of an email template includes the folder where the template is stored (for example, MyFolder/EmailTemplate1). If the value type has no parent, this field is null.
    
    This field is available in API version 36.0 and later.

### valueTypeFields

- **Type**: [ValueTypeField](#describemetadataobject)\[\]
- **Description**: One or more metadata components and their attributes.

## ValueTypeField

This object is returned as part of the DescribeValueTypeResult and represents the metadata for one field. Each ValueTypeField

### fields

- **Type**: ValueTypeField
- **Description**: The ValueTypeField object for the next field, if any.

### foreignKeyDomain

- **Type**: string
- **Description**: If isForeignKey is True, foreignKeyDomain is the type of object, such as Account or Opportunity.

### isForeignKey

- **Type**: boolean
- **Description**: True if the field is a foreign key. That means this field is the primary key in a different database table.

### isNameField

- **Type**: boolean
- **Description**: True if this value type field is a fullName field; otherwise False.

### minOccurs

- **Type**: int
- **Description**: 1 if this field is required, 0 otherwise.

### name

- **Type**: string
- **Description**: The name of this value type field. The name is null for parent fields.

### picklistValues

- **Type**: [PicklistEntry](#describepicklistentry)\[\]
- **Description**: The individual picklist values if the field is a picklist.

### soapType

- **Type**: string
- **Description**: The data type of the field, such as boolean or double.

### valueRequired

- **Type**: boolean
- **Description**: Required. Indicates whether this value type field must have a value (true) or can be null (false).

## PicklistEntry

This object is returned as part of the DescribeValueTypeResult and represents the metadata for one picklist value. Each PicklistEntry has these properties.

### active

- **Type**: boolean
- **Description**: True if the picklist value is active and displayed in the drop-down list for the picklist field in the user interface. False if the picklist value is inactive.

### defaultValue

- **Type**: boolean
- **Description**: True if the picklist value is a default value, otherwise, False.

### label

- **Type**: string
- **Description**: Display name of this item in the picklist.

### validFor

- **Type**: string

### value

- **Type**: string
- **Description**: Value of this item in the picklist.

<!-- document id=d8d777d13f6642f51fe17ae2db9584dd4bb702ce8d128d97ac6c3aa769c0af43 url=/legacydeveloper/current/en-us/api_meta/meta_dev_platforms.md -->

# Development Platforms

Metadata API supports both file-based and CRUD-based development.

## File-Based Development

The declarative or file-based asynchronous Metadata API [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") and [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") operations deploy or retrieve a .zip file that holds components in a set of folders, and a manifest file named package.xml. For more information, see [Deploying and Retrieving Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based.htm). The easiest way to access the file-based functionality is to use the Salesforce Extensions for Visual Studio Code or Salesforce CLI.

## CRUD-Based Development

The [CRUD Metadata API calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects.") act upon the metadata components in a manner similar to the way synchronous API calls in the enterprise WSDL act upon objects. For more information about the enterprise WSDL, see the [SOAP API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/ "HTML (New Window)").

<!-- document id=33608e2d7768d805e9263fb6c617745a788c7e0060b2b30c8b6125b06d10e528 url=/legacydeveloper/current/en-us/api_meta/meta_devhubsettings.md -->

# DevHubSettings

Represents Dev Hub settings.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all org settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

DevHubSettings values are stored in the DevHub.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

DevHubSettings are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d369860e114">Field Name</th>

              <th class="featureTableHeader  " id="d369860e117">Field Type</th>

              <th class="featureTableHeader  " id="d369860e120">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d369860e114" data-title="Field Name"><span class="keyword parmname">enableALMDevopsCorePref&nbsp;</span></td>

              <td class="entry" headers="d369860e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369860e120" data-title="Description">Indicates whether the&nbsp;Lifecycle Center is enabled: <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>. When enabled, you
                can access the&nbsp;AI-powered, Lifecycle Center for change and release management in the
                org.<p class="p">Available in API version 65.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d369860e114" data-title="Field Name"><span class="keyword parmname">enableDevOpsCenterGA</span></td>

              <td class="entry" headers="d369860e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369860e120" data-title="Description">Indicates whether DevOps Center managed package is enabled: <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>.
                When enabled, you can install and use the generally available (GA) DevOps Center
                package in the org. This is an older version of Lifecycle Center.<p class="p">Available in API
                  version 56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d369860e114" data-title="Field Name">
                <span class="keyword parmname">enableALMSimpleDeployDataPref</span>
              </td>

              <td class="entry" headers="d369860e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369860e120" data-title="Description">Indicates whether configuration data migration to a target org is enabled:
                <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>. When enabled, you can migrate configuration data from a
                Salesforce org to a target org.<p class="p">To enable
                  <span class="keyword parmname">enableALMSimpleDeployDataPref</span>, first enable
                  <span class="keyword parmname">enableALMSimpleDeployPref</span>.
                </p>
                <p class="p">Available in API version
                  65.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d369860e114" data-title="Field Name"><span class="keyword parmname">enableALMSimpleDeployPref</span></td>

              <td class="entry" headers="d369860e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369860e120" data-title="Description">Indicates whether metadata deployment to a target org is enabled: <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>.
                When enabled, you can deploy the metadata from a Salesforce org to a target
                org.<p class="p">Available in API version 65.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d369860e114" data-title="Field Name"><span class="keyword parmname">enableDevopsCenterMigrationPref</span></td>

              <td class="entry" headers="d369860e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369860e120" data-title="Description">Indicates whether migration from the DevOps Center managed package to the
                Lifecycle Center is enabled: <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>. When enabled, you can migrate projects from
                the DevOps Center managed package to the Lifecycle Center in the org.<p class="p">Available in
                  API version 67.0 and later.</p>
                <div class="box message info" id="note_z5x_wf5_xjc">
                  <a name="note_z5x_wf5_xjc"><!-- --></a>
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>enableDevopsCenterMigrationPref is available as a developer preview. Feature
                            isn’t generally available unless or until Salesforce announces its general
                            availability in documentation or in press releases or public statements. All
                            commands, parameters, and other features are subject to change or deprecation at
                            any time, with or without notice. Don't implement functionality developed with
                            these commands or tools.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d369860e114" data-title="Field Name"><span class="keyword parmname">enablePackaging2</span></td>

              <td class="entry" headers="d369860e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369860e120" data-title="Description">Indicates whether unlocked and second-generation managed packaging is enabled:
                <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>. <p class="p">To enable <span class="keyword parmname">enablePackaging2</span>, first enable
                  <span class="keyword parmname">enableScratchOrgManagementPref</span>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d369860e114" data-title="Field Name"><span class="keyword parmname" id="ops_scratchorgmanagementpref"><a name="ops_scratchorgmanagementpref"><!-- --></a>enableScratchOrgManagementPref</span></td>

              <td class="entry" headers="d369860e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369860e120" data-title="Description">Indicates whether Dev Hub is enabled: <samp class="codeph nolang">true</samp>
                or <samp class="codeph nolang">false</samp>. When enabled, a Dev Hub allows you to
                create and manage scratch orgs.</td>

            </tr>

            <tr>
              <td class="entry" headers="d369860e114" data-title="Field Name"><span class="keyword parmname">enableScratchOrgSnapshotPref</span></td>

              <td class="entry" headers="d369860e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369860e120" data-title="Description">Indicates whether Scratch Org Snapshots is enabled: <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>. When enabled, you
                can create snapshots of a fully configured scratch org. A snapshot is a
                point-in-time copy of a scratch org that you can use to create additional scratch
                orgs.<p class="p">Available in API version 61.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d369860e114" data-title="Field Name"><span class="keyword parmname">enableShapeExportPref</span></td>

              <td class="entry" headers="d369860e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d369860e120" data-title="Description">Indicates whether Org Shape is enabled: <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>. When enabled, you
                can create org shapes as the basis for scratch orgs.<p class="p">Available in API version 55.0
                  and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a DevHubSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<DevHubSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enablePackaging2\>true</enablePackaging2\>
    <enableScratchOrgManagementPref\>true</enableScratchOrgManagementPref\>
</DevHubSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=da1ad878cee19cc8d9e3b95cf34b9b062d3ff279bc0c527176dc7927debd14cb url=/legacydeveloper/current/en-us/api_meta/meta_dgtassetmgmtprovider.md -->

# DgtAssetMgmtProvider

Represents external content providers, such as digital asset management (DAM) systems, that integrate with Salesforce CMS. When combined with the DgtAssetMgmtPrvdLghtCpnt type, this metadata type enables organizations to configure external content systems as content providers within the Salesforce platform.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

DgtAssetMgmtProvider components have the suffix .dgtAssetMgmtProvider and are stored in the dgtAssetMgmtProviders folder.

## Version

DgtAssetMgmtProvider components are available in API version 65.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| icon | 
Field Type

string

Description

Stores a reference to the icon resource (typically a Lightning icon or custom image) that visually represents the external content provider in the user interface.



 |
| label | 

Field Type

string

Description

Required. Specifies the display label for the external content provider that users see when they select or view the provider.



 |
| masterLabel | 

Field Type

string

Description

Required. Specifies the primary identifier for the provider in metadata contexts and localization.



 |

## Declarative Metadata Sample Definition

The following is an example of a DgtAssetMgmtProvider component.

<?xml version="1.0" encoding="UTF-8"?>
<DgtAssetMgmtProvider xmlns="http://soap.sforce.com/2006/04/metadata">
    <icon\>My icon</icon\>
    <label\>My text</label\>
    <masterLabel\>My text</masterLabel\>
</DgtAssetMgmtProvider\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>DgtAssetMgmtProvider</name\>
    </types\>
    <version\>65.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=8782b7be252ee01f2c5577a3b4ce6796ba8d996730e44a874b0deb3f487920b0 url=/legacydeveloper/current/en-us/api_meta/meta_dgtassetmgmtprvdlghtcpnt.md -->

# DgtAssetMgmtPrvdLghtCpnt

Represents the Lightning web component configurations for external content providers, such as digital asset management (DAM) systems. This metadata type enables the integration of external content systems with Salesforce CMS using custom Lightning web components.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

DgtAssetMgmtPrvdLghtCpnt components have the suffix .dgtAssetMgmtPrvdLghtCpnt and are stored in the dgtAssetMgmtPrvdLghtCpnts folder.

## Version

DgtAssetMgmtPrvdLghtCpnt components are available in API version 65.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| dgtAssetMgmtProvider | 
Field Type

string

Description

Required. References the external content provider, represented by the [DgtAssetMgmtProvider](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dgtassetmgmtprovider.htm "Represents external content providers, such as digital asset management (DAM) systems, that integrate with Salesforce CMS. When combined with the DgtAssetMgmtPrvdLghtCpnt type, this metadata type enables organizations to configure external content systems as content providers within the Salesforce platform.") type, that this Lightning web component configuration supports.



 |
| lightningComponentBundle | 

Field Type

string

Description

References the Lightning web component, represented by the [LightningComponentBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningcomponentbundle.htm "Represents a Lightning web component bundle. A bundle contains Lightning web component resources.") type, that implements the user interface for the external content provider in Salesforce CMS.

The LightningComponentBundle must be deployed and available before you reference it.



 |
| masterLabel | 

Field Type

string

Description

Required. Specifies the display name of the Lightning web component configuration as it appears in the UI.



 |
| type | 

Field Type

DgtAssetMgmtPrvdLghtCpntType (enumeration of type string)

Description

Required. Specifies the type of external content provider Lightning web component that’s being configured. Possible values are:

- DIGITAL\_ASSET\_MANAGER: Represents a component that provides full management capabilities for external content providers, including browsing, searching, and selecting.
- NONE: Represents an undefined or default provider type. Indicates that no specific provider type is assigned.





 |

## Declarative Metadata Sample Definition

The following is an example of a DgtAssetMgmtPrvdLghtCpnt component.

<?xml version="1.0" encoding="UTF-8"?>
<DgtAssetMgmtPrvdLghtCpnt xmlns="http://soap.sforce.com/2006/04/metadata">
    <dgtAssetMgmtProvider\>External Content Provider</dgtAssetMgmtProvider\>
    <lightningComponentBundle\>myLightningComponentBundle</lightningComponentBundle\>
    <masterLabel\>myComponent</masterLabel\>
    <type\>DIGITAL\_ASSET\_MANAGER</type\>
</DgtAssetMgmtPrvdLghtCpnt\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>DgtAssetMgmtPrvdLghtCpnt</name\>
    </types\>
    <version\>65.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=7d807f152ee5d0c1dc113d3a2f045c498d31aa44b2b6403d5217139f51497c6d url=/legacydeveloper/current/en-us/api_meta/meta_digitalexperiencebundle.md -->

# DigitalExperienceBundle

Represents a text-based code structure of your organization’s workspaces, organized by workspace type, and each workspace’s content items.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DigitalExperienceBundle components have the suffix .digitalExperience and are stored in the digitalExperiences folder.

DigitalExperienceBundle uses workspaces and content types to organize your data in a content-focused structure.

- Workspace: For enhanced Lightning Web Runtime (LWR) sites, a collection of related content items that form the site when combined with data from the [DigitalExperienceConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperienceconfig.htm "Represents details for your organization’s workspaces, such as the site label, site URL path prefix, and workspace type.") metadata type.
    
    For Salesforce CMS, a collection of related content items contained in a general workspace.
    
    For Marketing Cloud, a collection of related content items contained in a marketing or general workspace.
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    The maximum length for a workspace name is 80 characters.
- Workspace type: A way to categorize different kinds of workspaces. For example, the workspace type for enhanced LWR sites is site, and the workspace type for marketing workspaces in Marketing Cloud is marketing. The workspace type determines which content types are available in the workspace. In the DigitalExperienceBundle folder structure, all workspaces of a given type are under that workspace type. site, marketing, and general are the supported workspace types.
- Content types: A way to categorize different kinds of content in a workspace. For example, all routes in an enhanced LWR site are stored under a content type folder called sfdc\_cms\_\_route. Similarly, forms for a marketing workspace are stored under a content type folder called sfdc\_cms\_\_form.
- Content items: For enhanced LWR sites, the individual settings and site components that make up an enhanced LWR site. For example, each of the routes in an enhanced LWR site is a single content item.
    
    For marketing workspaces, the content items used in marketing campaigns. For example, each form in a workspace is a single content item.

Here’s an example of the DigitalExperienceBundle structure.

![DigitalExperienceBundle folder structure](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/DigitalExperienceBundle.png)

When retrieved, DigitalExperienceBundle contains workspace type folders (1) under the digitalExperiences folder.

The marketing folder contains one or more workspace folders (2), each representing a marketing workspace in Marketing Cloud. The site folder contains one or more workspace folders (3), each representing the workspace for an individual enhanced LWR site. Each workspace folder contains an XML file with information about the workspace, such as the label. For enhanced LWR sites, be sure to keep the label value in sync with the site’s network name.

Each workspace folder also contains several content type folders that represent each of the different content types (4) used in that workspace. For example, marketing workspaces support landing pages, forms, emails, and referenced images and branding.

Finally, each content type folder can contain one or more content subfolders. Each content subfolder can contain additional subfolders and several files that, when combined, represent an individual content item, such as a specific view (5).

- A \_meta.json file that contains the metadata for the content item. Use the \_meta.json file to learn the location of a content item within the workspace, or to move the content item to another location, including creating a new location for the content item. You can also use the \_meta.json file to view a content item’s parent-child relationships, to move the content item from one parent to another, or to remove a parent-child relationship entirely.
- A content.json file that contains the primary version of the content item. Each content.json file includes values for the content item’s type, title, and content body. Use this file to edit the content’s properties on your local machine or scratch org and then deploy.
- If applicable, additional JSON files that represent variants of the content item, such as language translations.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Before you deploy the DigitalExperienceBundle in a target org, make sure that any translated variants of content in the target org are also in the source org. If the target org contains a JSON file for a translated variant that isn’t in the source org, deploying the DigitalExperienceBundle fails.

The \_meta.json file contains several properties:

| Property | Description |
| --- | --- |
| apiName | 
Field Type

string

Description

Required.

The name of the associated content item. The apiName allows only alphanumeric and underscore characters and must begin with a letter.

You can use an apiName one time per content type in a given workspace. For example, a single workspace can contain both a view named “home” and a route named “home” but can’t contain two views named “home”.



 |
| parent | 

Field Type

string

Description

The developer name of the content item’s parent. If the content item doesn’t have a parent, then either the parent value is blank or the parent property isn’t displayed at all.



 |
| path | 

Field Type

string

Description

The location of the content item within the workspace’s folder structure. The value is blank for content types at the root level, such as appPage and site.



 |
| type | 

Field Type

string

Description

Required.

The full name of the content type from which the content item was created.

The type is prefixed with sfdc\_cms\_\_. For example, all views in a site workspace have the content type sfdc\_cms\_\_view.



 |

## Version

DigitalExperienceBundle components are available in API version 56.0 and later.

## Special Access Rules

In Experience Cloud, you can use DigitalExperienceBundle for enhanced LWR sites created in Winter ’23 or later. For Aura sites and other LWR sites, use the [ExperienceBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencebundle.htm "Represents a text-based code structure of the settings and site components, such as pages, branding sets, and themes that make up an Experience Builder site. Developers can quickly update and deploy Experience Builder sites programmatically using their preferred development tools. This type extends the Metadata metadata type and inherits its fullName field.") (recommended) or the [SiteDotCom](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sitedotcom.htm "Represents a site for deployment.") metadata types. Packaging is unsupported for enhanced LWR sites.

In Salesforce CMS and in Marketing Cloud, you must have a contributor role in a workspace to retrieve it. For Marketing Cloud, you can package the content of general and marketing workspaces, including landing pages, forms, and emails (and their associated images and branding).

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Contains the description of the workspace.

For site workspaces, this value is empty.



 |
| digitalExperienceFolderShares | 

Field Type

[DigitalExperienceFolderShare\[\]](#DigitalExperienceFolderShare)

Description

The list of folders in the source marketing workspace that are shared with target marketing workspaces.

Available in API version 61.0 and later.



 |
| label | 

Field Type

string

Description

Required.

A user-friendly name for DigitalExperienceBundle, which is defined when the DigitalExperienceBundle is created.



 |
| spaceResources | 

Field Type

[DigitalExperience\[\]](#DigitalExperience)

Description

The list of resources in this DigitalExperienceBundle. Each resource represents a content type, such as views, routes, themes, and languageSettings.



 |

## DigitalExperience

Represents content in the bundle. When retrieved as part of DigitalExperienceBundle, DigitalExperience represents all content for the requested workspace or workspaces. When retrieved on its own, DigitalExperience represents only the content types you specify.

This subtype extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

When you retrieve DigitalExperience, the folder structure matches that of DigitalExperienceBundle, with only the specified content returned.

| Field Name | Description |
| --- | --- |
| fileName | 
Field Type

string

Description

Required.

Name of the resource file.



 |
| filePath | 

Field Type

string

Description

Path to the file within the artifact folder.



 |
| format | 

Field Type

string

Description

Required.

Only JSON is allowed.



 |

## DigitalExperienceFolderShare

Represents a folder in a source marketing workspace that’s shared with other target marketing workspaces. Available in API version 61.0 and later.

| Field Name | Description |
| --- | --- |
| folderPath | 
Field Type

string

Description

The root folder of the shared workspace. The allowed value is \_root.



 |
| sharedWith | 

Field Type

[SharedWith\[\]](#SharedWith)

Description

The list of target workspaces that the source workspace is shared with.



 |

## SharedWith

Represents a target marketing workspace that the source marketing workspace is shared with. Available in API version 61.0 and later.

| Field Name | Description |
| --- | --- |
| fullyQualifiedName | 
Field Type

string

Description

The target workspace that the source workspace is shared with. It uses the format workspace\_type/target\_workspace\_name. For example, marketing/Workspace2.



 |

## Declarative Metadata Sample Definition

The following is an example of a DigitalExperienceBundle component.

<?xml version="1.0" encoding="UTF-8"?>
<DigitalExperienceBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>content</description\>
    <label\>isv1</label\>
</DigitalExperienceBundle\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>site/isv1</members\>
        <name\>DigitalExperienceBundle</name\>
    </types\>
    <version\>56.0</version\>
</Package\>

## Usage

![Tip](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_tip.png)

#### Tip

Before you update the JSON files of an Experience Builder site, we recommend making a copy of the site’s folder as a backup.

To retrieve and deploy DigitalExperienceBundle, 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

- **[DigitalExperienceBundle: Marketing Workspace Bundle and Folders](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle_marketing.htm)**  
    DigitalExperienceBundle uses the marketing workspace type to organize content items used in marketing campaigns in a content-focused, text-based code structure.
- **[DigitalExperienceBundle: Site Workspace Bundle and Folders](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle_site.htm)**  
    DigitalExperienceBundle uses the site workspace type to organize data for enhanced LWR sites in a content-focused, text-based code structure.

<!-- document id=cbec524a0a62ffd80500da9b534914965d6ce61b51d443c43c2cc9de6b6df86b url=/legacydeveloper/current/en-us/api_meta/meta_digitalexperiencebundle_marketing.md -->

# DigitalExperienceBundle: Marketing Workspace Bundle and Folders

DigitalExperienceBundle uses the marketing workspace type to organize content items used in marketing campaigns in a content-focused, text-based code structure.

For Marketing Cloud, the marketing folder contains one or more workspace folders, each representing an individual marketing workspace. Each workspace folder contains a collection of related content items, such as landing pages, forms, and emails, and their associated images and branding.

The folder for each marketing workspace includes content type folders, content item subfolders, and associated data that's contained in content.json and \_meta.json files.

![Marketing workspace type folder structure](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/DigitalExperienceBundle_marketing.png)

The following content type folders represent the content types that are supported in a marketing workspace. For example, forms for a marketing workspace are stored under a content type folder called sfdc\_cms\_\_form.

- [sfdc\_cms\_\_brand Folder](#brand_folder)
- [sfdc\_cms\_\_brandSettings Folder](#brandSettings_folder)
- [sfdc\_cms\_\_email Folder](#email_folder)
- [sfdc\_cms\_\_form Folder](#form_folder)
- [sfdc\_cms\_\_image Folder](#image_folder)
- [sfdc\_cms\_\_landingPage Folder](#landingpage_folder)
- [sfdc\_cms\_\_languageSettings Folder](#language_folder)

## sfdc\_cms\_\_brand Folder

This content type folder contains one content subfolder per brand. Each content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

{
  "type" : "sfdc\_cms\_\_brand",
  "title" : "brand 1",
  "contentBody" : {
    "baseFontFamily" : "{!$brand.fontFamily.arial}",
    "baseFontSize" : {
      "unit" : "px",
      "value" : 16.0
    },
    "borderRadius" : {
      "round" : {
        "unit" : "rem",
        "value" : 0.25
      },
      "square" : {
        "unit" : "rem",
        "value" : 0.0
      }
    },
    "borderWeight" : {
      "medium" : {
        "unit" : "rem",
        "value" : 0.125
      },
      "none" : {
        "unit" : "rem",
        "value" : 0.0
      },
      ...
    },
    "buttonStyleGroup" : {
      "primary" : {
        "lightning:borderRadius" : "{!$brand.borderRadius.round}",
        "lightning:borderWidth" : "{!$brand.borderWeight.thin}",
        "lightning:buttonColorGroup" : {
          "backgroundColor" : "{!$brand.colorScheme.primaryAccent}",
          "backgroundHoverColor" : "{!$brand.colorScheme.primaryAccentDerived}",
          "borderColor" : "{!$brand.colorScheme.primaryAccent}",
          "borderHoverColor" : "{!$brand.colorScheme.primaryAccentDerived}",
          "textColor" : "{!$brand.colorScheme.primaryAccentContrast}",
          "textHoverColor" : "{!$brand.colorScheme.primaryAccentContrastDerived}"
        },
        "lightning:padding" : {
          "bottom" : {
            "unit" : "rem",
            "value" : 0.5
          },
          ...
        },
        "lightning:typography" : "{!$brand.typography.button.button1}"
      },
      "secondary" : {...},
      "tertiary" : {...}
    },
    "colorScheme" : {
      "contrast" : "#000000",
      "neutral" : "#747474",
      "primaryAccent" : "#99F077",
      "primaryAccentContrast" : "#ffffff",
      "primaryAccentContrastDerived" : "#000000",
      "primaryAccentDerived" : "#7fd65f",
      "root" : "#ffffff"
    },
    "fontFamily" : {
      "arial" : {
        "category" : "sans-serif",
        "fallbacks" : \[ "Helvetica" \],
        "name" : "Arial"
      },
      "arialBlack" : {
        "category" : "sans-serif",
        "fallbacks" : \[ "Gadget" \],
        "name" : "Arial Black"
      },
      ...
    },
    "fontSize" : {
      "large" : {
        "unit" : "rem",
        "value" : 1.125
      },
      "medium" : {
        "unit" : "rem",
        "value" : 1.0
      },
      ...
    },
    "spacing" : {
      "large" : {
        "bottom" : {
          "unit" : "rem",
          "value" : 1.5
        },
        "left" : {
          "unit" : "rem",
          "value" : 1.5
        },
        "right" : {
          "unit" : "rem",
          "value" : 1.5
        },
        "top" : {
          "unit" : "rem",
          "value" : 1.5
        }
      },
      ...
    },
    "typography" : {
      "button" : {
        "button1" : {
          "fontFamily" : "{!$brand.baseFontFamily}",
          "fontSize" : "{!$brand.fontSize.medium}",
          "fontWeight" : "{!$brand.fontWeight.normal}",
          "letterSpacing" : "normal",
          "lineHeight" : 1.5,
          "textTransform" : "none"
        }
      },
      ...
    },
    ...
    "lightning:dataProviders" : \[ \],
    "sfdc\_cms:einsteinBrandProperties" : {
      "personality" : {
        "defaultPersonality" : "professional"
      }
    },
    "sfdc\_cms:variants" : \[ \]
  },
  "urlName" : "brand-1",
  "sfdc\_cms:title" : "brand 1",
}

## sfdc\_cms\_\_brandSettings Folder

This content type folder contains one content subfolder called brandSettings. The brandSettings content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

{
  "type" : "sfdc\_cms\_\_brandSettings",
  "title" : "Brand Settings",
  "contentBody" : {
    "defaultBrand" : "brand3"
  },
  "urlName" : "brand-settings"
}

## sfdc\_cms\_\_email Folder

This content type folder contains one content subfolder per email. Each content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

In marketing workspaces, the default data graph, personalization recommenders, personalization points, and decisions aren't included in the bundle. If the workspace includes emails with personalized content that’s based on these objects, then:

- Any merge field or repeater that uses the default data graph or a personalization recommender from the source org is broken in the target org.
- Any dynamic content variations of email components are removed and only the default variations appear in the email.

<apiName>/content.json

{
  "type" : "sfdc\_cms\_\_email",
  "title" : "Email\_marketingSpaceA",
  "contentBody" : {
    "backgroundColor" : "#f3f3f3",
    "lightning:brandSource" : {
      "defaultBrandOption" : "sfdcBrand"
    },
    "lightning:colorScheme" : "{!$brand.colorScheme}",
    "lightning:dataProviders" : \[ {
      "attributes" : {
        "objectApiName" : "UnifiedIndividual\_\_dlm"
      },
      "definition" : "sfdc\_cms\_\_unifiedIndividualDataProvider",
      "sfdcExpressionKey" : "unifiedIndividual"
    } \],
    "lightning:padding" : "{!$brand.spacing.none}",
    "messagePurpose" : "promotional",
    "sfdc\_cms:block" : {
      "definition" : "sfdc\_cms/rootContentBlock",
      "id" : "6458e24b-c1a8-4f7d-b6f0-3659c092f1c3",
      "type" : "block",
      "children" : \[ {
        "attributes" : {
          "lightning:borderRadius" : "{!$brand.borderRadius.square}",
          "lightning:borderWidth" : "{!$brand.borderWeight.none}",
          "lightning:colorScheme" : "{!$brand.colorScheme}",
          "lightning:margin" : "{!$brand.spacing.none}",
          "lightning:padding" : "{!$brand.spacing.xSmall}",
          "stackOnMobile" : true,
          "lightning:backgroundImage" : {
            "repeat" : "no-repeat",
            "position" : "center center",
            "size" : "cover"
          }
        },
        "definition" : "lightning/section",
        "id" : "b61c4d08-7985-41f2-a38c-7f8338e56e00",
        "type" : "block",
        "children" : \[ {
          "attributes" : {
            "columnWidth" : 12.0,
            "lightning:borderRadius" : "{!$brand.borderRadius.square}",
            "lightning:borderWidth" : "{!$brand.borderWeight.none}",
            "lightning:colorScheme" : "{!$brand.colorScheme}",
            "lightning:margin" : "{!$brand.spacing.none}",
            "lightning:padding" : "{!$brand.spacing.xSmall}",
            "lightning:verticalAlignment" : "top",
            "lightning:backgroundImage" : {
              "repeat" : "no-repeat",
              "position" : "center center",
              "size" : "cover"
            }
          },
          "definition" : "lightning/column",
          "id" : "778d9976-82ec-49aa-a3de-ac6485332434",
          "type" : "block",
          "children" : \[ \]
        } \]
      } \]
    },
    "sfdc\_cms:title" : "Email\_marketingSpaceA",
    "subjectLine" : "Email\_marketingSpaceA subject{!$organization.Address}",
    "lightning:expressions" : \[ \],
    "lightning:backgroundImage" : {
      "repeat" : "no-repeat",
      "position" : "center center",
      "size" : "cover"
    },
    "sfdc\_cms:variants" : \[ \]
  },
  "urlName" : "email-mk1"
}

## sfdc\_cms\_\_form Folder

This content type folder contains one content subfolder per form. Each content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

{
  "type" : "sfdc\_cms\_\_form",
  "title" : "Form1\_mk1",
  "contentBody" : {
    "lightning:brandSource" : {
      "defaultBrandOption" : "sfdcBrand"
    },
    "lightning:dataProviders" : \[ {
      "attributes" : {
        "objectApiName" : "Account",
        "recordTypeId" : "012000000000000AAA"
      },
      "definition" : "sfdc\_cms\_\_recordDataProvider",
      "sfdcExpressionKey" : "Flow1"
    } \],
    "sfdc\_cms:block" : {
      "definition" : "sfdc\_cms/rootContentBlock",
      "id" : "fef7b2b0-5ddf-4f0e-b0d5-cdbc77a897e9",
      "type" : "block",
      "children" : \[ {
        "attributes" : {
          "lightning:borderRadius" : "{!$brand.borderRadius.square}",
          "lightning:borderWidth" : "{!$brand.borderWeight.none}",
          "lightning:colorScheme" : "{!$brand.colorScheme}",
          "lightning:margin" : "{!$brand.spacing.none}",
          "lightning:padding" : "{!$brand.spacing.xSmall}",
          "stackOnMobile" : true,
          "lightning:backgroundImage" : {
            "repeat" : "no-repeat",
            "position" : "center center",
            "size" : "cover"
          }
        },
        "definition" : "lightning/section",
        "id" : "43dc4273-47e2-43ad-9e64-f0862eb0fcdf",
        "type" : "block",
        "children" : \[ {
          "attributes" : {
            "columnWidth" : 12.0,
            "lightning:borderRadius" : "{!$brand.borderRadius.square}",
            "lightning:borderWidth" : "{!$brand.borderWeight.none}",
            "lightning:colorScheme" : "{!$brand.colorScheme}",
            "lightning:margin" : "{!$brand.spacing.none}",
            "lightning:padding" : "{!$brand.spacing.xSmall}",
            "lightning:verticalAlignment" : "top",
            "lightning:backgroundImage" : {
              "repeat" : "no-repeat",
              "position" : "center center",
              "size" : "cover"
            }
          },
          "definition" : "lightning/column",
          "id" : "95fc1b5c-481d-4d32-bd03-fec0a4d7aaa0",
          "type" : "block",
          "children" : \[ {
            "attributes" : {
              "lightning:borderRadius" : "{!$brand.borderRadius.square}",
              "lightning:borderWidth" : "{!$brand.borderWeight.none}",
              "lightning:formInputColorGroup" : {
                "backgroundColor" : "{!$brand.colorScheme.root}",
                "borderColor" : "{!$brand.colorScheme.neutral}",
                "textColor" : "{!$brand.colorScheme.contrast}"
              },
              "lightning:horizontalAlignment" : "left",
              "lightning:inputTypography" : "{!$brand.typography.input.input1}",
              "lightning:labelTypography" : "{!$brand.typography.label.label1}",
              "lightning:margin" : "{!$brand.spacing.none}",
              "lightning:padding" : "{!$brand.spacing.none}",
              "maxLength" : 255.0,
              "sfdc\_cms:fieldReference" : "{!Flow1.Name}",
              "sfdc\_cms:formInputLabelProperty" : "Account Name",
              "sfdc\_cms:formInputNameProperty" : "Name",
              "sfdc\_cms:formInputRequiredProperty" : true,
              "width" : "auto"
            },
            "definition" : "lightning/inputText",
            "id" : "6aac0596-26c6-457a-9a9a-cc43ba622739",
            "type" : "block"
          } \]
        } \]
      }, {
        "attributes" : {
          "lightning:borderRadius" : "{!$brand.borderRadius.square}",
          "lightning:borderWidth" : "{!$brand.borderWeight.none}",
          "lightning:colorScheme" : "{!$brand.colorScheme}",
          "lightning:margin" : "{!$brand.spacing.none}",
          "lightning:padding" : "{!$brand.spacing.xSmall}",
          "stackOnMobile" : true,
          "lightning:backgroundImage" : {
            "repeat" : "no-repeat",
            "position" : "center center",
            "size" : "cover"
          }
        },
        "definition" : "lightning/section",
        "id" : "7fe6298e-8c83-4dac-9596-02c629fdc519",
        "type" : "block",
        "children" : \[ {
          "attributes" : {
            "columnWidth" : 12.0,
            "lightning:borderRadius" : "{!$brand.borderRadius.square}",
            "lightning:borderWidth" : "{!$brand.borderWeight.none}",
            "lightning:colorScheme" : "{!$brand.colorScheme}",
            "lightning:margin" : "{!$brand.spacing.none}",
            "lightning:padding" : "{!$brand.spacing.xSmall}",
            "lightning:verticalAlignment" : "top",
            "lightning:backgroundImage" : {
              "repeat" : "no-repeat",
              "position" : "center center",
              "size" : "cover"
            }
          },
          "definition" : "lightning/column",
          "id" : "976bff41-3fa9-4d04-aaf8-3590cb87909f",
          "type" : "block",
          "children" : \[ {
            "attributes" : {
              "lightning:borderRadius" : "{!$brand.buttonStyleGroup.primary.lightning:borderRadius}",
              "lightning:borderWidth" : "{!$brand.buttonStyleGroup.primary.lightning:borderWidth}",
              "lightning:buttonColorGroup" : "{!$brand.buttonStyleGroup.primary.lightning:buttonColorGroup}",
              "lightning:horizontalAlignment" : "center",
              "lightning:margin" : "{!$brand.spacing.none}",
              "lightning:padding" : "{!$brand.buttonStyleGroup.primary.lightning:padding}",
              "lightning:typography" : "{!$brand.buttonStyleGroup.primary.lightning:typography}",
              "sfdc\_cms:styleGroup" : "{!$brand.buttonStyleGroup.primary}",
              "text" : "Submit",
              "width" : "auto",
              "lightning:click" : {
                "actions" : \[ {
                  "definition" : "sfdc\_cms/customEventAction",
                  "attributes" : {
                    "type" : "formsubmit",
                    "options" : {
                      "bubbles" : true
                    }
                  }
                } \]
              }
            },
            "definition" : "lightning/actionButton",
            "id" : "84c67ba2-fffc-46d1-80af-35e66ae85ef3",
            "type" : "block"
          } \]
        } \]
      } \]
    },
    "sfdc\_cms:title" : "Form1\_mk1",
    "formsubmission" : {
      "actions" : \[ {
        "definition" : "sfdc\_cms/umaFormSubmissionAction",
        "attributes" : {
          "formId" : "{!$form.id}",
          "pageReferenceId" : "{!$page.id}",
          "formData" : "{!$form.fields}"
        }
      }, {
        "definition" : "sfdc\_cms/showThankYouAction",
        "attributes" : {
          "message" : "Thank you for your submission."
        }
      } \]
    }
  },
  "urlName" : "form1-mk1"
}

## sfdc\_cms\_\_image Folder

This content type folder contains one content subfolder per image. Each content subfolder contains two or more JSON files and a \_media subfolder that contains the image file.

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

{
  "type" : "sfdc\_cms\_\_image",
  "title" : "Img1\_mk1",
  "contentBody" : {
    "sfdc\_cms:media" : {
      "source" : {
        "mimeType" : "image/png",
        "ref" : "0sNSB000001rKsr2AE",
        "type" : "file",
        "size" : 538158
      }
    }
  },
  "urlName" : "img1-mk1"
}

## sfdc\_cms\_\_landingPage Folder

This content type folder contains one content subfolder per landing page. Each content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

{
  "type" : "sfdc\_cms\_\_landingPage",
  "title" : "LandingPageA\_marketingSpaceA",
  "contentBody" : {
    "lightning:brandSource" : {
      "defaultBrandOption" : "sfdcBrand"
    },
    "sfdc\_cms:block" : {
      "definition" : "sfdc\_cms/rootContentBlock",
      "id" : "ac065643-646a-4b1e-b5ed-7eeeed90d0d3",
      "type" : "block",
      "children" : \[ {
        "attributes" : {
          "lightning:borderRadius" : "{!$brand.borderRadius.square}",
          "lightning:borderWidth" : "{!$brand.borderWeight.none}",
          "lightning:colorScheme" : "{!$brand.colorScheme}",
          "lightning:margin" : "{!$brand.spacing.none}",
          "lightning:padding" : "{!$brand.spacing.xSmall}",
          "stackOnMobile" : true,
          "lightning:backgroundImage" : {
            "repeat" : "no-repeat",
            "position" : "center center",
            "size" : "cover"
          }
        },
        "definition" : "lightning/section",
        "id" : "f6371eda-aafc-4164-a18f-284e49071b76",
        "type" : "block",
        "children" : \[ {
          "attributes" : {
            "columnWidth" : 12.0,
            "lightning:borderRadius" : "{!$brand.borderRadius.square}",
            "lightning:borderWidth" : "{!$brand.borderWeight.none}",
            "lightning:colorScheme" : "{!$brand.colorScheme}",
            "lightning:margin" : "{!$brand.spacing.none}",
            "lightning:padding" : "{!$brand.spacing.xSmall}",
            "lightning:verticalAlignment" : "top",
            "lightning:backgroundImage" : {
              "repeat" : "no-repeat",
              "position" : "center center",
              "size" : "cover"
            }
          },
          "definition" : "lightning/column",
          "id" : "db82b936-f2d8-4d47-b373-71dff7fc1f1d",
          "type" : "block",
          "children" : \[ {
            "attributes" : {
              "imageFitConfig" : {
                "width" : {
                  "unit" : "%",
                  "value" : 100.0
                }
              },
              "imageInfo" : {
                "altText" : "",
                "overrideAltText" : false,
                "source" : {
                  "ref" : "Img1\_mk1",
                  "type" : "imageReference"
                },
                "url" : "/cms/media/MCWJDAQWY2HREBRENINOZIKNNVNM"
              },
              "lightning:borderRadius" : "{!$brand.borderRadius.square}",
              "lightning:borderWidth" : "{!$brand.borderWeight.none}",
              "lightning:colorGroup" : {
                "backgroundColor" : "{!$brand.colorScheme.root}",
                "borderColor" : "{!$brand.colorScheme.neutral}",
                "linkColor" : "{!$brand.colorScheme.primaryAccent}",
                "textColor" : "{!$brand.colorScheme.contrast}"
              },
              "lightning:horizontalAlignment" : "center",
              "lightning:margin" : "{!$brand.spacing.none}",
              "lightning:padding" : "{!$brand.spacing.none}",
              "lightning:typography" : "{!$brand.typography.paragraph.paragraph1}"
            },
            "definition" : "lightning/image",
            "id" : "6775db07-8343-420c-918a-0d91c193902d",
            "type" : "block"
          } \]
        } \]
      } \]
    },
    "sfdc\_cms:seoProperties" : {
      "isIndexed" : false,
      "title" : "LandingPageA\_marketingSpaceA"
    },
    "sfdc\_cms:title" : "LandingPageA\_marketingSpaceA",
    "lightning:dataProviders" : \[ \],
    "lightning:backgroundImage" : {
      "repeat" : "no-repeat",
      "position" : "center center",
      "size" : "cover"
    }
  },
  "urlName" : "lp1-mk1"
}

## sfdc\_cms\_\_languageSettings Folder

This content type folder contains one content subfolder called languages. The languages content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

{
  "type" : "sfdc\_cms\_\_languageSettings",
  "title" : "LanguageContent",
  "contentBody" : {
    "languages" : \[ {
      "locale" : "en\_US",
      "label" : "English (US)",
      "isActive" : true,
      "isAuthoringOnly" : false
    } \],
    "defaultLocale" : "en\_US"
  },
  "urlName" : "languagecontent"
}

<!-- document id=a6c2da5f119ceeaf5265437012b38d8f3aa42d233704bbe40da9bf54ddaab881 url=/legacydeveloper/current/en-us/api_meta/meta_digitalexperiencebundle_site.md -->

# DigitalExperienceBundle: Site Workspace Bundle and Folders

DigitalExperienceBundle uses the site workspace type to organize data for enhanced LWR sites in a content-focused, text-based code structure.

The site folder contains one or more workspace folders, each representing the workspace for an individual enhanced LWR site. Each workspace folder contains a collection of related content items, such as settings and site components, that form the site when combined with data from the [DigitalExperienceConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperienceconfig.htm "Represents details for your organization’s workspaces, such as the site label, site URL path prefix, and workspace type.") metadata type.

The workspace folder for each site includes content type folders, content item subfolders, and associated data that's contained in content.json and \_meta.json files.

![Site workspace type folder structure](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/DigitalExperienceBundle_site.png)

The following content type folders represent the content types that are supported in an enhanced LWR site. For example, all routes in an enhanced LWR site are stored under the sfdc\_cms\_\_route content type folder.

- [sfdc\_cms\_\_appPage Folder](#apppage_folder_section)
- [sfdc\_cms\_\_brandingSet Folder](#brandingset_folder_section)
- [sfdc\_cms\_\_languageSettings Folder](#languagesettings_folder_section)
- [sfdc\_cms\_\_route Folder](#route_folder_section)
- [sfdc\_cms\_\_site Folder](#site_folder_section)
- [sfdc\_cms\_\_theme Folder](#theme_folder_section)
- [sfdc\_cms\_\_themeLayout Folder](#themelayout_folder_section)
- [sfdc\_cms\_\_view Folder](#view_folder_section)

## sfdc\_cms\_\_appPage Folder

This content type folder exists at the root level and contains one content subfolder that represents the site’s single-page application. Only one sfdc\_cms\_\_appPage content item is allowed per site.

The content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

| Property | Description |
| --- | --- |
| currentThemeId | 
Field Type

content link

Description

Represents the apiName of the site’s active theme.



 |
| headMarkup | 

Field Type

string

Description

Allows the addition of custom markup to the site's main page <head> tag. Similar to using **Experience Builder** | **Setting** | **Advanced** | **Head Markup**.

See [Salesforce Help for markup guidance](https://help.salesforce.com/s/articleView?id=experience.community_builder_page_head.htm&type=5&language=en_US "HTML (New Window)").



 |
| isLockerServiceEnabled | 

Field Type

boolean

Description

Indicates whether Lightning Locker is enabled (true) or not (false). The default value is true.



 |
| isRelaxedCSPLevel | 

Field Type

boolean

Description

Controls the ability to run scripts and controls script access to third-party hosts. The default is false.

A false value sets a strict CSP security level, and blocks access to inline scripts and all hosts. A true value sets a relaxed CSP security level, and permits access to inline scripts and allowed hosts. To learn more, see [Select a Security Level in Experience Builder Sites](https://help.salesforce.com/s/articleView?id=experience.networks_security_csp_scriptlevel.htm&type=5&language=en_US "HTML (New Window)").



 |
| templateName | 

Field Type

string

Description

Required.

The unique developer name of the template. Valid values are:

- talon-template-byo—Represents the Build Your Own (LWR) template
- microsite-template-marketing—Represents the Microsite template





 |
| title | 

Field Type

string

Description

Required.

Represents the label of the appPage.



 |
| type | 

Field Type

string

Description

Required.

Represents the content type. The only allowed value is sfdc\_cms\_\_appPage.



 |

{
  "type" : "sfdc\_cms\_\_appPage",
  "title" : "main",
  "contentBody" : {
    "currentThemeId" : "Build\_Your\_Own\_LWR",
    "headMarkup" : "<meta charset="UTF-8" />\\n<meta name="viewport" content="width=device-width, initial-scale=1" />\\n<title>Welcome to LWC Communities!</title>\\n\\n<link rel="stylesheet" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/%7B%20basePath%20%7D/assets/styles/styles.css?{%20versionKey%20}" />\\n\\n\\n<!-- webruntime-branding-shared stylesheets -->\\n<link rel="stylesheet" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/%7B%20basePath%20%7D/assets/styles/salesforce-lightning-design-system.min.css?{%20versionKey%20}" />\\n<link rel="stylesheet" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/%7B%20basePath%20%7D/assets/styles/dxp-site-spacing-styling-hooks.min.css?{%20versionKey%20}" />\\n<link rel="stylesheet" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/%7B%20basePath%20%7D/assets/styles/dxp-styling-hooks.min.css?{%20versionKey%20}" />\\n<link rel="stylesheet" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/%7B%20basePath%20%7D/assets/styles/dxp-slds-extensions.min.css?{%20versionKey%20}" />\\n\\n\\n<!-- webruntime-branding-shared stylesheets -->",
    "isLockerServiceEnabled" : true,
    "isRelaxedCSPLevel" : false,
    "templateName" : "talon-template-byo"
  }
}

## sfdc\_cms\_\_brandingSet Folder

This content type folder contains one content subfolder per branding set. Each content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

| Property | Description |
| --- | --- |
| brandingSetType | 
Field Type

[enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string

Description

Represents whether the color palette stored in the branding set is for the entire site or a specific section. You can’t change one branding set type to another.

Valid values are:

- APP—The branding set applies to the entire site. There can be only one branding set of this type.
- SCOPED—A SCOPED branding set can be applied only to a section component.





 |
| definitionName | 

Field Type

string

Description

Required. Represents the name for the branding set used in the site or template’s theme.

There are two standard templates that have unique naming:

- Build Your Own (LWR) uses talon-template-byo:branding
- Microsite uses microsite-template-marketing:branding





 |
| title | 

Field Type

string

Description

Required.

Represents the label of the brandingSet content item.

The maximum length is 100 characters. The title must be unique within the space’s brandingSet content items.



 |
| type | 

Field Type

string

Description

Required.

Represents the content type. The only supported value is sfdc\_cms\_\_brandingSet.



 |
| values | 

Field Type

object (map)

Description

Required.

Represents a map of branding values that can be applied to a site.



 |

{
  "type" : "sfdc\_cms\_\_brandingSet",
  "title" : "Build Your Own (LWR)",
  "contentBody" : {
    "brandingSetType" : "APP",
    "definitionName" : "talon-template-byo:branding",
    "values" : {
      "BackgroundColor" : "#ffffff",
      "BaseFontSize" : "1rem",
      "BodyFont" : "Salesforce Sans",
      "BodyFontSize" : "1rem",
      "BodyFontStyle" : "normal",
      "BodyFontWeight" : "400",
      "BodyLetterSpacing" : "0em",
      "BodyLineHeight" : "1.5",
      "BodySmallFont" : "Salesforce Sans",
      "BodySmallFontSize" : "0.75rem",
      "BodySmallFontStyle" : "normal",
      "BodySmallFontWeight" : "400",
      "BodySmallLetterSpacing" : "0em",
      "BodySmallLineHeight" : "1.25",
      "BodySmallTextColor" : "var(--dxp-g-root-contrast)",
      "BodySmallTextDecoration" : "none",
      "BodySmallTextTransform" : "none",
      "BodyTextColor" : "var(--dxp-g-root-contrast)",
      "BodyTextDecoration" : "none",
      "BodyTextTransform" : "none",
      "ButtonActiveColor" : "var(--dxp-s-button-color-1)",
      "ButtonBorderRadius" : "4px",
      "ButtonColor" : "var(--dxp-g-brand)",
      "ButtonFocusColor" : "var(--dxp-s-button-color-1)",
      "ButtonFont" : "Salesforce Sans",
      "ButtonFontSize" : "1rem",
      "ButtonFontStyle" : "normal",
      "ButtonFontWeight" : "400",
      "ButtonHoverColor" : "var(--dxp-s-button-color-1)",
      "ButtonLargeBorderRadius" : "4px",
      "ButtonLargeFontSize" : "1.25rem",
      "ButtonLargePadding" : "1.25rem",
      "ButtonLetterSpacing" : "0em",
      "ButtonLineHeight" : "2",
      "ButtonPadding" : "1rem",
      "ButtonSmallBorderRadius" : "4px",
      "ButtonSmallFontSize" : "0.75rem",
      "ButtonSmallPadding" : "0.75rem",
      "ButtonTextTransform" : "none",
      "ColumnSpacerSizeDesktop" : "1rem",
      "ColumnSpacerSizeMobile" : "0.75rem",
      "ComponentSpacerSizeDesktop" : "1.5rem",
      "ComponentSpacerSizeMobile" : "1.5rem",
      "DropdownBackgroundColor" : "var(--dxp-g-root)",
      "DropdownBackgroundHoverColor" : "var(--dxp-g-neutral)",
      "DropdownBorderColor" : "var(--dxp-g-neutral)",
      "DropdownTextColor" : "var(--dxp-g-root-contrast)",
      "DropdownTextHoverColor" : "var(--dxp-g-neutral-contrast)",
      "FormElementBackgroundColor" : "var(--dxp-g-root)",
      "FormElementBorderColor" : "var(--dxp-g-neutral-3)",
      "FormElementBorderRadius" : "4px",
      "FormElementBorderWidth" : "1px",
      "FormElementLabelColor" : "var(--dxp-g-root-contrast)",
      "FormElementTextColor" : "var(--dxp-g-root-contrast)",
      "HeadingExtraLargeColor" : "var(--dxp-g-root-contrast)",
      "HeadingExtraLargeFont" : "Salesforce Sans",
      "HeadingExtraLargeFontSize" : "2.5rem",
      "HeadingExtraLargeFontStyle" : "normal",
      "HeadingExtraLargeFontWeight" : "300",
      "HeadingExtraLargeLetterSpacing" : "0em",
      "HeadingExtraLargeLineHeight" : "1.25",
      "HeadingExtraLargeTextDecoration" : "none",
      "HeadingExtraLargeTextTransform" : "none",
      "HeadingLargeColor" : "var(--dxp-g-root-contrast)",
      "HeadingLargeFont" : "Salesforce Sans",
      "HeadingLargeFontSize" : "1.75rem",
      "HeadingLargeFontStyle" : "normal",
      "HeadingLargeFontWeight" : "300",
      "HeadingLargeLetterSpacing" : "0em",
      "HeadingLargeLineHeight" : "1.25",
      "HeadingLargeTextDecoration" : "none",
      "HeadingLargeTextTransform" : "none",
      "HeadingMediumColor" : "var(--dxp-g-root-contrast)",
      "HeadingMediumFont" : "Salesforce Sans",
      "HeadingMediumFontSize" : "1.25rem",
      "HeadingMediumFontStyle" : "normal",
      "HeadingMediumFontWeight" : "300",
      "HeadingMediumLetterSpacing" : "0em",
      "HeadingMediumLineHeight" : "1.25",
      "HeadingMediumTextDecoration" : "none",
      "HeadingMediumTextTransform" : "none",
      "HeadingSmallColor" : "var(--dxp-g-root-contrast)",
      "HeadingSmallFont" : "Salesforce Sans",
      "HeadingSmallFontSize" : "1.125rem",
      "HeadingSmallFontStyle" : "normal",
      "HeadingSmallFontWeight" : "300",
      "HeadingSmallLetterSpacing" : "0em",
      "HeadingSmallLineHeight" : "1.25",
      "HeadingSmallTextDecoration" : "none",
      "HeadingSmallTextTransform" : "none",
      "HorizontalRowPaddingDesktop" : "1rem",
      "HorizontalRowPaddingMobile" : "0.75rem",
      "LinkColor" : "var(--dxp-g-brand)",
      "LinkHoverColor" : "var(--dxp-s-link-text-color-1)",
      "LinkTextDecoration" : "none",
      "LinkTextDecorationFocus" : "underline",
      "LinkTextDecorationHover" : "underline",
      "MaxContentWidthDesktop" : "1800px",
      "MaxContentWidthMobile" : "none",
      "MobileBaseFontSize" : "1rem",
      "PrimaryAccentColor" : "#005fb2",
      "PrimaryAccentForegroundColor" : "#ffffff",
      "SiteLogo" : "",
      "TextColor" : "#1a1b1e",
      "VerticalRowPaddingDesktop" : "1rem",
      "VerticalRowPaddingMobile" : "0.75rem",
      "\_BackgroundColor1" : "#ebebeb",
      "\_BackgroundColor2" : "#c2c2c2",
      "\_BackgroundColor3" : "#858585",
      "\_ButtonActiveColorContrast" : "var(--dxp-g-brand-contrast-1)",
      "\_ButtonColor1" : "var(--dxp-g-brand-1)",
      "\_ButtonColorContrast" : "var(--dxp-g-brand-contrast)",
      "\_ButtonFocusColorContrast" : "var(--dxp-g-brand-contrast-1)",
      "\_ButtonHoverColorContrast" : "var(--dxp-g-brand-contrast-1)",
      "\_DestructiveColor" : "#c23934",
      "\_DestructiveColor1" : "#a2302b",
      "\_DestructiveColor2" : "#611d1a",
      "\_DestructiveColor3" : "#010000",
      "\_DestructiveForegroundColor" : "#ffffff",
      "\_DestructiveForegroundColor1" : "#ffffff",
      "\_DestructiveForegroundColor2" : "#ffffff",
      "\_DestructiveForegroundColor3" : "#ffffff",
      "\_InfoColor" : "#16325c",
      "\_InfoColor1" : "#0e203b",
      "\_InfoColor2" : "#000000",
      "\_InfoColor3" : "#000000",
      "\_InfoForegroundColor" : "#ffffff",
      "\_InfoForegroundColor1" : "#ffffff",
      "\_InfoForegroundColor2" : "#ffffff",
      "\_InfoForegroundColor3" : "#ffffff",
      "\_LinkColor1" : "var(--dxp-g-brand-1)",
      "\_NeutralColor" : "#ecebea",
      "\_NeutralColor1" : "#d9d7d5",
      "\_NeutralColor2" : "#b2aeaa",
      "\_NeutralColor3" : "#76716b",
      "\_NeutralForegroundColor" : "#000000",
      "\_NeutralForegroundColor1" : "#000000",
      "\_NeutralForegroundColor2" : "#000000",
      "\_NeutralForegroundColor3" : "#ffffff",
      "\_OfflineColor" : "#444444",
      "\_OfflineColor1" : "#303030",
      "\_OfflineColor2" : "#070707",
      "\_OfflineColor3" : "#000000",
      "\_OfflineForegroundColor" : "#ffffff",
      "\_OfflineForegroundColor1" : "#ffffff",
      "\_OfflineForegroundColor2" : "#ffffff",
      "\_OfflineForegroundColor3" : "#ffffff",
      "\_PrimaryAccentColor1" : "#004989",
      "\_PrimaryAccentColor2" : "#001e38",
      "\_PrimaryAccentColor3" : "#000000",
      "\_PrimaryAccentForegroundColor1" : "#ffffff",
      "\_PrimaryAccentForegroundColor2" : "#ffffff",
      "\_PrimaryAccentForegroundColor3" : "#ffffff",
      "\_SiteLogoUrl" : "",
      "\_SuccessColor" : "#4bca81",
      "\_SuccessColor1" : "#36b66c",
      "\_SuccessColor2" : "#237747",
      "\_SuccessColor3" : "#07190f",
      "\_SuccessForegroundColor" : "#000000",
      "\_SuccessForegroundColor1" : "#000000",
      "\_SuccessForegroundColor2" : "#ffffff",
      "\_SuccessForegroundColor3" : "#ffffff",
      "\_TextColor1" : "#000000",
      "\_TextColor2" : "#000000",
      "\_TextColor3" : "#000000",
      "\_WarningColor" : "#ffb75d",
      "\_WarningColor1" : "#ffa534",
      "\_WarningColor2" : "#e27d00",
      "\_WarningColor3" : "#673900",
      "\_WarningForegroundColor" : "#000000",
      "\_WarningForegroundColor1" : "#000000",
      "\_WarningForegroundColor2" : "#000000",
      "\_WarningForegroundColor3" : "#ffffff"
    }
  }
}

## sfdc\_cms\_\_languageSettings Folder

This content type folder contains one content subfolder called languages. The languages content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

| Property | Description |
| --- | --- |
| defaultLocale | 
Field Type

string

Description

Represents the default locale for a workspace. The language listed here is the default fallback language for all of the workspace’s languageTypes.



 |
| languages | 

Field Type

languageType\[\]

Description

Required.

Represents the languages available in the space. Each languageType contains values related to that particular language.



 |
| languageType.fallbacklocale | 

Field Type

string

Description

Represents the locale to use when no content is available for the selected locale. For example, if a site visitor chooses Japanese from the language selector but there’s no content for that page in Japanese, content is displayed in the fallback locale.

The fallbackLocale's isAuthoringOnly value must be false.

Only one level of fallback is allowed. Here are examples for a workspace with a locale of en\_US, and with Spanish, French, and Finnish as supported locales.

- Not allowed: Spanish falls back to French, and French falls back to Finnish. This configuration includes two levels of fallback.
- Allowed: Spanish falls back to French, and French falls back to English. en\_US is the workspace’s default.
- Allowed: Spanish falls back to French, and French has no fallback.

This property is displayed only if the languageType.fallbackLocale is different from the workspace’s default locale.



 |
| languageType.isActive | 

Field Type

boolean

Description

Indicates whether the language is active (true) or inactive (false). The only supported value is true.



 |
| languageType.isAuthoringOnly | 

Field Type

boolean

Description

Indicates whether the language is scoped only to authoring workspace (true) or not (false). The default value is false.

When set to true, the languageType and its associated translations aren’t visible to site visitors. When set to false, site visitors can see the languageType and its associated translations.



 |
| languageType.label | 

Field Type

string

Description

Required. Defines the display label for a language. The display label appears in any language selector components that you add to your site and in the language selector in Experience Builder.

The default value is the locale name. For example, if languageType.locale\=fr, then languageType.label\=French.



 |
| languageType.locale | 

Field Type

string

Description

Required. Represents the languageCode appended with the countryCode, separated by an underscore. For example, en\_US indicates a languageCode of English, and a countryCode of United States.

Defines the locale, or geographic region, of a language. Locales determine the display format for date and time, user names, address, and commas and periods in numbers.

Each languageType.locale and languageType.label combination can be used only one time per workspace.



 |
| title | 

Field Type

string

Description

Required.

Represents the label of the content item.



 |
| type | 

Field Type

string

Description

Required.

Represents the content type. The only allowed value is sfdc\_cms\_\_languageSettings.



 |

{
  "type" : "sfdc\_cms\_\_languageSettings",
  "title" : "LanguageContent",
  "contentBody" : {
    "languages" : \[ {
      "locale" : "en\_US",
      "label" : "English (US)",
      "isActive" : true,
      "isAuthoringOnly" : false
    } \],
    "defaultLocale" : "en\_US"
  }
}

## sfdc\_cms\_\_route Folder

This content type folder contains one content subfolder for each of the site’s routes. Each route content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

| Property | Description |
| --- | --- |
| activeViewId | 
Field Type

content link

Description

Required.

Represents the apiName of the route’s active view.

Must reference an existing view in the same workspace.



 |
| configurationTags | 

Field Type

string\[\]

Description

Represents the configuration tags for the route. The only allowed value is all-in-static-site.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Don’t edit this property, because it’s an internal property.















 |
| pageAccess | 

Field Type

[enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string

Description

Identifies the status of a route as public or private.

When set to the default value UseParent, the status of the site determines the status of the route. This value isn’t editable from the user interface for routes that are always private.

Valid values are:

- UseParent
- Public
- RequiresLogin

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can change the pageAccess value only if the site is authenticated.















 |
| routeType | 

Field Type

string

Description

Required.

Identifies the type of route. The routeType value must be unique within a workspace. This value must match the [viewType](#view_folder_section) value in the corresponding view content item.



 |
| title | 

Field Type

string

Description

Required.

Represents the label of the route.



 |
| type | 

Field Type

string

Description

Required.

Represents the content type. The only supported value is sfdc\_cms\_\_route.



 |
| urlPrefix | 

Field Type

string

Description

Required.

Represents the base URL for the route.



 |

{
  "type" : "sfdc\_cms\_\_route",
  "title" : "Error",
  "contentBody" : {
    "activeViewId" : "error",
    "configurationTags" : \[ \],
    "pageAccess" : "UseParent",
    "routeType" : "error",
    "urlPrefix" : "error"
  }
}

## sfdc\_cms\_\_site Folder

This content type folder exists at the root level and contains one content subfolder. The content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

| Property | Description |
| --- | --- |
| AppContainer | 
Field Type

boolean

Description

Valid only for external React apps. When set to true, indicates that the site is used in a React app.

Available in API version 66.0 and later.



 |
| AppSpace | 

Field Type

string

Description

Valid only for external React apps. Refers to the related React app. Uses the format NamespacePrefix\_\_DeveloperName (for example, MyNamespace\_\_MyWebApp or c\_\_MyWebApp for orgs without a registered namespace).

Available in API version 66.0 and later.



 |
| authenticationType | 

Field Type

[enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string

Description

Required.

Indicates whether guest users have access to the site.

Valid values are:

- AUTHENTICATED—The site isn’t public. Only authenticated users can access the site after logging in.
- AUTHENTICATED\_WITH\_PUBLIC\_ACCESS\_ENABLED—The site is an authenticated site, but the **Public can access the site** checkbox is enabled in Experience Builder in **Settings** | **General**. Guest users can access the site.
- UNAUTHENTICATED—The unauthenticated site is publicly available to anyone on the web, and doesn’t support login or authentication. UNAUTHENTICATED is a legacy value. We recommend using AUTHENTICATED\_WITH\_PUBLIC\_ACCESS\_ENABLED access to allow guest user access.





 |
| title | 

Field Type

string

Description

Required.

Represents the label of the content item.



 |
| type | 

Field Type

string

Description

Required.

Represents the content type. The only allowed value is sfdc\_cms\_\_site.



 |

{
  "type" : "sfdc\_cms\_\_site",
  "title" : "Capricorn\_Coffee",
  "contentBody" : {
    "authenticationType" : "AUTHENTICATED"
  }
}

## sfdc\_cms\_\_theme Folder

This content type folder contains one content subfolder, representing the site’s theme. The content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

<apiName>/content.json

| Property | Description |
| --- | --- |
| activeBrandingSetId | 
Field Type

content link

Description

Required.

Represents the apiName of the site’s active branding set.

Must reference an existing brandingSet with a type of APP in the same workspace.



 |
| definitionName | 

Field Type

string

Description

Required.

Represents the definition name of a theme.

Must match the template’s theme definition name.



 |
| layouts | 

Field Type

layout\[\]

Description

Required.

Represents an array of the theme layouts available in the workspace and provides details about each theme layout.

The template and features used in the workspace determine which layouts are required. For example, the ServiceNotAvailable layout is required if the site includes a Service Not Available page.



 |
| layouts.layoutId | 

Field Type

content link

Description

Required.

Represents the apiName of an available theme layout. Must refer to an existing theme layout in the same workspace.



 |
| layouts.layoutType | 

Field Type

string

Description

Represents the name of the theme layout specified in Experience Builder.

An inner theme layout is required. The inner theme layout is applied by default to all of a site’s pages except for login pages.



 |
| title | 

Field Type

string

Description

Required.

Represents the name of the theme.



 |
| type | 

Field Type

string

Description

Required.

Represents the content type. The only allowed value is sfdc\_cms\_\_theme.



 |

{
  "type" : "sfdc\_cms\_\_theme",
  "title" : "Build Your Own (LWR)",
  "contentBody" : {
    "activeBrandingSetId" : "Build\_Your\_Own\_LWR",
    "definitionName" : "byo",
    "layouts" : \[ {
      "layoutId" : "snaThemeLayout",
      "layoutType" : "ServiceNotAvailable"
    }, {
      "layoutId" : "scopedHeaderAndFooter",
      "layoutType" : "Inner"
    } \]
  }
}

## sfdc\_cms\_\_themeLayout Folder

This content type folder contains one content subfolder for each theme layout in the site. Each content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

We recommend that you don’t add, reorder, or delete a component within a locked region using the DigitalExperienceBundle. To find out which regions are locked, in Experience Builder, view the Page Structure tab for the page that you’re working on. If the region that you’re modifying has a lock icon next to it, it’s a locked region.

<apiName>/content.json

| Property | Description |
| --- | --- |
| children | 
Field Type

regionType\[\]

Description

Represents individual regions within a layout.



 |
| component | 

Field Type

componentType

Description

Required.

Contains the layout details for this theme layout in regions and components.



 |
| componentType.attributes | 

Field Type

map

Description

A map of design attribute values used by the component definition to render the definition.



 |
| componentType.attributes.dxpStyle | 

Field Type

map

Description

Lets you define visibility, padding, and margin values for a component.

Visibility controls whether the component is visible on desktop, tablet, and mobile versions of your site.

Margin and padding are map types that contain string properties for top, right, bottom, and left spacing. Padding controls space within a component. Margin controls space around the outside of a component. Units for margin and padding can be px, rem, or %, and all four spacing values must use the same unit. This field is available in API version 57.0 and later.



 |
| componentType.children | 

Field Type

regionType\[\]

Description

Represents regions within a component.



 |
| componentType.definition | 

Field Type

string

Description

Required.

Represents the name of the Lightning Web Component (LWC) using the format namespace:componentName.

Must be one of the theme layouts defined as part of the default theme, or use the target [lightningCommunity\_\_Theme\_Layout](https://developer.salesforce.com/docs/atlas.en-us.264.0.exp_cloud_lwr.meta/exp_cloud_lwr/get_started_layout.htm "HTML (New Window)"). The default theme layouts differ per theme. For example, the Build Your Own (BYO) template uses the BYO theme, with the allowed theme layouts community\_byo:scopedHeaderandFooter and community\_layout:simpleThemeLayout.



 |
| componentType.id | 

Field Type

UUID

Description

Required.

Represents the UUID of a component.



 |
| componentType.scopedBrandingSetId | 

Field Type

content link

Description

Represents the brandingSet that applies to this component. The brandingSet must be of type SCOPED.

This property is applicable only if the component’s definitionName is community\_layout:section.



 |
| componentType.customCssClasses | 

Field Type

string

Description

Represents the custom CSS classes applied to the host element of the component. Must be a space-delimited list of valid CSS classes. This field is available in API version 59.0 and later.



 |
| componentType.title | 

Field Type

string

Description

Represents a component variation name. Available in API version 59.0 and later.



 |
| componentType.type | 

Field Type

string

Description

Required.

Allowed values are:

- component
- mutationComponent



 |
| componentType.variations | 

Field Type

componentType\[\]

Description

Represents a component variation within a component. Available in API version 59.0 and later.



 |
| componentVariationType.rule | 

Field Type

rule type

Description

A visibility rule associated with a component variation. Available in API version 59.0 and later.



 |
| componentVariationType.variationId | 

Field Type

string

Description

The unique ID of a component variation. Available in API version 59.0 and later.



 |
| contentOperations | 

Field Type

contentOperationType

Description

A content operation of the variation or visibility type.



 |
| contentOperationsType.operations | 

Field Type

operationsType\[\]

Description

Component visibility operation.



 |
| expressionCriteriaType.criterionNumber | 

Field Type

integer

Description

The sequence number of an expression criteria. Available in API version 59.0 and later.



 |
| expressionCriteriaType.operator | 

Field Type

string

Description

Operator of the criteria or condition in a visibility rule.

Supported operators are:

- EQUAL
- NE: Does not equal
- CONTAINS
- NC: Does not contain
- LT: Less than
- GT: Greater than
- LE: Less than or equal to
- GE: Greater than or equal to
- StartsWith





 |
| expressionCriteriaType.resource | 

Field Type

string

Description

The resource of the criteria or condition in a visibility rule.



 |
| expressionCriteriaType.value | 

Field Type

object

Description

The value of the criteria or condition in a visibility rule. The value can be number, boolean, or string.



 |
| operationsType.isActive | 

Field Type

boolean

Description

When true, the visibility operation is active.



 |
| operationsType.isHiddenOnOperationSuccess | 

Field Type

boolean

Description

When true, the component is hidden when the operation is successful.



 |
| operationsType.rule | 

Field Type

RuleType

Description

The component visibility rule.



 |
| operationsType.ruleToVariationList | 

Field Type

componentVariationType\[\]

Description

Variation rules associated with a specific component ID. Only 15 variations are allowed in one ruleToVariationList, which means only 15 variations can correspond to a specific targetId. Available in API version 59.0 and later.



 |
| operationsType.targetId | 

Field Type

string

Description

The component ID where the visibility rule is applied.



 |
| regionType.children | 

Field Type

componentType\[\]

Description

Represents individual components within the region.



 |
| regionType.id | 

Field Type

UUID

Description

Required.

Represents the UUID of a region.



 |
| regionType.name | 

Field Type

string

Description

Required.

Represents the name of the region.



 |
| regionType.title | 

Field Type

string

Description

Represents the label for a region.



 |
| regionType.type | 

Field Type

string

Description

Required.

region is the only allowed value.



 |
| regionType.variations | 

Field Type

componentType\[\]

Description

Represents a component variation within a region. Available in API version 59.0 and later.



 |
| ruleType.criteriaType | 

Field Type

string

Description

The condition or criteria type of the rule. Allowed values include AllCriteriaMatch and AnyCriterionMatches.



 |
| ruleType.customFormula | 

Field Type

string

Description

A custom formula created from expression criteria for a visibility rule. Available in API version 59.0 and later.



 |
| ruleType.description | 

Field Type

string

Description

The description of a visibility rule.



 |
| ruleType.expressionCriteria | 

Field Type

expressionCriteriaType\[\]

Description

The expression criteria of a visibility rule.



 |
| ruleType.name | 

Field Type

string

Description

The name of a visibility rule.



 |
| title | 

Field Type

string

Description

Required.

Represents the label of the content item.



 |
| type | 

Field Type

string

Description

Required.

Represents the content type. The only allowed value is sfdc\_cms\_\_themeLayout.



 |

{
  "type" : "sfdc\_cms\_\_themeLayout",
  "title" : "Service Not Available Theme Layout",
  "contentBody" : {
    "component" : {
      "id" : "50458146-12d8-4dd7-a37b-62f71615c1a0",
      "type" : "component",
      "children" : \[ {
        "title": "Theme Header",
          "id": "8fc2497b-fae7-4570-bc69-63a7a229e6fc",
          "type": "region",
          "name": "header",
          "children": \[
            {
              "id": "05224a3a-8044-9h2h-9187-b3f43155344d",
              "type": "component",
              "definition": "community\_builder:htmlEditor",
              "attributes": {
                "richTextValue": "<div style="display: flex; justify-content: center; align-items: center; margin: 50px 0; flex-direction: column; text-align: center;"><div style="background-image: url(assets/img/desert.svg); background-size: cover; background-position: center; height: 300px; width: 100%; max-width: 600px; min-width: 300px;"></div><h1 class="slds-text-heading\_medium slds-p-bottom\_x-small">Start Building Your Page</h1> <div>Drag and drop a component into the content slots.</div></div>"
              },
              "variations": \[
                {
                  "id": "5d700461-4c2a-4930-98e5-366ec2a4d41e",
                  "title": "Variation Country USA",
                  "type": "mutationComponent",
                  "definition": "community\_builder:htmlEditor",
                  "attributes": {
                    "richTextValue": "<div style="display: flex; justify-content: center; align-items: center; margin: 50px 0; flex-direction: column; text-align: center;"><div style="background-image: url(assets/img/desert.svg); background-size: cover; background-position: center; height: 300px; width: 100%; max-width: 600px; min-width: 300px;"></div><h1 class="slds-text-heading\_medium slds-p-bottom\_x-small">Start Building Your Page</h1> <div>Drag and drop a component into the content slots.</div></div>"
                  }
                }
              \]
            }
          \]
        },
        {
        "title" : "Theme Footer",
        "id" : "05224a3a-8044-9h2h-9187-b3f43155344d",
        "type" : "region",
        "name" : "footer"
      } \],
      "definition" : "community\_layout:simpleThemeLayout",
      "attributes": {}
    },    "contentOperations": {
      "operations": \[
        {
          "targetId": "05224a3a-8044-9h2h-9187-b3f43155344d",
          "isHiddenOnOperationSuccess": false,
          "isActive": true,
          "rule": {
            "name": "708b6ff0-d50c-4cea-a492-kkjk4b174e86",
            "description": "",
            "criteriaType": "AllCriteriaMatch",
            "expressionCriteria": \[
              {
                "resource": "User.Record.FirstName",
                "operator": "Equal",
                "value": "Clark"
              }
            \]
          }
        },
        {
          "targetId": "05224a3a-8044-9h2h-9187-b3f43155344d",
          "ruleToVariationList": \[
            {
              "variationId": "5d700461-4c2a-4930-98e5-366ec2a4d41e",
              "rule": {
                "name": "6e1ea488-13d8-477a-a9d7-93f442cc7936",
                "description": "",
                "criteriaType": "CustomLogicMatches",
                "customFormula": "(1 && 3) || 2",
                "expressionCriteria": \[
                  {
                    "resource": "User.Record.Country",
                    "operator": "Equal",
                    "value": "USA",
                    "criterionNumber": 1
                  },
                  {
                    "resource": "User.Record.City",
                    "operator": "Equal",
                    "value": "Chicago",
                    "criterionNumber": 2
                  },
                  {
                    "resource": "User.Record.PostalCode",
                    "operator": "Equal",
                    "value": "60131",
                    "criterionNumber": 3
                  }
                \]
              }
            }
          \]
        }
      \]
    }
  }
}

## sfdc\_cms\_\_view Folder

This content type folder contains one content subfolder per view. Each content subfolder contains two or more JSON files:

- [\_meta.json](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm#meta_json_description)
- content.json
- If applicable, additional JSON files that represent variations of the content item

Each Experience Builder site is built from single-page applications, which are web apps that load a single HTML page. Single-page applications consist of multiple views that update the page dynamically as the user interacts with it. A view is made up of regions that contain other regions or components in the rendered page for the user. Single-page applications in your site are defined in the sfdc\_cms\_\_appPage folder.

Each content.json file in the sfdc\_cms\_\_view folder contains a hidden region named sfdcHiddenRegion. The hidden region contains a component with a definition of community\_builder:seoAssistant that represents the SEO assistant component. This component corresponds to the SEO page properties that you can configure in Experience Builder and isn't visible on your pages. To improve search engine results, use the SEO assistant component to set the customHeadTags, description, and pageTitle properties for your public and custom site pages. You can’t edit the other properties associated with the SEO assistant component. To learn more about what the title, description, and custom head tags properties represent and which head tags are allowed, see [SEO Page Properties in Experience Builder](https://help.salesforce.com/s/articleView?id=experience.networks_seo_tags.htm&type=5&language=en_US "HTML (New Window)").

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

We recommend that you don’t add, reorder, or delete a component within a locked region using the DigitalExperienceBundle. To find out which regions are locked, in Experience Builder, view the Page Structure tab for the page that you’re working on. If the region that you’re modifying has a lock icon next to it, it’s a locked region.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If there are specific style overrides for mobile or tablet views in the target org, make sure that these overrides are also present in the source org. If the target org contains mobile or tablet JSON files within the mobile or tablet folders that aren’t present in the source org, deploying the DigitalExperienceBundle fails.

<apiName>/content.json

| Property | Description |
| --- | --- |
| children | 
Field Type

regionType\[\]

Description

Represents individual regions within a view.



 |
| component | 

Field Type

componentType

Description

Required.

Represents the view layout and contains regions and components that help render a view.



 |
| componentType.attributes | 

Field Type

map

Description

A map of design attribute values used by the component definition to render the definition.



 |
| componentType.attributes.dxpStyle | 

Field Type

map

Description

Lets you define visibility, padding, and margin values for a component.

Visibility controls whether the component is visible on desktop, tablet, and mobile versions of your site.

Margin and padding are map types that contain string properties for top, right, bottom, and left spacing. Padding controls space within a component. Margin controls space around the outside of a component. Units for margin and padding can be px, rem, or %, and all four spacing values must use the same unit. This field is available in API version 57.0 and later.



 |
| componentType.children | 

Field Type

regionType\[\]

Description

Represents regions within a component.



 |
| componentType.definition | 

Field Type

string

Description

Required.

Represents the name of the Lightning Web Component (LWC) in the format namespace:componentName.



 |
| componentType.id | 

Field Type

UUID

Description

Required.

Represents the UUID of a component.



 |
| componentType.scopedBrandingSetId | 

Field Type

content link

Description

Represents the brandingSet that applies to this component. The brandingSet must be of type SCOPED.

This property is applicable only if the component’s definitionName is community\_layout:section.



 |
| componentType.customCssClasses | 

Field Type

string

Description

Represents the custom CSS classes applied to the host element of the component. Must be a space-delimited list of valid CSS classes. This field is available in API version 59.0 and later.



 |
| componentType.title | 

Field Type

string

Description

Represents a component variation name. Available in API version 59.0 and later.



 |
| componentType.type | 

Field Type

string

Description

Required.

Allowed values are:

- component
- mutationComponent





 |
| componentType.variations | 

Field Type

componentType\[\]

Description

Represents a component variation within a component. Available in API version 59.0 and later.



 |
| componentVariationType.rule | 

Field Type

rule type

Description

A visibility rule associated with a component variation. Available in API version 59.0 and later.



 |
| componentVariationType.variationId | 

Field Type

string

Description

The unique ID of a component variation. Available in API version 59.0 and later.



 |
| contentOperations | 

Field Type

contentOperationType

Description

A content operation of the variation or visibility type.



 |
| expressionCriteriaType.criterionNumber | 

Field Type

integer

Description

The sequence number of an expression criteria. Available in API version 59.0 and later.



 |
| contentOperationsType.operations | 

Field Type

operationsType\[\]

Description

Component visibility operation.



 |
| expressionCriteriaType.operator | 

Field Type

string

Description

Operator of the criteria or condition in a visibility rule.

Supported operators are:

- EQUAL
- NE: Does not equal
- CONTAINS
- NC: Does not contain
- LT: Less than
- GT: Greater than
- LE: Less than or equal to
- GE: Greater than or equal to
- StartsWith





 |
| expressionCriteriaType.resource | 

Field Type

string

Description

The resource of the criteria or condition in a visibility rule.



 |
| expressionCriteriaType.value | 

Field Type

object

Description

The value of the criteria or condition in a visibility rule. The value can be number, boolean, or string.



 |
| operationsType.isActive | 

Field Type

boolean

Description

When true, the visibility operation is active.



 |
| operationsType.isHiddenOnOperationSuccess | 

Field Type

boolean

Description

When true, the component is hidden when the operation is successful.



 |
| operationsType.rule | 

Field Type

RuleType

Description

The component visibility rule.



 |
| operationsType.ruleToVariationList | 

Field Type

componentVariationType\[\]

Description

Variation rules associated with a specific component ID. Only 15 variations are allowed in one ruleToVariationList, which means only 15 variations can correspond to a specific targetId. Available in API version 59.0 and later.



 |
| operationsType.targetId | 

Field Type

string

Description

The component ID where the visibility rule is applied.



 |
| regionType.children | 

Field Type

componentType\[\]

Description

Represents individual components within the region.



 |
| regionType.id | 

Field Type

UUID

Description

Required.

Represents the UUID of a region.



 |
| regionType.name | 

Field Type

string

Description

Required.

Represents the name of the region.



 |
| regionType.title | 

Field Type

string

Description

Represents the label for a region.



 |
| regionType.type | 

Field Type

string

Description

Required.

region is the only allowed value.



 |
| regionType.variations | 

Field Type

componentType\[\]

Description

Represents a component variation within a region. Available in API version 59.0 and later.



 |
| ruleType.criteriaType | 

Field Type

string

Description

The condition or criteria type of the rule. Allowed values include AllCriteriaMatch and AnyCriterionMatches.



 |
| ruleType.customFormula | 

Field Type

string

Description

A custom formula created from expression criteria for a visibility rule. Available in API version 59.0 and later.



 |
| ruleType.description | 

Field Type

string

Description

The description of a visibility rule.



 |
| ruleType.expressionCriteria | 

Field Type

expressionCriteriaType\[\]

Description

The expression criteria of a visibility rule.



 |
| ruleType.name | 

Field Type

string

Description

The name of a visibility rule.



 |
| themeLayoutType | 

Field Type

string

Description

Required.

Represents the apiName of the view’s active theme layout.

Must reference an existing theme layout in the same workspace.



 |
| title | 

Field Type

string

Description

Represents the name of the view. Limited to 80 characters.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

We recommend keeping the title value and the pageTitle value in sync. If you update either value for a view, ensure that you manually update the other value in the same content.json file to match.















 |
| type | 

Field Type

string

Description

Required.

Represents the content type. The only allowed value is sfdc\_cms\_\_view.



 |
| viewType | 

Field Type

string

Description

Required.

Identifies the type of view. The viewType value must be unique within a workspace. This value must match the [routeType](#route_folder_section) value in the corresponding route content item.



 |

{
  "type" : "sfdc\_cms\_\_view",
  "title" : "Home",
  "contentBody" : {
    "themeLayoutType" : "Inner",
    "viewType" : "home",
    "component" : {
      "id" : "40c14c97-1846-4872-8e9e-cdf3d11beb34",
      "type" : "component",
      "children" : \[ {
        "title" : "Content",
        "id" : "c507f23d-6e2a-457a-9656-2377846dd639",
        "type" : "region",
        "children" : \[ {
          "id" : "21f99012-3a2f-488e-bf48-f782dc7b4300",
          "type" : "component",
          "children" : \[ {
            "title" : "Column 1",
             "id": "05224a3a-8044-4bfb-9187-b3f43155344d",
            "type" : "region",
            "children" : \[ {
              "id" : "05224a3a-8044-4bfb-9187-b3f43155344d",
              "type" : "component",
              "definition" : "community\_builder:htmlEditor",
              "attributes" : {
                "dxpStyle" : {
                  "isVisible" : false,
                  "margin" : {
                    "bottom" : "20px",
                    "left" : "20px",
                    "right" : "20px",
                    "top" : "20px"
                  },
                  "padding" : {
                    "bottom" : "20px",
                    "left" : "20px",
                    "right" : "20px",
                    "top" : "20px"
                  }
                },
                "richTextValue" : "<div style="display: flex; justify-content: center; align-items: center; margin: 50px 0; flex-direction: column; text-align: center;"><div style="background-image: url(assets/img/desert.svg); background-size: cover; background-position: center; height: 300px; width: 100%; max-width: 600px; min-width: 300px;"></div><h1 class="slds-text-heading\_medium slds-p-bottom\_x-small">Start Building Your Page</h1> <div>Drag and drop a component into the content slots.</div></div>"
              },
               "variations": \[
                        {
                          "id": "5d700461-4c2a-4930-98e5-366ec2a4d41e",
                          "title": "Variation Country USA",
                          "type": "mutationComponent",
                          "definition": "community\_builder:htmlEditor",
                          "attributes": {
                            "richTextValue": "<div style="display: flex; justify-content: center; align-items: center; margin: 50px 0; flex-direction: column; text-align: center;"><div style="background-image: url(assets/img/desert.svg); background-size: cover; background-position: center; height: 300px; width: 100%; max-width: 600px; min-width: 300px;"></div><h1 class="slds-text-heading\_medium slds-p-bottom\_x-small">Start Building Your Page</h1> <div>Drag and drop a component into the content slots.</div></div>"
                          }
                        }
                      \]
              "customCssClasses": "myClass"
            } \],
            "name" : "col1"
          } \],
          "definition" : "community\_layout:section",
          "attributes" : {
            "backgroundImageConfig" : "",
            "backgroundImageOverlay" : "rgba(0,0,0,0)",
            "sectionConfig" : "{"UUID":"21f99012-3a2f-488e-bf48-f782dc7b4300","columns":\[{"UUID":"5019aeeb-6437-4194-8369-22c19aa45dc9","columnName":"Column 1","columnKey":"col1","columnWidth":"12","seedComponents":null}\]}"
          }
        } \],
        "name" : "content"
      }, {
        "title" : "sfdcHiddenRegion",
        "id" : "8157e041-9c41-460a-b596-c45babbbd53b",
        "type" : "region",
        "children" : \[ {
          "id" : "2d536aae-a859-4264-ba9e-9a569daf7213",
          "type" : "component",
          "definition" : "community\_builder:seoAssistant",
          "attributes" : {
            "customHeadTags" : "",
            "description" : "",
            "pageTitle" : "Home",
            "recordId" : "{!recordId}"
          }
        } \],
        "name" : "sfdcHiddenRegion"
      } \],
      "definition": "community\_layout:sldsFlexibleLayout"
    },
    "contentOperations": {
      "operations": \[
        {
          "targetId": "05224a3a-8044-4bfb-9187-b3f43155344d",
          "isHiddenOnOperationSuccess": false,
          "isActive": true,
          "rule": {
            "name": "a53bb452-003f-4015-a751-0403c70731a1",
            "description": "",
            "criteriaType": "AllCriteriaMatch",
            "expressionCriteria": \[
              {
                "resource": "User.isGuest",
                "operator": "Equal",
                "value": false
              }
            \]
          }
        },
        {
          "targetId": "05224a3a-8044-9h2h-9187-b3f43155344d",
          "ruleToVariationList": \[
            {
              "variationId": "5d700461-4c2a-4930-98e5-366ec2a4d41e",
              "rule": {
                "name": "6e1ea488-13d8-477a-a9d7-93f442cc7936",
                "description": "",
                "criteriaType": "CustomLogicMatches",
                "customFormula": "(1 && 3) || 2",
                "expressionCriteria": \[
                  {
                    "resource": "User.Record.Country",
                    "operator": "Equal",
                    "value": "USA",
                    "criterionNumber": 1
                  },
                  {
                    "resource": "User.Record.City",
                    "operator": "Equal",
                    "value": "Chicago",
                    "criterionNumber": 2
                  },
                  {
                    "resource": "User.Record.PostalCode",
                    "operator": "Equal",
                    "value": "60131",
                    "criterionNumber": 3
                  }
                \]
              }
            }
          \]
        }
      \]
    }
  }
}

<!-- document id=4880e2daca198b976e3229c1d83da74f29e5e710ca79886dc732e64b38fc6d02 url=/legacydeveloper/current/en-us/api_meta/meta_digitalexperienceconfig.md -->

# 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 the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

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

## Version

DigitalExperienceConfig components are available in API version 56.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| label | 
Field Type

string

Description

Required.

The name of the site.



 |
| site | 

Field Type

[Site](#Site)

Description

Required.

Contains site-related settings, such as the site’s URL path prefix.



 |
| space | 

Field Type

string

Description

Required.

References the workspace that contains the site’s content items such as brandingSets, themes, views, and routes.



 |

## Site

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

| Field Name | Description |
| --- | --- |
| urlPathPrefix | 
Field Type

string

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.

<?xml version="1.0" encoding="UTF-8"?>
<DigitalExperienceConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>Capricorn\_Coffee</label\>
    <site\>
        <urlPathPrefix\>CapricornCoffee</urlPathPrefix\>
    </site\>
    <space\>site/Capricorn\_Coffee1</space\>
</DigitalExperienceConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Capricorn\_Coffee1</members\>
        <name\>DigitalExperienceConfig</name\>
    </types\>
    <version\>56.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=ff462b0ca9416ff0098df895580de8cb0783d7ea101085deea969dbbecdac1f4 url=/legacydeveloper/current/en-us/api_meta/meta_disclosuredefinition.md -->

# DisclosureDefinition

Represents information that defines a disclosure type, such as details of the publisher or vendor who created or implemented the report.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DisclosureDefinition components have the suffix .disclosureDefinition and are stored in the disclosureDefinitions folder.

## Version

DisclosureDefinition components are available in API version 57.0 and later.

## Special Access Rules

The DisclosureAndComplianceHubAddOn license is required to access this object along with user access for the Disclosure Compliance Hub permission set license.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1080900e101">Field Name</th>

              <th class="featureTableHeader  " id="d1080900e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1080900e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1080900e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The description about the disclosure definition.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1080900e101" data-title="Field Name"><span class="keyword parmname">disclosureType</span></td>

              <td class="entry" headers="d1080900e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The API name of the disclosure type
                  associated with this definition.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1080900e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d1080900e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type. The default is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1080900e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1080900e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">A user-friendly name for
                  DisclosureDefinition, which is defined when the
                  DisclosureDefinition is created.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a DisclosureDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<DisclosureDefinition
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<description\>This is GRI Disclosure Definition</description\>
	<disclosureType\>disclstype10</disclosureType\>
	<isProtected\>false</isProtected\>
	<masterLabel\>GRI</masterLabel\>
</DisclosureDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<fullName\>Pkg</fullName\>
	<types\>
		<members\>GRI</members\>
		<name\>DisclosureDefinition</name\>
	</types\>
	<types\>
		<members\>dt12</members\>
		<name\>DisclosureType</name\>
	</types\>
	<version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=64683dd9a51d0dc99a27c8194f511b67227991581afe732bf3d851c357d4b7bb url=/legacydeveloper/current/en-us/api_meta/meta_disclosuredefinitionversion.md -->

# DisclosureDefinitionVersion

Represents the version information about the disclosure definition.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DisclosureDefinitionVersion components have the suffix .disclosureDefinitionVersion and are stored in the disclosureDefinitionVersions folder.

## Version

DisclosureDefinitionVersion components are available in API version 57.0 and later.

## Special Access Rules

The DisclosureAndComplianceHubAddOn and OmniStudioDesignerAddon licenses are required to access this object along with user access for the Disclosure Compliance Hub and OmniStudio Admin permission set licenses.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1081385e101">Field Name</th>

              <th class="featureTableHeader  " id="d1081385e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">authoring​Mode</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: AuthoringMode (enumeration of type string)</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Specifies the authoring mode used to launch the disclosure authoring experience.</p>

                <p class="p">Possible values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Microsoft 365
                      Word</samp></li>

                  <li class="li"><samp class="codeph nolang">Omniscript and
                      Microsoft 365 Word</samp></li>

                  <li class="li"><samp class="codeph nolang">Omniscript
                      Form</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The description about the disclosure definition
                  version.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">disclosureDef​CurrVer</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: For internal use only.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">disclosureDefinition</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The API name of the disclosure
                  definition associated with this version.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">documentTemplate​GlobalKey</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The document template global key associated with the
                  DOCX template for the disclosure definition
                  version.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether the disclosure definition version is
                  an active version (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">isCurrentVersion</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether this is the current version of the
                  disclosure definition specified in the
                  <span class="keyword parmname">disclosureDefinition</span> field
                  (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>).
                </p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type. The default is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">A user-friendly name for
                  DisclosureDefinitionVersion, which is defined when the
                  DisclosureDefinitionVersion is created.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">omniScriptCnfgApiName</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The API name of the Omniscript configuration that's associated with the disclosure
                  definition version. This field is required only when
                  <span class="keyword parmname">authoringMode</span>isn’t <samp class="codeph nolang">Microsoft 365
                    Word</samp>.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">omniScriptConfiguration</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">The ID of the Omniscript configuration record.</p>

                <p class="p"><strong class="ph b">Note</strong>: The value of this field is
                  automatically populated using the API name of the
                  OmniScript configuration specified in the
                  <span class="keyword parmname">omniScriptCnfgApiName</span>
                  field.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">versionNumber</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The version of the disclosure definition
                  published by the author.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a DisclosureDefinitionVersion component.

<?xml version="1.0" encoding="UTF-8"?>
<DisclosureDefinitionVersion xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>This is GRI Disclosure Definition Version</description\>
    <versionNumber\>disclosure definition version number</versionNumber\>
    <isActive\>false</isActive\>
    <disclosureDefinition\>df10</disclosureDefinition\>
    <omniScriptConfiguration\>omni script configuration</omniScriptConfiguration\>
    <omniScriptCnfgApiName\>omni script config api name</omniScriptCnfgApiName\>
    <isCurrentVersion\>true</isCurrentVersion\>
    <disclosureDefCurrVer\>df10.Id</disclosureDefCurrVer\>
    <documentTemplateGlobalKey\>document template global key</documentTemplateGlobalKey\>
    <authoringMode\>OmniScriptForm</authoringMode\>
    <masterLabel\>GRI</masterLabel\>
    <isProtected\>false</isProtected\>
</DisclosureDefinitionVersion\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<fullName\>Pkg</fullName\>
	<types\>
		<members\>GRI</members\>
		<name\>DisclosureDefinitionVersion</name\>
	</types\>
	<types\>
		<members\>df10</members\>
		<name\>DisclosureDefinition</name\>
	</types\>
	<types\>
		<members\>dt10</members\>
		<name\>DisclosureType</name\>
	</types\>
	<version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=6cf03f50bd4c4c685849dca062dc831fd7c48c6def18d82cad4eeaf7225cae19 url=/legacydeveloper/current/en-us/api_meta/meta_disclosuretype.md -->

# DisclosureType

Represents the types of disclosures that are done by an individual or an organization and the associated metadata.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DisclosureType components have the suffix .disclosureType and are stored in the disclosureTypes folder.

## Version

DisclosureType components are available in API version 57.0 and later.

## Special Access Rules

The DisclosureAndComplianceHubAddOn license is required to access this object along with user access for the Disclosure Compliance Hub permission set license.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1082454e101">Field Name</th>

              <th class="featureTableHeader  " id="d1082454e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1082454e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1082454e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The description about the disclosure type.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1082454e101" data-title="Field Name"><span class="keyword parmname">disclosureBodyLogo</span></td>

              <td class="entry" headers="d1082454e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The logo ID of the standard body to which an individual
                  or a company is making a disclosure.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1082454e101" data-title="Field Name"><span class="keyword parmname">disclosureBodyUrl</span></td>

              <td class="entry" headers="d1082454e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The URL of the disclosure standard body.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1082454e101" data-title="Field Name"><span class="keyword parmname">disclosureCategory</span></td>

              <td class="entry" headers="d1082454e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The name of the clause category that's
                  used for disclosure.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1082454e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d1082454e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type. The default is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1082454e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1082454e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">A user-friendly name for DisclosureType,
                  which is defined when the DisclosureType is
                  created.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a DisclosureType component.

<?xml version="1.0" encoding="UTF-8"?>
<DisclosureType
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<description\>This is ESG Disclosure Type</description\>
	<disclosureBodyLogo\>asdf</disclosureBodyLogo\>
	<disclosureCategory\>EnvSocGvnc</disclosureCategory\>
	<disclosureBodyUrl\>disclosure body url</disclosureBodyUrl\>
	<isProtected\>false</isProtected\>
	<masterLabel\>ESG</masterLabel\>
</DisclosureType\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<fullName\>Pkg</fullName\>
	<types\>
		<members\>ESG</members\>
		<name\>DisclosureType</name\>
	</types\>
	<types\>
		<name\>StaticResource</name\>
		<members\>asdf</members\>
	</types\>
	<version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=fb4f16792e54ae7ae9e9caef5cd983ac5e4fdd38246fbec82a482360d619b3f6 url=/legacydeveloper/current/en-us/api_meta/meta_discoveryaimodel.md -->

# DiscoveryAIModel

Represents the metadata associated with a model used in Einstein Discovery.

A model is a sophisticated, custom algorithm that Einstein Discovery generates based on a comprehensive, statistical understanding of past outcomes. Einstein Discovery uses models to predict future outcomes. A model accepts the values of one or more predictor variables as input and produces a predicted outcome as output, along with (optionally) top factors and improvements. In Package Manager, this type is listed as "Discovery Model".

You can also build models using a third-party modeling tool, and then import them into Salesforce using Model Manager in Analytics Studio.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Write operations for DiscoveryAIModel objects are generally not supported.

## Declarative Metadata File Suffix and Directory Location

A DiscoveryAIModel is stored in the discovery folder. DiscoveryAIModels have two files:

- file with .model suffix contains the model's actual data
- file named _ModelName_.model-meta.xml suffix contains the model's metadata

Here is a sample package.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Maximize\_Sales</members\>
        <name\>DiscoveryAIModel</name\>
    </types\>
    <version\>53.0</version\>
</Package\>

## Version

DiscoveryAIModels are available in API version 51.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d384673e115">Field Name</th>

              <th class="featureTableHeader  " id="d384673e118">Field Type</th>

              <th class="featureTableHeader  " id="d384673e121">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">algorithmType</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type"><a class="xref" href="#DiscoveryAlgorithmType">DiscoveryAlgorithmType</a></td>

              <td class="entry" headers="d384673e121" data-title="Description">Algorithm that Einstein Discovery used to create the model
                associated with this story.</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">classificationThreshold</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type">double</td>

              <td class="entry" headers="d384673e121" data-title="Description">Threshold value. Applies only to binary classification models.
                For regression models, this is null.</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type">string</td>

              <td class="entry" headers="d384673e121" data-title="Description">Model description.</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type">string</td>

              <td class="entry" headers="d384673e121" data-title="Description">Model label. If you package a model, this label appears in
                Package Manager.</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">modelFields</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type">
                <a class="xref" href="#DiscoveryModelField">DiscoveryModelField</a>[]
              </td>

              <td class="entry" headers="d384673e121" data-title="Description">One or more model fields (variables).</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">modelRuntimeType</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type"><a class="xref" href="#DiscoveryModelRuntimeType">DiscoveryModelRuntimeType</a></td>

              <td class="entry" headers="d384673e121" data-title="Description">Model run-time type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">predictedField</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type">string</td>

              <td class="entry" headers="d384673e121" data-title="Description">Name of the field that is predicted.</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">predictionType</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type">DiscoveryPredictionType</td>

              <td class="entry" headers="d384673e121" data-title="Description">Type of prediction. One of the following strings: <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">Regression</span></li>

                  <li class="li"><span class="keyword parmname">Classification</span></li>

                  <li class="li"><span class="keyword parmname">Unknown</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">sourceType</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type"><a class="xref" href="#DiscoveryModelSourceType">DiscoveryModelSourceType</a></td>

              <td class="entry" headers="d384673e121" data-title="Description">Source type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type"><a class="xref" href="#DiscoveryAIModelStatus">DiscoveryAIModelStatus</a></td>

              <td class="entry" headers="d384673e121" data-title="Description">Model status (enabled or disabled).</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">trainingMetrics</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type">string</td>

              <td class="entry" headers="d384673e121" data-title="Description">JSON object that represents metrics about the model when it was
                trained. </td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e115" data-title="Field Name"><span class="keyword parmname">transformations</span></td>

              <td class="entry" headers="d384673e118" data-title="Field Type"><a class="xref" href="#DiscoveryModelTransform">DiscoveryModelTransform</a></td>

              <td class="entry" headers="d384673e121" data-title="Description">One or more model transformations.</td>

            </tr>

          </tbody>

        </table>

## DiscoveryAlgorithmType

Represents the algorithm that Einstein Discovery used to create the model.

| Field Name | Field Type | Description |
| --- | --- | --- |
| Best | string | Tournament Model. Genetic algorithm used to generate high-quality solutions to optimization and search problems, like optimizing decision trees for better performance. |
| Glm | string | Generalized Linear Model. Regression-based algorithm. |
| Gbm | string | Gradient Boost Machine. Decision tree-based ensemble machine learning algorithm. |
| Xgboost | string | XGBoost. Decision tree-based ensemble machine learning algorithm. |
| Drf | string | Random Forest. Supervised learning algorithm that uses multiple decision trees, randomization, and other optimization techniques. |

## DiscoveryModelField

Represents a field (variable) in the model.

| Field Name | Field Type | Description |
| --- | --- | --- |
| isDisparateImpact | boolean | Indicates whether the field is disparate impact (true) or not (false). |
| isSensitive | boolean | Indicates whether the field is sensitive (true) or not (false). |
| label | string | Field label displayed in the UI. |
| name | string | Field name. |
| type | [DiscoveryModelFieldType](#DiscoveryModelFieldType) | Field type. Enumerated. |
| values | string\[\] | A list of field values. |

## DiscoveryModelTransform

Represents a transformation in the model.

| Field Name | Field Type | Description |
| --- | --- | --- |
| config | string | The configuration for the transformation. |
| sourceFieldNames | string\[\] | A list of the source field names. |
| targetFieldNames | string\[\] | A list of the target field names. |
| type | [DiscoveryAIModelTransformationType](#DiscoveryAIModelTransformationType) | Type of transformation. |

## DiscoveryAIModelTransformationType

Represents the type of transformation to apply before making a prediction.

| Field Name | Field Type | Description |
| --- | --- | --- |
| TypographicClustering | string | Typographic clustering transformation. |
| SentimentAnalysis | string | Sentiment analysis transformation. |
| FreeTextClustering | string | Free text clustering transformation. |
| NumericalImputation | string | Numerical imputation transformation. |
| CatagoricalImputation | string | Catagorical imputation transformation. |
| TimeSeriesForecast | string | Time series forecast transformation. |
| ExtractMonthOfYear | string | Extract month of year transformation. |
| ExtractDayOfWeek | string | Extract day of week transformation. |
| ZipCodeAnalysis | string | Zip code analysis transformation. |

## DiscoveryModelFieldType

Represents the data type of a model field.

| Field Name | Field Type | Description |
| --- | --- | --- |
| Text | string | Text data type. |
| Number | string | Number data type. |
| Date | string | Date data type. |

## DiscoveryModelRuntimeType

Represents the model run-type.

| Field Name | Field Type | Description |
| --- | --- | --- |
| Discovery | string | The model run-type is Einstein Discovery. |
| H2O | string | The model run-type is H20. |
| T | string | The model run-type is Tensorflow v2.4.4. |
| Tf27 | string | The model run-type is Tensorflow v2.7.0. |
| SC102 | string | The model run-type is Scikit Learn v1.0.2. |

## DiscoveryModelSourceType

Represents the source tool used to build the model: Discovery or an external tool (the model was uploaded into Salesforce).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d384673e1015">Field Name</th>

              <th class="featureTableHeader  " id="d384673e1018">Field Type</th>

              <th class="featureTableHeader  " id="d384673e1021">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d384673e1015" data-title="Field Name"><span class="keyword parmname">Discovery</span></td>

              <td class="entry" headers="d384673e1018" data-title="Field Type">string</td>

              <td class="entry" headers="d384673e1021" data-title="Description">Einstein Discovery built the model.</td>

            </tr>

            <tr>
              <td class="entry" headers="d384673e1015" data-title="Field Name"><span class="keyword parmname">UserUpload</span></td>

              <td class="entry" headers="d384673e1018" data-title="Field Type">string</td>

              <td class="entry" headers="d384673e1021" data-title="Description">An external tool built the model. The model was then uploaded
                into Salesforce. <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>This source type is not supported in the
                            Metadata API.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## DiscoveryAIModelStatus

Represents the status of the model (Enabled or Disabled).

| Field Name | Field Type | Description |
| --- | --- | --- |
| Disabled | string | The model is disabled (inactive). |
| Uploading | string | The model is uploading. |
| UploadFailed | string | The model failed to upload. |
| UploadCompleted | string | The model upload is complete. |
| Validating | string | The model is validating. |
| ValidationFailed | string | The model validation failed. |
| ValidationCompleted | string | The model validation is complete. |
| Enabled | string | The model is enabled (active). |

## Declarative Metadata Sample Definitions

Here is a sample DiscoveryAIModel:

<?xml version="1.0" encoding="UTF-8"?>
<DiscoveryAIModel xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <content xsi:nil="true"/>
   <algorithmType\>Glm</algorithmType\>
   <classificationThreshold\>0.7383</classificationThreshold\>
   <label\>Maximize Tenure</label\>
   <modelFields\>
      <label\>Field</label\>
      <name\>Field</name\>
      <type\>Text</type\>
   </modelFields\>
   <modelFields\>
      <label\>PTO</label\>
      <name\>PTO</name\>
      <type\>Number</type\>
   </modelFields\>
   <modelFields\>
      <label\>Level</label\>
      <name\>Level</name\>
      <type\>Text</type\>
   </modelFields\>
   <modelFields\>
      <label\>Salary</label\>
      <name\>Salary</name\>
      <type\>Number</type\>
   </modelFields\>
   <modelFields\>
      <label\>Tenure</label\>
      <name\>Tenure</name\>
      <type\>Number</type\>
   </modelFields\>
   <modelRuntimeType\>Discovery</modelRuntimeType\>
   <predictedField\>Tenure</predictedField\>
   <predictionType\>Classification</predictionType\>
   <sourceType\>Discovery</sourceType\>
   <status\>Enabled</status\>
</DiscoveryAIModel\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=43f017759da7da03b1b6404d3510e323893bad0a7bee60ff76f181d6cfe17cf4 url=/legacydeveloper/current/en-us/api_meta/meta_discoverygoal.md -->

# DiscoveryGoal

Represents the metadata associated with an Einstein Discovery prediction definition.

A prediction definition is a container object in Einstein Discovery that is associated with one or more deployed models. If a prediction definition contains multiple models, then each model produces predictions for a different segment of the data. A prediction definition can contain up to ten active models. In Package Manager, this type is listed as "Discovery Prediction".

## Declarative Metadata File Suffix and Directory Location

A DiscoveryGoal is stored in the discovery folder. DiscoveryGoals have a .goal file suffix. Here is a sample package.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>employees\_Tenure</members\>
        <name\>DiscoveryGoal</name\>
    </types\>
    <version\>53.0</version\>
</Package\>

## Version

DiscoveryGoals are available in API version 51.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d388724e94">Field Name</th>

              <th class="featureTableHeader  " id="d388724e97">Field Type</th>

              <th class="featureTableHeader  " id="d388724e100">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d388724e100" data-title="Description">Indicates whether the prediction definition is active (True) or
                not (False).</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">deployedModels</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type">
                <a class="xref" href="#DiscoveryDeployedModel">DiscoveryDeployedModel</a>[]
              </td>

              <td class="entry" headers="d388724e100" data-title="Description">One or more deployed models associated with this prediction
                definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type">string</td>

              <td class="entry" headers="d388724e100" data-title="Description">Name of the prediction definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">modelCards</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type"><a class="xref" href="#DiscoveryModelCard">DiscoveryModelCard[]</a></td>

              <td class="entry" headers="d388724e100" data-title="Description">Model card for this prediction definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">outcome</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type"><a class="xref" href="#DiscoveryGoalOutcome">DiscoveryGoalOutcome</a></td>

              <td class="entry" headers="d388724e100" data-title="Description">Outcome variable of this prediction definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">predictionType</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type"><a class="xref" href="#DiscoveryPredictionType">DiscoveryPredictionType</a></td>

              <td class="entry" headers="d388724e100" data-title="Description">Type of prediction: <span class="keyword parmname">Regression</span>,
                <span class="keyword parmname">Classification</span>, or
                <span class="keyword parmname">Unknown</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">pushbackField</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type">string</td>

              <td class="entry" headers="d388724e100" data-title="Description">Automated writeback field for predictions. A custom field on the
                Salesforce object specified in
                <span class="keyword parmname">subscribedEntity</span>. <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Removing a pushback
                            field from the goal metadata causes the field to be deleted from
                            the Salesforce object as well.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">pushbackType</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type"><a class="xref" href="#DiscoveryPushbackType">DiscoveryPushbackType</a></td>

              <td class="entry" headers="d388724e100" data-title="Description">Type of writeback field for predictions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">subscribedEntity</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type">string</td>

              <td class="entry" headers="d388724e100" data-title="Description">Salesforce object associated with this model.</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e94" data-title="Field Name"><span class="keyword parmname">terminalStateFilters</span></td>

              <td class="entry" headers="d388724e97" data-title="Field Type">
                <a class="xref" href="#DiscoveryFilter">DiscoveryFilter</a>[]
              </td>

              <td class="entry" headers="d388724e100" data-title="Description">If specified, one or more filter expressions that define the
                conditions under which an observation has attained its terminal
                state (the actual outcome has been reached). For performance
                monitoring, Einstein Discovery determines model accuracy by
                comparing a model’s predicted outcomes with actual (observed)
                outcomes.</td>

            </tr>

          </tbody>

        </table>

## DiscoveryDeployedModel

Represents a model deployed in Salesforce.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d388724e293">Field Name</th>

              <th class="featureTableHeader  " id="d388724e296">Field Type</th>

              <th class="featureTableHeader  " id="d388724e299">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d388724e293" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d388724e296" data-title="Field Type">boolean</td>

              <td class="entry" headers="d388724e299" data-title="Description">Indicates whether the deployed model is active (True) or inactive
                (False).</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e293" data-title="Field Name"><span class="keyword parmname">aiModel</span></td>

              <td class="entry" headers="d388724e296" data-title="Field Type">string</td>

              <td class="entry" headers="d388724e299" data-title="Description">Full name of the DiscoveryAIModel being deployed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e293" data-title="Field Name"><span class="keyword parmname">classificationThreshold</span></td>

              <td class="entry" headers="d388724e296" data-title="Field Type">double</td>

              <td class="entry" headers="d388724e299" data-title="Description">
                <p class="p">Threshold value. Applies only to binary classification models.
                  For regression models, this is null.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e293" data-title="Field Name"><span class="keyword parmname">fieldMappings</span></td>

              <td class="entry" headers="d388724e296" data-title="Field Type">
                <a class="xref" href="#DiscoveryFieldMap">DiscoveryFieldMap</a>[]
              </td>

              <td class="entry" headers="d388724e299" data-title="Description">One or more mappings between model variables and either fields
                (in Salesforce objects) or columns (in CRM Analytics
                datasets).</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e293" data-title="Field Name"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d388724e296" data-title="Field Type">
                <a class="xref" href="#DiscoveryFilter">DiscoveryFilter</a>[]
              </td>

              <td class="entry" headers="d388724e299" data-title="Description">If specified, one or more segmentation filters for the deployed
                model. When making a prediction, the first model that has filters
                matching a specific input row will be used to make the prediction.
                No filters indicates that the model matches all input rows. </td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e293" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d388724e296" data-title="Field Type">string</td>

              <td class="entry" headers="d388724e299" data-title="Description">Label for the deployed model. Appears in Model Manager.</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e293" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d388724e296" data-title="Field Type">string</td>

              <td class="entry" headers="d388724e299" data-title="Description">Name of the deployed model.</td>

            </tr>

            <tr>
              <td class="entry" headers="d388724e293" data-title="Field Name"><span class="keyword parmname">prescribableFields</span></td>

              <td class="entry" headers="d388724e296" data-title="Field Type">
                <a class="xref" href="#DiscoveryPrescribableField">DiscoveryPrescribableField</a>[]
              </td>

              <td class="entry" headers="d388724e299" data-title="Description">Actionable fields associated with improvements.</td>

            </tr>

          </tbody>

        </table>

## DiscoveryFieldMap

Represents a mapping between model variables and field values.

| Field Name | Field Type | Description |
| --- | --- | --- |
| mappedField | string | Field in a Salesforce object or column in a CRM Analytics dataset. |
| modelField | string | Model variable. |
| sobjectFieldJoinKey | string | Join key for a Salesforce object. Null if sourceType is AnalyticsDatasetField. |
| source | string | If the mapping is to a CRM Analytics dataset, this is the name of the dataset. Otherwise, null. |
| sourceFieldJoinKey | string | If the mapping is to a CRM Analytics dataset, this is the lookup column on that dataset used to perform the join. Otherwise, null. |
| sourceType | [DiscoveryFieldMapSourceType](#DiscoveryFieldMapSourceType) | Data source type for field mapping. |

## DiscoveryFieldMapSourceType

Represents the data source type for field mapping: SalesforceField or AnalyticsDatasetField.

| Field Name | Field Type | Description |
| --- | --- | --- |
| SalesforceField | string | Field in a Salesforce object. |
| AnalyticsDatasetField | string | Column in a CRM Analytics dataset. |

## DiscoveryFilter

Represents a field filter.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Name of the field to filter. |
| operator | DiscoveryFilterOperator | Operator used to calculate the filter. |
| type | [DiscoveryFilterFieldType](#DiscoveryFilterFieldType) | Type of filter value. |
| values | [DiscoveryFilterValue](#DiscoveryFilterValue)\[\] | One or more values selected for the filter. |

## DiscoveryFilterOperator

Represents a filter operator.

| Field Name | Field Type | Description |
| --- | --- | --- |
| Equal | string | Equal to operator (=). |
| NotEqual | string | Not equal to operator (<>). |
| GreaterThan | string | Greater than operator (>). |
| GreaterThanOrEqual | string | Greater than or equal to operator (>=). |
| LessThan | string | Less than operator (<). |
| LessThanOrEqual | string | Less than or equal to operator (<=). |
| Between | string | Between operator. |
| NotBetween | string | Not between operator. |
| InSet | string | In set operator. |
| NotIn | string | Not in operator. |
| Contains | string | Contains operator. |
| StartsWith | string | Starts with operator. |
| EndsWith | string | Ends with operator. |
| IsNull | string | Is null operator. |
| IsNotNull | string | Is not null operator. |

## DiscoveryFilterFieldType

Represents the data type of the filter field.

| Field Name | Field Type | Description |
| --- | --- | --- |
| Text | string | Text field type. |
| Number | string | Number field type. |
| Date | string | Date field type. |
| DateTime | string | Datetime field type. |
| Boolean | string | Boolean field type. |

## DiscoveryFilterValue

Represents a filter value.

| Field Name | Field Type | Description |
| --- | --- | --- |
| type | [DiscoveryFilterValueType](#DiscoveryFilterValueType) | Type of filter value. |
| value | [DiscoveryFilterValue](#DiscoveryFilterValue) | Value. |

## DiscoveryFilterValueType

Represents the type of filter value.

| Field Name | Field Type | Description |
| --- | --- | --- |
| Constant | string | Filter value is a constant. |
| PlaceHolder | string | Filter value is a placeholder. |

## DiscoveryPrescribableField

Represents custom improvement text.

| Field Name | Field Type | Description |
| --- | --- | --- |
| customDefinitions | [DiscoveryCustomPrescribableFieldDefinition](#DiscoveryCustomPrescribableFieldDefinition)\[\] | One or more strings for custom improvement text. Uses the default improvement text if none are specified. |
| name | string | Name of the model field that is actionable. |

## DiscoveryCustomPrescribableFieldDefinition

Represents a field definition in custom improvement text.

| Field Name | Field Type | Description |
| --- | --- | --- |
| filters | DiscoveryFilter\[\] | Represents one or more filters associated with custom improvement text. |
| template | string | If specified, represents the user-provided template from which the custom text is computed. If not specified, then the default text is used. |

## DiscoveryModelCard

Represents a model card associated with an Einstein Discovery prediction definition.

| Field Name | Field Type | Description |
| --- | --- | --- |
| contactEmail | string | Contact email for this model card. |
| contactName | string | Contact name for this model card. |
| label | string | Title for this model card. |
| sections | string | Sections in the model card. |

## DiscoveryGoalOutcome

Represents the outcome variable of the model.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Name of the outcome variable. |
| fieldLabel | string | Label for the outcome variable. |
| goal | [DiscoveryOutcomeGoal](#DiscoveryOutcomeGoal) | Goal for the outcome variable. |
| mappedField | string | Mapped field. |

## DiscoveryOutcomeGoal

Represents the goal for an outcome.

| Field Name | Field Type | Description |
| --- | --- | --- |
| Minimize | string | Maximize the outcome. |
| Maximize | string | Minimize the outcome. |
| None | string | Reserved for future use. |

## DiscoveryPredictionType

Represents the prediction type for a model.

| Field Name | Field Type | Description |
| --- | --- | --- |
| Unknown | string | Unknown prediction type. |
| Regression | string | Regression prediction (numeric use case). |
| Classification | string | Binary classification prediction. |
| MulticlassClassification | string | Multiclass classification prediction. |

## DiscoveryPushbackType

Represents the type of writeback field. Must be set to AiRecordInsight.

| Field Name | Field Type | Description |
| --- | --- | --- |
| AiRecordInsight | string | Automatic writeback type. Required. |
| Direct | string | Currently not supported. Reserved for future use. |

## Declarative Metadata Sample Definitions

Here is a sample DiscoveryGoal:

<?xml version="1.0" encoding="UTF-8"?>
<DiscoveryGoal xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <active\>true</active\>
   <deployedModels\>
      <active\>true</active\>
      <aiModel\>Maximize\_Tenure</aiModel\>
      <fieldMappings\>
         <mappedField\>Opportunity.Amount</mappedField\>
         <modelField\>PTO</modelField\>
         <sourceType\>SalesforceField</sourceType\>
      </fieldMappings\>
      <fieldMappings\>
         <mappedField\>Opportunity.ExpectedRevenue</mappedField\>
         <modelField\>Salary</modelField\>
         <sourceType\>SalesforceField</sourceType\>
      </fieldMappings\>
      <fieldMappings\>
         <mappedField\>Level</mappedField\>
         <modelField\>Level</modelField\>
         <sobjectFieldJoinKey\>Opportunity.Name</sobjectFieldJoinKey\>
         <source\>employees</source\>
         <sourceFieldJoinKey\>Name</sourceFieldJoinKey\>
         <sourceType\>AnalyticsDatasetField</sourceType\>
      </fieldMappings\>
      <fieldMappings\>
         <mappedField\>Opportunity.StageName</mappedField\>
         <modelField\>Field</modelField\>
         <sourceType\>SalesforceField</sourceType\>
      </fieldMappings\>
      <filters\>
         <field\>Opportunity.StageName</field\>
         <operator\>Equal</operator\>
         <values\>
            <type\>Constant</type\>
            <value\>Qualification</value\>
         </values\>
      </filters\>
      <label\>employees</label\>
      <name\>employees</name\>
      <prescribableFields\>
         <customDefinitions\>
           <filters\>
              <field\>Salary</field\>
              <operator\>LessThan</operator\>
              <type\>Number</type\>
              <values\>
                 <type\>PlaceHolder</type\>
                 <value\>\[value\_low\]</value\>
              </values\>
           </filters\>
           <template\>Increase \[field\_name\] by \[diff\]</template\>
         </customDefinitions\>
         <customDefinitions\>
            <filters\>
               <field\>Salary</field\>
               <operator\>GreaterThan</operator\>
               <type\>Number</type\>
               <values\>
                   <type\>PlaceHolder</type\>
                   <value\>\[value\_low\]</value\>
                </values\>
             </filters\>
             <template xsi:nil="true"/>
          </customDefinitions\>
          <name\>Salary</name\>
      </prescribableFields\>
      <prescribableFields\>
          <customDefinitions\>
             <filters\>
                <field\>Level</field\>
                <operator\>LessThan</operator\>
                <type\>Number</type\>
                <values\>
                   <type\>PlaceHolder</type\>
                   <value\>\[value\_low\]</value\>
                </values\>
            </filters\>
            <template xsi:nil="true"/>
          </customDefinitions\>
          <customDefinitions\>
             <filters\>
                <field\>Level</field\>
                <operator\>GreaterThan</operator\>
                <type\>Number</type\>
                <values\>
                   <type\>PlaceHolder</type\>
                   <value\>\[value\_low\]</value\>
                 </values\>
              </filters\>
              <template xsi:nil="true"/>
          </customDefinitions\>
          <name\>Level</name\>
      </prescribableFields\>
      <prescribableFields\>
         <name\>Field</name\>
      </prescribableFields\>
   </deployedModels\>
   <label\>employees\_Tenure</label\>
   <outcome\>
      <field\>Tenure</field\>
      <fieldLabel\>Tenure</fieldLabel\>
      <goal\>Maximize</goal\>
      <mappedField\>Opportunity.Amount</mappedField\>
   </outcome\>
   <predictionType\>Regression</predictionType\>
   <pushbackField\>My\_Pushback\_Field\_\_c</pushbackField\>
   <subscribedEntity\>Opportunity</subscribedEntity\>
   <terminalStateFilters\>
      <field\>Opportunity.Amount</field\>
      <operator\>GreaterThan</operator\>
      <values\>
         <type\>Constant</type\>
         <value\>5</value\>
      </values\>
   </terminalStateFilters\>
   <terminalStateFilters\>
      <field\>Opportunity.Amount</field\>
      <operator\>LessThan</operator\>
      <values\>
         <type\>Constant</type\>
         <value\>10</value\>
      </values\>
   </terminalStateFilters\>
</DiscoveryGoal\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=2def6322ee0017ad023c0b6a65bf290276e3b82fbd25ab9c5687aa5a29d02e39 url=/legacydeveloper/current/en-us/api_meta/meta_discoverystory.md -->

# DiscoveryStory

Represents the metadata associated with a story used in Einstein Discovery.

A story defines the data and analytical settings that Einstein Discovery uses to generate insights and build predictive models. Story settings include the outcome variable, whether to maximize or minimize the outcome variable, the data to analyze in a CRM Analytics dataset, and other preferences. Story settings tell Einstein Discovery how to conduct the analysis and communicate its results. In Package Manager, this type is listed as "Discovery Story".

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Write operations for DiscoveryStory objects are generally not supported.

## Declarative Metadata File Suffix and Directory Location

A DiscoveryStory is stored in the discovery folder. DiscoveryStory have two files:

- file with .story suffix contains the story’s actual data
- file named _ModelName_.story-meta.xml suffix contains the story’s metadata

Here is a sample package.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Subscriber\_Changes</members\>
        <name\>DiscoveryStory</name\>
    </types\>
    <version\>55.0</version\>
</Package\>

## Version

DiscoveryStorys are available in API version 54.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d394449e112">Field Name</th>

              <th class="featureTableHeader  " id="d394449e115">Field Type</th>

              <th class="featureTableHeader  " id="d394449e118">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d394449e112" data-title="Field Name"><span class="keyword parmname">application</span></td>

              <td class="entry" headers="d394449e115" data-title="Field Type">string</td>

              <td class="entry" headers="d394449e118" data-title="Description">Required. The CRM Analytics app the story is associated with.</td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e112" data-title="Field Name"><span class="keyword parmname">autopilot</span></td>

              <td class="entry" headers="d394449e115" data-title="Field Type">DiscoveryStoryAutopilotStatus</td>

              <td class="entry" headers="d394449e118" data-title="Description">Optional. The autopilot status for the story. One of the following strings: <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">Enabled</span></li>

                  <li class="li"><span class="keyword parmname">Disabled</span></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e112" data-title="Field Name"><span class="keyword parmname">classificationThreshold</span></td>

              <td class="entry" headers="d394449e115" data-title="Field Type">double</td>

              <td class="entry" headers="d394449e118" data-title="Description">Optional. The threshold for classification predictions for the story.</td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e112" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d394449e115" data-title="Field Type">string</td>

              <td class="entry" headers="d394449e118" data-title="Description">Required. The story label. If you package a story, this label appears in
                Package Manager.</td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e112" data-title="Field Name"><span class="keyword parmname">outcome</span></td>

              <td class="entry" headers="d394449e115" data-title="Field Type"><a class="xref" href="#DiscoveryStoryOutcome">DiscoveryStoryOutcome</a></td>

              <td class="entry" headers="d394449e118" data-title="Description">Required. The selected outcome of the story.</td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e112" data-title="Field Name"><span class="keyword parmname">sourceContainer</span></td>

              <td class="entry" headers="d394449e115" data-title="Field Type">string</td>

              <td class="entry" headers="d394449e118" data-title="Description">Required. The source ID for the story.</td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e112" data-title="Field Name"><span class="keyword parmname">sourceType</span></td>

              <td class="entry" headers="d394449e115" data-title="Field Type">DiscoveryStorySourceType</td>

              <td class="entry" headers="d394449e118" data-title="Description">Required. The source type of the story. One of the following strings: <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">AnalyticsDataset</span></li>

                  <li class="li"><span class="keyword parmname">LiveDataset</span></li>

                  <li class="li"><span class="keyword parmname">Report</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e112" data-title="Field Name"><span class="keyword parmname">validationContainer</span></td>

              <td class="entry" headers="d394449e115" data-title="Field Type">string</td>

              <td class="entry" headers="d394449e118" data-title="Description">Optional. The validation ID for the story.</td>

            </tr>

          </tbody>

        </table>

## DiscoveryStoryOutcome

Represents the selected outcome of the generated story.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d394449e284">Field Name</th>

              <th class="featureTableHeader  " id="d394449e287">Field Type</th>

              <th class="featureTableHeader  " id="d394449e290">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d394449e284" data-title="Field Name"><span class="keyword parmname">failureValue</span></td>

              <td class="entry" headers="d394449e287" data-title="Field Type">string</td>

              <td class="entry" headers="d394449e290" data-title="Description">Optional. The value if the story failed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e284" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d394449e287" data-title="Field Type">string</td>

              <td class="entry" headers="d394449e290" data-title="Description">Required. The field configuration for the story.</td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e284" data-title="Field Name"><span class="keyword parmname">goal</span></td>

              <td class="entry" headers="d394449e287" data-title="Field Type">DiscoveryStoryOutcomeGoal</td>

              <td class="entry" headers="d394449e290" data-title="Description">Required. The story outcome goal. One of the following strings: <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">Maximize</span></li>

                  <li class="li"><span class="keyword parmname">Minimize</span></li>

                  <li class="li"><span class="keyword parmname">None</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e284" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d394449e287" data-title="Field Type">string</td>

              <td class="entry" headers="d394449e290" data-title="Description">Required. The story outcome label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e284" data-title="Field Name"><span class="keyword parmname">successValue</span></td>

              <td class="entry" headers="d394449e287" data-title="Field Type">string</td>

              <td class="entry" headers="d394449e290" data-title="Description">Optional. The value if the story succeeded.</td>

            </tr>

            <tr>
              <td class="entry" headers="d394449e284" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d394449e287" data-title="Field Type">DiscoveryStoryOutcomeType</td>

              <td class="entry" headers="d394449e290" data-title="Description">Required. The story outcome type. One of the following strings: <ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">Categorical</span></li>

                  <li class="li"><span class="keyword parmname">Count</span></li>

                  <li class="li"><span class="keyword parmname">Number</span></li>

                  <li class="li"><span class="keyword parmname">Text</span></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definitions

Here is a sample DiscoveryStory:

<?xml version="1.0" encoding="UTF-8"?>
<DiscoverStory xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <application\>MyStoryApp</application\>
    <autopilot\>Enabled</autopilot\>
    <classificationThreshold\>0.7383</classificationThreshold\>
    <label\>SubscriberChanges</label\>
    <outcome\>
        <field\>Subscriber</field\>
        <goal\>Minimize</goal\>
        <label\>SubscriberChangeOutcome</label\>
        <successValue\>Success</successValue\>
        <type\>Numerical</type\>
    </outcome\>
    <sourceContainer\>01X00000000xxxx1AB</sourceContainer\>
    <sourceType\>AnalyticsDataset</sourceType\>
</DiscoveryStory\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=73f3f2483793e992a08eed0e0af1f3635bc99f73536b8dee7f692260414eef22 url=/legacydeveloper/current/en-us/api_meta/meta_document.md -->

# Document

Represents a Document. All documents must be in a document folder, such as sampleFolder/TestDocument.

This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

## Retrieving Documents

You can’t use the wildcard (\*) symbol with documents in package.xml.  To retrieve the list of documents for populating package.xml with explicit names, call listMetadata() and pass in DocumentFolder as the type. Note that DocumentFolder is not returned as a type in describeMetadata().  Document is returned from describeMetadata() with an associated attribute of inFolder set to true.  If that attribute is set to true, you can construct the type by using the component name with the word Folder, such as DocumentFolder.

The following example shows folders in package.xml:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyDBFolder/MyDBName</members\>
        <name\>Dashboard</name\>
    </types\>
    <types\>
        <members\>MyDocumentFolder/MyDocumentName</members\>
        <name\>Document</name\>
    </types\>
    <types\>
        <members\>unfiled$public/MarketingProductInquiryResponse</members\>
        <members\>unfiled$public/SalesNewCustomerEmail</members\>
        <name\>EmailTemplate</name\>
    </types\>
    <types\>
        <members\>MyReportFolder/MyReportName</members\>
        <name\>Report</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

For each document an accompanying metadata file named DocumentFilename\-meta.xml is created in the document folder. For example, for a document TestDocument.png in the sampleFolder folder, there’s a TestDocument.png-meta.xml in the documents/sampleFolder of the package.

## Version

Documents are available in API version 10.0 and later.

In API version 17.0 and later, you can delete a folder containing documents moved to the Recycle Bin. When you delete the folder, any related documents in the Recycle Bin are permanently deleted.

In API version 18.0 and later, documents do not need an extension.

## Fields

This metadata type contains the following fields:

| Field Name | Field Type | Description |
| --- | --- | --- |
| content | base64 | Content of the document. Base 64-encoded binary data. Prior to making an API call, client applications must encode the binary attachment data as base64. Upon receiving a response, client applications must decode the base64 data to binary. This conversion is usually handled for you by a SOAP client. This field is inherited from the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") component. |
| description | string | A description of the document. Enter a description to distinguish this document from others. |
| fullName | string | The name of the document, including the folder name. In version 17.0 and earlier, the fullName included the document extension. In version 18.0 and later, the fullName does not include the file extension. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. If this field contained characters before version 14.0 that are no longer allowed, the characters were stripped out of this field, and the previous value of the field was saved in the name field. This field is inherited from the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") component. |
| internalUseOnly | boolean | Required. Indicates whether the document is confidential (true) or not (false). This field and public are mutually exclusive; you cannot set both to true. |
| keywords | string | Contains one or more words that describe the document. A check for matches to words in this field is performed when doing a search. |
| name | string | The list of characters allowed in the fullName field has been reduced for versions 14.0 and later. This field contains the value contained in the fullName field before version 14.0. This field is only populated if the value of the fullName field contained characters that are no longer accepted in that field. |
| public | boolean | Required. Indicates whether the document is an image available for HTML email templates and does not require a Salesforce username and password to view in an email (true) or not (false). If the images will be used as a custom app logo or custom tab icon, both of which require a Salesforce username and password to view, set this field to false. This field and internalUseOnly are mutually exclusive; you cannot set both to true. |

## Declarative Metadata Sample Definition

The following is the definition of a document:

<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="http://soap.sforce.com/2006/04/metadata">
    <internalUseOnly\>false</internalUseOnly\>
    <name\>Q2 Campaign Analysis</name\>
    <public\>false</public\>
    <description\>Analyze Q2 campaign effectiveness</description\>
</Document\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Folder](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_folder.htm "Represents a folder. This type extends the Metadata metadata type and inherits its fullName field.")

<!-- document id=8ab7dbe6d2a64320cad234353a2895f85466e22227aa685f3f991981bddea579 url=/legacydeveloper/current/en-us/api_meta/meta_documentcategory.md -->

# DocumentCategory

Represents a document category.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DocumentCategory components have the suffix .documentCategory and are stored in the documentCategory folder.

## Version

DocumentCategory components are available in API version 59.0 and later.

## Special Access Rules

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

A description of the DocumentCategory.



 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label of the DocumentCategory. This internal label doesn’t get translated.





 |

## Declarative Metadata Sample Definition

The following is an example of a DocumentCategory component.

<?xml version="1.0" encoding="UTF-8"?>
<DocumentCategory xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>Address\_Proof</masterLabel\>
</DocumentCategory\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>DocumentCategory</name\>
    </types\>
    <version\>59.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=1e3a8d3163de713bb10f5d5462a4d25616a840e9b7e28b006324799976d6787d url=/legacydeveloper/current/en-us/api_meta/meta_documentcategorydocumenttype.md -->

# DocumentCategoryDocumentType

Represents the junction between a DocumentCategory and a DocumentType. Puts a DocumentType in a DocumentCategory.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DocumentCategoryDocumentType components have the suffix .documentCategoryDocumentType and are stored in the documentCategoryDocumentTypes folder.

## Version

DocumentCategoryDocumentType components are available in API version 59.0 and later.

## Special Access Rules

## Fields

| Field Name | Description |
| --- | --- |
| documentCategory | 
Field Type

string

Description

Required.

The master label of the related DocumentCategory.





 |
| documentType | 

Field Type

string

Description

Required.

The master label of the related DocumentType.





 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label of the DocumentCategoryDocumentType. This internal label doesn’t get translated.





 |

## Declarative Metadata Sample Definition

The following is an example of a DocumentCategoryDocumentType component.

<?xml version="1.0" encoding="UTF-8"?>
<DocumentCategoryDocumentType xmlns="http://soap.sforce.com/2006/04/metadata">
    <documentCategory\>Address\_Proof</documentCategory\>
    <documentType\>Utility\_Bill</documentType\>
    <masterLabel\>junction1</masterLabel\>
</DocumentCategoryDocumentType\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>DocumentCategory</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>DocumentCategoryDocumentType</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>DocumentType</name\>
    </types\>
    <version\>59.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=ea6120a3831735586a67df0c90c4969e4e3e8a6931e294f13e6894b4b1cf47ce url=/legacydeveloper/current/en-us/api_meta/meta_documentchecklistsettings.md -->

# DocumentChecklistSettings

Represents an org’s DocumentChecklistItem settings.

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

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

DocumentChecklistSettings components are stored in the DocumentChecklist.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

DocumentChecklistSettings components are available in API versions 55.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| dciCustomSharing | boolean | Indicates whether the custom sharing rule for document checklist items is enabled for your org (true) or not (false). The default value is false. |
| deleteDCIWithFiles | boolean | Indicates whether deletion of document checklist items is enabled for your org (true) or not (false). The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of a DocumentChecklistSettings.settings component.

<?xml version="1.0" encoding="UTF-8"?>
<DocumentChecklistSettings
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<dciCustomSharing\>true</dciCustomSharing\>
	<deleteDCIWithFiles\>true</deleteDCIWithFiles\>
</DocumentChecklistSettings\>

## Example Package Manifest

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>DocumentChecklist</members\>
		<name\>Settings</name\>
	</types\>
	<version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=1cb74c9c3e883f9ef735eaa70a3431fe7668529766c60430b5fba4b20c27c7e6 url=/legacydeveloper/current/en-us/api_meta/meta_documentgenerationsetting.md -->

# DocumentGenerationSetting

Represents an org's settings for automatic document generation from templates. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

DocumentGenerationSetting components have the suffix documentGenerationSetting and are stored in the documentGenerationSettings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

DocumentGenerationSetting components are available in API version 52.0 and later.

## Special Access Rules

DocumentGenerationSetting is available if your org has the DocGen platform license and related addon and user licenses.

Server-side document generation isn't enabled by default, and selecting isServerSideDocGenEnabled isn't sufficient. To enable this feature, see the [Request Access to Server-Side Document Generation](https://help.salesforce.com/apex/HTViewSolution?urlname=Request-Access-to-Server-Side-Document-Generation&language=en_US) knowledge article.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d397987e117">Field Name</th>

              <th class="featureTableHeader  " id="d397987e120">Field Type</th>

              <th class="featureTableHeader  " id="d397987e123">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d397987e117" data-title="Field Name"><span class="keyword parmname">documentTemplateLibraryName</span></td>

              <td class="entry" headers="d397987e120" data-title="Field Type">String</td>

              <td class="entry" headers="d397987e123" data-title="Description">Required. The name of the library that stores the document templates to which
                this setting applies.</td>

            </tr>

            <tr>
              <td class="entry" headers="d397987e117" data-title="Field Name"><span class="keyword parmname">generationMechanism</span></td>

              <td class="entry" headers="d397987e120" data-title="Field Type">GenerationMechanism (enumeration of type string)</td>

              <td class="entry" headers="d397987e123" data-title="Description">Specifies how and where a document is generated. Valid values are:<div class="p">
                  <ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">ClientSide</samp>—Generates documents
                      in the browser with an optional preview.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">ServerSide</samp>—Generates documents
                      on the server and attaches them to the objects for which they're
                      generated.
                    </li>

                  </ul>

                </div>
                <p class="p">The default is <samp class="codeph nolang">ClientSide</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d397987e117" data-title="Field Name"><span class="keyword parmname">guestAccessNamedCredential</span></td>

              <td class="entry" headers="d397987e120" data-title="Field Type">String</td>

              <td class="entry" headers="d397987e123" data-title="Description">Specifies the named credential that lets guest users generate
                documents.</td>

            </tr>

            <tr>
              <td class="entry" headers="d397987e117" data-title="Field Name"><span class="keyword parmname">inProgDocGenRqstTmot</span></td>

              <td class="entry" headers="d397987e120" data-title="Field Type">Integer</td>

              <td class="entry" headers="d397987e123" data-title="Description">The time interval (in hours) after which InProgress<samp class="codeph nolang">DocumentGenerationProcess</samp> records (single point or batch request) are
                terminated and the request status is updated to Failed. Specify a valid whole number
                between 1 and 24. The default value is set to 6.</td>

            </tr>

            <tr>
              <td class="entry" headers="d397987e117" data-title="Field Name"><span class="keyword parmname">isInProgRqstTmotEnab</span></td>

              <td class="entry" headers="d397987e120" data-title="Field Type">Boolean</td>

              <td class="entry" headers="d397987e123" data-title="Description">Indicates whether the InProgress DocGen Request Time Out (hrs) is enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d397987e117" data-title="Field Name"><span class="keyword parmname">isServerSideDocGenEnabled</span></td>

              <td class="entry" headers="d397987e120" data-title="Field Type">Boolean</td>

              <td class="entry" headers="d397987e123" data-title="Description">Enables server-side document generation if the prerequisite license is present
                in the org.</td>

            </tr>

            <tr>
              <td class="entry" headers="d397987e117" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d397987e120" data-title="Field Type">String</td>

              <td class="entry" headers="d397987e123" data-title="Description">Required. Specifies a name for the setting, such as <samp class="codeph nolang">DocGen</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d397987e117" data-title="Field Name"><span class="keyword parmname">previewType</span></td>

              <td class="entry" headers="d397987e120" data-title="Field Type">PreviewType (enumeration of type string)</td>

              <td class="entry" headers="d397987e123" data-title="Description">Specifies the format of previews of generated documents. Valid values are:<div class="p">
                  <ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">PDF</samp>—Displays how the generated
                      document looks in PDF format.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang" id="InternalUsers-4D1EB2B9"><a name="InternalUsers-4D1EB2B9"><!-- --></a>Thumbnail</samp>—Displays a miniature representation of the
                      generated document.
                    </li>

                  </ul>

                </div>
                <p class="p">The default is <samp class="codeph nolang">PDF</samp>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a DocumentGenerationSetting component.

<?xml version="1.0" encoding="UTF-8"?>
<DocumentGenerationSetting xmlns="http://soap.sforce.com/2021/10/metadata">
   <documentTemplateLibraryName>DocgenDocumentTemplateLibrary</documentTemplateLibraryName>
   <masterLabel>DocGen</masterLabel>
</DocumentGenerationSetting>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2021/10/metadata">
    <types>
        <members>DocumentGeneration</members>
        <name>Settings</name>
    </types>
    <version>53.0</version>
</Package>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=77c18f8dc793206b48a4618199b4cdf95e33bff87efb02b675e6152cccf8f6f2 url=/legacydeveloper/current/en-us/api_meta/meta_documenttype.md -->

# DocumentType

Represents a document type.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

DocumentType components have the suffix .documentType and are stored in the documentTypes folder.

## Version

DocumentType components are available in API version 59.0 and later.

## Special Access Rules

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

A description of the DocumentType.



 |
| isActive | 

Field Type

boolean

Description

Required.

Specifies whether the DocumentType is active.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label of the DocumentType. This internal label doesn’t get translated.





 |

## Declarative Metadata Sample Definition

The following is an example of a DocumentType component.

<?xml version="1.0" encoding="UTF-8"?>
<DocumentType xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Utility\_Bill</description\>
    <isActive\>true</isActive\>
    <masterLabel\>Utility\_Bill</masterLabel\>
</DocumentType\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>DocumentType</name\>
    </types\>
    <version\>59.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=590910154de6c3c5a0d62d91370e4d71f76b4fa1328a8d649a15c5820c311f16 url=/legacydeveloper/current/en-us/api_meta/meta_deploy_concurrent_retrieve.md -->

# Does a Retrieve Job Have a Status of Pending?

If you initiate several concurrent retrieve operations for a single org, Metadata API automatically puts some of those jobs in a queue, if that becomes necessary for service protection. If a retrieve job has a status of Pending, it’s in the queue. When one of the active retrieve jobs completes, Metadata API takes a pending job from the queue and activates it. If a retrieve job has a status of InProgress, it’s active. The process repeats until the job queue is cleared.

For more information, see "Metadata Limits" in the Salesforce Developer Limits and Allocations Quick Reference.

<!-- document id=638bfb698ecad63395353ed2ae0e526d65c384977707fa5b451a34ebb70980a2 url=/legacydeveloper/current/en-us/api_meta/meta_duplicaterule.md -->

# DuplicateRule

Represents a rule that specifies how duplicate records in an object are detected. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

DuplicateRule components have the .duplicateRule suffix and are stored in the duplicateRules/ directory. The name of the component file is based on the name of the object associated with the rule. For example, the component file name duplicateRules/Account.Standard\_Account\_Duplicate\_Rule.duplicateRule describes a duplicate rule component associated with the Account object.

## Version

DuplicateRule components are available in API version 68.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d399266e101">Field Name</th>

              <th class="featureTableHeader  " id="d399266e104">Field Type</th>

              <th class="featureTableHeader  " id="d399266e107">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname" id="actionOnInsert"><a name="actionOnInsert"><!-- --></a>actionOnInsert</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">DupeActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. Determines what the duplicate rule does when users or the
                DuplicateRule API try to insert a record that is a duplicate. Valid values are:<dl class="dl detailList">

                  <dt class="dt dlterm"><samp class="codeph nolang" id="insertActionAllow"><a name="insertActionAllow"><!-- --></a>Allow</samp></dt>

                  <dd class="dd">For users, if <span class="keyword parmname">operationsOnInsert</span> is set to <samp class="codeph nolang">alert</samp>, the UI displays the value of <span class="keyword parmname">alertText</span> in a dialog. The dialog prompts
                    users to continue or cancel. If the user chooses to continue, the insertion
                    proceeds. If the user chooses to cancel, the record isn’t inserted.<p class="p">The
                      DuplicateRule API returns an error code and a message. To complete the
                      insertion, the code must set the <span class="keyword parmname">allowSave</span> field in
                      DuplicateRuleHeader to <samp class="codeph nolang">true</samp>
                      and reissue the request.</p>
                    <p class="p">If
                      <span class="keyword parmname">operationsOnInsert</span>isn’t set to <samp class="codeph nolang">alert</samp>, the UI inserts the record without
                      issuing an alert. The API inserts the record and doesn’t return an error
                      code.
                    </p>
                  </dd>



                  <dt class="dt dlterm"><samp class="codeph nolang">Block</samp></dt>

                  <dd class="dd">For users, the UI displays an error message and prevents them from inserting
                    the new record. The DuplicateRule API returns an error and doesn’t insert the
                    record. </dd>


                </dl>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname" id="actionOnUpdate"><a name="actionOnUpdate"><!-- --></a>actionOnUpdate</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">DupeActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. Determines what the duplicate rule does when users or the
                DuplicateRule API try to update a record, and the result is a duplicate. Valid
                values are:<dl class="dl detailList">

                  <dt class="dt dlterm"><samp class="codeph nolang" id="updateActionAllow"><a name="updateActionAllow"><!-- --></a>Allow</samp></dt>

                  <dd class="dd">For users, if <span class="keyword parmname">operationsOnUpdate</span> is set to <samp class="codeph nolang">alert</samp>, the UI displays the value of
                    <span class="keyword parmname">alertText</span> in a dialog. The dialog prompts users to
                    continue or cancel. If the user chooses to continue, the update proceeds. If
                    the user chooses to cancel, the record isn’t updated.<p class="p">The DuplicateRule API
                      returns a message. To complete the update, the code must set the
                      <span class="keyword parmname">allowSave</span> field in DuplicateRuleHeader to <samp class="codeph nolang">true</samp>
                      and reissue the request.
                    </p>
                    <p class="p">If
                      <span class="keyword parmname">operationsOnUpdate</span>isn’t set to <samp class="codeph nolang">alert</samp>, the UI updates the record without
                      issuing an alert. The API updates the record and doesn’t return an error
                      code.
                    </p>
                  </dd>



                  <dt class="dt dlterm"><samp class="codeph nolang">Block</samp></dt>

                  <dd class="dd">For users, the UI displays an error message and prevents them from
                    continuing. The DuplicateRule API returns an error.</dd>


                </dl>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname" id="alertText"><a name="alertText"><!-- --></a>alertText</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">string</td>

              <td class="entry" headers="d399266e107" data-title="Description">Text that’s sent when the duplicate rule is triggered. The text is only sent if
                <span class="keyword parmname">isActive</span> is <samp class="codeph nolang">true</samp>. In the
                UI, the text displays as a message. The DuplicateRule API returns the message in its
                response. <p class="p">You can set a value for <span class="keyword parmname">alertText</span> only when you
                  have <span class="keyword parmname">actionOnInsert</span> or <span class="keyword parmname">actionOnUpdate</span>
                  (or both) set to <samp class="codeph nolang">Allow</samp>. Otherwise, you
                  receive a validation error when you add or update this component.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">string</td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. Text that describes the duplicate rule. The value is
                customer-supplied, but isn’t visible in the UI.</td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname">duplicateRuleFilter</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type"><a class="xref" href="#DuplicateRuleFilter">DuplicateRuleFilter</a></td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. Criteria that define how to find records to consider when looking for
                duplicates. For example, use <span class="keyword parmname">duplicateRuleFilter</span> to exclude
                records from the match when looking for duplicates.</td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname">duplicateRuleMatchRules</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">
                <a class="xref" href="#DuplicateRuleMatchRule">DuplicateRuleMatchRule</a>[]
              </td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. One or more <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_matchingrule.htm" title="Represents a matching rule that is used to identify duplicate records.">MatchingRule</a> components for
                the DuplicateRule. A <samp class="codeph nolang">MatchingRule</samp> controls what
                constitutes a match between records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">boolean</td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, the DuplicateRule
                detects duplicate records. Otherwise, the rule has no effect.</td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">string</td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. Label for this DuplicateRule. This value is the internal label for
                the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname" id="operationsOnInsert"><a name="operationsOnInsert"><!-- --></a>operationsOnInsert</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">string[]</td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. Controls the action to take when <span class="keyword parmname">actionOnInsert</span>
                is set to <samp class="codeph nolang">Allow</samp> and the duplicate rule is
                triggered. Either one or both of these values can be set in the array:<dl class="dl detailList">

                  <dt class="dt dlterm"><samp class="codeph nolang">alert</samp></dt>

                  <dd class="dd">If set, the action specified in <span class="keyword parmname">actionOnInsert</span> occurs;
                    otherwise, the insert proceeds.</dd>



                  <dt class="dt dlterm"><samp class="codeph nolang">report</samp></dt>

                  <dd class="dd">If set, the insert operation is added to the report of duplicates.</dd>


                </dl>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname" id="operationsOnUpdate"><a name="operationsOnUpdate"><!-- --></a>operationsOnUpdate</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">string[]</td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. Controls the action to take when <span class="keyword parmname">actionOnUpdate</span>
                is set to <samp class="codeph nolang">Allow</samp> and the duplicate rule is
                triggered. Either one or both of these values can be set in the array:<dl class="dl detailList">

                  <dt class="dt dlterm"><samp class="codeph nolang">alert</samp></dt>

                  <dd class="dd">If set, the action specified in <span class="keyword parmname">actionOnUpdate</span> occurs;
                    otherwise, the update proceeds.</dd>



                  <dt class="dt dlterm"><samp class="codeph nolang">report</samp></dt>

                  <dd class="dd">If set, the update operation is added to the report of duplicates.</dd>


                </dl>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname">securityOption</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">DupeSecurityOptionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. Determines how record sharing rules affect duplicate management.
                Valid values are:<dl class="dl detailList">

                  <dt class="dt dlterm"><samp class="codeph nolang">EnforceSharingRules</samp></dt>

                  <dd class="dd">Sharing rules affect duplicate management. If a duplicate rule is triggered
                    because an insert or update duplicates an existing record, but the running
                    user doesn’t have sharing access to that record, the insert or update
                    proceeds. The sharing rule doesn’t prevent the user from creating or updating
                    the record because the record is hidden from the user. No message is
                    issued.</dd>



                  <dt class="dt dlterm"><samp class="codeph nolang">BypassSharingRules</samp></dt>

                  <dd class="dd">Sharing rules don’t affect duplicate management. If a duplicate rule is
                    triggered because an insert or update duplicates an existing record, sharing
                    rules are ignored, but other access restrictions apply.</dd>


                </dl>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d399266e101" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d399266e104" data-title="Field Type">int</td>

              <td class="entry" headers="d399266e107" data-title="Description">Required. Determines the order in which duplicate rules are applied.</td>

            </tr>

          </tbody>

        </table>

## DuplicateRuleMatchRule

Describes the [MatchingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_matchingrule.htm#meta_matchingrule "Represents a matching rule that is used to identify duplicate records.") associated with the DuplicateRule. The MatchingRule identifies duplicate records.

| Field Name | Field Type | Description |
| --- | --- | --- |
| matchRuleSObjectType | string | Required. The name of the target object of the matching rule. For example, if you define a duplicate rule for Contact records, and you want to match with Lead records, the value of matchRuleSObjectType is Lead. |
| matchingRule | string | Required. Value that corresponds to the value of developerName in the [MatchingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_matchingrule.htm "Represents a matching rule that is used to identify duplicate records.") for this duplicate rule. |
| objectMapping | [ObjectMapping](#ObjectMapping) | Required. Foreign key to an [ObjectMapping](#ObjectMapping) that maps fields from the duplicate rule’s object to fields in the target object specified by matchRuleSObjectType. |

## DuplicateRuleFilter

Specifies filter criteria for a DuplicateRule. Salesforce only applies the DuplicateRule if the record matches the criteria.

| Field Name | Field Type | Description |
| --- | --- | --- |
| booleanFilter | string | Required. A string of boolean operators that establishes the filter logic for the filter items specified in duplicateRuleFilterItems. |
| duplicateRuleFilterItems | [DuplicateRuleFilterItem](#DuplicateRuleFilterItem)\[\] | Required. A list of [DuplicateRuleFilterItem](#DuplicateRuleFilterItem) components. |

## DuplicateRuleFilterItem

This type extends the [FilterItem](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem) type and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| sortOrder | int | Required. The order of this item in the duplicate rule filter. |
| table | string | Required. The object that has the field specified in the field field of [DuplicateRuleFilterItem.](#DuplicateRuleFilterItem) See the documentation for [FilterItem](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem) for the definition of field. |

## ObjectMapping

Represents a map of fields in the input object of the DuplicateRule to fields in the output object of DuplicateRule. The input object is the object associated with the DuplicateRule. The output object can be the same object or a different object with similar fields.

For example, you can have a DuplicateRule that looks for duplicates between the Contact object and the Lead object. In this case, the input object is Contact, and the output object is Lead.

| Field Name | Field Type | Description |
| --- | --- | --- |
| inputObject | string | Required. The input object for the duplicate rule. The DuplicateRule is associated with this object. For example, if you define a duplicate rule for Contact records, and you want to match with Lead records, the value of inputObject is Contact. |
| mappingFields | [ObjectMappingField](#ObjectMappingField)\[\] | Required. The mapping of source object fields to target object fields for the duplicate rule. |
| outputObject | string | Required. The output object for the duplicate rule. This value is the same as the value of the matchRuleSObjectType field in [DuplicateRuleMatchRule](#DuplicateRuleMatchRule). Any duplicate rules that this object has are ignored when the DuplicateRule API uses the ObjectMapping. |

## ObjectMappingField

A field name in the input object of the DuplicateRule, and the corresponding field name in the output object.

| Field Name | Field Type | Description |
| --- | --- | --- |
| inputField | string | Required. Field in the object specified by the inputObject field in [ObjectMapping](#ObjectMapping). This field is mapped to the field in outputField, which is assumed to be a field in the object specified by the outputObject field in [ObjectMapping](#ObjectMapping). |
| outputField | string | Required. Field in the object specified by the outputObject field in [ObjectMapping](#ObjectMapping). The field is mapped to the field name in inputField, which is assumed to be a field in the object specified by the inputObject in [ObjectMapping](#ObjectMapping). |

## Declarative Metadata Sample Definition

The following is an example of a DuplicateRule component.

<?xml version="1.0" encoding="UTF-8"?>
<DuplicateRule xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <actionOnInsert\>Allow</actionOnInsert\>
    <actionOnUpdate\>Allow</actionOnUpdate\>
    <alertText\>You are creating a duplicate record. Use an existing record instead.</alertText\>
    <description\>Detects a contact that duplicates a Lead</description\>
    <duplicateRuleFilter\>
        <booleanFilter xsi:nil="true"/>
        <duplicateRuleFilterItems\>
            <field\>Username</field\>
            <operation\>equals</operation\>
            <value\>user@example.com</value\>
            <sortOrder\>1</sortOrder\>
            <table\>User</table\>
        </duplicateRuleFilterItems\>
    </duplicateRuleFilter\>
    <duplicateRuleMatchRules\>
        <matchRuleSObjectType\>Lead</matchRuleSObjectType\>
        <matchingRule\>ContactToLeadDuplicate\_matching\_rule</matchingRule\>
        <objectMapping\>
            <inputObject\>Contact</inputObject\>
            <mappingFields\>
                <inputField\>FirstName</inputField\>
                <outputField\>FirstName</outputField\>
            </mappingFields\>
            <mappingFields\>
                <inputField\>LastName</inputField\>
                <outputField\>LastName</outputField\>
            </mappingFields\>
            <outputObject\>Lead</outputObject\>
        </objectMapping\>
    </duplicateRuleMatchRules\>
    <isActive\>true</isActive\>
    <masterLabel\>ContactToLeadDuplicate</masterLabel\>
    <operationsOnInsert\>Alert</operationsOnInsert\>
    <operationsOnInsert\>Report</operationsOnInsert\>
    <operationsOnUpdate\>Alert</operationsOnUpdate\>
    <operationsOnUpdate\>Report</operationsOnUpdate\>
    <securityOption\>EnforceSharingRules</securityOption\>
    <sortOrder\>1</sortOrder\>
</DuplicateRule\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ContactToLeadDuplicate</members\>
        <name\>DuplicateRule</name\>
    </types\>
    <version\>38.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=a07b5079ecf58f34cda7552b13e344e3685cdb445e73061544c0d553f70a8021 url=/legacydeveloper/current/en-us/api_meta/meta_dynamicformssettings.md -->

# DynamicFormsSettings

Represents the settings related to Dynamic Forms.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

DynamicFormsSettings values are stored in the DynamicForms.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

DynamicFormsSettings components are available in API version 58.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| enableFormsOnMobile | 
Field Type

boolean

Description

Determines whether an org has Dynamic Forms for Mobile (Beta) enabled (true) or not (false).

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms](https://www.salesforce.com/company/legal/agreements/).















 |

## Declarative Metadata Sample Definition

The following is an example of a DynamicFormsSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<DynamicFormsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableFormsOnMobile\>true</enableFormsOnMobile\>
</DynamicFormsSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>DynamicForms</members\>
        <name\>Settings</name\>
    </types\>
    <version\>58.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=5890ae555843690637fec890979d11bcbeaf3269b2d6b195dc147524e11ca3db url=/legacydeveloper/current/en-us/api_meta/meta_eacsettings.md -->

# EACSettings

Represents the Einstein Activity Capture metadata type. Use Einstein Activity Capture to add emails and events from your Microsoft or Google account to the activity timeline of related Salesforce records. Automatically sync contact and event data between your Microsoft or Google account and Salesforce. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

EACSettings components have the suffix EAC and are stored in the Settings folder.

## Version

EACSettings components are available in API version 48.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d402312e104">Field Name</th>

              <th class="featureTableHeader  " id="d402312e107">Field Type</th>

              <th class="featureTableHeader  " id="d402312e110">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">addRcCompToFlexiPages</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether the Recommended Connections component is automatically added
                (<samp class="codeph nolang">true</samp>) to standard contact, lead, and person
                account Lightning record pages or not (<samp class="codeph nolang">false</samp>).<p class="p">Default value is <samp class="codeph nolang">false</samp>.
                </p>
                <p class="p">Available in API version 53.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">autoContactCreationPref</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether Automatic Contact Creation is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">Default value is <samp class="codeph nolang">false</samp>.</p>
                <p class="p">Available in API version 61.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">autoContactEnrichmentPref</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether Automatic Contact Enhancements is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">Default value is <samp class="codeph nolang">false</samp>.
                </p>
                <p class="p">Available in API version 61.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">automatedEmailFilter</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether the setting to prevent automated emails from being shared is
                on (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">Available in API version 54.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">autoPopulateGoogleMeetLinks</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether the details to join with Google Meet are added (<samp class="codeph nolang">true</samp>) to the Google version of the event or not
                (<samp class="codeph nolang">false</samp>) when sales reps create events in
                Salesforce. The Google Meet details don’t sync back to Salesforce. <p class="p">Default value
                  is <samp class="codeph nolang">false</samp>. </p>
                <p class="p">Available in API version
                  53.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">enableActivityAnalyticsPref</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether the Activities dashboard is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">For orgs that enable Einstein Activity Capture after the
                  Summer ‘21 release, the default value is <samp class="codeph nolang">false</samp>. </p>
                <p class="p">Available in API version 53.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">enableActivityCapture</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether Einstein Activity Capture is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <span class="keyword parmname">provisionProductivityFeatures</span> must be
                <samp class="codeph nolang">true</samp> to use this feature. To ensure that your
                org's requirements for handling sensitive data are met, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=sales.aac_setup_things_to_know.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Einstein Activity Capture
                  Considerations</a>. <p class="p">Default value is <samp class="codeph nolang">false</samp>. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">enableActivityMetrics</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether Activity Metrics are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                <span class="keyword parmname">enableActivityCapture</span> must be <samp class="codeph nolang">true</samp> to use this feature. Before enabling this feature, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=sales.aac_activity_metrics_considerations.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Considerations for Using
                  Activity Metrics</a>.<p class="p">Default value is <samp class="codeph nolang">false</samp>. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">enableActivitySyncEngine</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether combined sync and capture is enabled for events, contacts,
                and emails (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">Default value is <samp class="codeph nolang">false</samp>. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">enableEACForEveryonePref</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether users who have the <span class="keyword parmname">enableActivityCapture</span>
                set to <samp class="codeph nolang">false</samp> can still see emails and events in
                their Salesforce timeline (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). <p class="p">Default value is <samp class="codeph nolang">true</samp>. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">enableEnforceEacSharingPref</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether new Einstein Activity Capture users are required to keep
                their activity sharing setting as Don’t Share (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Users can
                still share individual emails and events, and respond to sharing requests from other
                users.</td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">enableInboxActivitySharing</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether the default activity sharing for new users is set to
                <span class="keyword parmname">Everyone</span> (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). <p class="p">For example, if
                  <span class="keyword parmname">enableInboxActivitySharing</span> is <samp class="codeph nolang">true</samp>, then new Einstein Activity Capture users have their activity
                  sharing set to <span class="keyword parmname">Everyone</span> by default. This setting does not
                  affect the activity sharing setting of existing users.
                </p>
                <p class="p">Default value is
                  <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">enableInsightsInTimeline</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether Email Insights is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">Default
                  value is <samp class="codeph nolang">true</samp>. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">enableInsightsInTimelineEacStd</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether Email Insights is enabled for users with an Einstein Activity
                Capture Standard permission set (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). For more information, see "Turn On
                Einstein Email Insights" in Salesforce Help.<p class="p">Default value is <samp class="codeph nolang">false</samp>. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">provisionProductivityFeatures</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether your org is ready for productivity features to be enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">Default value is <samp class="codeph nolang">false</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">relationshipGraphPref</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether Buyer Relationship Map is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">Default value is <samp class="codeph nolang">true</samp>.
                </p>
                <p class="p">Available in API version 61.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">salesforceEventsOnlyPref</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether the activity timeline shows only events that are Salesforce
                records (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). For more information, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=sales.aac_event_considerations.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Guidelines for Using Events
                  with Einstein Activity Capture</a>
                <p class="p">Available in API version 53.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">sensitiveEmailFilter</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether the setting to prevent sensitive emails from being shared is
                on (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">Available in API version 54.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">syncEmailToCoreActivity</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether Sync Email as Salesforce Activity is turned on (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">Available in API version 63.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">syncInternalEvents</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether internal events sync between the connected account and
                Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Events are internal when all attendees are
                part of the internal domain.<p class="p">Available in API version 53.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d402312e104" data-title="Field Name"><span class="keyword parmname">s2XSvcAccEmail</span></td>

              <td class="entry" headers="d402312e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d402312e110" data-title="Description">Indicates whether a warning email has be sent to the customer if they're using
                Service Account OAuth on Exchange Online (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). <p class="p">Default value is <samp class="codeph nolang">false</samp>. </p>
                <p class="p">Available in API version 62.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the EAC.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<EACSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableActivityCapture\>true</enableActivityCapture\>
	<enableActivityMetrics\>true</enableActivityMetrics\>
	<enableActivitySyncEngine\>true</enableActivitySyncEngine\>
	<enableEACForEveryonePref\>true</enableEACForEveryonePref\>
	<enableInboxActivitySharing\>true</enableInboxActivitySharing\>
	<enableInsightsInTimeline\>true</enableInsightsInTimeline\>
	<enableInsightsInTimelineEacStd\>true</enableInsightsInTimelineEacStd\>
	<provisionProductivityFeatures\>true</provisionProductivityFeatures\>
</EACSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the EAC settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>EAC</members\>
		<name\>Settings</name\>
	</types\>
	<version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=620d1ed602483846d85bc900887f6cfc65026a90f895c019128c50f08b7acb95 url=/legacydeveloper/current/en-us/api_meta/meta_eclairgeodata.md -->

# EclairGeoData

Represents an Analytics custom map chart. Custom maps are user-defined maps that are uploaded to Analytics and are used just as standard maps are. Custom maps are accessed in Analytics from the list of maps available with the map chart type.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

EclairGeoData components have the suffix geodata and are stored in the eclair folder.

## Version

EclairGeoData components are available in API version 39.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| maps | [EclairMap](#EclairMap)\[\] | A list of EclairMap objects. Each EclairMap object specifies the bounding box (if any) and the map name that appears in the user interface. |
| masterLabel | string | Required. Label for this object. This display value is the internal label that is not translated. |

## EclairMap

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d404370e154">Field Name</th>

              <th class="featureTableHeader  " id="d404370e157">Field Type</th>

              <th class="featureTableHeader  " id="d404370e160">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d404370e154" data-title="Field Name"><span class="keyword parmname">boundingBoxBottom</span></td>

              <td class="entry" headers="d404370e157" data-title="Field Type">double</td>

              <td class="entry" headers="d404370e160" data-title="Description">When bounding-box coordinates are used, this contains the bottom
                coordinate.</td>

            </tr>

            <tr>
              <td class="entry" headers="d404370e154" data-title="Field Name"><span class="keyword parmname">boundingBoxLeft</span></td>

              <td class="entry" headers="d404370e157" data-title="Field Type">double</td>

              <td class="entry" headers="d404370e160" data-title="Description">When bounding-box coordinates are used, this contains the left side
                coordinate.</td>

            </tr>

            <tr>
              <td class="entry" headers="d404370e154" data-title="Field Name"><span class="keyword parmname">boundingBoxRight</span></td>

              <td class="entry" headers="d404370e157" data-title="Field Type">double</td>

              <td class="entry" headers="d404370e160" data-title="Description">When bounding-box coordinates are used, this contains the right side
                coordinate.</td>

            </tr>

            <tr>
              <td class="entry" headers="d404370e154" data-title="Field Name"><span class="keyword parmname">boundingBoxTop</span></td>

              <td class="entry" headers="d404370e157" data-title="Field Type">double</td>

              <td class="entry" headers="d404370e160" data-title="Description">When bounding-box coordinates are used, this contains the top
                coordinate.</td>

            </tr>

            <tr>
              <td class="entry" headers="d404370e154" data-title="Field Name"><span class="keyword parmname">mapLabel</span></td>

              <td class="entry" headers="d404370e157" data-title="Field Type">string</td>

              <td class="entry" headers="d404370e160" data-title="Description">Required. The user-interface name of the map. This name appears in the maps
                list for the map chart in Analytics.</td>

            </tr>

            <tr>
              <td class="entry" headers="d404370e154" data-title="Field Name"><span class="keyword parmname">mapName</span></td>

              <td class="entry" headers="d404370e157" data-title="Field Type">string</td>

              <td class="entry" headers="d404370e160" data-title="Description">Required. Label for this object. This display value is the internal label that
                is not translated.</td>

            </tr>


            <tr>
              <td class="entry" headers="d404370e154" data-title="Field Name"><span class="keyword parmname">projection</span></td>

              <td class="entry" headers="d404370e157" data-title="Field Type">string</td>

              <td class="entry" headers="d404370e160" data-title="Description">Required. The type of map projection used to create the map. Valid values are:
                <a name="map_projection_type_list"><!-- --></a>
                <ul class="ul bulletList" id="map_projection_type_list">
                  <li class="li">Equirectangular</li>

                  <li class="li">Mercator</li>

                  <li class="li">AlbersUSA</li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an EclairGeoData component:

          <EclairGeoData xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <content xsi:nil="true"/>            
            <maps\>              
              <boundingBoxBottom\>0.0</boundingBoxBottom\>              
              <boundingBoxLeft\>100.0</boundingBoxLeft\>              
              <boundingBoxRight\>100.0</boundingBoxRight\>              
              <boundingBoxTop\>0.0</boundingBoxTop\>              
              <mapLabel\>WorldMap0 Label</mapLabel\>              
              <mapName\>WorldMap0</mapName\>              
              <projection\>Equirectangular</projection\>
            </maps\>
            <maps\>
              <boundingBoxBottom\>1.0</boundingBoxBottom\>
              <boundingBoxLeft\>101.0</boundingBoxLeft\>
              <boundingBoxRight\>101.0</boundingBoxRight\>
              <boundingBoxTop\>1.0</boundingBoxTop\>
              <mapLabel\>WorldMap1 Label</mapLabel\>
              <mapName\>WorldMap1</mapName\>
              <projection\>Mercator</projection\>
            </maps\>
            <masterLabel\>WorldMapGeoDataToCreate Label</masterLabel\>
          </EclairGeoData\>
          

The following is an example package.xml that references the previous definition.

        <?xml version="1.0" encoding="UTF-8"?>
        <Package xmlns="http://soap.sforce.com/2006/04/metadata">
          <types\>
            <members\>\*</members\>
            <name\>EclairGeoData</name\>
          </types\>
          <version\>39.0</version\>
        </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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=cc359e476b14449280800303d5ff8103964b362388ca13e81e55d16fecba0c8f url=/legacydeveloper/current/en-us/api_meta/meta_einsteinagentsettings.md -->

# EinsteinAgentSettings

Represents settings for Einstein classification apps, Einstein Case Classification and Einstein Case Wrap-Up, in an org. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

EinsteinAgentSettings values are stored in the EinsteinAgent.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

EinsteinAgentSettings components are available in API version 52.0 and later. In API version 52.0, we renamed CaseClassificationSettings components to EinsteinAgentSettings components to reflect how we consolidated settings for Einstein Case Classification and Einstein Case Wrap-Up. CaseClassificationSettings components are available in API version 47.0 through 51.0.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| einsteinAgentRecommendations | boolean | Indicates whether Einstein classification apps are enabled in your org. The default value is false. |
| reRunAttributeBasedRules | boolean | If true, skills-based routing rules are run after Einstein Case Classification automatically updates field values. The default value is false. |
| runAssignmentRules | boolean | If true, assignment rules are run after Einstein Case Classification automatically updates field values. The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of a EinsteinAgentSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<EinsteinAgentSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <einsteinAgentRecommendations\>true</einsteinAgentRecommendations\>
    <reRunAttributeBasedRules\>true</reRunAttributeBasedRules\>
    <runAssignmentRules\>true</runAssignmentRules\>
</EinsteinAgentSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>EinsteinAgent</members\>
        <name\>Settings</name\>
    </types\>
    <version\>52.0</version\>
</Package\>

<!-- document id=7f183a2554b75400c3edf8c2698531661c68ee275dad7dd11ad6d74ef1c24b97 url=/legacydeveloper/current/en-us/api_meta/meta_einsteinaisettings.md -->

# EinsteinAISettings

Represents Einstein AI settings, including AI feedback integration with Data 360 and PII masking for AI trust features.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

EinsteinAISettings values are stored in the EinsteinAISettings.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

EinsteinAISettings is available in API version 60.0 and later. Individual fields may have specific minimum API version requirements as noted in the field descriptions.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| enableAIFeedbackWithDC | 
Field Type

boolean

Description

Indicates whether AI feedback integration with Data 360 is enabled (true) or not (false). Available in API version 60.0 and later.



 |
| enableTrustPIIMasking | 

Field Type

boolean

Description

Indicates whether PII (Personally Identifiable Information) masking for AI trust features is enabled (true) or not (false). Available in API version 60.0 and later.



 |

## Declarative Metadata Sample Definition

The following is an example of an EinsteinAISettings component.

<?xml version="1.0" encoding="UTF-8"?>
<EinsteinAISettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAIFeedbackWithDC\>true</enableAIFeedbackWithDC\>
    <enableTrustPIIMasking\>true</enableTrustPIIMasking\>
</EinsteinAISettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>EinsteinAI</members\>
        <name\>Settings</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=142d396867c4c543fb776fd78e9cac61ff6c0e7ffa1f9c9971b92fa32114a88a url=/legacydeveloper/current/en-us/api_meta/meta_einsteingptsettings.md -->

# EinsteinGptSettings

Represents settings for Einstein Generative AI features in an org. This type extends the Metadata metadata type and inherits its fullName field

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

EinsteinGptSettings values are stored in the EinsteinGpt.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

EinsteinGptSettings components are available in API version 61.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| disableAIProvAWSBedrock | boolean | Indicates whether AWS Bedrock is turned off and access to its models are blocked. The default value is false. |
| disableAIProvAzureOpenAI | boolean | Indicates whether Azure OpenAI is turned off and access to its models are blocked. The default value is false. |
| disableAIProvOpenAI | boolean | Indicates whether OpenAI is turned off and access to its models are blocked. The default value is false. |
| disableAIProvVertexGemini | boolean | Indicates whether Vertex AI (Google) is turned off and access to its models are blocked. The default value is false. |
| disableAIProviderRegionFallback | boolean | Indicates whether the fallback of Azure OpenAI requests outside the model endpoint region for your org is turned off. The default value is false. |
| enableAIModelBeta | boolean | Indicates whether to turn on beta models for Einstein generative AI features. The default value is false. |
| enableEinsteinGptAllowUnsafePTInputChanges | boolean | Reserved for internal use. |
| enableEinsteinGPTDeployPromptTemplatesAsActive | boolean | Indicates whether to turn on the Deploy Active Prompt Template Versions Only setting. Deploys only the active version of prompt templates to this org, and skips inactive versions. If a template doesn't have an active version, the deployment fails. The default value is false. |
| enableEinsteinGptGlobalLangSupport | boolean | Indicates whether to turn on global languages with prompt templates. The default value is false. |
| enableEinsteinGptPlatform | boolean | Indicates whether to turn on generative AI features across Salesforce. The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of an EinsteinGptSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<EinsteinGptSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableEinsteinGptGlobalLangSupport\>true</einsteinAgentRecommendations\>
    <enableEinsteinGptPlatform\>true</reRunAttributeBasedRules\>
</EinsteinGptSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>EinsteinGpt</members\>
        <name\>Settings</name\>
    </types\>
    <version\>63.0</version\>
</Package\>

<!-- document id=671dd079602012f4258988c80deac5481bf2c7a22a760d5f53d0e648ce7145d6 url=/legacydeveloper/current/en-us/api_meta/meta_emailadministrationsettings.md -->

# EmailAdministrationSettings

Represents an organization’s email administration settings, including email deliverability, security compliance, relay configurations, and system notifications. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

EmailAdministrationSettings values are stored in the EmailAdminstration.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

EmailAdministrationSettings is available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d406937e102">Field Name</th>

              <th class="featureTableHeader  " id="d406937e105">Field Type</th>

              <th class="featureTableHeader  " id="d406937e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableComplianceBcc</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether a copy of each outbound email message is sent
                to an email address you specify (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>. <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p> To use this feature,
                            you must specify an email address in <strong class="ph uicontrol">Compliance BCC
                              Email</strong> in Setup.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableEmailConsentManagement</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether Enforce Email Privacy Settings is enabled
                <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. When enabled, Salesforce
                respects each recipient’s email privacy preferences. Default value
                is <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableEmailSenderIdCompliance</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether outgoing emails comply with Sender ID email
                protocols (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). This field has a
                default value of <samp class="codeph nolang">false</samp>. To
                enable this preference, enableEmailSpfCompliance<samp class="codeph nolang"> must be set to true</samp>.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Evaluate the multiple standard email
                            security protocols (SPF, DKIM, and DMARC) supported by
                            Salesforce before you enable this setting. </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname" id="meta_enableEmailSpfCompliance"><a name="meta_enableEmailSpfCompliance"><!-- --></a>enableEmailSpfCompliance</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether outgoing emails comply with Sender Policy
                Framework (SPF) email authentication (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableEmailToSalesforce</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether Email to Salesforce is enabled (<samp class="codeph nolang">true</samp>) or disabled (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableEmailWorkflowApproval</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether users can respond to email approval requests
                directly from their email (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                This field has a default value of <samp class="codeph nolang">false</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=approvals_email_limitations.htm&amp;language=en_US" target="_blank">Considerations for Email
                  Approval</a> before enabling this field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableEnhancedEmailEnabled</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether Enhanced Email is enabled <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname" id="meta:enableHandleBouncedEmails"><a name="meta:enableHandleBouncedEmails"><!-- --></a>enableHandleBouncedEmails</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether emails sent from Salesforce to an invalid email
                address bounce back to Salesforce (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) . This field has a default value of <samp class="codeph nolang">true</samp>. With bounce handling enabled,
                reps know which lead, contact, or person account has a bad email
                address, and they know which specific email wasn’t
                delivered.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableHtmlEmail</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether users receive Email-To-Case emails in HTML
                format (<samp class="codeph nolang">true</samp>) or receive a text
                version instead (<samp class="codeph nolang">false</samp>). This
                field has a default value of <samp class="codeph nolang">false</samp>. When this field is set to <samp class="codeph nolang">true</samp>, users receive a warning
                message about potential malicious HTML before they view incoming
                HTML email content.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname" id="enableInternationalEmailAddresses"><a name="enableInternationalEmailAddresses"><!-- --></a>enableInternationalEmailAddresses</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether non-Latin-based characters are allowed in email
                addresses (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>) when sending emails
                to and from Salesforce. This field has a default value of <samp class="codeph nolang">true</samp> in orgs created in Summer '20
                or later. In orgs created in Spring '20 or earlier, the default
                value is <samp class="codeph nolang">false</samp>. Available in
                API version 49.0 and later.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Review the Email Address
                            Internationalization prerequisites and considerations in
                            Salesforce Help before enabling this
                            setting.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableListEmailLogActivities</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether Salesforce logs sent list emails as activities
                <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableResendBouncedEmails</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether the system forwards a copy of each bounced
                email message to the sender (<samp class="codeph nolang">true</samp>) or only displays the bounce alert (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>. To enable this
                preference, enableHandleBouncedEmails<samp class="codeph nolang"> must be set to true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableRestrictTlsToDomains</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether the selected Transport Layer Security (TLS)
                setting applies only to specific domains (<samp class="codeph nolang">true</samp>) or applies to all domains
                (<samp class="codeph nolang">false</samp>). This field has a
                default value of <samp class="codeph nolang">false</samp>.
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>To enable this preference, you must specify a
                            <strong class="ph uicontrol">TLS Setting</strong> other than Preferred and
                            provide the comma-separated list of domains through
                            <strong class="ph uicontrol">Deliverability</strong> in Setup. When this
                            field is set to <samp class="codeph nolang">true</samp>, any
                            domains not in the list use the system default TLS Setting of
                            Preferred.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableSendThroughGmailPref</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Deprecated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableSendViaExchangePref</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether users can use Office 365 to send emails <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableSendViaGmailPref</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether users can use Gmail to send emails <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">enableUseOrgFootersForExtTrans</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether emails sent through external email services
                (such as Gmail or Office 365) include the Salesforce footer (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">sendMassEmailNotification</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether users receive an auto-generated status email
                from Salesforce for each mass email they send (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d406937e102" data-title="Field Name"><span class="keyword parmname">sendTextOnlySystemEmails</span></td>

              <td class="entry" headers="d406937e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d406937e108" data-title="Description">Indicates whether all system emails are sent via text only
                (<samp class="codeph nolang">true</samp>) or allow other
                formats (<samp class="codeph nolang">false</samp>). This field has
                a default value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an EmailAdministrationSettings component.

<?xml version="1.0" encoding="UTF-8"?>
                <EmailAdministrationSettings xmlns="http://soap.sforce.com/2006/04/metadata">
                <enableEmailWorkflowApproval\>false</enableEmailWorkflowApproval\>
                <enableComplianceBcc\>false</enableComplianceBcc\>
                <enableEmailSenderIdCompliance\>false</enableEmailSenderIdCompliance\>
                <enableEmailSpfCompliance\>true</enableEmailSpfCompliance\>
                <enableEmailToSalesforce\>false</enableEmailToSalesforce\>
                <enableHandleBouncedEmails\>true</enableHandleBouncedEmails\>
                <enableHtmlEmail\>true</enableHtmlEmail\>
                <enableInternationalEmailAddresses\>true</enableInternationalEmailAddresses\>
                <enableResendBouncedEmails\>false</enableResendBouncedEmails\>
                <enableRestrictTlsToDomains\>false</enableRestrictTlsToDomains\>
                <sendMassEmailNotification\>true</sendMassEmailNotification\>
                <sendTextOnlySystemEmails\>false</sendTextOnlySystemEmails\>
                <enableUseOrgFootersForExtTrans\>false</enableUseOrgFootersForExtTrans\>
                <enableSendViaGmailPref\>false</enableSendViaGmailPref\>
                <enableSendViaExchangePref\>true</enableSendViaExchangePref\>
                <enableListEmailLogActivities\>false</enableListEmailLogActivities\>
                <enableEnhancedEmailEnabled\>false</enableEnhancedEmailEnabled\>
                <enableEmailConsentManagement\>false</enableEmailConsentManagement\>
                </EmailAdministrationSettings\>
            

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
                <Package xmlns="http://soap.sforce.com/2006/04/metadata">
                <types\>
                <members\>EmailAdministration</members\>
                <name\>Settings</name\>
                </types\>   
                <version\>49.0</version\>
                </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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [_Salesforce Help_: Email Address Internationalization](https://help.salesforce.com/articleView?id=emailadmin_eai.htm&language=en_US "Salesforce Help: Email Address
    Internationalization - HTML (New Window)")

<!-- document id=d6c1df3365148155bf0a1ccc36edc10ab2065030a111195b97391f5bb3dc1711 url=/legacydeveloper/current/en-us/api_meta/meta_emailauthorizationsettings.md -->

# EmailAuthorizationSettings

Represents your org’s email authorization settings. This type extends the MetadataForSettings metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

EmailAuthorizationSettings values are stored in the EmailAuthorization.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

EmailAuthorizationSettings components are available in API version 66.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| enableSubstituteFromAddress | 
Field Type

boolean

Description

If true , Salesforce substitutes the From address to send outbound emails with unverified email domains. The outbound email uses the From address email@**_UniqueId_**.sfcustomeremail.com, where **_UniqueId_** is your org ID or Experience Cloud site ID. If false, Salesforce users and automations can send messages from Salesforce only when the email domain is verified. The default is false.

This field applies only to outbound email that requires domain-level verification. For more information, including exemptions to domain-level verification, see [Requirements to Send Email from Salesforce](https://help.salesforce.com/s/articleView?id=xcloud.security_email_verification_requirements.htm&type=5&language=en_US) in Salesforce Help.



 |

## Declarative Metadata Sample Definition

The following is an example of an EmailAuthorizationSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<EmailAuthorizationSettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <enableSubstituteFromAddress\>true</enableSubstituteFromAddress\>
</EmailAuthorizationSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>EmailAuthorization</members\>
        <name\>Settings</name\>
    </types\>
    <version\>66.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=736dbcf2b40339db68a5fc6ebda82f543ae21d697d5e866181ac72a1d2f28e8a url=/legacydeveloper/current/en-us/api_meta/meta_emailintegrationsettings.md -->

# EmailIntegrationSettings

Represents an org’s settings for the Outlook integration, Gmail integration, and Salesforce Inbox. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

EmailIntegrationSettings values are stored in the EmailIntegration.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

EmailIntegrationSettings fields are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d409095e104">Field Name</th>

              <th class="featureTableHeader  " id="d409095e107">Field Type</th>

              <th class="featureTableHeader  " id="d409095e110">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">doesEmailLogAsEmailMessageInOutlook</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether the Outlook integration logs emails to the Email Message
                object (<samp class="codeph nolang">true</samp>) or as tasks (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">true</samp>. <p class="p">This field can only be used if the
                  <span class="keyword parmname">enableOutlookIntegration</span> field is set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">doesGmailStayConnectedToSalesforce</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Gmail integration users log in to Salesforce from Gmail each
                time their session expires. If set to <samp class="codeph nolang">true</samp>,
                users log in from the Gmail integration one time, and their credentials are
                remembered the next time they use the Gmail integration. If set to <samp class="codeph nolang">false</samp>, users log in to Salesforce from the Gmail
                integration each time their Salesforce session expires. The default value is <samp class="codeph nolang">false</samp>. <p class="p">This field can only be used if the
                  <span class="keyword parmname">enableGmailIntegration</span> field is set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableContactAndEventSync</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether users can sync calendar events and contacts between
                Salesforce and their Microsoft and Google accounts ( <samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Lightning
                Sync or Einstein Activity Capture must be enabled to use this feature. The default
                value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version 48.0
                  and later. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableContextualEverywhere</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">
                <p class="p">Indicates whether contextual insights in Sales Cloud Everywhere, available in the
                  Salesforce Chrome extension, are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">This field is available in API version 58.0 and later. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableEmailTrackingInMobile</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Salesforce Inbox users can track emails (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) while in the Outlook integration with Inbox or the Gmail
                integration with Inbox. It also controls email tracking in the Inbox mobile app and
                legacy versions of Inbox. The default value is <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableEngageForOutlook</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Engage For Outlook is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to
                <samp class="codeph nolang">true</samp>, Engage users can connect their Outlook
                account and send Engage emails from their Outlook inbox.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableExtensionHostUnrestricted</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether the contextual web experience is enabled in the chrome
                extension or not.</td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableGmailIntegration</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether the Gmail integration is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to
                <samp class="codeph nolang">true</samp>, G Suite users with the Gmail
                integration can connect their Gmail account and work with Salesforce data in their
                email. The default value is <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableInboxInternalEmailTracking</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">
                <p class="p">Indicates whether a read-receipt status is shown for emails that are sent within
                  the same domain (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">This field is available in API version 58.0 and later. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableInboxMobileIntune</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Inbox is enabled to use Microsoft Intune to manage security
                settings (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to <samp class="codeph nolang">true</samp>, Inbox mobile users need a Microsoft Intune license to log in to
                the app. The default value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version 50.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableOutlookIntegration</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether the Outlook integration is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to <samp class="codeph nolang">true</samp>, Outlook
                users with the Outlook integration can connect their Outlook account and work with
                Salesforce data in their email. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableProductivityFeatures</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Inbox features, such as Availability and Send later, are
                available (<samp class="codeph nolang">true</samp>) or not available (<samp class="codeph nolang">false</samp>) in the Outlook or Gmail integration. The
                default value is <samp class="codeph nolang">false</samp>.<p class="p">This field can only
                  be used if either the <span class="keyword parmname">enableOutlookIntegration</span> or
                  <span class="keyword parmname">enableGmailIntegration</span> field is set to <samp class="codeph nolang">true</samp> and if the org has an Inbox
                  license.
                </p>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>To see Inbox features, users must also have either the Inbox
                            with Einstein Activity Capture or the Inbox without Einstein Activity capture
                            permission set.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableSupplementalContactInfoInMobile</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Salesforce Inbox mobile app users see third-party contact
                information when contacts are shown (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>) in the Inbox mobile app. The
                default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">isLayoutCustomizationAllowed</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Salesforce admins are allowed (<samp class="codeph nolang">true</samp>) or not allowed (<samp class="codeph nolang">false</samp>) to
                create custom email application panes using the Lightning App Builder. The email
                application pane defines the layout of the Salesforce pane in Outlook and Gmail. The
                default value is <samp class="codeph nolang">true</samp>.<p class="p">This field can only be
                  used if either the <span class="keyword parmname">enableOutlookIntegration</span> or
                  <span class="keyword parmname">enableGmailIntegration</span> field is set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">orgIsSyncingEventsOutbound</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether changes to Salesforce events sync to Outlook and Google
                calendars <samp class="codeph nolang">(true</samp>) or not (<samp class="codeph nolang">false</samp>).<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>This field is set by Salesforce. We do
                            not recommend that you set this field manually, as doing so may cause
                            interruptions in your org's event syncing.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
                <p class="p">This field is available in API
                  version 50.0 and later</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"></td>

              <td class="entry" headers="d409095e107" data-title="Field Type"></td>

              <td class="entry" headers="d409095e110" data-title="Description"></td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">shouldUseTrustedDomainsList</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates if the web domains listed in the Outlook Integration &amp; Sync page
                in Salesforce Setup are supported (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). These domains are for users who
                access email using Outlook on the web. The default value is <samp class="codeph nolang">true</samp>.<p class="p">This field can only be used if the
                  <span class="keyword parmname">enableOutlookIntegration</span> field is set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a EmailIntegrationSettings file.

<?xml version="1.0" encoding="UTF-8"?>
<EmailIntegrationSettings xmlns="http://soap.sforce.com/2006/04/metadata">
        <enableContactAndEventSync\>true</enableContactAndEventSync\>
        <enableProductivityFeatures\>true</enableProductivityFeatures\>
        <doesGmailStayConnectedToSalesforce\>true</doesGmailStayConnectedToSalesforce\>
        <enableOutlookIntegration\>true</enableOutlookIntegration\>
        <enableGmailIntegration\>true</enableGmailIntegration\>
        <isLayoutCustomizationAllowed\>true</isLayoutCustomizationAllowed\>
        <doesEmailLogAsEmailMessageInOutlook\>false</doesEmailLogAsEmailMessageInOutlook\>
        <shouldUseTrustedDomainsList\>false</shouldUseTrustedDomainsList\>
        <enableEmailTrackingInMobile\>true</enableEmailTrackingInMobile\>
        <enableSupplementalContactInfoInMobile\>false</enableSupplementalContactInfoInMobile\>
        <enableEngageForOutlook\>true</enableEngageForOutlook\>
</EmailIntegrationSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>EmailIntegration</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=bd4c772c69a6fc87323b225ed9f2201df7e4ffac1224905c3766cb92f26d398c url=/legacydeveloper/current/en-us/api_meta/meta_emailservicesfunction.md -->

# EmailServicesFunction

Represents an email service. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

EmailServicesFunction components have the suffix .xml and are stored in the emailservices folder.

## Version

EmailServicesFunction components are available in API version 42.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d410756e85">Field Name</th>

              <th class="featureTableHeader  " id="d410756e88">Field Type</th>

              <th class="featureTableHeader  " id="d410756e91">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="ApexClassId"><a name="ApexClassId"><!-- --></a>apexClass</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">string</td>

              <td class="entry" headers="d410756e91" data-title="Description">Required. The name of the Apex class that the email service uses to process
                inbound messages.</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname">attachmentOption</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">EmailServicesAttOptions (enumeration of type string)</td>

              <td class="entry" headers="d410756e91" data-title="Description">Required. Indicates the types of attachments the email service accepts. One of
                the following values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">None</samp>—The email service accepts the
                    message but discards any attachment.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NoContent</samp>—The attachment metadata
                    (filename, MIME type, and so on) is provided to the Apex class, but the body is
                    set to <samp class="codeph nolang">null</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TextOnly</samp>—The email service only
                    accepts the following types of attachments:<ul class="ul bulletList">
                      <li class="li">Attachments with a Multipurpose Internet Mail Extension (MIME) type of
                        text.</li>

                      <li class="li">Attachments with a MIME type of application/octet-stream and a file name
                        that ends with either a .vcf or .vcs extension. These are saved as
                        text/x-vcard and text/calendar MIME types, respectively.</li>

                    </ul>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">BinaryOnly</samp>—The email service only
                    accepts binary attachments, such as image, audio, application, and video
                    files.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">All</samp>—The email service accepts any
                    type of attachment.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="EsAuthenticationFailureAction"><a name="EsAuthenticationFailureAction"><!-- --></a>authenticationFailureAction</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">EmailServicesErrorAction (enumeration of type string)</td>

              <td class="entry" headers="d410756e91" data-title="Description">Required. Indicates what the email service does with messages that fail or do
                not support any of the authentication protocols if the isAuthenticationRequired field is true.</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="EsAuthorizationFailureAction"><a name="EsAuthorizationFailureAction"><!-- --></a>authorizationFailureAction</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">EmailServicesErrorAction (enumeration of type string)</td>

              <td class="entry" headers="d410756e91" data-title="Description">Required. Indicates what the email service does with messages received from
                senders who are not listed in the authorizedSenders field on either the
                email service or email service address.</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="EsAuthorizedSenders"><a name="EsAuthorizedSenders"><!-- --></a>authorizedSenders</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">string</td>

              <td class="entry" headers="d410756e91" data-title="Description">Configures the email service to only accept messages from the email addresses
                or domains listed in this field. If the email service receives a message from an
                unlisted email address or domain, the email service performs the action specified in
                the authorizationFailureAction
                field. Leave this field blank if you want the email service to receive email from
                any email address. </td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname">emailServicesAddresses</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type"><a class="xref" href="#EmailServicesAddress_descr">EmailServicesAddress</a></td>

              <td class="entry" headers="d410756e91" data-title="Description">A list of EmailServiceAddress records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="ErrorRoutingAddress"><a name="ErrorRoutingAddress"><!-- --></a>errorRoutingAddress</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">email</td>

              <td class="entry" headers="d410756e91" data-title="Description">The destination email address for error notification email messages when
                isErrorRoutingEnabled<samp class="codeph nolang"> is true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="EsFunctionInactiveAction"><a name="EsFunctionInactiveAction"><!-- --></a>functionInactiveAction</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">EmailServicesErrorAction (enumeration of type string)</td>

              <td class="entry" headers="d410756e91" data-title="Description">Required. Indicates what the email service does with messages it receives when
                the email service itself is inactive. <div class="p">One of the following values:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">UseSystemDefault</samp>—The system default is
                      used.
                    </li>

                    <li class="li" id="EsBounceMessage">
                      <a name="EsBounceMessage"><!-- --></a><samp class="codeph nolang">Bounce</samp>—The email
                      service returns the message to the sender with a notification that explains
                      why the message was rejected.
                    </li>

                    <li class="li" id="EsDiscardMessage">
                      <a name="EsDiscardMessage"><!-- --></a><samp class="codeph nolang">Discard</samp>—The email
                      service deletes the message without notifying the sender.
                    </li>

                    <li class="li" id="EsRequeueMessage">
                      <a name="EsRequeueMessage"><!-- --></a><samp class="codeph nolang">Requeue</samp>—The email
                      service queues the message for processing in the next 24 hours. If the message
                      is not processed within 24 hours, the email service returns the message to the
                      sender with a notification that explains why the message was rejected.
                    </li>

                  </ul>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname">functionName</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">string</td>

              <td class="entry" headers="d410756e91" data-title="Description">Required. The name of the email service in the API. This name can contain only
                underscores and alphanumeric characters and must be unique in your org. The value in
                this 64-character field must begin with a letter, not include spaces, not end with
                an underscore, and not contain two consecutive underscores.<div class="p">In managed packages,
                  this field prevents naming conflicts on package installations. This field is
                  automatically generated, but you can supply your own value if you create the
                  record using the API. With this field, a developer can change the object’s name in
                  a managed package and the changes are reflected in a subscriber’s organization.
                  <div class="box message info">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p>When creating large sets of data, always specify a unique
                              <span class="keyword parmname">functionName</span> for each record. If no
                              <span class="keyword parmname">functionName</span> is specified, performance may slow while
                              Salesforce generates one for each record.
                            </p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d410756e91" data-title="Description">Indicates whether this object is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="EsIsAuthenticationRequired"><a name="EsIsAuthenticationRequired"><!-- --></a>isAuthenticationRequired</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d410756e91" data-title="Description">Configures the email service to verify the legitimacy of the sending server
                before processing a message. The email service uses the SPF, SenderId, and
                DomainKeys protocols to verify the sender's legitimacy: If the sending server passes
                at least one of these protocols and does not fail any, the email service accepts the
                email. If the server fails a protocol or does not support any of the protocols, the
                email service performs the action specified in the authenticationFailureAction
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="IsErrorRoutingEnabled"><a name="IsErrorRoutingEnabled"><!-- --></a>isErrorRoutingEnabled</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d410756e91" data-title="Description">When incoming email messages can’t be processed, indicates whether error
                notification email messages are routed to a chosen address or to the
                senders.</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="IsTextAttachmentsAsBinary"><a name="IsTextAttachmentsAsBinary"><!-- --></a>isTextAttachmentsAsBinary</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d410756e91" data-title="Description">If <samp class="codeph nolang">true</samp>, text attachments are supplied to
                the Apex code as a <samp class="codeph nolang">Messaging.BinaryAttachment</samp>
                instead of as a <samp class="codeph nolang">Messaging.TextAttachment</samp>. This
                means that the body is supplied as an Apex Blob instead of as an Apex
                String.</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="EsIsTlsRequired"><a name="EsIsTlsRequired"><!-- --></a>isTlsRequired</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d410756e91" data-title="Description">Not currently in use. </td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e85" data-title="Field Name"><span class="keyword parmname" id="EsOverLimitAction"><a name="EsOverLimitAction"><!-- --></a>overLimitAction</span></td>

              <td class="entry" headers="d410756e88" data-title="Field Type">EmailServicesErrorAction (enumeration of type string)</td>

              <td class="entry" headers="d410756e91" data-title="Description">Required. Indicates what the email service does with messages if the total
                number of messages processed by all email services combined has reached the daily
                limit for your organization.<div class="p" id="EsPossibleActions">
                  <a name="EsPossibleActions"><!-- --></a>One of the following values:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">UseSystemDefault</samp>—The system
                      default is used.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Bounce</samp>—The email service returns the
                      message to the sender with a notification that explains why the message was
                      rejected.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Discard</samp>—The email service deletes the
                      message without notifying the sender.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Requeue</samp>—The email service queues the
                      message for processing in the next 24 hours. If the message is not processed
                      within 24 hours, the email service returns the message to the sender with a
                      notification that explains why the message was rejected.
                    </li>

                  </ul>
                </div>
                <p class="p">The system calculates the limit by multiplying the number of user
                  licenses by 1,000.</p>
              </td>

            </tr>

          </tbody>

        </table>

## EmailServicesAddress

Each email service has one or more email addresses to which users can send messages for processing. An email service only processes messages it receives at one of its addresses.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d410756e440">Field Name</th>

              <th class="featureTableHeader  " id="d410756e443">Field Type</th>

              <th class="featureTableHeader  " id="d410756e446">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d410756e440" data-title="Field Name"><span class="keyword parmname">authorizedSenders</span></td>

              <td class="entry" headers="d410756e443" data-title="Field Type">string</td>

              <td class="entry" headers="d410756e446" data-title="Description">Configures the email service address to only accept messages from the email
                addresses or domains listed in this field. If the email service address receives a
                message from an unlisted email address or domain, the email service performs the
                action specified in the authorizationFailureAction field of its
                associated email service. Leave this field blank if you want the email service
                address to receive email from any email address. </td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e440" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d410756e443" data-title="Field Type">string</td>

              <td class="entry" headers="d410756e446" data-title="Description">Required. The name of the object in the API. This name can contain only
                underscores and alphanumeric characters and must be unique in your org. It must
                begin with a letter, not include spaces, not end with an underscore, and not contain
                two consecutive underscores. This 25-character field must be unique among other
                EmailServicesAddress records under the same EmailServiceFunction parent.<div class="p">In
                  managed packages, this field prevents naming conflicts on package installations.
                  This field is automatically generated, but you can supply your own value if you
                  create the record using the API. With this field, a developer can change the
                  object’s name in a managed package and the changes are reflected in a subscriber’s
                  organization.<div class="box message info">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p>When creating large sets of data, always specify a unique
                              <span class="keyword parmname">developerName</span> for each record. If no
                              <span class="keyword parmname">developerName</span> is specified, performance might be slow
                              while Salesforce generates one for each record.
                            </p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e440" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d410756e443" data-title="Field Type">boolean</td>

              <td class="entry" headers="d410756e446" data-title="Description">Indicates whether this object is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e440" data-title="Field Name"><span class="keyword parmname">localPart</span></td>

              <td class="entry" headers="d410756e443" data-title="Field Type">string</td>

              <td class="entry" headers="d410756e446" data-title="Description">Required. The local-part of the email service address, which is the string that
                comes before the @ symbol. For the local-part of a Salesforce email address, all
                alphanumeric characters are valid, plus the following special characters: <p class="p"><samp class="codeph nolang">! # $ % &amp; amp; ' * / = ? ^ _ + - ` { | } ~
                    ,</samp></p>
                The dot character (.) is also valid as long as it's not the first or
                last character. Email addresses aren’t case sensitive.</td>

            </tr>

            <tr>
              <td class="entry" headers="d410756e440" data-title="Field Name"><span class="keyword parmname">runAsUser</span></td>

              <td class="entry" headers="d410756e443" data-title="Field Type">string</td>

              <td class="entry" headers="d410756e446" data-title="Description">Required. The username of the user whose permissions the email service assumes
                when processing messages sent to this address.</td>

            </tr>

          </tbody>

        </table>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ce3e44abb141df9b9fbff512f4c9b1f73cc2513d9fb118dde55cac39ef79ff17 url=/legacydeveloper/current/en-us/api_meta/meta_emailtemplate.md -->

# EmailTemplate

Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only.

This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

First-generation packaging only is supported for Lightning email templates.

## File Suffix and Directory Location

The file suffix is .email for the template file. The accompanying metadata file is named EmailTemplateName\-meta.xml.

EmailTemplate components are stored in the email folder in the corresponding package directory. For example, for an email template named SampleTemplate in the sampleFolder folder, there’s a SampleTemplate-meta.xml in the email/sampleFolder of the package.

## Retrieving Email Templates

You can’t use the wildcard (\*) symbol with email templates in package.xml. To retrieve the list of email templates for populating package.xml with explicit names, call listMetadata() and pass in EmailTemplate as the type.

The following example shows folders in package.xml:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyDBFolder/MyDBName</members\>
        <name\>Dashboard</name\>
    </types\>
    <types\>
        <members\>MyDocumentFolder/MyDocumentName</members\>
        <name\>Document</name\>
    </types\>
    <types\>
        <members\>unfiled$public/MarketingProductInquiryResponse</members\>
        <members\>unfiled$public/SalesNewCustomerEmail</members\>
        <name\>EmailTemplate</name\>
    </types\>
    <types\>
        <members\>MyReportFolder/MyReportName</members\>
        <name\>Report</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

## Version

Email templates are available in API version 12.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d412456e155">Field Name</th>

              <th class="featureTableHeader  " id="d412456e158">Field Type</th>

              <th class="featureTableHeader  " id="d412456e161">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname" id="field_apiVersion"><a name="field_apiVersion"><!-- --></a>apiVersion</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">double</td>

              <td class="entry" headers="d412456e161" data-title="Description">
                <span class="ph" id="field_apiVersion_desc"><a name="field_apiVersion_desc"><!-- --></a>The API version if it's a
                  Visualforce email template. Every Visualforce email template has
                  an API version specified at creation.</span> This field is
                available in API version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">attachedDocuments</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">string[]</td>

              <td class="entry" headers="d412456e161" data-title="Description"><span class="ph" id="field_attachedDocuments_desc"><a name="field_attachedDocuments_desc"><!-- --></a>A list of references to
                  documents in your organization. These documents are included as
                  attachments in the email template. Each document is referenced
                  by its path, for example
                  <span class="ph filepath">MyFolder/MyDocument.txt</span>.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">attachments</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">
                <a class="xref" href="#attachment">Attachment</a>[]
              </td>

              <td class="entry" headers="d412456e161" data-title="Description"><span class="ph" id="field_attachments_desc"><a name="field_attachments_desc"><!-- --></a>A list of attachments for the
                  email template.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">available</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">boolean</td>

              <td class="entry" headers="d412456e161" data-title="Description">Required. Indicates whether this template is offered to users
                when sending an email (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d412456e161" data-title="Description">Content of the email template. Base 64-encoded binary data.
                Before making an API call, client applications must encode the
                binary attachment data as base64. Upon receiving a response, client
                applications must decode the base64 data to binary. This conversion
                is handled for you by a SOAP client. This field contains:<ul class="ul bulletList">
                  <li class="li">Binary content of the email body if <a class="xref" href="#emailtemplate_type"><span class="keyword parmname">type</span></a> is
                    set to <samp class="codeph nolang">text</samp>
                  </li>

                  <li class="li">HTML email content if <a class="xref" href="#emailtemplate_type"><span class="keyword parmname">type</span></a> is
                    set to <samp class="codeph nolang">html</samp>
                  </li>

                  <li class="li">HTML body if <a class="xref" href="#emailtemplate_type"><span class="keyword parmname">type</span></a> is
                    set to <samp class="codeph nolang">custom</samp>
                  </li>

                  <li class="li">Visualforce body if <a class="xref" href="#emailtemplate_type"><span class="keyword parmname">type</span></a> is
                    set to <samp class="codeph nolang">visualforce</samp>
                  </li>

                </ul>
                <p class="p">This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm" title="MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.">MetadataWithContent</a> component.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">string</td>

              <td class="entry" headers="d412456e161" data-title="Description">The email template description describes the reason for creating
                the template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="ph" id="encodingKey_field_name"><a name="encodingKey_field_name"><!-- --></a><span class="keyword parmname">encodingKey</span></span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">
                <span class="ph" id="encodingKey_field_type"><a name="encodingKey_field_type"><!-- --></a>Encoding</span>
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)
              </td>

              <td class="entry" headers="d412456e161" data-title="Description">
                <span class="ph" id="encodingKey_content_1"><a name="encodingKey_content_1"><!-- --></a>Required for Classic email
                  templates. The default encoding setting is Unicode: <samp class="codeph xml">UTF-8</samp>.</span> Change it if your
                template requires data in a different format.<p class="p">Valid values
                  include:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">UTF-8</samp>—Unicode (UTF-8)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ISO-8859-1</samp>—General US &amp; Western Europe
                    (ISO-8859–1, ISO-LATIN-1)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Shift_JIS</samp>—Japanese (Shift-JIS)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ISO-2022-JP</samp>—Japanese (JIS)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EUC-JP</samp>—Japanese (EUC-JP)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">x-SJIS_0213</samp>—Japanese (Shift-JIS_2004)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ks_c_5601-1987</samp>—Korean (ks_c_5601-1987)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Big5</samp>—Traditional Chinese (Big5)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">GB2312</samp>—Simplified Chinese (GB2312)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Big5-HKSCS</samp>—Traditional Chinese Hong Kong
                    (Big5–HKSCS)
                  </li>

                </ul>

                <p class="p">Lightning email templates don’t use this field. Instead, the
                  encoding values are taken directly from the user’s encoding
                  settings.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname" id="emailtemplate_fullName"><a name="emailtemplate_fullName"><!-- --></a>fullName</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">string</td>

              <td class="entry" headers="d412456e161" data-title="Description">The email template developer name used as a unique identifier for
                API access. The <span class="keyword parmname">fullName</span> can contain only
                underscores and alphanumeric characters. It must be unique, begin
                with a letter, not include spaces, not end with an underscore, and
                not contain two consecutive underscores. If this field contained
                characters before version 14.0 that are no longer allowed, the
                characters were stripped out of this field, and the previous value
                of the field was saved in the <a class="xref" href="#emailtemplate_name"><span class="keyword parmname">name</span></a> field. This
                field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">letterhead</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">string</td>

              <td class="entry" headers="d412456e161" data-title="Description">The letterhead name associated with this email template. Only
                available when <a class="xref" href="#emailtemplate_type"><span class="keyword parmname">type</span></a> is set to
                <samp class="codeph nolang">html</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname" id="emailtemplate_name"><a name="emailtemplate_name"><!-- --></a>name</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">string</td>

              <td class="entry" headers="d412456e161" data-title="Description">Required. Email template name. The list of characters allowed in
                the <a class="xref" href="#emailtemplate_fullName"><span class="keyword parmname">fullName</span></a> field
                has been reduced for versions 14.0 and later. This field contains
                the value contained in the <a class="xref" href="#emailtemplate_fullName"><span class="keyword parmname">fullName</span></a> field
                before version 14.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname" id="field_packageVersions"><a name="field_packageVersions"><!-- --></a>packageVersions</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_classes.htm#PackageVersion">PackageVersion</a>[]
              </td>

              <td class="entry" headers="d412456e161" data-title="Description">
                <span class="ph" id="field_packageVersions_desc"><a name="field_packageVersions_desc"><!-- --></a>The list of package versions
                  for any managed packages containing components that are
                  referenced by this email template. This field is only relevant
                  for Visualforce email templates.</span>
                <p class="p">For more information about managed
                  packages, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_dev2gp.htm" target="_blank" title="HTML (New Window)">Second-Generation Managed
                    Packages</a> in the <cite class="cite">Salesforce DX Developer
                    Guide</cite>. This field is available in API version 16.0
                  and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">relatedEntityType</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">Object Name (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d412456e161" data-title="Description">Reserved for future use with Lightning Experience.</td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">style</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">EmailTemplateStyle (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d412456e161" data-title="Description">Required. The style of the template. This field is only available
                when <a class="xref" href="#emailtemplate_type">type</a> is set to <samp class="codeph nolang">html</samp>.<p class="p">Valid style values include:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">none</samp></li>

                  <li class="li"><samp class="codeph nolang">freeForm</samp></li>

                  <li class="li"><samp class="codeph nolang">formalLetter</samp></li>

                  <li class="li"><samp class="codeph nolang">promotionRight</samp></li>

                  <li class="li"><samp class="codeph nolang">promotionLeft</samp></li>

                  <li class="li"><samp class="codeph nolang">newsletter</samp></li>

                  <li class="li"><samp class="codeph nolang">products</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">subject</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">string</td>

              <td class="entry" headers="d412456e161" data-title="Description">The email subject.<p class="p">The limit is 1,000 characters for Lightning
                  email templates and 230 characters for Classic email
                  templates.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">textOnly</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">string</td>

              <td class="entry" headers="d412456e161" data-title="Description">The text of the email body if <a class="xref" href="#emailtemplate_type">type</a> is set to <samp class="codeph nolang">html</samp> or
                <samp class="codeph nolang">custom</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname" id="emailtemplate_type"><a name="emailtemplate_type"><!-- --></a>type</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">EmailTemplateType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d412456e161" data-title="Description">Required. The email template type.<p class="p"> The valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">text</samp> - all users can
                    create or change text email templates.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">html</samp> - administrators
                    and users with the “Edit HTML Templates”
                    permission can create HTML email templates based on a
                    letterhead.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">custom</samp> - administrators
                    and users with the “Edit HTML Templates”
                    permission can create custom HTML email templates without
                    using a letterhead. You must either know HTML or obtain the
                    HTML code to insert in your email template.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">visualforce</samp> -
                    administrators and users with the Customize
                    Application permission can create email templates
                    using Visualforce.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d412456e155" data-title="Field Name"><span class="keyword parmname">UiType</span></td>

              <td class="entry" headers="d412456e158" data-title="Field Type">EmailTemplateUiType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d412456e161" data-title="Description">Indicates the user interface where this template is usable. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Aloha</samp> (Salesforce
                    Classic)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SFX</samp> (Lightning
                    Experience)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SFX_Sample</samp> (Lightning
                    Experience Sample)
                  </li>

                </ul>
                <p class="p">If <span class="keyword parmname">UiType</span> is <samp class="codeph nolang">SFX</samp>, the
                  <span class="keyword parmname">type</span> must be
                  <span class="keyword parmname">custom</span>.
                </p>

                <p class="p">Packaging is supported for Salesforce Classic email templates only.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Example

<EmailTemplate\>
    <available\>true</available\>
    <description\>Notification that user has been added to a community.</description\>
    <encodingKey\>UTF-8</encodingKey\>
    <name\>Communities: New Member Welcome Email</name\>
    <style\>none</style\>
    <subject\>Welcome to {!Community\_Name}</subject\>
    <type\>custom</type\>
    <uiType\>Aloha</uiType\>
</EmailTemplate\>

## Attachment

Attachment represents an email attachment.

| Field | Field Type | Description |
| --- | --- | --- |
| content | base64Binary | Required. The attachment content. Base 64-encoded binary data. Before making an API call, client applications must encode the binary attachment data as base64. Upon receiving a response, client applications must decode the base64 data to binary. This conversion is handled for you by a SOAP client. |
| name | string | Required. The attachment file name. |

## Declarative Metadata Sample Definition

Here's a sample XML definition of an email template.

<?xml version="1.0" encoding="UTF-8"?>
<EmailTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <available\>true</available\>
    <description\>Sample Email Template</description\>
    <encodingKey\>ISO-8859-1</encodingKey\>
    <name\>Sample Email Template</name\>
    <style\>none</style\>
    <subject\>Sample email subject</subject\>
    <textOnly\>Your case has been resolved.</textOnly\>
    <type\>custom</type\>
</EmailTemplate\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Letterhead](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_letterhead.htm "Represents formatting options for the letterhead in an email template. A letterhead defines the logo, page color, and text settings for your HTML email templates. Use letterheads to ensure a consistent look and feel in your company’s emails.")

<!-- document id=0369f523f231948244212b60b9f7cb1674ff81a216656fa6dcf43b4e6e305625 url=/legacydeveloper/current/en-us/api_meta/meta_emailtemplatesettings.md -->

# EmailTemplateSettings

Represents an org’s email template settings. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

EmailTemplateSettings values are stored in the EmailTemplate.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

EmailTemplateSettings is available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d414784e101">Field Name</th>

              <th class="featureTableHeader  " id="d414784e104">Field Type</th>

              <th class="featureTableHeader  " id="d414784e107">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d414784e101" data-title="Field Name"><span class="keyword parmname">enableTemplateEnhancedFolderPref</span></td>

              <td class="entry" headers="d414784e104" data-title="Field Type">boolean</td>

              <td class="entry" headers="d414784e107" data-title="Description">Indicates whether Folders and Enhanced Sharing for Email
                Templates is enabled (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). This feature
                allows users to create and manage folders for email
                templates.<p class="p">Default value is <samp class="codeph nolang">false</samp>. </p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the package file.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>EmailTemplate</members\>
        <name\>Settings</name\>
    </types\>
</Package\>

The package file references the following EmaillTemplate.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<EmailTemplateSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableTemplateEnhancedFolderPref\>true</enableTemplateEnhancedFolderPref\>
</EmailTemplateSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a9b5f0fa73ed76fafbf9763c6e17f9ac556fc5682bf2deb721c74341664aa3a2 url=/legacydeveloper/current/en-us/api_meta/meta_embeddedservicebranding.md -->

# EmbeddedServiceBranding

Represents the branding for each Embedded Service deployment. This type extends the Metadata metadata type and inherits its fullName field.

This object works only with the legacy chat products. For Messaging for In-app and Web, use the [BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm "Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.") object.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

EmbeddedServiceBranding components are stored in the developer\_name.EmbeddedServiceBranding file in the EmbeddedServiceBranding folder.

## Version

EmbeddedServiceBranding is available in API version 39.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| contrastInvertedColor | string | Accent branding color used in the embedded component, displayed as a hexadecimal value. Changes made to this field in the API aren’t reflected in the embedded component. |
| contrastPrimaryColor | string | Accent branding color used in the embedded component, displayed as a hexadecimal value. |
| embeddedServiceConfig | string | Required. The Embedded Service configuration that this branding applies to. |
| font | string | Font used in the text of the embedded component. |
| height | int | Height of the embedded component. Available in API version 43.0 and later. |
| masterLabel | string | Required. The name of the Embedded Service configuration node. |
| navBarColor | string | Color used for the header in the embedded component, displayed as a hexadecimal value. |
| navBarTextColor | string | Color used for the text and icons in the header in the embedded component, displayed as a hexadecimal value. Available in API version 49.0 and later. |
| primaryColor | string | Primary branding color used in the embedded component, displayed as a hexadecimal value. |
| secondaryColor | string | Secondary branding color used in the embedded component, displayed as a hexadecimal value. |
| secondaryNavBarColor | string | Secondary branding color used for the header in the embedded component, displayed as a hexadecimal value. It applies to the header in the chat feature when it's trying to reconnect because of lost internet connection. Available in API version 49.0 and later. |
| width | int | Width of the embedded component. Available in API version 43.0 and later. |

## Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceBranding file.

<?xml version="1.0" encoding="UTF-8"?>
<EmbeddedServiceBranding xmlns="http://soap.sforce.com/2006/04/metadata">
    <contrastInvertedColor\>#ffffff</contrastInvertedColor\>
    <contrastPrimaryColor\>#333333</contrastPrimaryColor\>
    <embeddedServiceConfig\>EswConfig001</embeddedServiceConfig\>
    <font\>Salesforce Sans</font\>
    <height\>498</height\>
    <masterLabel\>EmbeddedServiceBranding\_Parent04IRM000000002a\_16033cd2c16</masterLabel\>
    <navBarColor\>#222222</navBarColor\>
    <primaryColor\>#222222</primaryColor\>
    <secondaryColor\>#005290</secondaryColor\>
    <width\>320</width\>
</EmbeddedServiceBranding\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=d39c23c2b2c5471b35d2b78608a5053876970283a8cde03feff0a19a2b147db8 url=/legacydeveloper/current/en-us/api_meta/meta_embeddedserviceconfig.md -->

# EmbeddedServiceConfig

Represents a setup node for creating an Embedded Service for Web deployment. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

EmbeddedServiceConfig components have the suffix .EmbeddedServiceConfig and are stored in the EmbeddedServiceConfig folder.

## Version

EmbeddedServiceConfig is available in API version 37.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d416065e106">Field Name</th>

              <th class="featureTableHeader  " id="d416065e109">Field Type</th>

              <th class="featureTableHeader  " id="d416065e112">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">areGuestUsersAllowed</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">boolean</td>

              <td class="entry" headers="d416065e112" data-title="Description">Specifies whether a user must be logged in to access an embedded component.
                Available in API version 45.0 and later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">authMethod</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">EmbeddedServiceAuthMethod (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d416065e112" data-title="Description">Type of login method selected for this Embedded Service deployment. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">CommunitiesLogin</samp>–Customers log in
                    using Communities.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomLogin</samp>–Customers log in using
                    your own custom authentication.
                  </li>

                </ul>
                Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">branding</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">string</td>

              <td class="entry" headers="d416065e112" data-title="Description">The branding set that has all of the branding configurations for this Embedded
                Service configuration. Available in API version 52.0 and later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">customMinimizedComponent</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">string</td>

              <td class="entry" headers="d416065e112" data-title="Description">The custom Lightning component that’s used in this Embedded Service deployment
                in its minimized state. Available in API version 43.0 to 45.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">deploymentFeature</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">EmbeddedServiceDeploymentFeature(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d416065e112" data-title="Description">The conversation type of this Embedded Service deployment. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">EmbeddedMessaging</samp>—Messaging for In-App
                    and Messaging for Web deployments
                  </li>

                  <li class="li"><samp class="codeph nolang">Flows</samp></li>

                  <li class="li"><samp class="codeph nolang">FieldService</samp></li>

                  <li class="li"><samp class="codeph nolang">LiveAgent</samp></li>

                  <li class="li"><samp class="codeph nolang">None</samp></li>

                </ul>
                Available in API version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">deploymentType</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">EmbeddedServiceDeploymentType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d416065e112" data-title="Description">The platform this Embedded Service is deployed to. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Mobile</samp>—For future use
                  </li>

                  <li class="li"><samp class="codeph nolang">Web</samp></li>

                  <li class="li"><samp class="codeph nolang">API</samp></li>

                </ul>
                Available in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">embeddedServiceAppointmentSettings</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">
                <a class="xref" href="#EmbeddedServiceAppointmentSettings">EmbeddedServiceAppointmentSettings</a>[]
              </td>

              <td class="entry" headers="d416065e112" data-title="Description">The settings of the Embedded Service deployment whose
                <span class="keyword parmname">deploymentFeature</span> is <samp class="codeph nolang">FieldService</samp>. Available in API version 46.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">embeddedServiceCustomComponents</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">
                <a class="xref" href="#EmbeddedServiceCustomComponent">EmbeddedServiceCustomComponent</a>[]
              </td>

              <td class="entry" headers="d416065e112" data-title="Description">The custom components used in this Embedded Service deployment. Available in
                API version 44.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"></td>

              <td class="entry" headers="d416065e109" data-title="Field Type"></td>

              <td class="entry" headers="d416065e112" data-title="Description"></td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">embeddedServiceCustomLabels</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">
                <a class="xref" href="#EmbeddedServiceCustomLabel">EmbeddedServiceCustomLabel</a>[]
              </td>

              <td class="entry" headers="d416065e112" data-title="Description">The custom labels used in this Embedded Service deployment. Available in API
                version 44.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">embeddedServiceCustomizations</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">
                <a class="xref" href="#EmbeddedServiceCustomization">EmbeddedServiceCustomization</a>[]
              </td>

              <td class="entry" headers="d416065e112" data-title="Description">The customizations used in this Embedded Service deployment. Each customization
                is associated with a static resource. Available in API version 50.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">embeddedServiceFlowConfig</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">
                <a class="xref" href="#EmbeddedServiceFlowConfig">EmbeddedServiceFlowConfig</a>[]
              </td>

              <td class="entry" headers="d416065e112" data-title="Description">Represents a setup node for creating an embedded flow. Available in API version
                45.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">embeddedServiceFlows</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">
                <a class="xref" href="#EmbeddedServiceFlow">EmbeddedServiceFlow</a>[]
              </td>

              <td class="entry" headers="d416065e112" data-title="Description">All of the flows used by this Embedded Service deployment. Available in API
                version 45.0 and later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">embeddedServiceLayouts</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">
                <a class="xref" href="#EmbeddedServiceLayout">EmbeddedServiceLayout</a>[]
              </td>

              <td class="entry" headers="d416065e112" data-title="Description">The layout of an Appointment Management deployment of an Embedded Service.
                Available in API version 44.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">isEnabled</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">boolean</td>

              <td class="entry" headers="d416065e112" data-title="Description">Indicates if this Embedded Service deployment is enabled (true).</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">isTermsAndConditionsEnabled</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">boolean</td>

              <td class="entry" headers="d416065e112" data-title="Description">Indicates whether Terms and Conditions is displayed. Displaying Terms and
                Conditions is supported if the <span class="keyword parmname">deploymentFeature</span> is either
                <samp class="codeph nolang">EmbeddedMesssaging</samp> or <samp class="codeph nolang">LiveAgent</samp>. The default is <samp class="codeph nolang">false</samp>. Available in API version 59.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">isTermsAndConditionsRequired</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">boolean</td>

              <td class="entry" headers="d416065e112" data-title="Description">Indicates whether acceptance of the Terms and Conditions is required before
                starting a chat. Displaying Terms and Conditions is supported if the
                <span class="keyword parmname">deploymentFeature</span> is either <samp class="codeph nolang">EmbeddedMesssaging</samp> or <samp class="codeph nolang">LiveAgent</samp>.
                The default is <samp class="codeph nolang">false</samp>. Available in API version
                59.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">string</td>

              <td class="entry" headers="d416065e112" data-title="Description">Required. The name of the Embedded Service configuration node. Available in API
                version 37.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">shouldHideAuthDialog</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">boolean</td>

              <td class="entry" headers="d416065e112" data-title="Description">Specifies whether the prompt that the customer log in again during a flow is
                hidden (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When it’s hidden, the customer is taken
                directly to your login page. This field is set to <samp class="codeph nolang">false</samp> by default. Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e106" data-title="Field Name"><span class="keyword parmname">site</span></td>

              <td class="entry" headers="d416065e109" data-title="Field Type">string</td>

              <td class="entry" headers="d416065e112" data-title="Description">Required. The name of the Experience site or website connected to this Embedded
                Service deployment. Available in API version 37.0 and later.</td>

            </tr>

          </tbody>

        </table>

## EmbeddedServiceAppointmentSettings

Returns the settings of an Embedded Service deployment whose deploymentFeature is FieldService. Available in API version 46.0 and later.

| Field Name | Description |
| --- | --- |
| appointmentConfirmImg | 
Field Type

string

Description

The URL of the image to display when an appointment is confirmed.



 |
| enabled | 

Field Type

boolean

Description

Required.

Indicates whether this deployment is enabled. The default is false.



 |
| homeImg | 

Field Type

string

Description

The URL of the image to display on the appointment management widget home screen.



 |
| logoImg | 

Field Type

string

Description

The URL of the logo to display in the appointment management widget.



 |
| shouldShowExistingAppointment | 

Field Type

boolean

Description

Indicates whether existing appointments are displayed in the appointment management widget. The default is false.



 |
| shouldShowNewAppointment | 

Field Type

boolean

Description

Indicates whether new appointments are displayed in the appointment management widget. The default is false.



 |

## EmbeddedServiceCustomComponent

Returns a custom component that’s associated with an EmbeddedServiceConfig setup.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d416065e768">Field Name</th>

              <th class="featureTableHeader  " id="d416065e771">Field Type</th>

              <th class="featureTableHeader  " id="d416065e774">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d416065e768" data-title="Field Name"><span class="keyword parmname">customComponent</span></td>

              <td class="entry" headers="d416065e771" data-title="Field Type">string</td>

              <td class="entry" headers="d416065e774" data-title="Description">The name of the custom component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e768" data-title="Field Name"><span class="keyword parmname">customComponentType</span></td>

              <td class="entry" headers="d416065e771" data-title="Field Type">EmbeddedServiceCustomComponentType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d416065e774" data-title="Description">The type of custom component. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">LA_Prechat</samp> (component for pre-chat in
                    Embedded Chat)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LA_Minimized</samp> (component for the minimized
                    chat window)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LA_PlainTextChatMessage</samp> (component for
                    the text area in Embedded Chat)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MIAW_Prechat</samp>(component for the prechat
                    form in Messaging for In-App and Web)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MIAW_Header</samp>(component for the header of
                    the messaging conversation window in Messaging for In-App and Web)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MIAW_TextMessage</samp>(component for the text
                    message bubbles in a Messaging for In-App and Web conversation)
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## EmbeddedServiceCustomLabel

Returns a custom label that’s associated with an EmbeddedServiceConfig setup.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d416065e870">Field Name</th>

              <th class="featureTableHeader  " id="d416065e873">Field Type</th>

              <th class="featureTableHeader  " id="d416065e876">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d416065e870" data-title="Field Name"><span class="keyword parmname">customLabel</span></td>

              <td class="entry" headers="d416065e873" data-title="Field Type">string</td>

              <td class="entry" headers="d416065e876" data-title="Description">The customized label that appears in the embedded component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e870" data-title="Field Name"><span class="keyword parmname">feature</span></td>

              <td class="entry" headers="d416065e873" data-title="Field Type">EmbeddedServiceFeature (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d416065e876" data-title="Description">The feature that this embedded component uses. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Base</samp></li>

                  <li class="li"><samp class="codeph nolang">ChannelMenu</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">EmbeddedMessaging</samp>—Messaging for In-App
                    and Messaging for Web deployments
                  </li>

                  <li class="li"><samp class="codeph nolang">FieldService</samp></li>

                  <li class="li"><samp class="codeph nolang">Flows</samp></li>

                  <li class="li"><samp class="codeph nolang">LiveAgent</samp></li>

                  <li class="li"><samp class="codeph nolang">NotInUse</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e870" data-title="Field Name"><span class="keyword parmname">labelKey</span></td>

              <td class="entry" headers="d416065e873" data-title="Field Type">EmbeddedServiceLabelKey (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d416065e876" data-title="Description">The type of label for this embedded component. The value corresponds to the
                label within a label group (substate of chat state or page type).</td>

            </tr>

          </tbody>

        </table>

## EmbeddedServiceCustomization

Returns the customization associated with the Embedded Service feature. Available in API version 50.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| customizationName | string | Required. The name of the customization applied to the embedded service. This name can contain only underscores and alphanumeric characters and must be unique in an EmbeddedServiceConfig setup. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. |
| description | string | A description of the customization. |
| embeddedServiceResources | [EmbeddedServiceResource](#EmbeddedServiceResource)\[\] | Required. The reference to the static resource that contains the javascript file of the customization. |

## EmbeddedServiceForm

Returns the form that’s used for pre-chat. Available in API version 62 and later.

<table class="featureTable sort_table" summary="">



            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d416065e1065">Field Name</th>

                <th class="featureTableHeader  " id="d416065e1068">Field Type</th>

                <th class="featureTableHeader  " id="d416065e1071">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d416065e1065" data-title="Field Name">displayContext</td>

                <td class="entry" headers="d416065e1068" data-title="Field Type">EmbeddedServiceFormDisplayContext (enumeration of type string)</td>

                <td class="entry" headers="d416065e1071" data-title="Description">Required. Indicates when we display this form. Values are: <ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">Session</samp>- The pre-chat form is displayed
                      every session.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Conversation</samp>- Tthe pre-chat form is
                      displayed every conversation.
                    </li>

                  </ul>
                  <ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">None</samp>- Don’t select this option.
                    </li>

                  </ul>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d416065e1065" data-title="Field Name">isActive</td>

                <td class="entry" headers="d416065e1068" data-title="Field Type">Boolean</td>

                <td class="entry" headers="d416065e1071" data-title="Description">Indicates whether the form is active. The default value is false.</td>

              </tr>

            </tbody>

          </table>

## EmbeddedServiceFormField

Represents an individual field in a prechat form. Available in API version 62 or higher.

<table class="featureTable sort_table" summary="">



            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d416065e1142">Field Name</th>

                <th class="featureTableHeader  " id="d416065e1145">Field Type</th>

                <th class="featureTableHeader  " id="d416065e1148">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d416065e1142" data-title="Field Name">formField</td>

                <td class="entry" headers="d416065e1145" data-title="Field Type">string or enum</td>

                <td class="entry" headers="d416065e1148" data-title="Description">Required. Maps to either a StandardMessingChannelParameter or a
                  CustomMessagingChannelParameter</td>

              </tr>

              <tr>
                <td class="entry" headers="d416065e1142" data-title="Field Name">messagingChannelParameterType</td>

                <td class="entry" headers="d416065e1145" data-title="Field Type"> MessagingChannelParameterType (enumeration of type string) OR
                  StandardMessagingChannelParameter (enumeration of type string)</td>

                <td class="entry" headers="d416065e1148" data-title="Description">Required. Indicates whether <span class="keyword parmname">formField</span> points to a
                  StandardMessagingChannelParameter or a CustomMessagingChannelParameter. Please match
                  the Enum value here to the formField passed in. Valid values for
                  MessagingChannelParameterType are:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">Standard</samp>
                      - select this field when you want to reference a
                      StandardMessagingChannelParameter&nbsp;
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Custom</samp> - select this field when you want
                      to reference a CustomMessagingChannelParameter&nbsp;
                    </li>

                  </ul>
                  Valid values for StandardMessagingChannelParameter are: <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">FirstName</samp></li>

                    <li class="li"><samp class="codeph nolang">LastName</samp></li>

                    <li class="li"><samp class="codeph nolang">Email</samp></li>

                    <li class="li"><samp class="codeph nolang">Subject</samp></li>

                  </ul>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d416065e1142" data-title="Field Name">formFieldType</td>

                <td class="entry" headers="d416065e1145" data-title="Field Type">EmbeddedServiceFormFieldType (enumeration of type string)</td>

                <td class="entry" headers="d416065e1148" data-title="Description">Required. Indicates the type of data is passed by the End User when filling out
                  the Prechat form. Valid values are: <ul class="ul bulletList">
                    <li class="li">Text</li>

                    <li class="li">Email</li>

                    <li class="li">Phone</li>

                    <li class="li">Number</li>

                    <li class="li">Checkbox</li>

                    <li class="li">Choicelist</li>

                  </ul>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d416065e1142" data-title="Field Name">displayOrder</td>

                <td class="entry" headers="d416065e1145" data-title="Field Type">Integer</td>

                <td class="entry" headers="d416065e1148" data-title="Description">Indicates the relative order of the form field in the prechat form. For Prechat
                  fields where <span class="keyword parmname">isHidden</span> is set to <samp class="codeph nolang">true</samp> displayOrder must be set to -1. For Prechat fields where
                  <span class="keyword parmname">isHidden</span> is set to <samp class="codeph nolang">false</samp>, this value must be greater than or equal to 0.
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d416065e1142" data-title="Field Name">isRequired</td>

                <td class="entry" headers="d416065e1145" data-title="Field Type">Boolean</td>

                <td class="entry" headers="d416065e1148" data-title="Description">Indicates whether a Prechat form field is required. If
                  <span class="keyword parmname">isHidden</span> is set to <samp class="codeph nolang">true</samp>,
                  <span class="keyword parmname">isRequired</span> must be set to <samp class="codeph nolang">false</samp>.
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d416065e1142" data-title="Field Name">isHidden</td>

                <td class="entry" headers="d416065e1145" data-title="Field Type">Boolean</td>

                <td class="entry" headers="d416065e1148" data-title="Description">Indicates whether a Prechat form field is displayed in the UI.
                  <span class="keyword parmname">isHidden</span> can only be set to <samp class="codeph nolang">true</samp> if the <span class="keyword parmname">formField</span> field is set to <samp class="codeph nolang">CustomMessagingChannelParameter</samp> and
                  <span class="keyword parmname">messagingChannelParameterType</span> is set to <samp class="codeph nolang">Custom</samp>.
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d416065e1142" data-title="Field Name">choiceList</td>

                <td class="entry" headers="d416065e1145" data-title="Field Type">ChoiceList</td>

                <td class="entry" headers="d416065e1148" data-title="Description">The choice list that's associated with
                  <span class="keyword parmname">EmbeddedServiceFormField</span>. ChoiceList can only be associated
                  if the formField is set to CustomMessagingChannelParameter and
                  messagingChannelParameterType is set to Custom.
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d416065e1142" data-title="Field Name">embeddedServiceCustomLabels</td>

                <td class="entry" headers="d416065e1145" data-title="Field Type">EmbeddedServiceCustomLabel[]</td>

                <td class="entry" headers="d416065e1148" data-title="Description">The custom label for this field.</td>

              </tr>

            </tbody>

          </table>

## embeddedServiceMessagingChannel

Returns the settings of an Embedded Service deployment whose

deploymentFeature

is EmbeddedMessaging. Available in API version 62 or higher.

| Field Name | Field Type | Description |
| --- | --- | --- |
| businessHours | String | The Business Hours record that’s associated with this specific embedded service deployment. |
| isEnabled | Boolean | Required. Indicates whether this embedded service deployment is enabled. |
| messagingChannel | String | Required. The MessagingChannel record that’s associated with this specific embedded service deployment. |
| shouldShowDeliveryReceipts | Boolean | Required. Indicates whether delivery receipts are shown in the UI. |
| shouldShowEmojiSelection | Boolean | Required. Indicates whether emoji selection is shown in the UI. |
| shouldShowReadReceipts | Boolean | Required. Indicates whether read reciepts are shown in the UI. |
| shouldShowTypingIndicators | Boolean | Required. Indicates whether typing indicators are shown in the UI. |
| shouldStartNewLineOnEnter | Boolean | Required. Indicates whether pressing Enter starts a new line of text in the UI. |

## EmbeddedServiceResource

Returns the static resource associated with the Embedded Service Chat feature customization. Available in API version 50.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d416065e1513">Field Name</th>

              <th class="featureTableHeader  " id="d416065e1516">Field Type</th>

              <th class="featureTableHeader  " id="d416065e1519">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d416065e1513" data-title="Field Name"><span class="keyword parmname">resource</span></td>

              <td class="entry" headers="d416065e1516" data-title="Field Type">string</td>

              <td class="entry" headers="d416065e1519" data-title="Description">Required. The ID of the static resource that contains the javascript file of
                the customization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e1513" data-title="Field Name"><span class="keyword parmname">resourceType</span></td>

              <td class="entry" headers="d416065e1516" data-title="Field Type">EmbeddedServiceResourceType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d416065e1519" data-title="Description">Required. The embedded service feature to customize. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ChatInvitation</samp>—Use for Chat
                    deployments.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SettingsFile</samp>—Use if you’re configuring a
                    settings file for a Channel Menu deployment.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## EmbeddedServiceFlow

Returns an embedded flow that’s associated with an EmbeddedServiceConfig setup.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d416065e1594">Field Name</th>

              <th class="featureTableHeader  " id="d416065e1597">Field Type</th>

              <th class="featureTableHeader  " id="d416065e1600">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d416065e1594" data-title="Field Name"><span class="keyword parmname">flow</span></td>

              <td class="entry" headers="d416065e1597" data-title="Field Type">string</td>

              <td class="entry" headers="d416065e1600" data-title="Description">The developer name of the flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e1594" data-title="Field Name"><span class="keyword parmname">flowType</span></td>

              <td class="entry" headers="d416065e1597" data-title="Field Type">EmbeddedServiceFlowType(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d416065e1600" data-title="Description">The type of flow. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FS_CancelAppointment</samp></li>

                  <li class="li"><samp class="codeph nolang">FS_Flow</samp></li>

                  <li class="li"><samp class="codeph nolang">FS_ModifyAppointment</samp></li>

                  <li class="li"><samp class="codeph nolang">FS_NewAppointment</samp></li>

                  <li class="li"><samp class="codeph nolang">LA_Survey</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e1594" data-title="Field Name"><span class="keyword parmname">isAuthenticationRequired</span></td>

              <td class="entry" headers="d416065e1597" data-title="Field Type">boolean</td>

              <td class="entry" headers="d416065e1600" data-title="Description">Indicates whether users are required to log in to access the Embedded Service
                component. The value can’t be <samp class="codeph nolang">true</samp> for the
                <samp class="codeph nolang">FS_Flow</samp> value and must be <samp class="codeph nolang">true</samp> for all other values.
              </td>

            </tr>

          </tbody>

        </table>

## EmbeddedServiceFlowConfig

Returns the EmbeddedServiceFlowConfig type.

| Field Name | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Indicates whether the embedded flow is enabled. |

## EmbeddedServiceLayout

Returns the layout of an Embedded Service deployment whose deploymentFeature is FieldService. Available in API version 44.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d416065e1765">Field Name</th>

              <th class="featureTableHeader  " id="d416065e1768">Field Type</th>

              <th class="featureTableHeader  " id="d416065e1771">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d416065e1765" data-title="Field Name"><span class="keyword parmname">embeddedServiceLayoutRules</span></td>

              <td class="entry" headers="d416065e1768" data-title="Field Type">
                <a class="xref" href="#EmbeddedServiceLayoutRule">EmbeddedServiceLayoutRule</a>[]
              </td>

              <td class="entry" headers="d416065e1771" data-title="Description">The appointment statuses that the layout of the Embedded Service deployment is
                valid for.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e1765" data-title="Field Name"><span class="keyword parmname">layout</span></td>

              <td class="entry" headers="d416065e1768" data-title="Field Type">string</td>

              <td class="entry" headers="d416065e1771" data-title="Description">The FlexiPage that represents the layout of this Embedded Service
                deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d416065e1765" data-title="Field Name"><span class="keyword parmname">layoutType</span></td>

              <td class="entry" headers="d416065e1768" data-title="Field Type">EmbeddedServiceLayoutType (enumeration of type string)</td>

              <td class="entry" headers="d416065e1771" data-title="Description">The type of layout applied to the Embedded Service deployment.<p class="p">Values
                  are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FS_AppointmentHome</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## EmbeddedServiceLayoutRule

Returns an appointment status for which the Embedded Service layout is valid for. This subtype is for Embedded Service deployments whose deploymentFeature is FieldService. Available in API version 44.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| appointmentStatus | string | The service appointment status that the EmbeddedServiceLayout subtype is valid for. |

## Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceConfig file.

<?xml version="1.0" encoding="UTF-8"?>
<EmbeddedServiceConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <areGuestUsersAllowed\>false</areGuestUsersAllowed\>
    <deploymentType\>Mobile</deploymentType\>
    <deploymentFeature\>EmbeddedMessaging</deploymentFeature\>
    <masterLabel\>ESWOne</masterLabel\>
    <shouldHideAuthDialog\>false</shouldHideAuthDialog\>

    <embeddedServiceMessagingChannel\>
        <isEnabled\>true</isEnabled\>
        <shouldShowTypingIndicators\>false</shouldShowTypingIndicators\>
        <shouldShowReadReceipts\>false</shouldShowReadReceipts\>
        <shouldShowDeliveryReceipts\>false</shouldShowDeliveryReceipts\>
        <shouldShowEmojiSelection\>false</shouldShowEmojiSelection\>
        <shouldStartNewLineOnEnter\>false</shouldStartNewLineOnEnter\>
        <messagingChannel\>EM1</messagingChannel\>
    </embeddedServiceMessagingChannel\>

    <embeddedServiceForms\>
        <isActive\>true</isActive\>
        <displayContext\>Session</displayContext\>

        <embeddedServiceFormFields\>
            <displayOrder\>0</displayOrder\>
            <formField\>\_FirstName</formField\>
            <messagingChannelParameterType\>Standard</messagingChannelParameterType\>
            <formFieldType\>Text</formFieldType\>
            <isHidden\>false</isHidden\>
            <isRequired\>true</isRequired\>
            <embeddedServiceCustomLabels\>
                <customLabel\>EM\_PreChat\_Base\_PrechatCustomFieldLabel\_133xx0000004GG2\_5523048</customLabel\>
                <labelKey\>EM\_PreChat\_Base\_PrechatCustomFieldLabel</labelKey\>
                <feature\>EmbeddedMessaging</feature\>
            </embeddedServiceCustomLabels\>
        </embeddedServiceFormFields\>
        <embeddedServiceFormFields\>
            <displayOrder\>1</displayOrder\>
            <formField\>\_LastName</formField\>
            <messagingChannelParameterType\>Standard</messagingChannelParameterType\>
            <formFieldType\>Text</formFieldType\>
            <isHidden\>false</isHidden\>
            <isRequired\>true</isRequired\>
            <embeddedServiceCustomLabels\>
                <customLabel\>EM\_PreChat\_Base\_PrechatCustomFieldLabel\_133xx0000004GG2\_5523058</customLabel\>
                <labelKey\>EM\_PreChat\_Base\_PrechatCustomFieldLabel</labelKey\>
                <feature\>EmbeddedMessaging</feature\>
            </embeddedServiceCustomLabels\>
        </embeddedServiceFormFields\>
        <embeddedServiceFormFields\>
            <displayOrder\>2</displayOrder\>
            <formField\>FavoriteFood\_name</formField\>
            <messagingChannelParameterType\>Custom</messagingChannelParameterType\>
            <formFieldType\>ChoiceList</formFieldType\>
            <isHidden\>false</isHidden\>
            <isRequired\>true</isRequired\>
            <choiceList\>Food</choiceList\>
        </embeddedServiceFormFields\>
    </embeddedServiceForms\>
</EmbeddedServiceConfig\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=c91eebe88b58c13ce4b82b969314175c5827338e914b0f2b427818946ae79d53 url=/legacydeveloper/current/en-us/api_meta/meta_embeddedservicefieldservice.md -->

# EmbeddedServiceFieldService

Represents a setup node for creating an embedded Appointment Management deployment. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

EmbeddedServiceFieldService components are stored in a developer\_name.EmbeddedServiceFieldService file in the EmbeddedServiceFieldService folder.

## Version

EmbeddedServiceFieldService is available in API version 43.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| appointmentBookingFlowName | string | Name of the appointment booking flow for this embedded Appointment Management (beta) deployment. |
| cancelApptBookingFlowName | string | Name of the appointment cancellation flow for this embedded Appointment Management (beta) deployment. |
| embeddedServiceConfig | string | Required. The name of the Embedded Service configuration node. |
| enabled | boolean | Required. Indicates whether this embedded Appointment Management deployment is enabled (true). |
| fieldServiceConfirmCardImg | string | URL of the image used for the confirmation card in embedded Appointment Management (beta). |
| fieldServiceHomeImg | string | URL of the image used for the home screen in embedded Appointment Management (beta). |
| fieldServiceLogoImg | string | URL of the logo used for the home screen in embedded Appointment Management (beta). |
| masterLabel | string | Required. Name of the embedded Appointment Management (beta) deployment. |
| modifyApptBookingFlowName | string | Name of the appointment modification flow for this embedded Appointment Management (beta) deployment. |
| shouldShowExistingAppointment | boolean | Specifies whether to display a button on the home screen for customers to access their existing appointments (true) or not (false). This field is false by default. |
| shouldShowNewAppointment | boolean | Specifies whether to display a button on the home screen for customers to create a new appointment (true) or not (false). This field is false by default. |

## Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceFieldService file.

<?xml version="1.0" encoding="UTF-8"?>
<EmbeddedServiceFieldService xmlns="http://soap.sforce.com/2006/04/metadata">
    <appointmentBookingFlowName\>ESW\_FS\_BookAppt\_Main\_Flow</appointmentBookingFlowName\>
    <cancelApptBookingFlowName\>ESW\_FS\_CancelAppt\_Flow</cancelApptBookingFlowName\>
    <embeddedServiceConfig\>EswFS</embeddedServiceConfig\>
    <enabled\>true</enabled\>
    <fieldServiceConfirmCardImg\>https://google.com/AppointmentConfirmationImg.png</fieldServiceConfirmCardImg\>
    <fieldServiceHomeImg\>https://google.com/HeroImg.png</fieldServiceHomeImg\>
    <fieldServiceLogoImg\>https://google.com/logo.png</fieldServiceLogoImg\>
    <masterLabel\>EmbeddedServiceFieldService\_Parent04IRM000000007p2AA\_162d4270834</masterLabel\>
    <modifyApptBookingFlowName\>ESW\_FS\_ModifyAppt\_Main\_Flow</modifyApptBookingFlowName\>
    <shouldShowExistingAppointment\>true</shouldShowExistingAppointment\>
    <shouldShowNewAppointment\>true</shouldShowNewAppointment\>
</EmbeddedServiceFieldService\>

## Usage

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Any changes you make to the image fields override what you’ve entered in Setup. We recommend setting your image URLs in Setup.

<!-- document id=062586af652c32361363d669f9198c0c14a44cf3a0d02f092486794866e31190 url=/legacydeveloper/current/en-us/api_meta/meta_embeddedserviceflowconfig.md -->

# EmbeddedServiceFlowConfig

Represents a setup node for creating an embedded flow. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

EmbeddedServiceFlowConfig components are stored in the developer\_name.EmbeddedServiceFlowConfig file in the EmbeddedServiceFlowConfig folder.

## Version

EmbeddedServiceFlowConfig is available in API version 45.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Indicates whether the embedded flow is enabled (true) or not (false). Defaults to false. |

## Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceFlowConfig file.

<?xml version="1.0" encoding="UTF-8"?>
<EmbeddedServiceFlowConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <enabled\>true</enabled\>
</EmbeddedServiceFlowConfig\>

<!-- document id=195c633dc86eaab09bfe9889cf64d63608836b039b489dfc7a1e1cbe18c407d3 url=/legacydeveloper/current/en-us/api_meta/meta_embeddedserviceliveagent.md -->

# EmbeddedServiceLiveAgent

Represents a setup node for creating an embedded chat deployment. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

EmbeddedServiceLiveAgent components are stored in the developer\_name.EmbeddedServiceLiveAgent file in the EmbeddedServiceLiveAgent folder.

## Version

EmbeddedServiceLiveAgent is available in API version 38.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d422563e92">Field Name</th>

              <th class="featureTableHeader  " id="d422563e95">Field Type</th>

              <th class="featureTableHeader  " id="d422563e98">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">avatarImg</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Avatar image for this embedded chat deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">customPrechatComponent</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">The custom Lightning Component that’s used for the pre-chat page in this
                embedded chat deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">embeddedServiceConfig</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Required. The name of the embedded service configuration node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">embeddedServiceQuickActions</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type"><a class="xref" href="#EmbeddedServiceQuickActions">EmbeddedServiceQuickAction</a></td>

              <td class="entry" headers="d422563e98" data-title="Description">The quick action used by the pre-chat form.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">enabled</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">boolean</td>

              <td class="entry" headers="d422563e98" data-title="Description">Required. Indicates whether this embedded chat deployment is enabled (<samp class="codeph nolang">true</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">fontSize</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">EmbeddedServiceFontSize (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d422563e98" data-title="Description">Required. The font size for the text in the embedded chat window. One of the
                following values: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Small</samp></li>

                  <li class="li"><samp class="codeph nolang">Medium</samp></li>

                  <li class="li"><samp class="codeph nolang">Large</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">headerBackgroundImg</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Header background image for this embedded chat window. Removed in API version
                49.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">isOfflineCaseEnabled</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">boolean</td>

              <td class="entry" headers="d422563e98" data-title="Description">Indicates whether offline support is enabled for this embedded chat deployment.
                Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">isQueuePositionEnabled</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">boolean</td>

              <td class="entry" headers="d422563e98" data-title="Description">Indicates whether queue position (displaying the chat visitor’s place in line
                while they wait for an agent) is enabled for this embedded chat deployment.
                Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">liveAgentChatUrl</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">The rest endpoint for chats.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">liveAgentContentUrl</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">The rest endpoint for cChat content.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">liveChatButton</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Required. Reference to a chat button created in Chat setup.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">liveChatDeployment</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Required. Reference to a deployment created in Chat setup.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Required. Name of the embedded chat deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">offlineCaseBackgroundImg</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Offline support case form background image for this embedded chat window.
                Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">prechatBackgroundImg</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Pre-chat background image for this embedded chat window.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">prechatEnabled</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Required. Indicates whether the embedded chat pre-chat form is enabled for this
                deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">prechatJson</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">JSON object of all the fields of the selected pre-chat form in Chat
                setup.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">scenario</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">EmbeddedServiceScenario (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d422563e98" data-title="Description">Required. The scenario for the embedded chat window that determines which
                objects to relate to the chat. One of the following values: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Sales</samp></li>

                  <li class="li"><samp class="codeph nolang">Service</samp></li>

                  <li class="li"><samp class="codeph nolang">Basic</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">smallCompanyLogoImg</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Company logo image for this embedded chat window.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e92" data-title="Field Name"><span class="keyword parmname">waitingStateBackgroundImg</span></td>

              <td class="entry" headers="d422563e95" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e98" data-title="Description">Chat waiting image for this embedded chat window.</td>

            </tr>

          </tbody>

        </table>

## EmbeddedServiceQuickAction

Returns a quick action that’s associated with an EmbeddedServiceLiveAgent setup. The quick action includes the pre-chat form fields that the embedded chat window displays and shows the order in which the fields are displayed.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d422563e448">Field Name</th>

              <th class="featureTableHeader  " id="d422563e451">Field Type</th>

              <th class="featureTableHeader  " id="d422563e454">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d422563e448" data-title="Field Name"><span class="keyword parmname">embeddedServiceLiveAgent</span></td>

              <td class="entry" headers="d422563e451" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e454" data-title="Description">Reference to the embedded chat deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e448" data-title="Field Name"><span class="keyword parmname">order</span></td>

              <td class="entry" headers="d422563e451" data-title="Field Type">int</td>

              <td class="entry" headers="d422563e454" data-title="Description">Order in which this quick action appears in the embedded chat pre-chat
                form.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e448" data-title="Field Name"><span class="keyword parmname">quickActionDefinition</span></td>

              <td class="entry" headers="d422563e451" data-title="Field Type">string</td>

              <td class="entry" headers="d422563e454" data-title="Description">Reference to a quick action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d422563e448" data-title="Field Name"><span class="keyword parmname">quickActionType</span></td>

              <td class="entry" headers="d422563e451" data-title="Field Type">EmbeddedServiceQuickActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d422563e454" data-title="Description">Quick action type. One of the following values: <ul class="ul bulletList">
                  <li class="li">
                    <span class="keyword parmname">Prechat</span>–Pre-chat
                  </li>

                  <li class="li">
                    <span class="keyword parmname">OfflineCase</span>–Offline support (Cases)
                  </li>

                </ul>
                Available in API version 43.0 and later.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceLiveAgent file.

<?xml version="1.0" encoding="UTF-8"?>
<EmbeddedServiceLiveAgent xmlns="http://soap.sforce.com/2006/04/metadata">
    <avatarImg\>https://google.com/avatar.png</avatarImg\>
    <customPrechatComponent\>auraCustomPrechat</customPrechatComponent\>
    <embeddedServiceConfig\>EswConfig001</embeddedServiceConfig\>
    <embeddedServiceQuickActions\>
        <embeddedServiceLiveAgent\>EmbeddedServiceLiveAgent\_Parent04Ixx0000000001EAA\_15ec5bd2971</embeddedServiceLiveAgent\>
        <order\>1</order\>
        <quickActionDefinition\>Snapins\_Contact\_QuickAction\_08hRM000000001h</quickActionDefinition\>
    </embeddedServiceQuickActions\>
    <embeddedServiceQuickActions\>
        <embeddedServiceLiveAgent\>EmbeddedServiceLiveAgent\_Parent04Ixx0000000001EAA\_15ec5bd2971</embeddedServiceLiveAgent\>
        <order\>1</order\>
        <quickActionDefinition\>Snapins\_Case\_OfflineCaseQuickAction\_08hRM000000001h</quickActionDefinition\>
        <quickActionType\>OfflineCase</quickActionType\>
    </embeddedServiceQuickActions\>
    <embeddedServiceQuickActions\>
        <embeddedServiceLiveAgent\>EmbeddedServiceLiveAgent\_Parent04Ixx0000000001EAA\_15ec5bd2971</embeddedServiceLiveAgent\>
        <order\>2</order\>
        <quickActionDefinition\>Snapins\_Case\_QuickAction\_08hRM000000001h</quickActionDefinition\>
    </embeddedServiceQuickActions\>
    <enabled\>true</enabled\>
    <fontSize\>Medium</fontSize\>
    <headerBackgroundImg\>https://google.com/headerBackgroundImg.png</headerBackgroundIm\>
    <isOfflineCaseEnabled\>true</isOfflineCaseEnabled\>
    <isQueuePositionEnabled\>true</isQueuePositionEnabled\>
    <liveChatButton\>chatButton01</liveChatButton\>
    <liveChatDeployment\>liveAgentDeployment01</liveChatDeployment\>
    <masterLabel\>EmbeddedServiceLiveAgent\_Parent04Ixx0000000001EAA\_15ec5bd2971</masterLabel\>
    <offlineCaseBackgroundImg\>https://google.com/offlineCaseBackgroundImg.png</offlineCaseBackgroundImg\>
    <prechatBackgroundImg\>https://google.com/prechatBackgroundImg.png</prechatBackgroundImg\>
    <prechatEnabled\>true</prechatEnabled\>
    <scenario\>Service</scenario\>
    <smallCompanyLogoImg\>https://google.com/smallCompanyLogoImg.png</smallCompanyLogoImg\>
    <waitingStateBackgroundImg\>https://google.com/waitingImage.png</waitingStateBackgroundImg\>
</EmbeddedServiceLiveAgent\>

## Usage

EmbeddedServiceLiveAgent represents a Chat configuration that is added to your web page. The EmbeddedServiceLiveAgent record contains a unique combination of a chat button and the Chat deployment that the administrator selects during setup.

To create an EmbeddedServiceLiveAgent record:

1. Create a Chat Deployment record.
2. Create a Chat Button record.
3. Create an EmbeddedServiceConfig record.
4. Set the fields for the Chat Deployment record, Chat Button record, and EmbeddedServiceConfig record as references on the EmbeddedServiceLiveAgent record.

Any changes you make to the image fields override what you’ve entered in Setup. We recommend setting your image URLs in Setup.

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b99bc19f052630adf79f5ed2886ff08a39512ec6c7a48ed3d71b76f6d2569d89 url=/legacydeveloper/current/en-us/api_meta/meta_embeddedservicemenusettings.md -->

# EmbeddedServiceMenuSettings

Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

EmbeddedServiceMenuSettings components are stored in the developer\_name.EmbeddedServiceMenuSettings folder.

## Version

EmbeddedServiceMenuSettings components are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| branding | string | The developer name of the associated BrandingSet. |
| embeddedServiceCustomLabels | [EmbeddedServiceCustomLabel](#embeddedservicecustomlabel_subtype)\[\] | Represents a customized label that appears in the embedded component for a particular channel menu deployment. |
| embeddedServiceCustomizations | [EmbeddedServiceCustomization](#EmbeddedServiceCustomization_subtype)\[\] | The customizations used in this Embedded Service deployment. Each customization is associated with a static resource. Available in API version 50.0 and later. |
| embeddedServiceMenuItems | [EmbeddedServiceMenuItem](#embeddedservicemenuitem_subtype)\[\] | Represents a channel menu item that lists a way in which customers can contact your business. |
| isEnabled | boolean | If true (default), the deployment is enabled. If false, the deployment is disabled. |
| masterLabel | string | Required. The name of the channel menu deployment. |
| site | string | Required. The name of the Experience site or website connected to this channel menu deployment. |

## EmbeddedServiceCustomLabel

Represents the custom labels used in your channel menu deployment.

| Field Name | Field Type | Description |
| --- | --- | --- |
| customLabel | string | The customized label that appears in the channel menu. |
| feature | EmbeddedServiceFeature ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | The feature using the custom label. For channel menu deployments, the value is ChannelMenu. |
| labelKey | EmbeddedServiceLabelKey ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | The type of label for this embedded component. The value corresponds to the label within a label group (substate of chat state or page type). |

## EmbeddedServiceCustomization

Returns the customization associated with the Embedded Service feature. Available in API version 50.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| customizationName | string | Required. The name of the customization applied to the embedded service. This name can contain only underscores and alphanumeric characters and must be unique in an EmbeddedServiceConfig setup. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. |
| description | string | A description of the customization. |
| embeddedServiceResources | [EmbeddedServiceResource](#EmbeddedServiceResource_subtype)\[\] | Required. The reference to the static resource that contains the javascript file of the customization. |

## EmbeddedServiceResource

Returns the static resource associated with the Embedded Service Chat feature customization. Available in API version 50.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d424513e404">Field Name</th>

              <th class="featureTableHeader  " id="d424513e407">Field Type</th>

              <th class="featureTableHeader  " id="d424513e410">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d424513e404" data-title="Field Name"><span class="keyword parmname">resource</span></td>

              <td class="entry" headers="d424513e407" data-title="Field Type">string</td>

              <td class="entry" headers="d424513e410" data-title="Description">Required. The ID of the static resource that contains the javascript file of
                the customization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e404" data-title="Field Name"><span class="keyword parmname">resourceType</span></td>

              <td class="entry" headers="d424513e407" data-title="Field Type">EmbeddedServiceResourceType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d424513e410" data-title="Description">Required. The embedded service feature to customize. Only the Chat feature is
                supported. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ChatInvitation</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## EmbeddedServiceMenuItem

Represents an item in a channel menu.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d424513e479">Field Name</th>

              <th class="featureTableHeader  " id="d424513e482">Field Type</th>

              <th class="featureTableHeader  " id="d424513e485">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">channel</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">string</td>

              <td class="entry" headers="d424513e485" data-title="Description">The ID of the channel type. If <span class="keyword parmname">channelType</span> is <samp class="codeph nolang">Phone</samp> or <samp class="codeph nolang">CustomURL</samp>, this field is <samp class="codeph nolang">null</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">channelType</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">EmbeddedServiceChannelType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d424513e485" data-title="Description">The type of communication channel. Values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">EmbeddedMessaging</samp></li>

                  <li class="li"><samp class="codeph nolang">EmbeddedServiceConfig</samp></li>

                  <li class="li"><samp class="codeph nolang">MessagingChannel</samp></li>

                  <li class="li"><samp class="codeph nolang">Phone</samp></li>

                  <li class="li"><samp class="codeph nolang">CustomURL</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">customUrl</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">string</td>

              <td class="entry" headers="d424513e485" data-title="Description">A custom URL that appears in the menu. The
                <span class="keyword parmname">shouldOpenUrlInSameTab</span> field determines where the URL
                opens.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">displayOrder</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">int</td>

              <td class="entry" headers="d424513e485" data-title="Description">The item’s order in the menu, such as 1 or 2.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">embeddedServiceCustomLabels</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">
                <a class="xref" href="#embeddedservicecustomlabel_subtype">EmbeddedServiceCustomLabel</a>[]
              </td>

              <td class="entry" headers="d424513e485" data-title="Description">Represents the custom labels used in your channel menu item.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">iconUrl</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">string</td>

              <td class="entry" headers="d424513e485" data-title="Description">The icon URL for the menu item. Icons can be used only for phone, SMS, custom
                URL, and chat menu items.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">isDisplayedOnPageLoad</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">boolean</td>

              <td class="entry" headers="d424513e485" data-title="Description">If <samp class="codeph nolang">true</samp>, the menu item is displayed on
                page load. Available in API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">itemName</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">string</td>

              <td class="entry" headers="d424513e485" data-title="Description">A unique custom name for the menu item, which is visible in the user
                interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">osOptionsHideInIOS</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">boolean</td>

              <td class="entry" headers="d424513e485" data-title="Description">If <samp class="codeph nolang">true</samp>, the menu item is hidden in
                iOS.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">osOptionsHideInLinuxOS</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">boolean</td>

              <td class="entry" headers="d424513e485" data-title="Description">If <samp class="codeph nolang">true</samp>, the menu item is hidden in Linux
                operating system.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">osOptionsHideInMacOS</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">boolean</td>

              <td class="entry" headers="d424513e485" data-title="Description">If <samp class="codeph nolang">true</samp>, the menu item is hidden in Mac
                operating system.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">osOptionsHideInOtherOS</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">boolean</td>

              <td class="entry" headers="d424513e485" data-title="Description">If <samp class="codeph nolang">true</samp>, the menu item is hidden in any
                operating system other than iOS, Linux, Mac, and Windows.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">osOptionsHideInWindowsOS</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">boolean</td>

              <td class="entry" headers="d424513e485" data-title="Description">If <samp class="codeph nolang">true</samp>, the menu item is hidden in
                Windows operating system.</td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">phoneNumber</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">string</td>

              <td class="entry" headers="d424513e485" data-title="Description">The phone number for menu items whose <span class="keyword parmname">channelType</span> is
                <samp class="codeph nolang">Phone</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d424513e479" data-title="Field Name"><span class="keyword parmname">shouldOpenUrlInSameTab</span></td>

              <td class="entry" headers="d424513e482" data-title="Field Type">boolean</td>

              <td class="entry" headers="d424513e485" data-title="Description">If the menu item’s <span class="keyword parmname">channelType</span> is <samp class="codeph nolang">CustomURL</samp>, this field indicates whether the link
                opens in the same tab (<samp class="codeph nolang">true</samp>) or a new tab
                (<samp class="codeph nolang">false</samp>).</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceMenuSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<EmbeddedServiceMenuSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <embeddedServiceCustomLabels\>
        <customLabel\>CM\_Container\_Header\_Primary\_Greeting\_3MsRM0000004CB5\_6181150</customLabel\>
        <labelKey\>CM\_Container\_Header\_Primary\_Greeting</labelKey\>
    </embeddedServiceCustomLabels\>
    <embeddedServiceCustomLabels\>
        <customLabel\>CM\_Container\_Header\_Secondary\_Greeting\_3MsRM0000004CB5\_4637097</customLabel\>
        <labelKey\>CM\_Container\_Header\_Secondary\_Greeting</labelKey\>
    </embeddedServiceCustomLabels\>
    <embeddedServiceMenuItems\>
        <channel\>Chat</channel\>
        <channelType\>EmbeddedServiceConfig</channelType\>
        <displayOrder\>1</displayOrder\>
        <embeddedServiceCustomLabels\>
            <customLabel\>CM\_Container\_MenuItems\_WebChatUnavailable\_3miRM0000004CuZ\_8003848</customLabel\>
            <labelKey\>CM\_Container\_MenuItems\_WebChatUnavailable</labelKey\>
        </embeddedServiceCustomLabels\>
        <embeddedServiceCustomLabels\>
            <customLabel\>CM\_Container\_MenuItems\_WebChatAvailable\_3miRM0000004CuZ\_5823055</customLabel\>
            <labelKey\>CM\_Container\_MenuItems\_WebChatAvailable</labelKey\>
        </embeddedServiceCustomLabels\>
        <itemName\>Chat1</itemName\>
        <osOptionsHideInIOS\>false</osOptionsHideInIOS\>
        <osOptionsHideInLinuxOS\>true</osOptionsHideInLinuxOS\>
        <osOptionsHideInMacOS\>false</osOptionsHideInMacOS\>
        <osOptionsHideInOtherOS\>false</osOptionsHideInOtherOS\>
        <osOptionsHideInWindowsOS\>true</osOptionsHideInWindowsOS\>
        <shouldOpenUrlInSameTab\>false</shouldOpenUrlInSameTab\>
    </embeddedServiceMenuItems\>
    <embeddedServiceMenuItems\>
        <channelType\>Phone</channelType\>
        <displayOrder\>2</displayOrder\>
        <itemName\>Phone1</itemName\>
        <osOptionsHideInIOS\>true</osOptionsHideInIOS\>
        <osOptionsHideInLinuxOS\>false</osOptionsHideInLinuxOS\>
        <osOptionsHideInMacOS\>true</osOptionsHideInMacOS\>
        <osOptionsHideInOtherOS\>false</osOptionsHideInOtherOS\>
        <osOptionsHideInWindowsOS\>false</osOptionsHideInWindowsOS\>
        <phoneNumber\>1234567890</phoneNumber\>
        <shouldOpenUrlInSameTab\>false</shouldOpenUrlInSameTab\>
    </embeddedServiceMenuItems\>
    <embeddedServiceMenuItems\>
        <channelType\>CustomURL</channelType\>
        <customUrl\>https://google.com</customUrl\>
        <displayOrder\>3</displayOrder\>
        <itemName\>url1</itemName\>
        <osOptionsHideInIOS\>false</osOptionsHideInIOS\>
        <osOptionsHideInLinuxOS\>false</osOptionsHideInLinuxOS\>
        <osOptionsHideInMacOS\>false</osOptionsHideInMacOS\>
        <osOptionsHideInOtherOS\>false</osOptionsHideInOtherOS\>
        <osOptionsHideInWindowsOS\>false</osOptionsHideInWindowsOS\>
        <shouldOpenUrlInSameTab\>false</shouldOpenUrlInSameTab\>
    </embeddedServiceMenuItems\>
    <isEnabled\>true</isEnabled\>
    <masterLabel\>ChannelMenuSettings</masterLabel\>
    <site\>SnapInCommunity</site\>
</EmbeddedServiceMenuSettings\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6b4521d2294a7990048cf3b9315362c0b6ebae45cb3bac301f5c5046f1b9cbbd url=/legacydeveloper/current/en-us/api_meta/meta_employeeusersettings.md -->

# EmployeeUserSettings

Represents the employee-user settings used for automatically creating or syncing employee and user data in work.com orgs. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

A EmployeeUserSettings component file has the suffix .settings and is stored in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

EmployeeUserSettings components are available in API version 50.0 and later.

## Special Access Rules

Access to the EmployeeUserSettings type requires the Workplace Command Center permission set license available in the org and assigned to the user. The WorkplaceCommandCenterUser scratch org feature must also be enabled in the org.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d427003e97">Field Name</th>

              <th class="featureTableHeader  " id="d427003e100">Field Type</th>

              <th class="featureTableHeader  " id="d427003e103">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d427003e97" data-title="Field Name"><span class="keyword parmname">emailEncoding</span></td>

              <td class="entry" headers="d427003e100" data-title="Field Type">string</td>

              <td class="entry" headers="d427003e103" data-title="Description">Required. <span class="ph" id="encodingKey_content_1"><a name="encodingKey_content_1"><!-- --></a>The default encoding setting is
                  Unicode: <samp class="codeph xml">UTF-8</samp>.</span>
                <div class="p">Valid values include:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">UTF-8</samp>—Unicode (UTF-8)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">ISO-8859-1</samp>—General US &amp; Western
                      Europe (ISO-8859–1, ISO-LATIN-1)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Shift_JIS</samp>—Japanese (Shift-JIS)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">ISO-2022-JP</samp>—Japanese (JIS)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">EUC-JP</samp>—Japanese (EUC-JP)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">x-SJIS_0213</samp>—Japanese
                      (Shift-JIS_2004)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">ks_c_5601-1987</samp>—Korean
                      (ks_c_5601-1987)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Big5</samp>—Traditional Chinese (Big5)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">GB2312</samp>—Simplified Chinese (GB2312)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Big5-HKSCS</samp>—Traditional Chinese Hong
                      Kong (Big5–HKSCS)
                    </li>

                  </ul>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d427003e97" data-title="Field Name"><span class="keyword parmname">enableEmployeeAutoCreateUser</span></td>

              <td class="entry" headers="d427003e100" data-title="Field Type">boolean</td>

              <td class="entry" headers="d427003e103" data-title="Description">If <samp class="codeph nolang">true</samp>, users are auto-created when a new
                employee record is created. The default value for this field is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d427003e97" data-title="Field Name"><span class="keyword parmname">enableEmployeeIsSourceOfTruth</span></td>

              <td class="entry" headers="d427003e100" data-title="Field Type">boolean</td>

              <td class="entry" headers="d427003e103" data-title="Description">If <samp class="codeph nolang">true</samp>, the employee record is the source
                of truth. The default value for this field is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d427003e97" data-title="Field Name"><span class="keyword parmname">permset</span></td>

              <td class="entry" headers="d427003e100" data-title="Field Type">string</td>

              <td class="entry" headers="d427003e103" data-title="Description">Represents a set of permissions that's used to grant more access to a user. You
                can use permission sets to grant access but not to deny access.</td>

            </tr>

            <tr>
              <td class="entry" headers="d427003e97" data-title="Field Name"><span class="keyword parmname">profile</span></td>

              <td class="entry" headers="d427003e100" data-title="Field Type">string</td>

              <td class="entry" headers="d427003e103" data-title="Description">Required. Represents a user profile. A profile defines a user’s permission to
                perform different functions within Salesforce.</td>

            </tr>

            <tr>
              <td class="entry" headers="d427003e97" data-title="Field Name"><span class="keyword parmname">usernameSuffix</span></td>

              <td class="entry" headers="d427003e100" data-title="Field Type">string</td>

              <td class="entry" headers="d427003e103" data-title="Description">Represents a domain name. We create a unique login by combining this domain
                name with each employee’s username.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example EmployeeUser.settings-meta.xml that deploys the EmployeeUserSettings metadata to an org. The file is in the dir path force-app/main/default/settings:

<?xml version="1.0" encoding="UTF-8"?>
<EmployeeUserSettings xmlns="http://soap.sforce.com/2006/04/metadata">
<emailEncoding\>ISO-8859-1</emailEncoding\>
<enableEmployeeAutoCreateUser\>true</enableEmployeeAutoCreateUser\>
<enableEmployeeIsSourceOfTruth\>false</enableEmployeeIsSourceOfTruth\>
<profile\>MarketingProfile</profile\>
<usernameSuffix\>example.com</usernameSuffix\>
</EmployeeUserSettings\>

The following example of package.xml file retrieves the EmployeeUserSettings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<name\>Settings</name\>
<members\>EmployeeUser</members\>
</types\>
<version\>50.0</version\>
</Package\>

<!-- document id=2b08dc004809541fbc6205f6eaf7c0748b698c1ca5d4a45aaff5823679307e3a url=/legacydeveloper/current/en-us/api_meta/meta_enablementmeasuredefinition.md -->

# EnablementMeasureDefinition

Represents an Enablement measure, which specifies the job-related activity that a user performs to complete a milestone or outcome in an Enablement program. A measure identifies a source object and optional related objects, with optional field filters and filter logic, for tracking the activity. To avoid deployment errors, deploy measures before you deploy programs.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

EnablementMeasureDefinition components have the suffix .enablementMeasureDefinition and are stored in the enablementMeasureDefinitions folder.

## Version

EnablementMeasureDefinition components are available in API version 61.0 and later.

## Special Access Rules

To access Enablement measures, the Design and Deliver Enablement Programs permission is required. This permission is available with the Enablement add-on license.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

An internal description for the measure to help Enablement admins understand the activity that’s tracked.



 |
| developerName | 

Field Type

string

Description

Required. The unique programmatic name for the measure record.





 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for the measure, which is defined when the measure is created.





 |
| sourceMeasureObject | 

Field Type

[EnablementMeasureSourceObjectDefinition](#EnablementMeasureSourceObjectDefinition)

Description

Required. The source object that tracks the activity you're measuring.





 |
| status | 

Field Type

EnblProgramMeasureStatus (enumeration of type string)

Description

Required. Indicates whether the measure is published for use in Enablement programs.

Values are:

- Draft—The measure is saved, but not activated for use in programs.
- Published—The measure is activated for use in programs. In Lightning Experience, this value is Active.





 |

## EnablementMeasureSourceObjectDefinition

Defines the source object, fields, field values, and calculation method for the job-related activity you’re measuring.

| Field Name | Description |
| --- | --- |
| aggregateFieldApiName | 
Field Type

string

Description

The unique programmatic name for the field that the aggregateFunction uses for calculating.

For example, if you’re measuring how much revenue a sales rep has won, the value of aggregateFunction is Sum and the value of aggregateFieldApiName is Amount, which is the programmatic name of the Amount field on the Opportunity object.





 |
| aggregateFunction | 

Field Type

EnablementAggregationType (enumeration of type string)

Description

Required. The method for calculating progress towards the milestone or outcome from records that qualify for the measure’s criteria.

Values are:

- Average
- Count
- Sum

For example, if you’re measuring the number of deals won, the function is Count.

If the function is Average or Sum, aggregateFieldApiName is required.





 |
| dateFieldApiName | 

Field Type

string

Description

Required. The unique programmatic name for the field that defines when users get credit for the activity you’re measuring. For example, if you’re measuring the number of deals won, this value can be ClosedDate, the programmatic name of the Close Date field on the Opportunity object.





 |
| displayFieldApiName | 

Field Type

string

Description

Required. The unique programmatic name for the field that primarily identifies records that qualify for the activity you’re measuring. For example, if you’re measuring the number of deals won, you’re tracking the Opportunity object, and maybe you want to identify opportunities by their name. In this case, this field can be Name, the programmatic name of the Opportunity Name field on the Opportunity object.





 |
| filterLogic | 

Field Type

string

Description

An expression that determines how to evaluate the optional field filters for the object.



 |
| filters | 

Field Type

[EnablementMeasureFilterDefinition\[\]](#EnablementMeasureFilterDefinition)

Description

The fields on the object and corresponding field values that further specify criteria for the activity you’re measuring.



 |
| objectApiName | 

Field Type

string

Description

Required. The unique programmatic name for the source object that tracks the activity you’re measuring. For example, if you’re measuring the number of deals won, this value is Opportunity, the programmatic name of the Opportunity object.





 |
| relatedMeasureObjects | 

Field Type

[EnablementMeasureRelatedObjectDefinition\[\]](#EnablementMeasureRelatedObjectDefinition)

Description

The optional related objects that further specify criteria for the activity you’re measuring. Related objects can also specify additional filters.



 |
| userFieldApiName | 

Field Type

string

Description

Required. The unique programmatic name for the field that defines who gets credit for the activity you’re measuring. For example, if you’re measuring the number of deals won by a sales rep, this value can be OwnerId, the developer name of the Opportunity Owner field on the Opportunity object.





 |

## EnablementMeasureFilterDefinition

Represents the fields on the source object or related objects and the corresponding field values that further specify criteria for the activity you’re measuring.

| Field Name | Description |
| --- | --- |
| fieldApiName | 
Field Type

string

Description

Required. The unique programmatic name for the field that you’re filtering by. For example, if you’re tracking activity on the Opportunity object and want to filter by the Stage field, this value can be StageName.





 |
| fieldValue | 

Field Type

string

Description

Required. The field value to filter by. For example, if you’re tracking activity on the Opportunity object and want to filter by the Stage field, this value can be Closed Won.





 |
| operator | 

Field Type

EnablementFilterOperator (enumeration of type string)

Description

Required. The logic for evaluating the specified field and field value.

Values are:

- Contains
- DoesNotContain
- DoesNotEqual
- EndsWith
- Equals
- GreaterThan
- GreaterThanOrEqual
- In
- IsNull
- LessThan
- LessThanOrEqual
- NotIn
- StartsWith





 |
| sequenceNumber | 

Field Type

int

Description

Required. A number that specifies the order of the filter, relative to other filters, starting at 1.





 |

## EnablementMeasureRelatedObjectDefinition

Represents objects related to the source object. Related objects can further specify criteria for the activity you’re measuring. Related objects can also have additional filters. For example, maybe you’re measuring deals won for a specific product line. In this case, the source object is Opportunity, the related object is Opportunity Product, and the related object can have a filter for the specific product name.

| Field Name | Description |
| --- | --- |
| filterLogic | 
Field Type

string

Description

An expression that determines how to evaluate the optional field filters for the object.



 |
| filters | 

Field Type

[EnablementMeasureFilterDefinition\[\]](#EnablementMeasureFilterDefinition)

Description

The fields on the related object and the corresponding field values that further specify criteria for the activity you’re measuring.



 |
| idFieldApiName | 

Field Type

string

Description

Required. The programmatic name of the field that links the related object to the primary object. For example, if the primary object is Opportunity and the related object is Opportunity Product, this value is OpportunityId, the developer name of the Opportunity field on the Opportunity Product object.





 |
| objectApiName | 

Field Type

string

Description

Required. The unique programmatic name for the related object. For example, if the related object is Opportunity Product, this value is OpportunityLineItem.





 |

## Declarative Metadata Sample Definition

The following is an example of an EnablementMeasureDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<EnablementMeasureDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Total amount in pipeline measure</description\>
    <developerName\>TotalAmountInPipeline</developerName\>
    <masterLabel\>Total Amount in Pipeline</masterLabel\>
    <status\>Draft</status\>
    <sourceMeasureObject\>
        <aggregateFieldApiName\>Amount</aggregateFieldApiName\>
        <aggregateFunction\>Sum</aggregateFunction\>
        <dateFieldApiName\>CreatedDate</dateFieldApiName\>
        <displayFieldApiName\>Name</displayFieldApiName\>
        <objectApiName\>Opportunity</objectApiName\>
        <userFieldApiName\>OwnerId</userFieldApiName\>
        <filters\>
            <fieldApiName\>StageName</fieldApiName\>
            <fieldValue\>Closed Won</fieldValue\>
            <operator\>Equals</operator\>
            <sequenceNumber\>1</sequenceNumber\>
        </filters\>
        <relatedMeasureObjects\>
            <objectApiName\>OpportunityLineItem</objectApiName\>
            <idFieldApiName\>OpportunityId</idFieldApiName\>
            <filterLogic\>1 OR 2</filterLogic\>
            <filters\>
                <fieldApiName\>UnitPrice</fieldApiName\>
                <fieldValue\>10000</fieldValue\>
                <operator\>GreaterThan</operator\>
                <sequenceNumber\>1</sequenceNumber\>
            </filters\>
            <filters\>
                <fieldApiName\>TotalPrice</fieldApiName\>
                <fieldValue\>10000</fieldValue\>
                <operator\>GreaterThan</operator\>
                <sequenceNumber\>2</sequenceNumber\>
            </filters\>
        </relatedMeasureObjects\>
    </sourceMeasureObject\>
</EnablementMeasureDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>TotalAmountInPipeline</members\>
        <name\>EnablementMeasureDefinition</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=419b36d4ac46621bb79601c618a9b79aea2827e83bc9877cbee7d40d0b5b9734 url=/legacydeveloper/current/en-us/api_meta/meta_enablementprogramdefinition.md -->

# EnablementProgramDefinition

Represents an Enablement program, which includes exercises and measurable milestones to help users such as sales reps achieve specific outcomes related to your company’s revenue goals.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

EnablementProgramDefinition components have the suffix .enablementProgramDefinition and are stored in the enablementProgramDefinitions folder.

## Version

EnablementProgramDefinition components are available in API version 61.0 and later.

## Special Access Rules

To access Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is available with the Enablement add-on license.

For partner programs in supported Experience Cloud sites, a [supported Partner Relationship Management (PRM) add-on license](https://help.salesforce.com/s/articleView?id=slack.prm_support_license_template.htm&type=5&language=en_US "HTML (New Window)") is also required.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Required. A summary of the program’s goals and content that’s visible to users.





 |
| developerName | 

Field Type

string

Description

Required. The unique programmatic name for the program record.





 |
| doesAllowSelfEnrollment | 

Field Type

boolean

Description

Indicates whether users can self-enroll in programs that are shared with them (true) or take only assigned programs (false). The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for the program, which is defined when the program is created.





 |
| name | 

Field Type

string

Description

Required. The name of the program that’s visible to users.





 |
| network | 

Field Type

string

Description

The Experience Cloud site where a program is published for partner users.



 |
| sections | 

Field Type

[EnablementProgramSection\[\]](#EnablementProgramSection)

Description

Groups of milestones and exercises within a program.



 |
| tasks | 

Field Type

[EnablementProgramTask\[\]](#EnablementProgramTask)

Description

The outcome, milestones, and exercises in the program.



 |
| type | 

Field Type

string

Description

Required. Indicates whether the program is for sales users in Lightning Experience (Enablement) or partner users in supported Experience Cloud sites (PtnrEnablement).





 |

## EnablementProgramSection

Represents a logical, trackable group of milestones and exercises within an Enablement program. When users take programs, they can expand or collapse sections.

| Field Name | Description |
| --- | --- |
| developerName | 
Field Type

string

Description

Required. The unique programmatic name for the section.





 |
| name | 

Field Type

string

Description

Required. The title of the section that’s visible to users when they take the program.



 |
| sequenceNumber | 

Field Type

int

Description

Required. A number that specifies the order of the section, relative to other sections, starting at 0.





 |
| tasks | 

Field Type

[EnablementProgramTask\[\]](#EnablementProgramTask)

Description

The milestones and exercises in the section.



 |

## EnablementProgramTask

Represents an outcome, milestone, or exercise in an Enablement program. A program task is also known as a program item.

| Field Name | Description |
| --- | --- |
| customSubCategoryName | 
Field Type

string

Description

The API name of custom exercise task subcategory. This value determines the type of the custom exercise and its associated content. Available in API version 63.0 and later.





 |
| day | 

Field Type

int

Description

Required. The day of the program when the item is due, relative to the program's start date. For example, if a user is expected to complete an exercise where they watch a product demo by day 2, this field’s value is 2. For an outcome, this field specifies the number of days the full program takes. For example, if your program lasts 60 days, the value of this field is 60 for the outcome. This field’s value contributes to the program’s due date that users see when they take the program.





 |
| description | 

Field Type

string

Description

Required. A summary of the outcome, milestone, or exercise that’s visible to users when they take the program.





 |
| developerName | 

Field Type

string

Description

Required. The unique programmatic name for the outcome, milestone, or exercise.





 |
| exercise | 

Field Type

[EnablementProgramTaskExercise](#EnablementProgramTaskExercise)

Description

The content used with an exercise.

If taskSubCategory is ActionItem, this field isn’t included when retrieving metadata.





 |
| milestone | 

Field Type

[EnablementProgramTaskMilestone](#EnablementProgramTaskMilestone)

Description

The definition of an outcome or milestone, including the Enablement measures used and the criteria for completing the goal.



 |
| name | 

Field Type

string

Description

Required. The title of the outcome, milestone, or exercise that’s visible to users when they take the program.





 |
| sequenceNumber | 

Field Type

int

Description

Required. A number that specifies the order of the milestone or exercise, relative to other milestones or exercises that have the same due date in the program or in the same section, starting at 0. This number determines the order of items that users see for that day in the program.





 |
| taskCategory | 

Field Type

ProgramTaskDefCategory (enumeration of type string)

Description

Required. The type of the program item.

Values are:

- Exercise
- Milestone

Milestone is used for both the program’s outcome and incremental milestones.





 |
| taskSubCategory | 

Field Type

string

Description

Required. The type of exercise. This value determines the content associated with the exercise. For example, if the field value is Video, the exercise must reference video content from the Enablement workspace in the Digital Experiences app. Possible values are:

- ActionItem
- AudioRecording
- CustomExercise—Available in API version 62.0 and later.
- Document
- FeedbackRequest
- Other
- OtherExercise
- ScheduledEvent
- TextLesson
- Trailhead
- Video

When taskCategory is Milestone, the value of taskSubCategory must be Other.





 |

## EnablementProgramTaskExercise

Represents the content used with an exercise in an Enablement program.

| Field Name | Description |
| --- | --- |
| cmsContent | 
Field Type

[EnablementProgramTaskCmsContent](#EnablementProgramTaskCmsContent)

Description

The definition of content managed in the Enablement workspace in the Digital Experiences app when taskSubCategory on EnablementProgramTask is AudioRecording, Document, OtherExercise, ScheduledEvent, TextLesson, or Video.





 |
| customContent | 

Field Type

[EnablementProgramTaskCustomContent](#EnablementProgramTaskCustomContent)

Description

The definition of content used with a custom exercise type when taskSubCategory on EnablementProgramTask is CustomExercise.





 |
| externalContent | 

Field Type

[EnablementProgramTaskExternalContent](#EnablementProgramTaskExternalContent)

Description

The definition of Trailhead content when taskSubCategory on EnablementProgramTask is Trailhead.



 |
| feedbackContent | 

Field Type

[EnablementProgramTaskFeedbackContent](#EnablementProgramTaskFeedbackContent)

Description

The definition of an assessment survey or Einstein prompt template when taskSubCategory on EnablementProgramTask is FeedbackRequest.



 |

## EnablementProgramTaskCmsContent

Defines content managed in the Enablement workspace in the Digital Experiences app for the Audio Recording, Document, Other, Scheduled Event, Text Lesson, or Video exercise types.

| Field Name | Description |
| --- | --- |
| apiName | 
Field Type

string

Description

Required in API version 62.0. The unique programmatic ID of the Digital Experiences content for the exercise. This string’s format is workspaceType/workspaceApiName.contentFQN/contentApiName, which matches the fullName field value on the corresponding DigitalExperience metadata type.

For example, a Link content record from the Enablement workspace has this API name: enablement/sfdcEnablement\_EnablementWorkspace.sfdc\_enablement\_\_link/link\_API\_name.





 |
| contentKey | 

Field Type

string

Description

Required in API version 61.0 only.





 |

## EnablementProgramTaskCustomContent

Defines content used with a custom exercise type.

| Field Name | Description |
| --- | --- |
| content | 
Field Type

string

Description

A serialized string returned by the Apex class that’s specified in the corresponding [LearningItemType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_learningitemtype.htm "Represents a custom exercise type that an Enablement user takes in an Enablement program in the Guidance Center. A custom exercise type also requires a corresponding LearningItem record for the Guidance Center and corresponding EnblProgramTaskDefinition and EnblProgramTaskSubCategory records for when admins create a program in Program Builder.") metadata type’s apexSerializerDeserializer field. This string identifies the content used with the custom exercise type so the custom exercise can be recreated in the destination org. This string:

- Can’t exceed 250 characters
- Must contain only alphanumeric characters

For details, see [Implement Custom Exercise Types for Enablement Programs](https://developer.salesforce.com/docs/sales/enablement/guide/enablement-custom-exercises-intro.html "HTML (New Window)") in the _Sales Programs and Partner Tracks with Enablement Developer Guide_.





 |

## EnablementProgramTaskExternalContent

Defines Trailhead content for the Trailhead exercise type.

| Field Name | Description |
| --- | --- |
| externalId | 
Field Type

string

Description

Required. The API name of the Trailhead module used with the exercise.





 |
| providerType | 

Field Type

ProgramExtContentDefProvider (enumeration of type string)

Description

Required. The supported external content platform or system.

Values are:

- Trailhead





 |

## EnablementProgramTaskFeedbackContent

Defines the assessment survey or Einstein prompt template for the Feedback Request exercise type.

| Field Name | Description |
| --- | --- |
| inviteeCount | 
Field Type

int

Description

The number of peers or managers that the user is required to invite for giving feedback when type is PeerFeedback. Each peer or manager receives an invitation to the assessment survey associated with the Feedback Request exercise.

When type is AIFeedback, this value is always 1.





 |
| promptTemplate | 

Field Type

string

Description

The prompt template to use with this exercise when type is AIFeedback.



 |
| surveyDeveloperName | 

Field Type

string

Description

The unique programmatic name for the assessment survey that’s sent to peers and managers when type is PeerFeedback.



 |
| type | 

Field Type

string

Description

Required. The type of feedback used with the exercise.

Values are:

- AIFeedback—Users submit a video call, and Einstein generates feedback from the call’s transcription. With this type, promptTemplate is required.
- PeerFeedback—Users submit a URL to a sample of their work, and select peers and managers to review their work. Selected peers and managers complete an assessment survey. With this type, surveyId is required.





 |

## EnablementProgramTaskMilestone

Defines the requirements for an outcome or milestone, including the Enablement measures used for tracking activity and the criteria for completing the outcome or milestone.

| Field Name | Description |
| --- | --- |
| compositeMilestoneType | 
Field Type

EnblCompositeMilestoneType (enumeration of type string)

Description

The type of logic to use for evaluating the activity from two Enablement measures in a composite milestone.

Values are:

- Addition
- Division
- Percentage





 |
| isMilestoneAnOutcome | 

Field Type

boolean

Description

Required. Indicates whether the program item is the program’s outcome (true) or an incremental milestone (false).





 |
| milestoneMeasures | 

Field Type

[EnablementProgramTaskMilestoneMeasure\[\]](#EnablementProgramTaskMilestoneMeasure)

Description

The Enablement measures used with the outcome or milestone.



 |
| milestoneTarget | 

Field Type

double

Description

The target value for a user to achieve to get credit for completing the outcome or milestone. The unit depends on the specific measure used with the outcome or milestone. For example, if the measure is the dollar amount of all closed opportunities, then the field value is measured in dollars.



 |
| minimumSampleSize | 

Field Type

int

Description

The number of records to evaluate when calculating progress for an outcome or milestone that uses an average-based measure. Use this field with milestoneTarget. For example, if you want users to achieve an average deal size of $50,000 after closing 4 deals, then this field’s value is 4 and milestoneTarget is 50000.



 |

## EnablementProgramTaskMilestoneMeasure

Defines the Enablement measure used with an outcome or milestone.

| Field Name | Description |
| --- | --- |
| measureDefinitionDeveloperName | 
Field Type

string

Description

The unique programmatic name of the Enablement measure used with the outcome or milestone.



 |
| sequenceNumber | 

Field Type

int

Description

A number that specifies the order of the Enablement measure when multiple measures are used with one outcome or milestone, starting at 0. For example, in a composite milestone that uses the Percentage function, the measure that provides the numerator value is sequence 0 and the measure that provides the denominator value is sequence 1.



 |

## Declarative Metadata Sample Definition

The following is an example of an EnablementProgramDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<EnablementProgramDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Get started with sales at Cloud Kicks and close your first deal!</description\>
    <developerName\>Get\_Started\_Close\_First\_Deal\_Program</developerName\>
    <doesAllowSelfEnrollment\>false</doesAllowSelfEnrollment\>
    <masterLabel\>Welcome to Sales at Cloud Kicks</masterLabel\>
    <name\>Welcome to Sales at Cloud Kicks</name\>
    <sections\>
        <developerName\>section\_0</developerName\>
        <name\>Learn the Ropes in Your First Week</name\>
        <sequenceNumber\>0</sequenceNumber\>
        <tasks\>
            <day\>1</day\>
            <description\>Learn the basics of sales at Cloud Kicks.</description\>
            <developerName\>task\_0</developerName\>
            <exercise\>
                <externalContent\>
                    <externalId\>sales-rep-training</externalId\>
                    <providerType\>Trailhead</providerType\>
                </externalContent\>
            </exercise\>
            <name\>Sales Rep Training</name\>
            <sequenceNumber\>0</sequenceNumber\>
            <taskCategory\>Exercise</taskCategory\>
            <taskSubCategory\>Trailhead</taskSubCategory\>
        </tasks\>
        <tasks\>
            <day\>2</day\>
            <description\>Watch our CEO explain the company vision.</description\>
            <developerName\>task\_1</developerName\>
            <exercise\>
                <cmsContent\>
                    <apiName\>enablement/sfdcEnablement\_EnablementWorkspace.sfdc\_enablement\_\_link/company\_vision\_video</apiName\>
                </cmsContent\>
            </exercise\>
            <name\>See Our Company Vision</name\>
            <sequenceNumber\>1</sequenceNumber\>
            <taskCategory\>Exercise</taskCategory\>
            <taskSubCategory\>Video</taskSubCategory\>
        </tasks\>
        <tasks\>
            <day\>3</day\>
            <description\>Action Item</description\>
            <developerName\>task\_2</developerName\>
            <name\>Action Item</name\>
            <sequenceNumber\>2</sequenceNumber\>
            <taskCategory\>Exercise</taskCategory\>
            <taskSubCategory\>ActionItem</taskSubCategory\>
        </tasks\>
        <tasks\>
            <day\>4</day\>
            <description\>Try out your first sales patch at Cloud Kicks and get feedback from our in-house experts.</description\>
            <developerName\>task\_3</developerName\>
            <exercise\>
                <feedbackContent\>
                <inviteeCount\>1</inviteeCount\>
                <surveyDeveloperName\>discovery\_call\_assessment</surveyDeveloperName\>
            </feedbackContent\>
            </exercise\>
            <name\>Feedback from Peers and Managers</name\>
            <sequenceNumber\>3</sequenceNumber\>
            <taskCategory\>Exercise</taskCategory\>
            <taskSubCategory\>FeedbackRequest</taskSubCategory\>
        </tasks\>
        <tasks\>
            <day\>5</day\>
            <description\>Complete a discovery calls by day 5.</description\>
            <developerName\>task\_4</developerName\>
            <isMilestoneAnOutcome\>false</isMilestoneAnOutcome\>
            <milestone\>
                <milestoneMeasures\>
                    <measureDefinitionDeveloperName\>salesforceTemplate\_CallsEmails</measureDefinitionDeveloperName\>
                </milestoneMeasures\>
                <milestoneTarget\>1.0</milestoneTarget\>
            </milestone\>
            <name\>Log a Discovery Call by Day 5</name\>
            <sequenceNumber\>4</sequenceNumber\>
            <taskCategory\>Milestone</taskCategory\>
            <taskSubCategory\>Other</taskSubCategory\>
        </tasks\>
        <tasks\>
            <day\>6</day\>
            <description\>Browse our sales leaders blog for more insights.</description\>
            <developerName\>task\_5</developerName\>
            <exercise\>
                <cmsContent\>
                    <apiName\>enablement/sfdcEnablement\_EnablementWorkspace.sfdc\_enablement\_\_link/sales\_blog</apiName\>
                </cmsContent\>
            </exercise\>
            <name\>Review Tips from Sales Leaders</name\>
            <sequenceNumber\>5</sequenceNumber\>
            <taskCategory\>Exercise</taskCategory\>
            <taskSubCategory\>OtherExercise</taskSubCategory\>
        </tasks\>
        <tasks\>
            <day\>7</day\>
            <description\>Follow a screen flow for onboarding to the sales team.</description\>
            <developerName\>task\_6</developerName\>
            <exercise\>
                <customContent\>
                    <content>flowDeveloperName=OnboardingFlow</content\>
                </customContent\>
            </exercise\>
            <name\>Onboarding Flow</name\>
            <sequenceNumber\>6</sequenceNumber\>
            <taskCategory\>Exercise</taskCategory\>
            <taskSubCategory\>CustomExercise</taskSubCategory\>
            <customSubCategoryName\>ScreenFlowTaskSubCategory</customSubCategoryName\>
        </tasks\>
    </sections\>
    <tasks\>
        <day\>30</day\>
        <description\>Close your first opportunity. To make sure it's counted, set the opportunity Stage field to Closed Won.</description\>
        <developerName\>task\_enablementProgramOutcomeCard</developerName\>
        <isMilestoneAnOutcome\>true</isMilestoneAnOutcome\>
        <milestone\>
            <milestoneMeasures\>
                <measureDefinitionDeveloperName\>measure\_CloseFirstDeal</measureDefinitionDeveloperName\>
            </milestoneMeasures\>
            <milestoneTarget\>1.0</milestoneTarget\>
        </milestone\>
        <name\>outcome</name\>
        <sequenceNumber\>0</sequenceNumber\>
        <taskCategory\>Milestone</taskCategory\>
        <taskSubCategory\>Other</taskSubCategory\>
    </tasks\>        
    <type\>Enablement</type\>
</EnablementProgramDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Get\_Started\_Close\_First\_Deal\_Program</members\>
        <name\>EnablementProgramDefinition</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=a2079e541441cad2b7ac2d33d8709e1fd0e51b0dbfd24a64ae4f59229af68eee url=/legacydeveloper/current/en-us/api_meta/meta_enblprogramtasksubcategory.md -->

# EnblProgramTaskSubCategory

Represents a custom exercise type that an Enablement admin adds to an Enablement program in Program Builder. A custom exercise type also requires a corresponding EnblProgramTaskDefinition record for Program Builder and corresponding LearningItem and LearningItemType records for when users take the exercise in the Guidance Center.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

EnblProgramTaskSubCategory components have the suffix .enblProgramTaskSubCategory and are stored in the enblProgramTaskSubCategories folder.

## Version

EnblProgramTaskSubCategory components are available in API version 62.0 and later.

## Special Access Rules

- For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license.
- For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Custom exercises aren’t compatible with Partner Enablement programs.

## Fields

| Field Name | Description |
| --- | --- |
| developerName | 
Field Type

string

Description

Required. The unique programmatic name for the EnblProgramTaskSubCategory record.





 |
| icon | 

Field Type

string

Description

Required. The icon to use for the custom exercise type in Program Builder.

Use the format iconType:iconName, where the values correspond to icon categories and names from the [Salesforce Lightning Design System](https://www.lightningdesignsystem.com/icons/ "HTML (New Window)").

- iconType is the type of icon, such as standard or doctype.
- iconName is the icon name, such as flow or slide.

For example, to use the Standard type Flow icon, this value is standard:flow. For details, see [Implement Custom Exercise Types for Enablement Programs](https://developer.salesforce.com/docs/sales/enablement/guide/enablement-custom-exercises-intro.html "HTML (New Window)") in the _Sales Programs and Partner Tracks with Enablement Developer Guide_.





 |
| learningItemType | 

Field Type

string

Description

Required. The programmatic name of the [LearningItemType](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_learningitemtype.htm "HTML (New Window)") record that represents this custom exercise type in the Guidance Center when users take a program.





 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for the EnblProgramTaskSubCategory, which is defined when it’s created.





 |

## Declarative Metadata Sample Definition

The following is an example of an EnblProgramTaskSubCategory component for a custom exercise type that shows a screen flow.

<?xml version="1.0" encoding="UTF-8"?>
<EnblProgramTaskSubCategory xmlns="http://soap.sforce.com/2006/04/metadata">
    <developerName\>ScreenFlowTaskSubCategory</developerName\>
    <icon\>standard:flow</icon\>
    <learningItemType\>ScreenFlowLearningItemType</learningItemType\>
    <masterLabel\>Screen Flow Exercise</masterLabel\>
</EnblProgramTaskSubCategory\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ScreenFlowTaskSubCategory</members\>
        <name\>EnblProgramTaskSubCategory</name\>
    </types\>
    <version\>62.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=121609f9816ac34ab7d1642cb2186ca6c2f5e9084f4c1c93bc7006e729decb51 url=/legacydeveloper/current/en-us/api_meta/meta_encryptionkeysettings.md -->

# EncryptionKeySettings

Represents an org’s encryption key settings, such as customer-supplied keys options and key derivation settings. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

EncryptionKeySettings values are stored in the EncryptionKey.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

EncryptionKeySettings is available in API versions 47.0 and later.

## Special Access Rules

To enable EncryptionKeySettings, you need the Customize Application and Manage Encryption Keys permissions.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| canEncryptTransactionalDatabase | boolean | Indicates whether users can encrypt the transactional database (true) or can’t (false). The default value is false. If set to true, transactional database encryption is enabled and a transactional database tenant secret is generated. Available in API version 63.0 and later. |
| canExternalKeyManagement | boolean | Indicates whether External Key Management is available (true) or not (false). The default value is false. If set to true, users can configure connections to external key stores and use keys saved in those key stores to encrypt and decrypt Salesforce data. Available in API version 63.0 and later. |
| canManageDataCloudKeys | boolean | Indicates whether key management for Data 360 is enabled and an initial customer-managed root key is present (true) or not (false). Available in API version 63.0 and later. |
| canOptOutOfDerivationWithBYOK | boolean | Indicates that users can opt out of key derivation processes on a key-by-key basis when they upload key material (true) or can’t (false). The default value is false. |
| enableCacheOnlyKeys | boolean | Indicates whether the Cache-Only Key Service is available (true) or not (false). The default value is false. If set to true, users can configure a cache-only key callout connection and apply key material stored outside of Salesforce to data on demand. |
| enableReplayDetection | boolean | Indicates whether cache-only key callouts are protected from replay attacks by a nonce (true) or not (false). Requires enableCacheOnlyKeys=”true” before setting enableReplayDetection to true. |

## Declarative Metadata Sample Definition

The following is an example of the EncryptionKey.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<EncryptionKeySettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <canEncryptTransactionalDatabase\>true</canEncryptTransactionalDatabase\>
    <canManageDataCloudKeys\>true</canManageDataCloudKeys\>
    <enableExternalKeyManagement\>true</enableExternalKeyManagement\>
</EncryptionKeySettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the encryption key settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>EncryptionKey</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=75800a628f1f189de3a92dc3fffe05989cd3e17232b013218ced9c67f99a63ad url=/legacydeveloper/current/en-us/api_meta/meta_enhancednotessettings.md -->

# EnhancedNotesSettings

Represents an org’s enhanced note settings, such as enabling enhanced notes and enabling tasks in enhanced notes.This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

EnhancedNotesSettings values are stored in the EnhancedNotes.settings file in the settings directory.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## Version

EnhancedNotesSettings is available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">

          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d435328e90">Field Name</th>

              <th class="featureTableHeader  " id="d435328e93">Field Type</th>

              <th class="featureTableHeader  " id="d435328e96">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d435328e90" data-title="Field Name"><span class="keyword parmname">enableEnhancedNotes</span></td>

              <td class="entry" headers="d435328e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d435328e96" data-title="Description">Indicates whether enhanced notes are enabled <samp class="codeph nolang">(true)</samp> or
                not <samp class="codeph nolang">(false)</samp>. With enhanced notes, users can
                relate a note to multiple records, access version history, and enjoy enhanced format
                options. Users must have the Use New Notes permission to use enhanced
                notes.<p class="p">Default value is <samp class="codeph nolang">true</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d435328e90" data-title="Field Name"><span class="keyword parmname">enableTasksOnEnhancedNotes</span></td>

              <td class="entry" headers="d435328e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d435328e96" data-title="Description">Indicates whether users can create tasks from notes <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. In the
                Salesforce app, users can create a task from a note by swiping a line on the note.
                Alternatively, they can tap in the toolbar to add or update the status of an action
                item. Users must have the Use New Notes permission to use enhanced notes.<p class="p">Default
                  value is <samp class="codeph nolang">true</samp>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the EnhancedNotesSettings.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<EnhancedNotesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableEnhancedNotes\>true</enableEnhancedNotes\>
	<enableTasksOnEnhancedNotes\>true</enableTasksOnEnhancedNotes\>
</EnhancedNotesSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the EnhancedNotesSettings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>EnhancedNotes</members\>
		<name\>Settings</name\>
	</types\>
	<version\>47.0</version\>
</Package\>

<!-- document id=87578a8f8edc708d915603803c7ea7321ddf4158cb38113b53ac35ad68836551 url=/legacydeveloper/current/en-us/api_meta/meta_entitlementprocess.md -->

# EntitlementProcess

Represents the settings for an entitlement process.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

Entitlement process values are stored in files in the entitlementProcesses directory. Each file has the name of a process and the suffix .entitlementProcess. Each file contains one entitlement process or, if entitlement versioning is enabled, one version of an entitlement process.

The name of the file is the name of the entitlement process with the version appended to the end, if applicable (for example, an entitlement process named “gold\_support” can have the file name “gold\_support\_v2.entitlementProcess”). This file name corresponds to the slaProcess.NameNorm field exposed through SOAP API. This file name is distinct from the name field, which represents what displays in the user interface and, if versioning is enabled, can be shared among multiple versions of the same entitlement process. The slaProcess.NameNorm field contains the lowercase version of the name field shown in the user interface.

## Version

Entitlement processes are available in API version 27.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d435695e113">Field Name</th>

              <th class="featureTableHeader  " id="d435695e116">Field Type</th>

              <th class="featureTableHeader  " id="d435695e119">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d435695e119" data-title="Description">Indicates whether the entitlement process is active (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname" id="EntitlementProcess_businessHours_field"><a name="EntitlementProcess_businessHours_field"><!-- --></a>businessHours</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e119" data-title="Description">
                <span class="ph" id="EntitlementProcess_businessHours_desc"><a name="EntitlementProcess_businessHours_desc"><!-- --></a>The business hours
                  that apply to the entitlement process.</span>
                <p class="p">This field is
                  available in API version 30.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e119" data-title="Description">The description of the entitlement process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname">entryStartDateField</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e119" data-title="Description">For milestone processes on which a case enters the process based
                on a custom date/time field on the case, specifies which date and
                time are used. Valid values are: <ul class="ul bulletList">
                  <li class="li">SlaStartDate (entitlement process start date)</li>

                  <li class="li">CreatedDate (date case was opened)</li>

                  <li class="li">ClosedDate (date case was closed)</li>

                  <li class="li">LastModifiedDate (date case was last modified)</li>

                  <li class="li">StopStartDate (date case was stopped)</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname">exitCriteriaBooleanFilter</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e119" data-title="Description">For milestone processes on which a case exits the process when
                custom criteria are met, and for which filter logic is added,
                specifies that logic.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname">exitCriteriaFilterItems</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a>[]
              </td>

              <td class="entry" headers="d435695e119" data-title="Description">For milestone processes on which a case exits the process when
                custom criteria are met, specifies those criteria.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname">exitCriteriaFormula</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e119" data-title="Description">For milestone processes on which a case exits the process when a
                custom formula evaluates to true, specifies that formula.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname" id="is_version_default_name"><a name="is_version_default_name"><!-- --></a>isVersionDefault</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d435695e119" data-title="Description">Indicates whether the entitlement process is the default version
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">This field is available
                  in API version 28.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname">milestones</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">
                <a class="xref" href="#EntitlementProcessMilestoneItem">EntitlementProcessMilestoneItem</a>[]
              </td>

              <td class="entry" headers="d435695e119" data-title="Description">Represents a milestone on the entitlement process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e119" data-title="Description">The name of the entitlement process as it displays in the user
                interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname">SObjectType</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e119" data-title="Description">Indicates the type of record that the entitlement process can run
                on.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname" id="version_master_name"><a name="version_master_name"><!-- --></a>versionMaster</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e119" data-title="Description">Identifies the sequence of versions to which this entitlement
                process belongs. This field’s contents can be any value as
                long as it’s identical among all versions of the entitlement
                process.<p class="p">This field is available in API version 28.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname" id="version_notes_name"><a name="version_notes_name"><!-- --></a>versionNotes</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e119" data-title="Description">The description of the entitlement process version.<p class="p">This field
                  is available in API version 28.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e113" data-title="Field Name"><span class="keyword parmname" id="version_number_name"><a name="version_number_name"><!-- --></a>versionNumber</span></td>

              <td class="entry" headers="d435695e116" data-title="Field Type">int</td>

              <td class="entry" headers="d435695e119" data-title="Description">The version number of the entitlement process. Must be 1 or
                greater.<p class="p">This field is available in API version 28.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## EntitlementProcessMilestoneItem

Represents a milestone item on an entitlement process.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d435695e393">Field Name</th>

              <th class="featureTableHeader  " id="d435695e396">Field Type</th>

              <th class="featureTableHeader  " id="d435695e399">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname" id="EntitlementProcessMilestoneItem_businessHours_field"><a name="EntitlementProcessMilestoneItem_businessHours_field"><!-- --></a>businessHours</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e399" data-title="Description">
                <span class="ph" id="EntitlementProcessMilestoneItem_businessHours_desc"><a name="EntitlementProcessMilestoneItem_businessHours_desc"><!-- --></a>The
                  business hours that apply to the milestone.</span>
                <p class="p">This field is
                  available in API version 30.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname">criteriaBooleanFilter</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e399" data-title="Description">For milestones that apply only when criteria are met and for
                which filter logic is added, specifies that logic.</td>

            </tr>


            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname">milestoneCompletionCriteria</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e399" data-title="Description">
                <p class="p">The criteria to be met for the milestone to be marked
                  complete.</p>

              </td>

            </tr>


            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname">milestoneCriteriaFilterItems</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a>[]
              </td>

              <td class="entry" headers="d435695e399" data-title="Description">For milestones that apply only when criteria are met, specifies
                those criteria.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname">milestoneCriteriaFormula</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e399" data-title="Description">For milestones that apply only when a formula evaluates to true,
                specifies that formula.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname">milestoneName</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e399" data-title="Description">The name of the milestone.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="ph" id="EntitlementProcessMilestoneItem_minutesCustomClass_field"><a name="EntitlementProcessMilestoneItem_minutesCustomClass_field"><!-- --></a><span class="keyword parmname">minutesCustomClass</span></span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">string</td>

              <td class="entry" headers="d435695e399" data-title="Description">
                <span class="ph" id="minutesCustomClass_desc"><a name="minutesCustomClass_desc"><!-- --></a>The name of the Apex class that
                  is&nbsp;used to calculate the trigger time.</span> This field is
                available in API version 30.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname">minutesToComplete</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">int</td>

              <td class="entry" headers="d435695e399" data-title="Description">The number of minutes from when the case enters the entitlement
                process that the milestone occurs.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname">successActions</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_workflow.htm#WorkflowActionReference">WorkflowActionReference</a>[]
              </td>

              <td class="entry" headers="d435695e399" data-title="Description">The actions triggered when the milestone is completed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname">timeTriggers</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">
                <a class="xref" href="#EntitlementProcessMilestoneTimeTrigger">EntitlementProcessMilestoneTimeTrigger</a>[]
              </td>

              <td class="entry" headers="d435695e399" data-title="Description">The time triggers on an entitlement process milestone.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e393" data-title="Field Name"><span class="keyword parmname">useCriteriaStartTime</span></td>

              <td class="entry" headers="d435695e396" data-title="Field Type">boolean</td>

              <td class="entry" headers="d435695e399" data-title="Description">When the milestone starts: when the milestone criteria are met
                (true) or when the case enters the entitlement process
                (false).</td>

            </tr>

          </tbody>

        </table>

## EntitlementProcessMilestoneTimeTrigger

Represents the time trigger on an entitlement process milestone.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d435695e604">Field Name</th>

              <th class="featureTableHeader  " id="d435695e607">Field Type</th>

              <th class="featureTableHeader  " id="d435695e610">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d435695e604" data-title="Field Name"><span class="keyword parmname">actions</span></td>

              <td class="entry" headers="d435695e607" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_workflow.htm#WorkflowActionReference">WorkflowActionReference</a>[]
              </td>

              <td class="entry" headers="d435695e610" data-title="Description">The actions to take when the time trigger is reached, if, at that
                time, the milestone isn’t completed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e604" data-title="Field Name"><span class="keyword parmname">timeLength</span></td>

              <td class="entry" headers="d435695e607" data-title="Field Type">int</td>

              <td class="entry" headers="d435695e610" data-title="Description">The length of time between the time trigger activation and the
                milestone target completion date. This length of time can be a
                negative or positive value. Negative values indicate that the target
                completion date hasn’t yet arrived and correspond to warning time
                triggers. Positive values indicate that the target completion date
                has passed and correspond to violation time triggers. </td>

            </tr>

            <tr>
              <td class="entry" headers="d435695e604" data-title="Field Name"><span class="keyword parmname">workflowTimeTriggerUnit</span></td>

              <td class="entry" headers="d435695e607" data-title="Field Type">MilestoneTimeUnits (enumeration of type string)</td>

              <td class="entry" headers="d435695e610" data-title="Description">Specifies the type of unit used to determine when a workflow is
                triggered. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Minutes</samp></li>

                  <li class="li"><samp class="codeph nolang">Hours</samp></li>

                  <li class="li"><samp class="codeph nolang">Days</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s a sample entitlement process.

<?xml version="1.0" encoding="UTF-8"?>
<EntitlementProcess xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <description\>eppersone</description\>
    <entryStartDateField\>SlaStartDate</entryStartDateField\>
    <exitCriteriaBooleanFilter\>1 OR 2</exitCriteriaBooleanFilter\>
    <exitCriteriaFilterItems\>
        <field\>Case.IsClosed</field\>
        <operation\>equals</operation\>
        <value\>true</value\>
    </exitCriteriaFilterItems\>
    <exitCriteriaFilterItems\>
        <field\>Case.Description</field\>
        <operation\>startsWith</operation\>
        <value\>foo</value\>
    </exitCriteriaFilterItems\>
    <milestones\>
        <milestoneName\>m1</milestoneName\>
        <minutesToComplete\>1</minutesToComplete\>
        <successActions\>
            <name\>emailBob</name\>
            <type\>Alert</type\>
        </successActions\>
        <timeTriggers\>
            <actions\>
                <name\>emailAlice</name\>
                <type\>Alert</type\>
            </actions\>
            <actions\>
                <name\>setEscalateToTrue</name\>
                <type\>FieldUpdate</type\>
            </actions\>
            <timeLength\>1</timeLength\>
            <workflowTimeTriggerUnit\>Minutes</workflowTimeTriggerUnit\>
        </timeTriggers\>
        <timeTriggers\>
            <actions\>
                <name\>setStopToTrue</name\>
                <type\>FieldUpdate</type\>
            </actions\>
            <timeLength\>2</timeLength\>
            <workflowTimeTriggerUnit\>Minutes</workflowTimeTriggerUnit\>
        </timeTriggers\>
        <useCriteriaStartTime\>false</useCriteriaStartTime\>
    </milestones\>
    <milestones\>
        <milestoneCriteriaFilterItems\>
            <field\>Case.Priority</field\>
            <operation\>equals</operation\>
            <value\>High</value\>
        </milestoneCriteriaFilterItems\>
        <milestoneName\>m2</milestoneName\>
        <minutesToComplete\>120</minutesToComplete\>
        <useCriteriaStartTime\>true</useCriteriaStartTime\>
        <successActions\>
            <name\>emailBob</name\>
            <type\>Alert</type\>
        </successActions\>
    </milestones\>
</EntitlementProcess\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=5fb7c11458ddb05a78de0bcf59e0593a2d80ba5d8c1fe83b4e9864f1998705b0 url=/legacydeveloper/current/en-us/api_meta/meta_entitlementsettings.md -->

# EntitlementSettings

Represents an organization’s entitlement settings.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

EntitlementSettings values are stored in the Entitlements.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

EntitlementSettings is available in API version 27.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d437965e98">Field Name</th>

              <th class="featureTableHeader  " id="d437965e101">Field Type</th>

              <th class="featureTableHeader  " id="d437965e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">assetLookupLimitedToActiveEntitlementsOnAccount</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether entitlements-related lookup filters on cases
                return only the assets related to the active entitlements on the
                case’s account (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">assetLookupLimitedToActiveEntitlementsOnContact</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether entitlements-related lookup filters on cases
                return only the assets related to the active entitlements on the
                case’s contact (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">assetLookupLimitedToSameAccount</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether entitlements-related lookup filters on cases
                return only the assets related to the case’s account (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">assetLookupLimitedToSameContact</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether entitlements-related lookup filters on cases
                return only the assets related to the case’s contact (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">enableEntitlements</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether entitlements are enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname" id="EnableEntitlementVersionsName"><a name="EnableEntitlementVersionsName"><!-- --></a>enableEntitlementVersioning</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">
                <span class="ph" id="EnableEntitlementVersionsDef"><a name="EnableEntitlementVersionsDef"><!-- --></a>Indicates whether
                  entitlement versioning is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</span>
                <p class="p">This field is available in API
                  version 28.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">enableMilestoneFeedItem</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">When set to <samp class="codeph nolang">true</samp>, indicates
                whether to post to the feed and the record owner’s profile page when
                a milestone is completed or violated. When set to <samp class="codeph nolang">false</samp>, indicates that no post
                occurs when a milestone is completed or violated.<p class="p">This field is
                  available in API version 47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">enableMilestoneStoppedTime</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether to show the <strong class="ph uicontrol">Stopped Time</strong>
                and <strong class="ph uicontrol">Actual Elapsed Time</strong> fields on an
                entitlement milestone (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph nolang">false</samp>).<p class="p">This field is
                  available in API version 47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">entitlementLookupLimitedToActiveStatus</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether entitlements-related lookup filters on cases
                return only active entitlements (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">entitlementLookupLimitedToSameAccount</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether entitlements-related lookup filters on cases
                return only the entitlements related to the case’s account
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">entitlementLookupLimitedToSameAsset</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether entitlements-related lookup filters on cases
                return only the entitlements related to the case’s asset
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">entitlementLookupLimitedToSameContact</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether entitlements-related lookup filters on cases
                return only the entitlements related to the case’s contact
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d437965e98" data-title="Field Name"><span class="keyword parmname">ignoreMilestoneBusinessHours</span></td>

              <td class="entry" headers="d437965e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d437965e104" data-title="Description">Indicates whether to show the time remaining on an event
                milestone in actual hours (<samp class="codeph nolang">true</samp>) or business hours (<samp class="codeph nolang">false</samp>).<p class="p">This field is available in API version 47.0
                  and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This is a sample entitlements settings file.

<?xml version="1.0" encoding="UTF-8"?>
<EntitlementSettings xmlns="http://soap.sforce.com/2006/04/metadata">   
    <assetLookupLimitedToActiveEntitlementsOnAccount\>
        false
    </assetLookupLimitedToActiveEntitlementsOnAccount\>   
    <assetLookupLimitedToActiveEntitlementsOnContact\>
        false
    </assetLookupLimitedToActiveEntitlementsOnContact\>   
    <assetLookupLimitedToSameAccount\>
        false
    </assetLookupLimitedToSameAccount\>   
    <assetLookupLimitedToSameContact\>
        false
    </assetLookupLimitedToSameContact\>   
    <enableEntitlements\>
        true
    </enableEntitlements\>    
    <entitlementLookupLimitedToActiveStatus\>
        false
    </entitlementLookupLimitedToActiveStatus\>   
    <entitlementLookupLimitedToSameAccount\>
        false
    </entitlementLookupLimitedToSameAccount\>   
    <entitlementLookupLimitedToSameAsset\>
        false
    </entitlementLookupLimitedToSameAsset\>   
    <entitlementLookupLimitedToSameContact\>
        false
    </entitlementLookupLimitedToSameContact\>
</EntitlementSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=d3d209c36657c0e187c3d2d837f6134618b82feec4632f67fd7b7b4119aa41d6 url=/legacydeveloper/current/en-us/api_meta/meta_entitlementtemplate.md -->

# EntitlementTemplate

Represents an entitlement template. Entitlement templates are predefined terms of customer support that you can quickly add to products. For example, you can create entitlement templates for Web or phone support so that users can easily add entitlements to products offered to customers.

EntitlementTemplate extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Declarative Metadata File Suffix and Directory Location

EntitlementTemplate components are stored in the entitlementTemplates directory of the corresponding package directory. The file name matches the unique name of the entitlement template, and the extension is .entitlementTemplate.

## Version

Lightning Platform EntitlementTemplate components are available in API version 18.0 and higher.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| businessHours | string | The entitlement's supported business hours. |
| casesPerEntitlement | int | The total number of cases the entitlement supports. |
| entitlementProcess | string | The entitlement process associated with the entitlement. Entitlement processes are timelines that include all the steps (milestones) that your support team must complete to resolve cases. Each process includes logic to determine how to enforce the correct service level for your customers. |
| isPerIncident | boolean | true if entitlements created from this template service a limited number of cases; false otherwise. |
| term | int | The number of days the entitlement is in effect. |
| type | string | The type of entitlement, such as Web or phone support. |

## Declarative Metadata Sample Definition

A sample XML definition of an entitlement template is shown below.

<?xml version="1.0" encoding="UTF-8"?>
<EntitlementTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <businessHours\>AlternateBusinessHours</businessHours\>
    <casesPerEntitlement\>12</casesPerEntitlement\>
    <entitlementProcess\>Process1</entitlementProcess\>
    <isPerIncident\>true</isPerIncident\>
    <term\>33</term\>
    <type\>Phone Support</type\>
</EntitlementTemplate\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=7477f95fdf210e5bb8a46548f8ef1b27334ad5863f5a6b67a1248c83b96a8701 url=/legacydeveloper/current/en-us/api_meta/meta_error.md -->

# Error

Represents an error that occurred during a synchronous CRUD (createMetadata(), updateMetadata(), or deleteMetadata()) operation.

## Version

Available in API version 30.0 and later.

## extendedErrorDetails

- **Type**: ExtendedErrorDetails
- **Description**: More details about the error, including an extended error code and extra error properties, when available. Reserved for future use. For a description of the ExtendedErrorDetails element, see [ExtendedErrorDetails](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_concepts_core_data_objects.htm#extended_error_details_topic) in the SOAP API Developer Guide.

## fields

- **Type**: string\[\]
- **Description**: An array containing names of fields that affected the error condition.

## message

- **Type**: string
- **Description**: The error message text.

## statusCode

- **Type**: StatusCode
- **Description**: A status code corresponding to the error. For a description of each StatusCode value, see [StatusCode](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_concepts_core_data_objects.htm#statuscode_topic) in the SOAP API Developer Guide.

<!-- document id=0bd377ca014d0c83993455f80f1e6f1a80fd65db7d7c9305181df2bfce2068b0 url=/legacydeveloper/current/en-us/api_meta/meta_error_handling.md -->

# Error Handling

Metadata API calls return error information that your client application can use to identify and resolve runtime errors.

Metadata API provides these types of error handling.

- Since the Metadata API uses the enterprise or partner WSDLs to authenticate, it uses SOAP fault messages defined in those WSDLs for errors resulting from badly formed messages, failed authentication, or similar problems. Each SOAP fault has an associated ExceptionCode. For more details, see [Error Handling](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_concepts_errorhandling.htm) in the SOAP API Developer Guide.
- For errors with the asynchronous create(), update(), and delete() calls, see the error status code in the statusCode field in the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object for the associated component.
- For errors with the synchronous CRUD calls, see the error status code in the statusCode field of the [Error](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_error.htm "Represents an error that occurred during a synchronous CRUD (createMetadata(), updateMetadata(), or deleteMetadata()) operation.") object corresponding to each error in the array returned by the errors field of the appropriate result object. For example, the result object of [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") is [SaveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_saveResult.htm "Contains result information for the createMetadata, updateMetadata, or renameMetadata call.").
- For errors with [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org."), see the problem and success fields in the [DeployMessage](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm#deploymessage) object for the associated component.
- For errors with [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization."), see the problem field in the [RetrieveMessage](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm#meta_retrieveresult_retrievemessage) object for the associated component.

For sample code, see [Step 3: Walk Through the Java Sample Code](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_java_sample.htm#meta_quickstart_java_sample).

<!-- document id=bce4a1f9837632d738a0306b531dfacd1a60168e08d3b4a4b6c38c453227159b url=/legacydeveloper/current/en-us/api_meta/meta_error_handling_session_exp.md -->

# Error Handling for Session Expiration

When you sign on via the login() call, a new client session begins and a corresponding unique session ID is generated. Sessions automatically expire after the amount of time specified in the **Security Controls** setup area of the Salesforce application (default two hours). When your session expires, the exception code INVALID\_SESSION\_ID is returned. If this happens, you must invoke the login() call again. For more information about login(), see the [SOAP API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/ "HTML (New Window)").

<!-- document id=7de1b122d7f6dfead33460687d7eb36f2fb1c7a68c6b0d0620fb64911db7bd81 url=/legacydeveloper/current/en-us/api_meta/meta_escalationrules.md -->

# EscalationRules

Represents case escalation rules to escalate cases automatically if they aren’t resolved within a certain time. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object.

The package.xml syntax for accessing all escalation rules for all objects is:

    <types>
        <members>\*</members>
        <name>EscalationRules</name>
    </types>

All rules for a specific object use a similar syntax without the wildcard. For example, all escalation rules for the Case object would use this syntax:

    <types>
        <members>Case</members>
        <name>EscalationRules</name>
    </types>

You can also access specific escalation rules for an object. The following example only accesses the “samplerule” and “newrule” escalation rules on the Case object. Notice that for this example the type name syntax is EscalationRule and not EscalationRules.

    <types>
        <members>Case.samplerule</members>
        <members>Case.newrule</members>
        <name>EscalationRule</name>
    </types>

## File Suffix and Directory Location

EscalationRules for an object have the suffix .escalationRules and are stored in the escalationRules folder. For example, all Case escalation rules are stored in the Case.escalationRules file.

## Version

EscalationRules components are available in API version 27.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| escalationRule | [EscalationRule\[\]](#escalationrule_sub) | Represents one escalation rule and specifies whether it’s active or not. Escalation rules are processed in the order they appear in the EscalationRules container. |

## EscalationRule

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d439772e160">Field Name</th>

              <th class="featureTableHeader  " id="d439772e163">Field Type</th>

              <th class="featureTableHeader  " id="d439772e166">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d439772e160" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d439772e163" data-title="Field Type">boolean</td>

              <td class="entry" headers="d439772e166" data-title="Description">Indicates whether the escalation rule is active (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e160" data-title="Field Name"><span class="keyword parmname">fullname</span></td>

              <td class="entry" headers="d439772e163" data-title="Field Type">string</td>

              <td class="entry" headers="d439772e166" data-title="Description">Inherited from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for this
                metadata type. It must be specified when creating, updating, or
                deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a> to see an
                example of this field specified for a call.<p class="p">This value can't be
                  <samp class="codeph java">null</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e160" data-title="Field Name"><span class="keyword parmname">ruleEntry</span></td>

              <td class="entry" headers="d439772e163" data-title="Field Type"><span class="keyword parmname"><a class="xref" href="#RuleEntry">RuleEntry[]</a></span></td>

              <td class="entry" headers="d439772e166" data-title="Description">Contains the definitions of the rule entries in the escalation
                rule. </td>

            </tr>

          </tbody>

        </table>

## RuleEntry

Represents the fields used by the rule.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d439772e270">Field Name</th>

              <th class="featureTableHeader  " id="d439772e273">Field Type</th>

              <th class="featureTableHeader  " id="d439772e276">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d439772e270" data-title="Field Name"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d439772e273" data-title="Field Type">string</td>

              <td class="entry" headers="d439772e276" data-title="Description">Advanced filter conditions that were specified for the rule.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e270" data-title="Field Name"><span class="keyword parmname">businessHours</span></td>

              <td class="entry" headers="d439772e273" data-title="Field Type">string</td>

              <td class="entry" headers="d439772e276" data-title="Description">The hours when escalation actions are performed. Specify only if
                <span class="keyword parmname">businessHoursSource</span> is set to
                <span class="keyword parmname">Static</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e270" data-title="Field Name"><span class="keyword parmname">businessHoursSource</span></td>

              <td class="entry" headers="d439772e273" data-title="Field Type">BusinessHoursSourceType (enumerations of type string)</td>

              <td class="entry" headers="d439772e276" data-title="Description">Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Case</samp></li>

                  <li class="li"><samp class="codeph nolang">Static</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e270" data-title="Field Name"><span class="keyword parmname">criteriaItems</span></td>

              <td class="entry" headers="d439772e273" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a></td>

              <td class="entry" headers="d439772e276" data-title="Description">The items in the list that define the assignment criteria.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e270" data-title="Field Name"><span class="keyword parmname">disableEscalationWhenModified</span></td>

              <td class="entry" headers="d439772e273" data-title="Field Type">boolean</td>

              <td class="entry" headers="d439772e276" data-title="Description">Indicates whether the escalation is disabled when the record is
                modified <samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e270" data-title="Field Name"><span class="keyword parmname">escalationAction</span></td>

              <td class="entry" headers="d439772e273" data-title="Field Type">
                <a class="xref" href="#EscalationAction_section">EscalationAction</a>[]
              </td>

              <td class="entry" headers="d439772e276" data-title="Description">The actions to perform when the escalation criteria are met.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e270" data-title="Field Name"><span class="keyword parmname">escalationStartTime</span></td>

              <td class="entry" headers="d439772e273" data-title="Field Type">EscalationStartTimeType (enumeration of type string)</td>

              <td class="entry" headers="d439772e276" data-title="Description">Indicates the start time for the escalation. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CaseCreation</samp></li>

                  <li class="li"><samp class="codeph nolang">CaseLastModified</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e270" data-title="Field Name"><span class="keyword parmname">formula</span></td>

              <td class="entry" headers="d439772e273" data-title="Field Type">string</td>

              <td class="entry" headers="d439772e276" data-title="Description">The validation formula. <p class="p">Specify either
                  <span class="keyword parmname">formula</span> or
                  <span class="keyword parmname">criteriaItems</span>, but not both fields.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## EscalationAction

Describes the action to take for an escalation rule.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d439772e463">Field Name</th>

              <th class="featureTableHeader  " id="d439772e466">Field Type</th>

              <th class="featureTableHeader  " id="d439772e469">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d439772e463" data-title="Field Name"><span class="keyword parmname">assignedTo</span></td>

              <td class="entry" headers="d439772e466" data-title="Field Type">string</td>

              <td class="entry" headers="d439772e469" data-title="Description">The name of the user or queue the item is assigned to. </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e463" data-title="Field Name"><span class="keyword parmname">assignedToTemplate</span></td>

              <td class="entry" headers="d439772e466" data-title="Field Type">string</td>

              <td class="entry" headers="d439772e469" data-title="Description">Specifies the template to use for the email that is automatically
                sent to the new owner specified by the escalation rule. <p class="p">Lightning
                  email templates aren’t packageable. We recommend using a Classic
                  email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e463" data-title="Field Name"><span class="keyword parmname">assignedToType</span></td>

              <td class="entry" headers="d439772e466" data-title="Field Type">AssignToLookupValueType (enumeration of type string)</td>

              <td class="entry" headers="d439772e469" data-title="Description">Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">User</samp></li>

                  <li class="li"><samp class="codeph nolang">Queue</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e463" data-title="Field Name"><span class="keyword parmname">minutesToEscalation</span></td>

              <td class="entry" headers="d439772e466" data-title="Field Type">int</td>

              <td class="entry" headers="d439772e469" data-title="Description">The number of minutes until the escalation occurs. </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e463" data-title="Field Name"><span class="keyword parmname">notifyCaseOwner</span></td>

              <td class="entry" headers="d439772e466" data-title="Field Type">boolean</td>

              <td class="entry" headers="d439772e469" data-title="Description">Indicates that the owner of the case is notified when the case is
                escalated <samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e463" data-title="Field Name"><span class="keyword parmname">notifyEmail</span></td>

              <td class="entry" headers="d439772e466" data-title="Field Type">string</td>

              <td class="entry" headers="d439772e469" data-title="Description">Specifies the email address of the user to notify. </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e463" data-title="Field Name"><span class="keyword parmname">notifyTo</span></td>

              <td class="entry" headers="d439772e466" data-title="Field Type">string</td>

              <td class="entry" headers="d439772e469" data-title="Description">Specifies the user to notify. </td>

            </tr>

            <tr>
              <td class="entry" headers="d439772e463" data-title="Field Name"><span class="keyword parmname">notifyToTemplate</span></td>

              <td class="entry" headers="d439772e466" data-title="Field Type">string</td>

              <td class="entry" headers="d439772e469" data-title="Description">Specifies the template to user for the notification email.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example EscalationRules component:

<EscalationRules xmlns="http://soap.sforce.com/2006/04/metadata">
    <escalationRule\>
        <fullName\>samplerule</fullName\>
        <active\>false</active\>
        <ruleEntry\>
            <businessHours\>test</businessHours\>
            <businessHoursSource\>Static</businessHoursSource\>
            <criteriaItems\>
                <field\>Case.Description</field\>
                <operation\>contains</operation\>
                <value\>test</value\>
            </criteriaItems\>
            <escalationAction\>
                <assignedTo\>someuser@org.com</assignedTo\>
                <assignedToTemplate\>emailtemplatename</assignedToTemplate\>
                <assignedToType\>User</assignedToType\>
                <minutesToEscalation\>1440</minutesToEscalation\>
                <notifyCaseOwner\>false</notifyCaseOwner\>
            </escalationAction\>
            <escalationStartTime\>CaseLastModified</escalationStartTime\>
        </ruleEntry\>
    </escalationRule\>
</EscalationRules\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=daacab59c689078a975d31f9648f1988739631a1504fd4288a57b0a1d3c69376 url=/legacydeveloper/current/en-us/api_meta/meta_eventdelivery.md -->

# EventDelivery

Represents how an event instance maps to a target payload. Removed in API version 46.0. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

Event delivery components have the suffix file path .delivery, and are stored in the eventDeliveries folder.

## Version

Event delivery components are available in API versions 41.0 to 45.0.

## Limits

Your org can have a maximum of 2500 EventDelivery object instances.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d441604e93">Field Name</th>

              <th class="featureTableHeader  " id="d441604e96">Field Type</th>

              <th class="featureTableHeader  " id="d441604e99">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d441604e93" data-title="Field Name"><span class="keyword parmname">eventParameters</span></td>

              <td class="entry" headers="d441604e96" data-title="Field Type">
                <a class="xref" href="#SubTypeID">EventParameterMap</a>[]
              </td>

              <td class="entry" headers="d441604e99" data-title="Description">An array of parameters to deliver in addition to the published event’s
                data.</td>

            </tr>

            <tr>
              <td class="entry" headers="d441604e93" data-title="Field Name"><span class="keyword parmname">eventSubscription</span></td>

              <td class="entry" headers="d441604e96" data-title="Field Type">string</td>

              <td class="entry" headers="d441604e99" data-title="Description"><span class="ph" id="eventSubscription_desc"><a name="eventSubscription_desc"><!-- --></a>Required. The ID of the subscription to deliver
                  the data to. </span></td>

            </tr>

            <tr>
              <td class="entry" headers="d441604e93" data-title="Field Name"><span class="keyword parmname">referenceData</span></td>

              <td class="entry" headers="d441604e96" data-title="Field Type">string</td>

              <td class="entry" headers="d441604e99" data-title="Description"><span class="ph" id="referenceData_desc"><a name="referenceData_desc"><!-- --></a>User-defined non-unique identifier.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d441604e93" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d441604e96" data-title="Field Type">EventDeliveryType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d441604e99" data-title="Description">
                <span class="ph" id="type_desc1"><a name="type_desc1"><!-- --></a>Required. Determines what action occurs when the event is
                  delivered to the listeners on behalf of the subscribers.</span>
                <p class="p" id="type_values"><a name="type_values"><!-- --></a>Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">StartFlow</samp>—When the event occurs,
                    it’s delivered to a flow of type CustomEvent. Those flows are built through
                    Process Builder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ResumeFlow</samp>—Reserved for future
                    use.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## EventParameterMap

Parameters to deliver in addition to the published event’s data.

If type is StartFlow, you must include a parameter where parameterName is FlowVersionName and parameterValue is the name of the flow that you want to start. The flow name must include its version number. For example, myFlow-3.

Each event delivery can have up to 10 parameters.

| Field Name | Field Type | Description |
| --- | --- | --- |
| parameterName | string | The parameter name. |
| parameterValue | string | The parameter value. |

## Declarative Metadata Sample Definition

The following is an example of an event delivery file.

<?xml version="1.0" encoding="UTF-8"?>
<EventDelivery xmlns="http://soap.sforce.com/2006/04/metadata">
   <eventParameters>
      <parameterName>FlowVersionName</parameterName>
      <parameterValue>My\_Event\_Based\_Process-1</parameterValue>
   </eventParameters>
   <eventSubscription>MySubscription</eventSubscription>
   <referenceData>My\_Event\_Based\_Process\_1</referenceData>
   <type>StartFlow</type>
</EventDelivery>

The following is an example package.xml that deploys or retrieves all the available event delivery metadata in your org.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>EventDelivery</members\>
      <name\>\*</name\>
   </types\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ce9cfb4be866a7292defa1cbfa779d78b942f4a8366ac6680200598ea8e75918 url=/legacydeveloper/current/en-us/api_meta/meta_eventrelayconfig.md -->

# EventRelayConfig

Represents the configuration of an event relay, which relays platform events and change data capture events from Salesforce to Amazon EventBridge.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

EventRelayConfig components have the suffix .eventRelay and are stored in the eventRelays folder.

## Version

EventRelayConfig components are available in API version 56.0 and later.

## Special Access Rules

- You must have the Customize Application permission to deploy and retrieve this type.
- You can update only the state and relayOption fields and not eventChannel or destinationResourceName.

## Fields

| Field Name | Description |
| --- | --- |
| destinationResourceName | 
Field Type

string

Description

Required. The developer name of the named credential, which stores the AWS account information. The destinationResourceName value contains the callout: prefix. For example: callout:MyRelayNamedCredential



 |
| eventChannel | 

Field Type

string

Description

Required. The full name of the event channel used in the event relay. For example: MyRelayChannel\_\_chn



 |
| label | 

Field Type

string

Description

The label for the event relay. The label is displayed in the user interface. Make sure you use a meaningful label that describes your event relay and try to make it unique.



 |
| relayOption | 

Field Type

string

Description

A JSON-encoded string that contains an option for resuming an event relay after the system recovers from an error. This option is used if the event relay can't resume after the last relayed event. The options available are:

- {"ReplayRecovery":"LATEST"}—(Default) Start relaying events from new events received in the event bus. Use this option if you aren’t interested in missed events while the relay was down.
- {"ReplayRecovery":"EARLIEST"}—Resend all events stored in the event bus and relay new events thereafter. The event bus stores events for up to three days. Use this option if you want to reprocess all stored events and catch up on missed events.





 |
| state | 

Field Type

EventRelayAdminState (enumeration of type string)

Description

The execution state of the event relay. Possible values are:

- RUN—The event relay is running and actively relaying event messages from Salesforce to Amazon EventBridge.
- PAUSE—An administrator paused the event relay. No events are relayed to Amazon EventBridge during this status. All current state information is saved.
- STOP—(Default) The event relay is stopped and no events are relayed to Amazon EventBridge. All current state information is deleted.
    
    The event relay is created with a default state of STOP if you don't specify this field. If you specify this field when creating an event relay, the only valid value you can set is STOP.
- DELETE—Reserved for future use.





 |
| usageType | 

Field Type

string

Description

Reserved for future use.



 |

## Declarative Metadata Sample Definition

The following is an example of an EventRelayConfig component with the file name Carbon\_Comparison\_Relay.eventRelay.

<?xml version="1.0" encoding="UTF-8"?>
<EventRelayConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <destinationResourceName\>callout:AWS\_Account</destinationResourceName\>
    <eventChannel\>Carbon\_Comparison\_Channel\_\_chn</eventChannel\>
    <label\>Carbon Comparison Relay</label\>
    <relayOption\>{"ReplayRecovery":"LATEST"}</relayOption\>
    <state\>STOP</state\>
</EventRelayConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Carbon\_Comparison\_Relay</members\>
        <name\>EventRelayConfig</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=8380049c07f3880f8d3ed7b97f9ab7cf8ef1c1a4ba9a3b7a424278462dccea59 url=/legacydeveloper/current/en-us/api_meta/meta_eventsettings.md -->

# EventSettings

Represents an org's platform event settings for Event Monitoring.

## File Suffix and Directory Location

EventSettings components have the suffix .settings and are stored in the settings folder.

## Version

EventSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d443109e81">Field Name</th>

              <th class="featureTableHeader  " id="d443109e84">Field Type</th>

              <th class="featureTableHeader  " id="d443109e87">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">bypassMeteringBlock</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Determines the behavior of metering service protection for Transaction Security
                policies. When <samp class="codeph nolang">true</samp>, metering occurs but
                doesn't block the user operation that triggered the policy. When <samp class="codeph nolang">false</samp> and a policy can't be handled within three
                seconds, metering occurs and the user's action is blocked. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableApexLimitEvents</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) Apex Limit events.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableDeleteMonitoringData</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Allows (<samp class="codeph nolang">true</samp>) or disallows (<samp class="codeph nolang">false</samp>) Apex limits. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableDynamicStreamingChannel</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the dynamic creation of a streaming channel
                when you subscribe to generic streaming. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableEventLogGeneration</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the generation of event monitoring log files.
                Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableEventLogWaveIntegration</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the integration of event monitoring log files
                and Analytics apps. Analytics apps help you visualize your user’s activity. Default
                value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableLightningLoggerEvents</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the generation of Lightning Logger events.
                Lightning Logger events track information about custom Lightning web components.
                Default value is <samp class="codeph nolang">false</samp>. Requires Salesforce
                Shield or Salesforce Event Monitoring add-on subscriptions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableLoginForensics</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the Login Forensics feature. Login Forensics
                helps you track and audit your org's user login activity. Default value is <samp class="codeph nolang">false</samp>. Available in API versions
                47.0–49.0.<div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_tip.png" alt="Tip">
                        <div class="mediaBd">
                          <h4 class="mbs">Tip</h4>
                          <p> In versions 50.0 and later, enable LoginEvent
                            on the Event Manager Setup page.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enablePlatformTracing</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) Platform Tracing in the org. Default value is
                <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableStreamingApi</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) Streaming API in the org. Default value is
                <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableTransactionSecurityPolicies</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the ability to create and use transaction
                security policies in the Salesforce UI. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">eventLogRetentionDuration</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">integer</td>

              <td class="entry" headers="d443109e87" data-title="Description">Specifies the number of days (between 30 and 365) that your event log file data
                is retained for. If this value is not set, your event log file data is retained for
                1 year by default. </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an EventSettings.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<EventSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableDeleteMonitoringData\>true</enableDeleteMonitoringData\>
    <enableDynamicStreamingChannel\>false</enableDynamicStreamingChannel\>
    <enableEventLogWaveIntegration\>true</enableEventLogWaveIntegration\>
    <enableStreamingApi\>true</enableStreamingApi\>
    <enableTransactionSecurityPolicies\>true</enableTransactionSecurityPolicies\>
</EventSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Event settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
       <members\>Event</members\>
       <name\>Settings</name\>
   </types\>
   <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b8286f97146b9c08ddd766fdf4a914c09cd6a390409f3c56a542da69e9a76a75 url=/legacydeveloper/current/en-us/api_meta/meta_eventsubscription.md -->

# EventSubscription

Represents a subscription to an event type. Removed in API version 46.0. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

EventSubscription components have the suffix file path .subscription, and are stored in the eventSubscriptions folder.

## Version

Event subscription components are available in API versions 41.0 to 45.0.

## Limits

Your org can have a maximum of:

- 4,000 total event subscriptions
- 2,000 active event subscriptions

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| active | boolean | If the subscription isn’t active, it never receives any events. |
| eventParameters | [EventParameterMap](#eventparametermap)\[\] | An array of parameters that must be true for published events. |
| eventType | string | Required. The name of the platform event. |
| referenceData | string | Required. If the subscriber is a flow of type CustomEvent, referenceData is flowName\_versionNumber. For example, Printer\_Management\_2. |

## EventParameterMap

An array of parameters that must be true for published events. For example, subscribe to Vendor Response events only if Status\_\_c is Shipped.

Each event subscription can have up to 10 parameters.

| Field Name | Field Type | Description |
| --- | --- | --- |
| parameterName | string | Required. The published event’s field name. |
| parameterValue | string | The value that must be true. |

## Declarative Metadata Sample Definition

The following is an example of an active event subscription.

<?xml version="1.0" encoding="UTF-8"?>
<EventSubscription xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <eventType\>Printer\_Status\_\_e</eventType\>
    <referenceData\>Printer\_Management</referenceData\>
</EventSubscription\>

The following is an example of an inactive event subscription that sets event parameters.

<?xml version="1.0" encoding="UTF-8"?>
<EventSubscription xmlns="http://soap.sforce.com/2006/04/metadata">
   <name>MySubscription</name>
   <active>false</active>
   <eventParameters>
      <parameterName>Ink\_Status\_\_c</parameterName>
      <parameterValue>low</parameterValue> 
   </eventParameters>
   <eventParameters>
      <parameterName>Serial\_Number\_\_c</parameterName>
      <parameterValue>00123456789</parameterValue>
   </eventParameters>
   <eventType>Printer\_Status\_\_e</eventType>
   <referenceData>My\_Event\_Based\_Process\_1</referenceData>
</EventSubscription>

The following is an example package.xml that deploys or retrieves all the available event subscription metadata in your org.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>EventSubscription</name\>
   </types\>
   <version\>41.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ecae62e993eb957f92706ae1efbec06772f71ae8e00808953887700ce99923ed url=/legacydeveloper/current/en-us/api_meta/meta_experiencebundle.md -->

# ExperienceBundle

Represents a text-based code structure of the settings and site components, such as pages, branding sets, and themes that make up an Experience Builder site. Developers can quickly update and deploy Experience Builder sites _programmatically_ using their preferred development tools. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExperienceBundle components have the suffix .json and are stored in the experiences folder when retrieved. Each Experience Builder site in your org has its own folder. Each of these folders contains [other folders for the supported properties](#experience_bundle_folders_section).

The ExperienceBundle can contain one or more site definitions under the experiences folder. Each site definition has resource folders for [brandingSets](#brandingSets_folder), [config](#config_folder), [routes](#routes_folder), [themes](#themes_folder), [variations](#variations_folder), and [views](#views_folder), each with additional, related configuration information in JSON files. Here’s an example site definition, showing the resource folders.

![Three-level folder structure](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/communities_dev/images/migrate_experiencebundle_structure.png)

## Version

ExperienceBundle components are available in API version 46.0 and later.

## Special Access Rules

To use the ExperienceBundle metadata type for Aura-based Experience Builder sites, from Setup, enter Digital Experiences in the Quick Find box, and then select **Settings**. Select **Enable ExperienceBundle Metadata API**, and save your changes. LWR sites use ExperienceBundle by default.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e146">Field Name</th>

              <th class="featureTableHeader  " id="d444970e149">Field Type</th>

              <th class="featureTableHeader  " id="d444970e152">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e146" data-title="Field Name">
                <span class="keyword parmname">experienceResources</span>
              </td>

              <td class="entry" headers="d444970e149" data-title="Field Type">
                <a class="xref" href="#ExperienceResources">ExperienceResources</a>[]
              </td>

              <td class="entry" headers="d444970e152" data-title="Description">The list of resources in this ExperienceBundle. Each resource represents an
                artifact of a site such as <a class="xref" href="#brandingSets_folder">brandingSets</a>, <a class="xref" href="#config_folder">config</a>,
                <a class="xref" href="#routes_folder">routes</a>, <a class="xref" href="#themes_folder">themes</a>, <a class="xref" href="#variations_folder">variations</a>, and <a class="xref" href="#views_folder">views</a>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e146" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d444970e149" data-title="Field Type">string</td>

              <td class="entry" headers="d444970e152" data-title="Description">Required. Represents the name of the ExperienceBundle.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e146" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e149" data-title="Field Type">SiteType (enumeration of type string)</td>

              <td class="entry" headers="d444970e152" data-title="Description">Required. <span class="ph" id="site_type_field_desc"><a name="site_type_field_desc"><!-- --></a>Identifies the kind of site. Only
                  Experience Builder sites are supported, using the value <samp class="codeph javascript">ChatterNetworkPicasso</samp>.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e146" data-title="Field Name"><span class="keyword parmname">urlPathPrefix</span></td>

              <td class="entry" headers="d444970e149" data-title="Field Type">string</td>

              <td class="entry" headers="d444970e152" data-title="Description">Specify a URL prefix for an Experience Builder site. For example, in the site
                URL SitesSubdomainName.force.com/customers, customers is the UrlPathPrefix.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>
                            For authenticated LWR sites created before Winter ’23 and Aura sites, the URL path
                            prefix ends in /s, and the part of the path without the /s must match the Network
                            metadata type’s URL. For unauthenticated LWR sites and authenticated LWR sites
                            created after Winter ’23 through Experience Builder or Connect API, this path
                            doesn’t contain /s, and the path can be anything as long as there’s no
                            conflict.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
                <strong class="ph b">Sample meta.xml
                  file</strong>
                <div class="codeSection">
                  <pre class="codeblock ">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;ExperienceBundle xmlns="http://soap.sforce.com/2006/04/metadata"&gt;
    &lt;label&gt;SampleStarterSite2&lt;/label&gt;
    &lt;type&gt;ChatterNetworkPicasso&lt;/type&gt;
    &lt;urlPathPrefix&gt;SampleStarterSite2/s&lt;/urlPathPrefix&gt;
&lt;/ExperienceBundle&gt;</pre>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## ExperienceResources

Represents a list of sites in the bundle.

| Field Name | Field Type | Description |
| --- | --- | --- |
| experienceResource | [ExperienceResource\[\]](#ExperienceResource) | The list of resources in this ExperienceBundle. Each resource represents a property for the site, such as [brandingSets](#brandingSets_folder), [config](#config_folder), [routes](#routes_folder), [themes](#themes_folder), and [views](#views_folder). |

## ExperienceResource

Represents specific site information included in the ExperienceBundle.

Each type has a folder in the structure. Each folder contains one or more files providing information about that type and the site. Each corresponds to a specific folder and file in the ExperienceBundle.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e355">Field Name</th>

              <th class="featureTableHeader  " id="d444970e358">Field Type</th>

              <th class="featureTableHeader  " id="d444970e361">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e355" data-title="Field Name"><span class="keyword parmname">fileName</span></td>

              <td class="entry" headers="d444970e358" data-title="Field Type">string</td>

              <td class="entry" headers="d444970e361" data-title="Description">Required. Name of resource file.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e355" data-title="Field Name"><span class="keyword parmname">format</span></td>

              <td class="entry" headers="d444970e358" data-title="Field Type">string</td>

              <td class="entry" headers="d444970e361" data-title="Description">Required. Only <samp class="codeph javascript">JSON</samp> is
                allowed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e355" data-title="Field Name"><span class="keyword parmname">source</span></td>

              <td class="entry" headers="d444970e358" data-title="Field Type">base64</td>

              <td class="entry" headers="d444970e361" data-title="Description">The <samp class="codeph javascript">JSON</samp> content of each file.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e355" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e358" data-title="Field Type">string</td>

              <td class="entry" headers="d444970e361" data-title="Description">Required. The type of the resource. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">brandingSets</samp></li>

                  <li class="li"><samp class="codeph javascript">config</samp></li>

                  <li class="li"><samp class="codeph javascript">routes</samp></li>

                  <li class="li"><samp class="codeph javascript">themes</samp></li>

                  <li class="li"><samp class="codeph javascript">views</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Folders and Bundled Definitions

Each ExperienceBundle includes folders and associated data that is contained in JSON files.

## brandingSets Folder

This folder contains one JSON file per branding set, named brandingSets\_name.json. Each file has the same structure and properties.

**<brandingSets\_name>.json**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e495">Property</th>

              <th class="featureTableHeader  " id="d444970e498">Type</th>

              <th class="featureTableHeader  " id="d444970e501">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e495" data-title="Property"><span class="keyword parmname">brandingSetType</span></td>

              <td class="entry" headers="d444970e498" data-title="Type">string</td>

              <td class="entry" headers="d444970e501" data-title="Description">Required in LWR sites. Not applicable for Aura sites. Represents whether the
                color palette stored in the branding set is for the entire site or a specific
                section. You can’t change one branding set type to another. Available in API Version
                52.0 and later.<div class="p">Valid values are:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">APP</samp>: The branding set applies to the
                      entire site. There can be only one branding set of this type.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">SCOPED</samp>: The branding set applies to a
                      specific section.
                    </li>

                  </ul>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e495" data-title="Property"><span class="keyword parmname">definitionName</span></td>

              <td class="entry" headers="d444970e498" data-title="Type">string</td>

              <td class="entry" headers="d444970e501" data-title="Description">Required. Represents the name for the branding set that is used in grouping
                branding sets under a theme. Defined as
                <var class="keyword varname">theme</var>:branding-<var class="keyword varname">theme</var>. <p class="p">For example, if the
                  site theme is Stella, the <span class="keyword parmname">definitionName</span> would be <samp class="codeph javascript">stella:branding-stella</samp>.</p>
                <div class="p">In addition,
                  there are several standard templates that have unique naming:<ul class="ul bulletList">
                    <li class="li">Customer Account Portal uses <samp class="codeph javascript">cpt:branding-cpt</samp>
                    </li>

                    <li class="li">Customer Service uses <samp class="codeph javascript">service:branding-service</samp>
                    </li>

                    <li class="li">Help Center uses <samp class="codeph javascript">helpCenter:branding-helpCenter</samp>
                    </li>

                    <li class="li">Partner Central uses <samp class="codeph javascript">prm:branding-prm</samp>
                    </li>

                    <li class="li">Build Your Own uses <samp class="codeph javascript">starter:branding-starter</samp>
                    </li>

                  </ul>
                </div>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>The combination of <span class="keyword parmname">definitionName</span> +
                            <span class="keyword parmname">label</span> must be unique in your org.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e495" data-title="Property"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d444970e498" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e501" data-title="Description">Represents the component’s GUID.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e495" data-title="Property"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d444970e498" data-title="Type">string</td>

              <td class="entry" headers="d444970e501" data-title="Description">Represents the name of the branding set.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>The combination of
                            <span class="keyword parmname">definitionName</span> + <span class="keyword parmname">label</span> must be unique
                            in your org.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e495" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e498" data-title="Type">string</td>

              <td class="entry" headers="d444970e501" data-title="Description">Represents the component type. The only supported value is <samp class="codeph nolang">brandingSet</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e495" data-title="Property"><span class="keyword parmname">values</span></td>

              <td class="entry" headers="d444970e498" data-title="Type">map</td>

              <td class="entry" headers="d444970e501" data-title="Description">Required. Represents a map of branding values that can be applied to a
                site.</td>

            </tr>

          </tbody>

        </table>

{
  "values" : {
    "HeaderBackgroundColor" : "#FFFFFF",
    "TextTransformStyle" : "none",
    "BorderColor" : "#D4D4D4",
    "DetailTextColor" : "#5A5A5A",
    "HeaderFonts" : "Ek Mukta",
    "CardBackgroundColor" : "rgba(255, 255, 255, 0)",
    "LoginBackgroundColor" : "#F4F4F4",
    "\_ActionColorTrans" : "rgba(25, 124, 190, 0.9)",
    "LoginBackgroundImage" : "../../../../sfsites/picasso/core/external/salesforceIdentity/images/background.jpg?v=1",
    "PageBackgroundColor" : "#F5F7FA",
    "\_HeaderTextColor" : "rgba(34,34,34,.8)",
    "\_NavigationMenuHoverColor" : "rgba(255,255,255,.2)",
    "\_HeaderInputBackgroundColor" : "rgba(255,255,255,.4)",
    "TextColor" : "#222222",
    "NavigationMenuTextColor" : "#222222",
    "\_HeaderPlaceholderTextColor" : "rgba(85,85,85,.8)",
    "\_OverlayTextColorShadow" : "#000000",
    "ActionColor" : "#0099DE",
    "CompanyLogo" : "",
    "\_LinkColorDarker" : "#135F90",
    "\_ActionColorDarker" : "#135F90",
    "\_HoverColor" : "rgba(25, 124, 190, 0.05)",
    "ErrorFontColor" : "#ff9e9e",
    "OverlayTextColor" : "#FFFFFF",
    "PrimaryFont" : "Ek Mukta",
    "LinkColor" : "#3558D6"
    },
  "definitionName" : "cpt:branding-cpt",
  "label" : "Customer Account Portal",
  "id" : "283407c3-5938-4a6b-b97f-621cda6968c8",
  "type" : "brandingSet"
 }

## config Folder

The config folder contains several JSON files.

- sitename.json
- languages.json
- nativeConfig.json
- page\_name.json
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    One for each single-page application in the site: loginAppPage.json and mainAppPage.json

**sitename.json File Properties**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e732">Property</th>

              <th class="featureTableHeader  " id="d444970e735">Type</th>

              <th class="featureTableHeader  " id="d444970e738">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">authenticationType</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">string</td>

              <td class="entry" headers="d444970e738" data-title="Description">For LWR sites, indicates whether guest users have access to the site.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>For
                            Aura sites, use <span class="keyword parmname">isAvailableToGuests</span> instead.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
                <div class="p">Valid
                  values are:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">AUTHENTICATED</samp>: The site isn’t public.
                      Only authenticated users can access the site after logging in.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">AUTHENTICATED_WITH_PUBLIC_ACCESS_ENABLED</samp>: The site is an
                      authenticated site, but the <strong class="ph uicontrol">Public can access the site</strong>
                      checkbox is enabled in Experience Builder in <span class="ph menucascade"><strong class="ph uicontrol">Settings</strong> | <strong class="ph uicontrol">General</strong></span>. Guest users can access the site.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">UNAUTHENTICATED</samp>: The unauthenticated
                      site is publicly available to anyone on the web, and doesn’t support login or
                      authentication. Guest users can access the site. <samp class="codeph nolang">UNAUTHENTICATED</samp> isn’t supported for LWR sites created after Winter
                      ’23 through Experience Builder or Connect API. To allow guest user access, we
                      recommend using <samp class="codeph nolang">AUTHENTICATED_WITH_PUBLIC_ACCESS_ENABLED</samp>.
                    </li>

                  </ul>
                </div>
                <p class="p">Available in API version 51.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">forgotPasswordRouteId</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e738" data-title="Description">Represents the ID of the route to use when a user forgets their password.<div class="box message info" id="nonlogin_template_note">
                  <a name="nonlogin_template_note"><!-- --></a>
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Unsupported if the active Experience Builder template
                            for the site doesn't support login (such as Help Center).</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">isAvailableToGuests</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">boolean</td>

              <td class="entry" headers="d444970e738" data-title="Description">For Aura sites, indicates whether public users have access to the site (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph javascript">false</samp>.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p> For LWR sites, use <span class="keyword parmname">authenticationType</span>
                            instead.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">isFilteredComponentsView</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">boolean</td>

              <td class="entry" headers="d444970e738" data-title="Description">Indicates whether the list of components is filtered based on the current page
                type (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Some components require specific parameters from the page and
                don't work unless you manually configure them. The default value is <samp class="codeph javascript">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">isLockerServiceEnabled</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">boolean</td>

              <td class="entry" headers="d444970e738" data-title="Description">Indicates whether Lightning Locker is enabled (<samp class="codeph nolang">true</samp>) or disabled (<samp class="codeph nolang">false</samp>). The
                default value is <samp class="codeph javascript">true</samp>.<p class="p"> Available in API
                  version 55.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">isProgressiveRenderingEnabled</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">boolean</td>

              <td class="entry" headers="d444970e738" data-title="Description">Indicates whether the display order of page components is prioritized (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph javascript">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">loginAppPageId</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e738" data-title="Description">Represents the ID of the login page. Unsupported if the active Experience
                Builder template for the site doesn't support login (such as Help Center).</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">mainAppPageId</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e738" data-title="Description">Required. Represents the ID of the main page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">preferredDomain</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">string</td>

              <td class="entry" headers="d444970e738" data-title="Description">Represents the name of the domain to use for indexing a site’s pages. Improves
                search engine results.<p class="p">Available in API version 48.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">preferredDomainId</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">string</td>

              <td class="entry" headers="d444970e738" data-title="Description">Represents the domain to use for indexing a site’s pages. Improves search
                engine results.<p class="p">Removed in API version 48.0. Use
                  <span class="keyword parmname">preferredDomain</span> instead.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">selfRegistrationRouteId</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e738" data-title="Description">Represents the ID of the login route to use for self-registration. Unsupported
                if the active Experience Builder template for the site doesn't support login (such
                as Help Center).</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e732" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e735" data-title="Type">string</td>

              <td class="entry" headers="d444970e738" data-title="Description">Represents the component type. The only supported value is <samp class="codeph javascript">site</samp>.</td>

            </tr>

          </tbody>

        </table>

**trustedSitesForScript container**

When implemented, there’s one trustedSitesForScript container in sitename.json.

| Property | Type | Description |
| --- | --- | --- |
| id | UUID | Represents the component's GUID. |
| isActive | boolean | Indicates if allowlisted item is active (true) and must be respected or inactive (false) and must not be treated as an allowlisted source. Default is false. |
| trustedSiteName | string | Name of the allowlisted source as it appears in the UI. |
| trustedSiteUrl | string | The fully qualified URL of the allowlisted source. |
| type | string | Represents the component type. The only supported value is trustedSitesForScripts. |

{
   "isAvailableToGuests" : false,
   "isFilteredComponentsView" : false,
   "mainAppPageId" : "df9907cb-6e68-4ca1-8bb2-51173ca5374e",
   "loginAppPageId" : "58e9939a-84b2-498d-bbc5-7a89d89087fa",
   "selfRegistrationRouteId" : "ad5c8bf1-297f-4ad3-b47c-0e35d85f10ef",
   "forgotPasswordRouteId" : "e3139f6f-44d8-4eec-be9d-3609ce063039",
   "isProgressiveRenderingEnabled" : false,
   "preferredDomain" : "none",
   "selfRegistrationRouteId" : "b8fe8ab1-f266-41e1-a63b-4791165f3c1d",
   "trustedSitesForScript" : \[ {
     "id" : "92c489e2-0b7b-4a48-9c88-bef7e8fe6f1b",
     "isActive" : true,
     "trustedSiteName" : "test",
     "trustedSiteUrl" : "https://123.com",
     "type" : "trustedSitesForScripts"
   }, {
     "id" : "92c489e2-0b7b-4a48-9c88-bef7e8fe6f1c",
     "isActive" : true,
     "trustedSiteName" : "test1",
     "trustedSiteUrl" : "https://1234.com",
     "type" : "trustedSitesForScripts"
  } \],
    "type" : "site"
}

**languages.json File Properties**

| Property | Type | Description |
| --- | --- | --- |
| defaultCode | string | Required. Represents the base language code plus the country code where used. |
| defaultLabel | string | Required. Defines the display label for the language. |
| id | UUID | Represents the component's GUID. |
| type | string | Represents the component type. The only supported value is languageContainer. |

There’s one section per supported language as a container in languages.json

**language container**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e1245">Property</th>

              <th class="featureTableHeader  " id="d444970e1248">Type</th>

              <th class="featureTableHeader  " id="d444970e1251">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e1245" data-title="Property"><span class="keyword parmname">countryCode</span></td>

              <td class="entry" headers="d444970e1248" data-title="Type">string</td>

              <td class="entry" headers="d444970e1251" data-title="Description">Represents the country code of the selected language. This string can be empty.
                It applies only when the selected language has variations depending on the country,
                like Arabic (Algeria) and Arabic (Bahrain). In this case, use <samp class="codeph javascript">countryCode</samp> to distinguish between them. <p class="p">For
                  example:<samp class="codeph javascript">{ languageCode<span class="string">" : "</span>ar<span class="string">", "</span>CountryCode<span class="string">" :
                    </span> <span class="string">"DZ"</span>, <span class="string">"Label"</span> : <span class="string">"Arabic (Algeria) (DZ)"</span>,}, { <span class="string">"Code"</span> : <span class="string">"ar"</span>, <span class="string">"CountryCode"</span> :
                    <span class="string">"BH"</span>, <span class="string">"Label"</span> : <span class="string">"Arabic (Bahrain) (BH)"</span>,}</samp></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1245" data-title="Property"><span class="keyword parmname">fallbackLanguageId</span></td>

              <td class="entry" headers="d444970e1248" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e1251" data-title="Description">Represents the language to use when no content is available for the selected
                language. For example, if a site visitor chooses <strong class="ph uicontrol">Japanese</strong>
                from the language selector, but there’s no content for that page in Japanese, then
                content is displayed in the fallback language. <p class="p">Only one level of fallback is
                  allowed for LWR sites. Here are examples for an LWR site where English is the
                  default language, and Spanish, French, and Finnish are available site
                  languages.</p>
                <ul class="ul bulletList">
                  <li class="li">Not allowed: Spanish falls back to French, and French falls back to Finnish.
                    This configuration includes two levels of fallback.</li>

                  <li class="li">Allowed: Spanish falls back to French, and French falls back to English. This
                    configuration is allowed because English is the site’s default language.</li>

                  <li class="li">Allowed: Spanish falls back to French, and French has no fallback. This
                    configuration includes only one level of fallback.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1245" data-title="Property"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d444970e1248" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e1251" data-title="Description">Represents the component's GUID.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1245" data-title="Property"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d444970e1248" data-title="Type">boolean</td>

              <td class="entry" headers="d444970e1251" data-title="Description">Indicates whether a language is available to site visitors in the language
                selector (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph javascript">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1245" data-title="Property"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d444970e1248" data-title="Type">string</td>

              <td class="entry" headers="d444970e1251" data-title="Description">Defines the display label for a language. The display label appears in any
                language selector components that you add to your site and in the language selector
                in Experience Builder.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1245" data-title="Property"><span class="keyword parmname">languageCode</span></td>

              <td class="entry" headers="d444970e1248" data-title="Type">string</td>

              <td class="entry" headers="d444970e1251" data-title="Description">Represents the language code for the selected language.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1245" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e1248" data-title="Type">string</td>

              <td class="entry" headers="d444970e1251" data-title="Description">Represents the component type. The only supported value is <samp class="codeph javascript">language</samp>.</td>

            </tr>

          </tbody>

        </table>

{
    "defaultCode" : "en\_US",
    "defaultLabel" : "English (US)",
    "id" : "04597c83-0b9d-4f16-9f4d-4ec28bd553b4",
    "type" : "languageContainer",
    "languages" : \[ {
        "languageCode" : "af",
        "countryCode" : "",
        "isActive" : true,
        "label" : "Afrikaans",
        "fallbackLanguageId" : "c6e7fe67-55e0-47b3-ad58-bf49539249f0",
        "id" : "22036d6f-11ce-4f7b-b7f0-f2c409f817ea",
        "type" : "language"
        }
     \]
 }

The page file represents single-page applications in the site. One file per page, named page\_name.json.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Each Experience Builder site is actually a single-page application, which is a web app that loads a single HTML page. Single-page applications use multiple [views](#views_folder) to update the page dynamically as the user interacts with it.

**nativeConfig.json File Properties**

| Property | Type | Description |
| --- | --- | --- |
| showHamburgerMenu | boolean | Required. Controls whether the hamburger menu is shown. |
| mobilePublisherAppUpdateConfig | boolean | Required. Controls whether and which App Version Update message is shown. To avoid service disruptions, users must be on the app version that supports enhanced domains. |
| id | UUID | Represents the component's GUID. |
| type | string | Represents the component type. The only supported value is nativeConfig. |

{
 "id": "a70a0e5e-0400-4531-94dc-8f587daa5946",
 "nativeMobileNavConfig": {
   "showBackButton": true,
   "showHamburgerMenuWithBackButton": false
 },

 "mobilePublisherAppUpdateConfig": {
   "enableAppUpdate" : true,
   "forceAppUpdate" : true,
   "minVersion" : {
       "ios" : {
           "version" : "10.0"
 },
       "android" : {
               "version" : "10.1"
 }
 }
 },
 "nativeTabMenu": {
   "branding": {
     "iconTintColorUnselected": "#C9C5C5",
     "barTintColor": "#FF00FF",
     "iconTintColor": "#555321"
   },
   "menuItems": \[
     {
       "iconAsset": "icon\_homepng",
       "targetUrl": "/"
     },
     {
       "name": "Test",
       "iconAsset": "icon\_filespng",
       "targetUrl": "/files"
     }
   \]
 },
 "showNavMenu": true,
 "type": "nativeConfig"
}

**nativeMobileNavConfig container**

A required container for the configuration for the Native Navigation Bar component.

| Property | Type | Description |
| --- | --- | --- |
| showBackButton | boolean | Controls whether the Back button is shown on iOS devices. |
| showHamburgerMenuWithBackButton | boolean | Controls whether the hamburger menu is shown, in addition to the Back button, on iOS devices. |

**mobilePublisherAppUpdateConfig container**

A required container for the configuration of the App Version Update message.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e1588">Property</th>

              <th class="featureTableHeader  " id="d444970e1591">Type</th>

              <th class="featureTableHeader  " id="d444970e1594">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e1588" data-title="Property"><span class="keyword parmname">enableAppUpdate</span></td>

              <td class="entry" headers="d444970e1591" data-title="Type">boolean</td>

              <td class="entry" headers="d444970e1594" data-title="Description">Controls whether the App Version Update message is shown, to encourage users to
                update by giving them a choice of whether to do so.<p class="p">Set the properties to <samp class="codeph javascript"><span class="string">"enableAppUpdate"</span> : true</samp>, and <samp class="codeph javascript"><span class="string">"forceAppUpdate"</span> : false</samp> to show the message
                  that encourages your users to update.</p>
                <p class="p">If you don’t want to show an update
                  message, for example if all your users are on the correct version or your site
                  uses a custom domain, set the property to <samp class="codeph javascript"><span class="string">"enableAppUpdate"</span> : false</samp>, and don’t use the <samp class="codeph javascript">forceAppUpdate</samp> property.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1588" data-title="Property"><span class="keyword parmname">forceAppUpdate</span></td>

              <td class="entry" headers="d444970e1591" data-title="Type">boolean</td>

              <td class="entry" headers="d444970e1594" data-title="Description">Controls whether the App Version Update message to require users to update is
                shown.<p class="p">Set the properties to <samp class="codeph javascript"><span class="string">"enableAppUpdate"</span> :
                    true</samp>, and <samp class="codeph javascript"><span class="string">"forceAppUpdate"</span> :
                    true</samp> to show the message that requires your users to
                  update.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1588" data-title="Property"><span class="keyword parmname">minVersion</span></td>

              <td class="entry" headers="d444970e1591" data-title="Type">string</td>

              <td class="entry" headers="d444970e1594" data-title="Description">
                <p class="p">Controls the iOS and Android Minimum App Versions. These property values are
                  currently hard coded to ensure that the app versions supporting enhanced domains
                  are used. </p>

              </td>

            </tr>

          </tbody>

        </table>

**nativeTabMenu container**

A required container for the configuration of the hamburger menu and Back button behavior.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e1691">Property</th>

              <th class="featureTableHeader  " id="d444970e1694">Type</th>

              <th class="featureTableHeader  " id="d444970e1697">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e1691" data-title="Property"><span class="keyword parmname">branding</span></td>

              <td class="entry" headers="d444970e1694" data-title="Type">map</td>

              <td class="entry" headers="d444970e1697" data-title="Description">Settings for the Native Navigation Bar component branding. Valid keys are:<ul class="ul bulletList">
                  <li class="li">iconTintColorUnselected</li>

                  <li class="li">iconTintColor</li>

                  <li class="li">barTintColor</li>

                </ul>
                <p class="p">Supply a valid 6 digit hexadecimal as the value for all
                  properties.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1691" data-title="Property"><span class="keyword parmname">menuItems</span></td>

              <td class="entry" headers="d444970e1694" data-title="Type">list</td>

              <td class="entry" headers="d444970e1697" data-title="Description">Items which must be displayed in the Native Navigation Bar component.</td>

            </tr>

          </tbody>

        </table>

**menuItems container**

A container within the nativeTabMenu container that specifies the items displayed in the tab bar of the Native Navigation Bar component.

| Property | Type | Description |
| --- | --- | --- |
| name | string | Optional. The label of the tab bar menu item. |
| targetUrl | string | Required. The relative URL to which the tab bar menu item points. |
| iconAsset | string | Required. Name of the ContentAsset to use for the tab bar menu item. |

**page\_name.json File Properties**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e1845">Property</th>

              <th class="featureTableHeader  " id="d444970e1848">Type</th>

              <th class="featureTableHeader  " id="d444970e1851">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e1845" data-title="Property"><span class="keyword parmname">cmsSettings</span></td>

              <td class="entry" headers="d444970e1848" data-title="Type">map</td>

              <td class="entry" headers="d444970e1851" data-title="Description">Settings for the CMS Connect header and footer. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">headerName</samp></li>

                  <li class="li"><samp class="codeph nolang">headerUrl</samp></li>

                  <li class="li"><samp class="codeph nolang">headerPersonalization</samp></li>

                  <li class="li"><samp class="codeph nolang">footerName</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">footerUrl</samp>
                  </li>

                  <li class="li"><samp class="codeph nolang">footerPersonalization</samp></li>

                </ul>
                Both source and target org must have the CMSConnect and CMSPersonalization org
                perms enabled for settings to be retrieved.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1845" data-title="Property"><span class="keyword parmname">currentThemeId</span></td>

              <td class="entry" headers="d444970e1848" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e1851" data-title="Description">Required. Represents the UUID of the site's current theme. This field is
                available for <span class="ph filepath">mainAppPage.json</span> and
                <span class="ph filepath">loginAppPage.json</span> (where applicable).
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1845" data-title="Property"><span class="keyword parmname">headMarkup</span></td>

              <td class="entry" headers="d444970e1848" data-title="Type">string</td>

              <td class="entry" headers="d444970e1851" data-title="Description">Required. Allows the addition of custom markup to the site's main page <samp class="codeph html"><span class="tag">&lt;head</span>&gt;</samp> tag. Similar to using <span class="ph menucascade"><strong class="ph uicontrol">Experience Builder</strong> | <strong class="ph uicontrol">Setting</strong> | <strong class="ph uicontrol">Advanced</strong> | <strong class="ph uicontrol">Head Markup</strong></span> See <a class="xref" href="https://help.salesforce.com/articleView?id=community_builder_page_head.htm&amp;type=5&amp;language=en_US" target="_blank">Salesforce Help for markup guidance</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1845" data-title="Property"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d444970e1848" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e1851" data-title="Description">Required. Represents the component's GUID.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1845" data-title="Property"><span class="keyword parmname">isRelaxedCSPLevel</span></td>

              <td class="entry" headers="d444970e1848" data-title="Type">boolean</td>

              <td class="entry" headers="d444970e1851" data-title="Description">Controls the ability to run scripts and script access to third-party hosts. The
                default is <samp class="codeph javascript">false</samp>. This field is available
                for <span class="ph filepath">mainAppPage.json</span> and <span class="ph filepath">loginAppPage.json</span>
                (where applicable).</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1845" data-title="Property"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d444970e1848" data-title="Type">string</td>

              <td class="entry" headers="d444970e1851" data-title="Description">Required. Represents the name of the page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1845" data-title="Property"><span class="keyword parmname">templateName</span></td>

              <td class="entry" headers="d444970e1848" data-title="Type">string</td>

              <td class="entry" headers="d444970e1851" data-title="Description">Required. The unique developer name of the template. Allowed values include:<ul class="ul bulletList">
                  <li class="li">CPT Community Template (which represents the Customer Account Portal
                    template)</li>

                  <li class="li">Help Center Template (which represents the Help Center template)</li>

                  <li class="li">microsite-template-marketing (which represents the Microsite (LWR)
                    template</li>

                  <li class="li">PRM Community Template (which represents the Partner Central template)</li>

                  <li class="li">Service Community Template (which represents the Customer Service
                    template)</li>

                  <li class="li">Starter Template (which represents the Build Your Own (Aura) template)</li>

                  <li class="li">talon-template-byo (which represents the Build Your Own (LWR) template)</li>

                  <li class="li">
                    <var class="keyword varname">Custom_template_name</var> (which is the name of a customized
                    template that was exported as a Bolt Solution)
                  </li>

                </ul>
                <p class="p">Alternatively, you can retrieve a list of allowed template name values using
                  Connect REST API. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_resources_communities_templates.htm" target="_blank" title="HTML (New Window)">Experience Builder Templates</a> in the <cite class="cite">Connect REST API Developer
                    Guide</cite>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e1845" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e1848" data-title="Type">string</td>

              <td class="entry" headers="d444970e1851" data-title="Description">Required. Represents the component type. The only supported value is <samp class="codeph javascript">appPage</samp>.</td>

            </tr>

          </tbody>

        </table>

{
    "headMarkup" : null,
    "isRelaxedCSPLevel" : false,
    "templateName" : "Starter Template",
    "cmsSettings" : { },
    "currentThemeId" : "ff52089c-6ad9-4dd9-b5b5-251d4a117ce3",
    "label" : "main",
    "id" : "df9907cb-6e68-4ca1-8bb2-51173ca5374e",
    "type" : "appPage"
}

## routes Folder

The routes folder contains one JSON file per page, named <page\_name>.json.

**<page\_name>.json**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e2109">Property</th>

              <th class="featureTableHeader  " id="d444970e2112">Type</th>

              <th class="featureTableHeader  " id="d444970e2115">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">activeViewId</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Represents the default view of the route. Used when there are no
                defined audiences or the user doesn’t match any audience.<p class="p">Available in API version
                  48.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">appPageId</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Represents the single page application (SPA) page for the route. It
                points to either <span class="ph filepath">main.json</span> or
                <span class="ph filepath">login.json</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">configurationTags</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">string[]</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Represents the configuration tags for the route. The only supported
                value is <samp class="codeph javascript">allow-<span class="keyword">in</span>-<span class="keyword">static</span>-site</samp>. Available in
                API Version 51.0 and later.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>This is an internal property and must not be
                            edited.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">devName</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">string[]</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Represents the unique API name that’s defined when creating a new
                route. Available in API version 59.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Represents the component GUID. Inherited from the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">string</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Represents the name of the route. Inherited from the
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">objectApiName</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">string</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. The name of the custom object API. (Not available for standard
                objects.)</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">pageAccess</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">string</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Identifies the status of a route as public or private. When set to
                the default value <samp class="codeph javascript">UseParent</samp>, the status of
                the site determines the status of the route. Not editable from the user interface
                for routes that are always private. Valid values are <samp class="codeph javascript">UseParent</samp>, <samp class="codeph javascript">Public</samp>, and <samp class="codeph javascript">RequiresLogin</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">routeType</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">string</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Identifies the type of route. Value is unique among all routes that
                share the same SPA page. The value in <span class="keyword parmname"><a class="xref" href="#views_folder">viewType</a></span> must match.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">string</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Represents the component type. The only supported value is <samp class="codeph javascript">route</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2109" data-title="Property"><span class="keyword parmname">urlPrefix</span></td>

              <td class="entry" headers="d444970e2112" data-title="Type">string</td>

              <td class="entry" headers="d444970e2115" data-title="Description">Required. Represents the base URL for the route.</td>

            </tr>

          </tbody>

        </table>

{
    "urlPrefix" : "",
    "appPageId" : "b5fe94e2-071f-47b2-b76d-427a624cb407",
    “configurationTags” : “allow-in\-static\-site”
    "routeType" : "home",
    "pageAccess" : "UseParent",
    "label" : "Home",
    "id" : "c7263124-7bc4-4147-a39a-25fe7e305b98",
    "type" : "route"
}

## themes Folder

The themes folder contains one JSON file per theme named theme\_name.json.

**theme\_name.json**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e2343">Property</th>

              <th class="featureTableHeader  " id="d444970e2346">Type</th>

              <th class="featureTableHeader  " id="d444970e2349">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e2343" data-title="Property"><span class="keyword parmname">activeBrandingSetId</span></td>

              <td class="entry" headers="d444970e2346" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e2349" data-title="Description">The id of the branding set currently in use. The branding set's <samp class="codeph javascript">definitionName</samp> must match the theme's <samp class="codeph javascript">brandingSetReference</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2343" data-title="Property"><span class="keyword parmname">customCSS</span></td>

              <td class="entry" headers="d444970e2346" data-title="Type">string</td>

              <td class="entry" headers="d444970e2349" data-title="Description">Custom CSS for pages created in the Experience Builder template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2343" data-title="Property"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d444970e2346" data-title="Type">string</td>

              <td class="entry" headers="d444970e2349" data-title="Description">Required. The unique developer name of the theme. Most themes derive their
                names directly, for example Jepson uses <samp class="codeph javascript">jespon</samp> for its <span class="keyword parmname">developerName</span>. <p class="p">Standard templates
                  have unique values:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph javascript">cpt</samp> for Customer Account Portal
                  </li>

                  <li class="li">
                    <samp class="codeph javascript">service</samp> for Customer Service
                  </li>

                  <li class="li">
                    <samp class="codeph javascript">helpCenter</samp> for Help Center
                  </li>

                  <li class="li">
                    <samp class="codeph javascript">prm</samp> for Partner Central
                  </li>

                  <li class="li">
                    <samp class="codeph javascript">starter</samp> for Build Your Own
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2343" data-title="Property"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d444970e2346" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e2349" data-title="Description">Required. Represents the component's GUID.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2343" data-title="Property"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d444970e2346" data-title="Type">string</td>

              <td class="entry" headers="d444970e2349" data-title="Description">Represents the name of the theme.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2343" data-title="Property"><span class="keyword parmname">layouts</span></td>

              <td class="entry" headers="d444970e2346" data-title="Type">map</td>

              <td class="entry" headers="d444970e2349" data-title="Description">Required. Maps <samp class="codeph javascript">ThemeLayoutType</samp> to
                UUID, and contains the definition of the ThemeLayout. Login and Inner theme layouts
                are always required.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2343" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e2346" data-title="Type">string</td>

              <td class="entry" headers="d444970e2349" data-title="Description">Required. Represents the component type. The only supported value is <samp class="codeph javascript">theme</samp>.</td>

            </tr>

          </tbody>

        </table>

{
    "developerName" : "cpt",
    "layouts" : {
        "Login" : "12162c3e-06ac-43a9-adc7-db36ae5140b0",
        "Inner" : "c09d58be-0622-4fc4-806a-ed34174929f9"
    },
    "customCSS" : "",
    "activeBrandingSetId" : "283407c3-5938-4a6b-b97f-621cda6968c8",
    "label" : "Customer Account Portal",
    "id" : "ff52089c-6ad9-4dd9-b5b5-251d4a117ce3",
    "type" : "theme",
    "views" : \[ {
        "componentName" : "salesforceIdentity:loginBody2",
        "label" : "Login",
        "id" : "12162c3e-06ac-43a9-adc7-db36ae5140b0",
        "type" : "view",
        "regions" : \[ {
            "regionName" : "header",
            "id" : "f8354922-11f2-495d-9d89-0a51943af2b0",
            "type" : "region",
            "components" : \[ \]
        } \]
    } \]
}

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Views can be children of a theme. These children are structured the same as [views](#views_folder) in the views folder.

## variations Folder

Experience variations let you change the default behavior of the Experience Builder site based on the audience. The variations folder contains one JSON file per experience variation. The file is named experienceVariation\_name.json.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

- Experience variations are available in API version 47.0 and later.
- The name of your JSON file must match the developerName of your variation to avoid issues when deploying a site more than one time.

Four distinct types of variations are supported: branding sets, page variations, component visibility, and component attributes. The different variations are indicated through the componentVariant container.

For example, you want the site to show a page variation for the home page when a user meets certain audience criteria. To achieve this, create an audience and then target that audience to your experience variation using targetId in the componentVariant container of the experience variation definition file.

**experienceVariation\_name.json**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e2579">Property</th>

              <th class="featureTableHeader  " id="d444970e2582">Type</th>

              <th class="featureTableHeader  " id="d444970e2585">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e2579" data-title="Property"><span class="keyword parmname">componentVariants</span></td>

              <td class="entry" headers="d444970e2582" data-title="Type">list</td>

              <td class="entry" headers="d444970e2585" data-title="Description">Required. A list of component variants that belong to this experience
                variation. <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Only one component variant per experience variation is
                            allowed.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2579" data-title="Property"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d444970e2582" data-title="Type">string</td>

              <td class="entry" headers="d444970e2585" data-title="Description">Required. The unique developer name of the experience variation. This name is
                used in the <samp class="codeph javascript">targetValue</samp> field of a
                Personalization API target and can’t be updated after it’s set.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>For more
                            information, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_audience.htm" title="Represents the audience in an Experience Builder site. An audience consists of different types of criteria, where the audience can be assigned and used for targeting in a site. This type extends the Metadata metadata type and inherits its fullName field.">Audience</a>.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2579" data-title="Property"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d444970e2582" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e2585" data-title="Description">Required. Represents the GUID of the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2579" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e2582" data-title="Type">string</td>

              <td class="entry" headers="d444970e2585" data-title="Description">Required. Represents the type of the component. The only supported value is
                <samp class="codeph javascript">experienceVariation</samp>.
              </td>

            </tr>

          </tbody>

        </table>

When implemented, there’s one container in each experienceVariation\_name.json file describing the variation.

**componentVariant container**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e2695">Property</th>

              <th class="featureTableHeader  " id="d444970e2698">Type</th>

              <th class="featureTableHeader  " id="d444970e2701">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e2695" data-title="Property"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d444970e2698" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e2701" data-title="Description">Required. Represents the GUID of the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2695" data-title="Property"><span class="keyword parmname">propertyOverrides</span></td>

              <td class="entry" headers="d444970e2698" data-title="Type">map</td>

              <td class="entry" headers="d444970e2701" data-title="Description">Required. Defines the property overrides for the given theme, route, or
                component <span class="keyword parmname">targetId</span>.<p class="p">For example, if
                  the <span class="keyword parmname">targetId</span> is pointing to a theme, you can override the
                  <span class="keyword parmname">defaultBrandingSet</span> property of the theme to use a different
                  branding set for this experience variation.
                </p>
                <div class="p">Supported property overrides:<dl class="dl detailList">

                    <dt class="dt dlterm"><samp class="codeph javascript">activeBrandingSetId</samp></dt>

                    <dd class="dd">Defines which branding set to use when <span class="keyword parmname">targetId</span> is a
                      theme. Uses the
                      format:<div class="codeSection javascript">
                        <pre class="codeblock javascript"><span class="string">"activeBrandingSetId"</span> : <span class="string">"</span><var class="keyword varname">ID_of_brandingset</var><span class="string">"</span></pre>
                      </div>
                    </dd>



                    <dt class="dt dlterm"><samp class="codeph javascript">activeViewId</samp></dt>

                    <dd class="dd">Defines which page variation to use when <span class="keyword parmname">targetId</span> is a route. Uses the
                      format:<div class="codeSection javascript">
                        <pre class="codeblock javascript"><span class="string">"activeViewId"</span> : <span class="string">"</span><var class="keyword varname">ID_of_view</var><span class="string">"</span></pre>
                      </div>
                    </dd>



                    <dt class="dt dlterm"><samp class="codeph javascript">componentAttributes</samp></dt>

                    <dd class="dd">Supported only for CMS Collection components and navigation components,
                      such as Navigation Menu or Tile Menu. Components can be placed in header and
                      footer regions, and also in the view body.</dd>

                    <dd class="dd">
                      <ul class="ul bulletList">
                        <li class="li">Defines which navigation linkset to display when
                          <span class="keyword parmname">targetId</span> is a navigation component.<p class="p">The value
                            of the property is a JSON container with a single key-value pair
                            denoting the attribute and the value of the attribute.</p>
                          <div class="p">
                            <samp class="codeph javascript">NavigationMenuEditorRefresh</samp> is the
                            only supported attribute. Uses the
                            format:<div class="codeSection javascript">
                              <pre class="codeblock javascript"><span class="string">"componentAttributes"</span> : {
   <span class="string">"NavigationMenuEditorRefresh"</span> : <span class="string">"</span><var class="keyword varname">linkset_name</var><span class="string">"
</span>}</pre>
                            </div>
                          </div>
                        </li>

                        <li class="li">Defines which content collection to display when
                          <span class="keyword parmname">targetId</span> is a CMS Collection component.<div class="p">The
                            value of the property is a JSON container with a single key-value pair
                            denoting the path to the attribute and the value of the attribute.
                            <samp class="codeph javascript">config/dataProviderDefinition/attributes/dataProviderInfo/apiName</samp>
                            is the only supported attribute. Uses the
                            format:<div class="codeSection javascript">
                              <pre class="codeblock javascript"><span class="string">"componentAttributes"</span> : {
   <span class="string">"config/dataProviderDefinition/attributes
</span>/dataProviderInfo/apiName<span class="string">":"</span><var class="keyword varname">collection_name</var><span class="string">"
</span>}</pre>
                            </div>
                          </div>
                        </li>

                      </ul>

                    </dd>



                    <dt class="dt dlterm"><samp class="codeph javascript">isVisible</samp></dt>

                    <dd class="dd">Defines whether a component is visible for the audience when <span class="keyword parmname">targetId</span> is a component. Unsupported
                      for components in header or footer regions. Uses the
                      format:<div class="codeSection javascript">
                        <pre class="codeblock javascript"><span class="string">"isVisible"</span>: <var class="keyword varname">boolean</var></pre>
                      </div>
                    </dd>


                  </dl>
                </div>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>
                          </p><ul class="ul bulletList">
                            <li class="li">Only one entry in the map is allowed.</li>

                            <li class="li">For a component, you can vary either its visibility or attributes but not
                              both together.</li>

                          </ul>

                          <p></p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2695" data-title="Property"><span class="keyword parmname">targetId</span></td>

              <td class="entry" headers="d444970e2698" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e2701" data-title="Description">Required. The UUID of the item whose properties you’re overriding. Must be the
                ID of a theme, route, or component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e2695" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e2698" data-title="Type">string</td>

              <td class="entry" headers="d444970e2701" data-title="Description">Required. Represents the type of the component. The only supported value is
                <samp class="codeph javascript">experienceVariation</samp>.
              </td>

            </tr>

          </tbody>

        </table>

**Example of an experience variation for a branding set**

{
   "id": "64e93604-78fa-11e9-8f9e-2a86e4085a59",
   "developerName": "BrandingVariation",
   "type": "experienceVariation",
   "componentVariants": \[{
      "id": "4bf0af78-8d73-11e9-bc42-526af7764f64",
      "type": "componentVariant",
      // Theme UUID
      "targetId": "c810858e-78fa-11e9-8f9e-2a86e4085a59",
      "propertyOverrides": {
         // Brandingset UUID
         "activeBrandingSetId": "be9f4760-78fa-11e9-8f9e-2a86e4085a59" 
      }
   }\]
}

**Example of an experience variation for a page variation**

{
   "id": "64e93604-78fa-11e9-8f9e-2a86e4085a59",
   "developerName": "PageVariation",
   "type": "experienceVariation",   
   "componentVariants": \[{
      "id": "4bf0af78-8d73-11e9-bc42-526af7764f64",
      "type": "componentVariant",
      // Route UUID
      "targetId": "c810858e-78fa-11e9-8f9e-2a86e4085a59", 
      "propertyOverrides": {
         // View UUID
         "activeViewId": "be9f4760-78fa-11e9-8f9e-2a86e4085a59"
      }
   }\]
}

**Example of an experience variation for component visibility**

{
   "id": "64e93604-78fa-11e9-8f9e-2a86e4085a59",
   "developerName": "ComponentVisibilityVariation",
   "type": "experienceVariation",
   "componentVariants": \[{
      "id": "4bf0af78-8d73-11e9-bc42-526af7764f64",
      "type": "componentVariant",
      // Component UUID
      "targetId": "c810858e-78fa-11e9-8f9e-2a86e4085a59", 
      "propertyOverrides": {
         "isVisible": true
      }
   }\]
}

**Example of a component variation for a CMS Collection component**

{
   "id" : "6ce1260f-cb01-45a0-8947-f2d85602a3db"
   "developerName": "Home\_CMS\_Collection\_Component\_Properties",
   "type": "experienceVariation",
   "componentVariants": \[{
      "id" : "3gh1260f-cb01-45a0-8947-f2d92037a4db"
      "type": "componentVariant",
      "targetId": "d77369e6-7230-43e7-9b59-6e91c47b3273",
      "propertyOverrides": {
         "componentAttributes": {
            "config/dataProviderDefinition/attributes/dataProviderInfo/apiName":"SilverCollection"
         }
      },
   }\],
}

**Example of a component variation for Navigation Menu component**

{
   "id" : "8cf943b8-525d-4c13-a719-6ebc7d61a81e",
   "developerName" : "Default\_Navigation\_Menu\_Component\_Properties", 
   "type" : "experienceVariation",
   "componentVariants" : \[{
      "id" : "5be1260f-cb01-45a0-8947-f2d85602a4db",
      "type" : "componentVariant",
      "targetId" : "fdf9eb51-ddc5-4e79-9ea8-5b94f5ca8db4",
      "propertyOverrides" : {
         "componentAttributes" : {
            "NavigationMenuEditorRefresh" : "NavMenu1"
         }
      },
   }\],
}

## views Folder

The views folder contains several JSON files that each define a view. Each Experience Builder site is built from single-page applications, which are web apps that load a single HTML page. Single-page applications consist of multiple views that update the page dynamically as the user interacts with it.

A view is made up of regions that contain other regions or components in the rendered page for the user. Within the views folder there’s one file per view, named view\_name.json.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Single-page applications in your site are defined in the [page files](#page_file_configfolder) of the [config folder](#config_folder).

**view\_name.json**

| Property | Type | Description |
| --- | --- | --- |
| appPageId | UUID | Required. Single page application (SPA) page ID of the view. It points to either main.json or login.json. |
| componentName | string | Required. The FQN of the layout component. The component must implement forceCommunity:layout or, for theme layouts, forceCommunity:themeLayout |
| id | UUID | Required. Represents the GUID of the component. |
| label | string | Required. The name that appears in **Experience Builder** | **Settings** | **Theme** | **Configure**. |
| themeLayoutType | string | Theme layout type of the view (exposed only for views). |
| type | string | Required. Represents the type of the component. The only supported value is view. |
| viewType | string | Required. Matches [routeType](#routes_folder) for the route. |

There are one or more regions as a container in each <view\_name>.json

**region container**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e3159">Property</th>

              <th class="featureTableHeader  " id="d444970e3162">Type</th>

              <th class="featureTableHeader  " id="d444970e3165">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e3159" data-title="Property"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d444970e3162" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e3165" data-title="Description">Required. Represents the component GUID.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e3159" data-title="Property"><span class="keyword parmname">regionLabel</span></td>

              <td class="entry" headers="d444970e3162" data-title="Type">string</td>

              <td class="entry" headers="d444970e3165" data-title="Description">Specifies region labels for tabs.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>This property is present only for tab
                            regions that are children of a component.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e3159" data-title="Property"><span class="keyword parmname">regionName</span></td>

              <td class="entry" headers="d444970e3162" data-title="Type">string</td>

              <td class="entry" headers="d444970e3165" data-title="Description">Required. Matches the design attribute in the design file of the layout
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e3159" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e3162" data-title="Type">string</td>

              <td class="entry" headers="d444970e3165" data-title="Description">Required. Represents the component type. The only supported value is <samp class="codeph javascript">region</samp>.</td>

            </tr>

          </tbody>

        </table>

Each <view\_name>.json file contains a hidden region called sfdcHiddenRegion. The hidden region contains a component that represents the SEO assistant component. In Aura sites, the component’s definition is forceCommunity:seoAssistant, and in LWR sites, the component’s definition is community\_builder:seoAssistant. This component corresponds to the SEO page properties that you can configure in Experience Builder and isn’t visible on your pages. To improve search engine results, use the SEO assistant component to set the customHeadTags, description, and pageTitle properties for your public and custom site pages. You can’t edit the other properties associated with the SEO assistant component. To learn more about what the title, description, and custom head tags properties represent and which head tags are allowed, see [SEO Page Properties in Experience Builder](https://help.salesforce.com/s/articleView?id=experience.networks_seo_tags.htm&type=5&language=en_US "HTML (New Window)").

There are one or more components as a container in the region section of each <view\_name>.json

**component container**

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d444970e3290">Property</th>

              <th class="featureTableHeader  " id="d444970e3293">Type</th>

              <th class="featureTableHeader  " id="d444970e3296">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d444970e3290" data-title="Property"><span class="keyword parmname">componentAttributes</span></td>

              <td class="entry" headers="d444970e3293" data-title="Type">HashMap</td>

              <td class="entry" headers="d444970e3296" data-title="Description">Required. The design attribute values of the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e3290" data-title="Property"><span class="keyword parmname">componentName</span></td>

              <td class="entry" headers="d444970e3293" data-title="Type">string</td>

              <td class="entry" headers="d444970e3296" data-title="Description">Required. The FQN of the component. Only components that can be used in the
                component panel in Experience Builder can be used in this field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e3290" data-title="Property"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d444970e3293" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e3296" data-title="Description">Required. Represents the component GUID.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>If you add a component to
                            ExperienceBundle, you can enter any value because the system automatically
                            generates a UUID for the component when deployed.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e3290" data-title="Property"><span class="keyword parmname">renderPriority</span></td>

              <td class="entry" headers="d444970e3293" data-title="Type">enums.priority</td>

              <td class="entry" headers="d444970e3296" data-title="Description">Sets priority value for progressive rendering of the component. Possible
                Values: <samp class="codeph javascript">HIGHEST</samp>, <samp class="codeph javascript">HIGH</samp>, <samp class="codeph javascript">NEUTRAL</samp>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Only evaluated if the site has progressive rendering turned
                            on in <span class="ph menucascade"><strong class="ph uicontrol">Experience Builder</strong> | <strong class="ph uicontrol">Settings</strong> | <strong class="ph uicontrol">Advanced</strong></span>.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e3290" data-title="Property"><span class="keyword parmname">renditionMap</span></td>

              <td class="entry" headers="d444970e3293" data-title="Type">HashMap</td>

              <td class="entry" headers="d444970e3296" data-title="Description">Map of different rendition keys to UUIDs of RenditionComponents.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e3290" data-title="Property"><span class="keyword parmname">scopedBrandingSetID</span></td>

              <td class="entry" headers="d444970e3293" data-title="Type">UUID</td>

              <td class="entry" headers="d444970e3296" data-title="Description">Required for LWR sites. Not applicable for Aura sites. Represents the ID of a
                branding set for a specific <samp class="codeph nolang">community_layout:section</samp> component. Available in API Version 52.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d444970e3290" data-title="Property"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d444970e3293" data-title="Type">string</td>

              <td class="entry" headers="d444970e3296" data-title="Description">Required. Represents the component type. The only supported value is <samp class="codeph javascript">component</samp>.</td>

            </tr>

          </tbody>

        </table>

Each component can have a rendition container in each <view\_name>.json

**rendition container**

| Property | Type | Description |
| --- | --- | --- |
| id | UUID | Required. Represents the component GUID. |
| renditionValue | map | Map of different variations of a component, such as different languages of text. |
| type | string | Required. Represents the component type. The only supported value is renditionComponent. |

{
    "themeLayoutType" : "Inner",
    "viewType" : "account-management",
    "appPageId" : "df9907cb-6e68-4ca1-8bb2-51173ca5374e",
    "componentName" : "siteforce:sldsOneColLayout",
    "label" : "Account Management",
    "id" : "9ca8fa47-8e87-4915-a6f7-c2d8d37f3076",
    "type" : "view",
    "regions" : \[ {
         "regionName" : "content",
         "id" : "969ada98-7d72-4e45-8a10-7db51fae247c",
         "type" : "region",
         "components" : \[ {
            "componentName" : "forceCommunity:tabset",
            "componentAttributes" : {
                "tabsetConfig" : "{"UUID":"4711850e-ffdc-4375-a45e-f716bcdbbb1c","activeTab":"tab1",
                \\"useOverflowMenu":false,"tabs":\[{"UUID":"bc8fb51f-4783-43d4-9376-60c07677a367","tabName":"Members",
                \\"tabKey":"tab1","locked":false,"allowGuestUser":false,"seedComponents":\[{"fqn":"forceCommunity:relatedList",
                \\"attributes":{"parentRecordId":"{!CurrentUser.accountId}","relatedListName":"Users","customTitle":"Members",
                \\"showCustomTitle":"true","showBreadCrumbs":"false","showRowNumbers":"false","showManualRefreshButton":"false"}}\]},
                {\\"UUID":"f2793a99-b757-4be4-846f-dc98a13a8139","tabName":"Branding","tabKey":"tab2","locked":false,
                \\"allowGuestUser":false,"seedComponents":\[{"fqn":"forceCommunity:accountBrandRecord",
                \\"attributes":{"recordId":"{!CurrentUser.accountId}"}}\]}\]}",
                "regions" : ""
            },
            "renderPriority" : "NEUTRAL",
            "renditionMap" : { },
            "id" : "4711850e-ffdc-4375-a45e-f716bcdbbb1c",
            "type" : "component",
            "renditions" : \[ {
               "renditionValue" : {
                  "LumenInstanceAttributes" : {
                  "richTextValue" : "<p>new text</p>"
                  }
               },
              "id" : "9d8878df-f520-4010-861c-57b930a3daab",
              "type" : "renditionComponent"
            } \]
        } \]
    } \]
}

## Declarative Metadata Sample Definition

Here’s an example of an ExperienceBundle declaration. For individual folder and file examples for the bundled code, see [brandingSets](#brandingSets_folder), [config](#config_folder), [routes](#routes_folder), [themes](#themes_folder), [variations](#variations_folder), and [views](#views_folder).

<xsd:complexType name="ExperienceBundle">
    <xsd:complexContent\>
        <xsd:extension base="tns:Metadata">
            <xsd:sequence\>
                <xsd:element name="experienceResources" minOccurs="0" type="tns:ExperienceResources"/>
                <xsd:element name="label" type="xsd:string"/>
                <xsd:element name="type" type="tns:SiteType"/>
            </xsd:sequence\>
        </xsd:extension\>
    </xsd:complexContent\>
</xsd:complexType\>
    <xsd:complexType name="ExperienceResources">
        <xsd:sequence\>
            <xsd:element name="experienceResource" minOccurs="0" maxOccurs="unbounded" type="tns:ExperienceResource"/>
        </xsd:sequence\>
    </xsd:complexType\>
<xsd:complexType name="ExperienceResource">
    <xsd:sequence\>
        <xsd:element name="fileName" type="xsd:string"/>
        <xsd:element name="format" type="xsd:string"/>
        <xsd:element name="source" minOccurs="0" type="xsd:base64Binary"/>
        <xsd:element name="type" type="xsd:string"/>
    </xsd:sequence\>
</xsd:complexType\>

## Usage

![Tip](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_tip.png)

#### Tip

Before you update the .json files of an Experience Builder site, we recommend making a copy of the site’s folder as a backup.

When you add a component to ExperienceBundle, you can enter any value for the id, because the system automatically generates a UUID for the component when deployed.

When deploying an Experience Builder site with ExperienceBundle, ensure that the SiteDotCom type isn’t included in the manifest file.

ExperienceBundle doesn’t support retrieving and deploying across different API versions. If you’re trying to upgrade ExperienceBundle metadata from an earlier API version to a later one—for example, from API version 48.0 to 49.0—take the following steps:

1. Set the API version in the package.xml manifest file to 48.0 and deploy the package.
2. Then, set the API version in package.xml to 49.0.
3. To get the latest ExperienceBundle updates, retrieve the 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [ExperienceBundleSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencebundlesettings.htm "Represents the org setting that enables the ExperienceBundle metadata type for Aura sites in Experience Cloud. The setting doesn’t affect LWR sites, which use ExperienceBundle by default. This type extends the Metadata metadata type and inherits its fullName field.")
- [_Developer Guide:_ ExperienceBundle for Experience Builder Sites](https://developer.salesforce.com/docs/atlas.en-us.264.0.communities_dev.meta/communities_dev/communities_dev_migrate_expbundle.htm "Developer Guide: ExperienceBundle for Experience
    Builder Sites - HTML (New Window)")

<!-- document id=0081a390b8011554d038b8baf49ebcdf6da271c41551dea2ac877ce9404984ac url=/legacydeveloper/current/en-us/api_meta/meta_experiencebundlesettings.md -->

# ExperienceBundleSettings

Represents the org setting that enables the ExperienceBundle metadata type for Aura sites in Experience Cloud. The setting doesn’t affect LWR sites, which use ExperienceBundle by default. This type extends the Metadata metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

ExperienceBundle is a text-based code structure of the settings and site components, such as pages, branding sets, and themes, that make up an Experience Builder site. Developers can quickly update and deploy one or more Experience Builder sites programmatically using their preferred development tools.

## File Suffix and Directory Location

ExperienceBundleSettings values are stored in a single file named ExperienceBundle.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ExperienceBundleSettings is available in API version 46.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableExperienceBundleMetadata | boolean | Indicates whether the ExperienceBundle metadata type is enabled for Aura sites. Default is false. LWR sites use ExperienceBundle by default. |

## Declarative Metadata Sample Definition

Here’s an example of ExperienceBundle.settings that references the previous definition.

<ExperienceBundleSettings xmlns="http://soap.sforce.com/2006/04/metadata">
        <enableExperienceBundleMetadata\>true</enableExperienceBundleMetadata\>
</ExperienceBundleSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [ExperienceBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencebundle.htm "Represents a text-based code structure of the settings and site components, such as pages, branding sets, and themes that make up an Experience Builder site. Developers can quickly update and deploy Experience Builder sites programmatically using their preferred development tools. This type extends the Metadata metadata type and inherits its fullName field.")

<!-- document id=a23995a16425e4d772f04d8ebc009de4ffbdb56c8297ba0c21f9001495821704 url=/legacydeveloper/current/en-us/api_meta/meta_experiencepropertytypebundle.md -->

# ExperiencePropertyTypeBundle (Beta)

Represents a property type. Replaced in Spring ’26 by the updated LightningPropertyType. When you create a custom property type for a Lightning web component, use LightningPropertyType instead, and deploy that bundle to your org.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms](https://www.salesforce.com/company/legal/agreements/ "HTML (New Window)").

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

To create a custom property type, see [LightningPropertyType](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_lightningtypebundle.htm).

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Structure and Directory Location

ExperiencePropertyTypeBundle components are stored in the experiencePropertyTypeBundles folder. Here’s an example of how the folder is structured.

+--myMetadataPackage
    +--experiencePropertyTypeBundles (1)
        +--addressProperty (2)
            +--schema.json (3)
            +--design.json (4)

- In the experiencePropertyTypeBundles folder (1) is a folder for each custom property type.
- Each custom property type folder is named in the format propertyTypeName. In this example (2), the name is addressProperty.
- Each propertyTypeName folder contains a JSON file or files that define the property type.
    - A schema.json file (3), which is a JSON schema that drives the property type validation
    - An optional design.json file (4), which provides the user experience and property editor information for that property type

## Version

ExperiencePropertyTypeBundle components are available in API version 58.0 and later.

## Special Access Rules

The ExperiencePropertyTypeBundle metadata type is available only for use with Lightning web components on LWR sites.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Explanatory text about the property type.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for ExperiencePropertyTypeBundle, which is defined when the ExperiencePropertyTypeBundle is created.





 |
| resources | 

Field Type

[ExperiencePropertyTypeBundleResource\[\]](#ExperiencePropertyTypeBundleResource)

Description

A list of source files in the experiencePropertyTypeBundles folder.



 |

## ExperiencePropertyTypeBundleResource

Represents a resource inside ExperiencePropertyTypeBundle.

| Field Name | Description |
| --- | --- |
| fileName | 
Field Type

string

Description

Required. The file name of the resource.





 |
| filePath | 

Field Type

string

Description

Required. The file path of the resource.





 |
| source | 

Field Type

base64Binary

Description

Required. The content of the resource.





 |

## Declarative Metadata Sample Definition

This package.xml file retrieves all the ExperiencePropertyTypeBundle components in an org.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExperiencePropertyTypeBundle</name\>
    </types\>
    <version\>58.0</version\>
</Package\>

In the retrieved .zip file, each property type is nested under an experiencePropertyTypeBundles folder.

This example shows the directory structure in the .zip file of a property type named addressProperty.

experiencePropertyTypeBundles
    addressProperty
        schema.json
        design.json

Here are the contents of the files in the addressProperty directory. The addressProperty is a complex type that includes subproperties for firstName, lastName, address, city, state, and postal code. Each subproperty is a primitive type.

Contents of schema.json:

{
 "title": "Simple Address Type",
 "lightning:type": "lightning\_\_objectType",
 "properties": {
   "firstName": {
     "lightning:type": "lightning\_\_textType",
     "title": "First Name"
   },
   "lastName": {
     "lightning:type": "lightning\_\_textType",
     "title": "Last Name"
   },
   "address": {
     "lightning:type": "lightning\_\_textType",
     "title": "Address Line 1"
   },
   "city": {
     "lightning:type": "lightning\_\_textType",
     "title": "City"
   },
   "state": {
     "lightning:type": "lightning\_\_textType",
     "title": "State"
   },
   "postalCode": {
     "lightning:type": "lightning\_\_numberType",
     "title": "Postal Code"
   }
 },
 "required": \["firstName", "lastName"\]
}

Contents of design.json (an optional file):

{
 "definition": "lightning/tabsetLayout",
 "children": \[
   {
     "definition": "lightning/tabLayout",
     “attributes”: {
        “label”: “First Tab”
     },
     “children”: \[
       {
         "definition": "lightning/propertyLayout",
         "attributes": {
           "property": "aProperty"
         }
       },
       {
         "definition": "lightning/propertyLayout",
         "attributes": {
           "property": "bProperty"
         }
       },
    \]
   },
     {
     "definition": "lightning/tabLayout",
     “attributes”: {
        “label”: “Second Tab”
     },
     “children”: \[
       {
         "definition": "lightning/propertyLayout",
         "attributes": {
           "property": "cProperty"
         }
       },
     \]
   },
 \]
}

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

#### See Also

- [_External Link_: Custom Property Types and Property Editors (Beta)](https://resources.docs.salesforce.com/rel1/doc/en-us/static/pdf/custom_property_types_and_editors.pdf)

<!-- document id=98811eb8b87f11fe90010f3c96d4d86bb5969cabc406697c8b72ffebc66d51af url=/legacydeveloper/current/en-us/api_meta/meta_explainabilitymsgtemplate.md -->

# ExplainabilityMsgTemplate

Represents information about the template that contains the decision explanation message for a specified expression set step type.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExplainabilityMsgTemplate components have the suffix .explainabilityMsgTemplate and are stored in the ExplainabilityMsgTemplates folder.

## Version

ExplainabilityMsgTemplate components are available in API version 56.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
|  |  |
| evaluationResult | 
Field Type

EvaluationResult (enumeration of type string)

Description

Required.

The type of result for which the message template can be used. The step type for which the result is evaluated can be a condition, conditional group, or branch.

Valid values are:

- Failed
- Passed
- NoResult





 |
| expressionSetStepType | 

Field Type

ExpressionSetStepType (enumeration of type string)

Description

Required.

The step type in an expression set that uses the explainability message template.

Valid values are:

- Aggregation
- Branch
- BusinessElement
- Calculation
- Condition
- DecisionTableLookup
- ListEnabledGroup
- ListFilter
- MatrixLookup
- ReferenceProcedure







 |
| expsSetProcessType | 

Field Type

ExpsSetProcessType (enumeration of type string)

Description

Required.

The type of industry that’s using the expression set.

Valid values are:

- Bre
- GpaCalculation
- InsuranceClaimProcessing—Available in API version 65.0 and later.
- ItServiceManagement—Available in API version 65.0 and later.
- PlanCostCalculation
- RatingDiscovery
- StudentInformationSystem—Available in API version 65.0 and later.
- StudentSuccess

When Business Rules Engine is enabled for a Salesforce instance, the default value is 'Bre’. Other process types are available to you depending on your industry solution and permission sets.



 |
| isDefault | 

Field Type

boolean

Description

Indicates whether the decision explainer template for a specified step type is default (true) or not (false).



 |
| masterLabel | 

Field Type

string

Description

Required.

Master label the for ExplainabilityMsgTemplate.



 |
| message | 

Field Type

string

Description

Required.

The message associated with the template for a specific expression set step type.



 |

## Declarative Metadata Sample Definition

The following is an example of an ExplainabilityMsgTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<ExplainabilityMsgTemplate
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<evaluationResult\>Passed</evaluationResult\>
	<expressionSetStepType\>Condition</expressionSetStepType\>
	<expsSetProcessType\>ProductQualification</expsSetProcessType\>
	<isDefault\>false</isDefault\>
	<masterLabel\>ML EMT testDM</masterLabel\>
	<message\>EMT Testing</message\>
</ExplainabilityMsgTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>\*</members\>
		<name\>ExplainabilityMsgTemplate</name\>
	</types\>
	<version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based.htm "HTML (New Window)").

<!-- document id=d7150ade17740d6d4e4b3ae5525486f88f0ac500740b2e4238fd477c9018041b url=/legacydeveloper/current/en-us/api_meta/meta_expressionsetdefinition.md -->

# ExpressionSetDefinition

Represents an expression set definition.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Before deploying an expression set or an expression set version to a target org, review these [Expression Set Migration Considerations](https://help.salesforce.com/s/articleView?id=ind.considerations_for_migrating_expression_sets.htm&type=5&language=en_US "HTML (New Window)").

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExpressionSetDefinition components have the suffix .expressionSetDefinition and are stored in the expressionSetDefinition folder.

## Version

ExpressionSetDefinition components are available in API version 55.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
|  |  |
| description | 
Field Type

string

Description

The description of an expression set definition.



 |
| executionMode | 

Field Type

ExpsSetExecutionMode (enumeration of type string)

Description

Specifies the execution mode for the expression set definition.

Valid values are:

- Cloud
- Local





 |
| executionScale | 

Field Type

ExpsSetExecutionScale (enumeration of type string)

Description

Specifies the scale of the inputs that an expression set processes. The scale determines where the expression set is executed.

Valid values are:

- High
- Low

Available in API version 61.0 and later.



 |
| interfaceSource​Type | 

Field Type

ExpsSetInterfaceSourceType (enumeration of type string)

Description

The interface source type designed by the consuming cloud that's making a customized expression set builder available to its users.

Valid values are:

- Bre
- Constraint (Available in API version 62.0 and later).
- DiscoveryProcedure (Available in API version 61.0 and later).
- EventOrchestration (Available in API version 61.0 and later).
- GpaCalculationProcedure (Available in API version 67.0 and later).
- IntelligentDecisionStudio (Available in API version 67.0 and later).
- ItServiceManagement (Available in API version 65.0 and later).
- PricingProcedure
- QualificationProcedure
- RatingDiscoveryProcedure (Available in API version 61.0 and later).
- RatingProcedure (Available in API version 67.0 and later).
- Sample

Available in API version 59.0 and later.



 |
| label | 

Field Type

string

Description

Required.

The UI label of an expression set definition.



 |
| processType | 

Field Type

ExpsSetProcessType (enumeration of type string)

Description

The process type that uses the expression set rule.

Valid values are:

- AssetRefreshEligibility—Available in API version 67.0 and later.
- Bre
- GpaCalculation
- HighScaleTestProcess—Available in API version 67.0 and later.
- InsuranceClaimProcessing—Available in API version 65.0 and later.
- ItServiceManagement—Available in API version 65.0 and later.
- PlanCostCalculation
- Program—Available in API version 67.0 and later.
- RatingDiscovery
- RevenueStandardTax—Available in API version 66.0 and later.
- StockRotation—Available in API version 67.0 and later.
- StudentInformationSystem—Available in API version 65.0 and later.
- StudentSuccess

When Business Rules Engine is enabled for a Salesforce instance, the default value is Bre. Other process types are available to you depending on your industry solution and permission sets.



 |
| resource​InitializationType | 

Field Type

ResourceInitializationType (enumeration of type string)

Description

Indicates whether the initial value of expression set variables and context tags is null or a default value.

Valid values are:

- Default
- Off

Available in API version 64.0 and later.



 |
| template | 

Field Type

boolean

Description

Defines whether an expression set is a template or not.



 |
| type | 

Field Type

ExpsSetType (enumeration of type string)

Description

The type of the expression set definition.

Valid values are:

- Custom
- Standard

Available in API version 67.0 and later.



 |
| usageSubType | 

Field Type

ExpsSetUsageSubType (enumeration of type string)

Description

The subtype of the industry that's using the expression set definition. If no value is specified, the field defaults to null.



 |
| versions | 

Field Type

[ExpressionSetDefinitionVersion](#ExpSetDefVer)\[\]

Description

Represents an array of expression set version definitions in an expression set.

This array must contain at least one version.





 |

## ExpressionSetDefinitionVersion​​

Represents a definition of an expression set version.

| Field Name | Description |
| --- | --- |
| decimalScale | 
Field Type

integer

Description

Number of decimal places to be used in the results of calculation steps that involve context variables.



 |
| description | 

Field Type

string

Description

Describes the version of an expression set definition.



 |
| endDate | 

Field Type

dateTime

Description

The date until which the expression set definition is available for use.



 |
| expressionSet​Definition | 

Field Type

string

Description

The full name of an expression set definition.



 |
| interface​SourceType | 

Field Type

ExpsSetInterfaceSourceType (enumeration of type string)

Description

The interface source type designed by the consuming cloud that's making a customized expression set builder available to its users.

Valid values are:

- Bre
- Constraint
- DiscoveryProcedure
- EventOrchestration
- GpaCalculationProcedure
- IntelligentDecisionStudio
- ItServiceManagement
- PricingProcedure
- QualificationProcedure
- RatingDiscoveryProcedure
- RatingProcedure
- Sample

Available in API version 67.0 and later.



 |
| label | 

Field Type

string

Description

Required.

The UI label of an expression set definition.



 |
| processType | 

Field Type

ExpsSetProcessType (enumeration of type string)

Description

The process type that uses the expression set rule. Available in API version 67.0 and later.



 |
| rank | 

Field Type

int

Description

The rank of the Expression Set Definition Version. When more than one enabled version matches an expression set call, and the start date time to end date time spans overlap, the version with the highest rank is chosen. Available in API version 62.0 and later.



 |
| shouldShow​ExplExternally | 

Field Type

boolean

Description

Indicates whether the decision explanation is exposed to external users (true) or not (false). The default value is false. Available in API version 56.0 and later.



 |
| startDate | 

Field Type

dateTime

Description

Required.

The date from when the expression set definition is available for use.



 |
| status | 

Field Type

ExpsSetStatus (enumeration of type string)

Description

Required.

The status of an expression set definition.

Valid values are:

- Active
- Draft
- Inactive
- InvalidDraft
- Obsolete





 |
| steps | 

Field Type

[ExpressionSetStep](#ExpSetStep)\[\]

Description

Represents an array of steps created in an expression set version.



 |
| uiTier | 

Field Type

boolean

Description

Indicates whether the API call originated from the design time builder or a package.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field is for internal use only.















 |
| variables | 

Field Type

[ExpressionSet​​Variable](#ExpSetVar)\[\]

Description

Represents an array of variables in an expression set version.



 |
| versionNumber | 

Field Type

int

Description

Required.

The version number of an expression set definition.



 |

## ExpressionSet​​Step

Represents a step in an expression set version.

| Field Name | Description |
| --- | --- |
| actionType | 
Field Type

BusinessKnowledgeModel (enumeration of type string)

Description

Specifies the type of action this step executes.

Valid values are:

- AiAcceleratorSubscriberChurnPrediction
- ApexAction
- ApexListAction (Available in API version 64.0 and later.)
- AssetDiscovery
- AssignBadgeToMember
- AssignParameterValues
- AssignmentElement
- AssignmentRuleCustomQueue (Available in API version 65.0 and later.)
- AssignmentRuleCustomUser (Available in API version 65.0 and later.)
- AteprlRecordCreator (Available in API version 65.0 and later.)
- AttributeAdjustmentMatrix
- AttributeDiscount
- AutomatedClaimsProcessingValidation
- BaseRate
- BindingObjectRateAdjustmentResolution (Available in API version 64.0 and later.)
- BindingObjectRateCardEntryResolution (Available in API version 64.0 and later.)
- BreAggregator
- BreAggregatorAssignment
- BreakdownLineMapping (Available in API version 64.0 and later.)
- BundleDiscount
- CalculateQuantity (Available in API version 64.0 and later.)
- ChangeMemberTier
- CheckMemberBadgeAssignment
- CommercePricing (Available in API version 62.0 and later.)
- CommitmentAdjustment (Available in API version 65.0 and later.)
- ComplianceCheck
- ComplianceControlLog (Available in API version 62.0 and later.)
- Constraint (Available in API version 64.0 and later.)
- CreditPoints
- Crud
- DebitPoints
- DerivedPricing
- DiscountDistributionService
- DiscoverySettings (Available in API version 64.0 and later.)
- DynamicRulesExecutor (Available in API version 65.0 and later.)
- EvaluateCategoryDisqualification (Available in API version 62.0 and later.)
- EvaluateCategoryQualification (Available in API version 62.0 and later.)
- EvaluateDisqualification
- EvaluateQualification
- FormulaBasedPricing
- FormulaBasedRating (Available in API version 62.0 and later.)
- GetCustomerPromotionAttrValue (Available in API version 64.0 and later.)
- GetMemberAttributesValues
- GetMemberPartnerLinkageStatus
- GetMemberPointBalance
- GetMemberPromotions
- GetMemberTier
- GetOutputsFromDecisionMatrix
- GetOutputsFromDecisionTable
- GetUserData
- GroupingAndAggregatePricing
- GroupingAndAggregateRating (Available in API version 62.0 and later.)
- IncreaseUsageForCumulativePromotion
- IntegrationOrchestration
- InterNodeDataCopy
- IssueExtendedReward (Available in API version 64.0 and later.)
- IssueVoucher
- ListGroup
- ListGroupCalculation
- ListPrice
- ManualDiscount
- ManualRatingDiscount (Available in API version 62.0 and later.)
- MapProduct
- MinimumPrice (Available in API version 62.0 and later.)
- MultiRecipientProductQualification (Available in API version 64.0 and later.)
- NegotiatedBaseRate (Available in API version 64.0 and later.)
- NegotiatedRateCardEntryResolution (Available in API version 64.0 and later.)
- NegotiatedTierAdjustment (Available in API version 64.0 and later.)
- NegotiatedVolumeAdjustment (Available in API version 64.0 and later.)
- PredictiveAI
- PriceAdjustmentMatrix
- PriceGuidance (Available in API version 64.0 and later.)
- PriceRevision (Available in API version 65.0 and later.)
- PricingPropagation (Available in API version 65.0 and later.)
- PricingSettings
- PromotionExecution (Available in API version 65.0 and later.)
- PromotionsDiscount
- Proration
- RateAdjustmentByAttributeResolution (Available in API version 62.0 and later.)
- RateAdjustmentByTierResolution (Available in API version 62.0 and later.)
- RateAdjustmentMatrix (Available in API version 62.0 and later.)
- RateAssignment (Available in API version 62.0 and later.)
- RateCardEntryResolution (Available in API version 62.0 and later.)
- RateCardResolution (Available in API version 62.0 and later.)
- RatingAttributeDiscount
- RatingBreakdownLineMapping (Available in API version 65.0 and later.)
- RatingRoundingValues (Available in API version 62.0 and later.)
- RatingSetting
- RatingTierDiscount
- RatingVolumeDiscount
- RecordAction
- RecordAlert
- RedeemVoucher
- RoundingValues
- RuleFetch
- RunFlow
- RunProgramProcess
- SampleBusinessElementWithContext
- SampleCustomElementWithExpressionAndListFilter
- SampleDynamicCustomElement
- SampleJavaBasedTaxCalculatorCustomElement
- SampleTaxCalculatorCustomElement
- SendMail
- StopPricing
- StopRating (Available in API version 62.0 and later.)
- SubscriptionPricing
- TermGpaCalculation (Available in API version 64.0 and later.)
- TermGpaReporting (Available in API version 64.0 and later.)
- TestCustomElement
- UpdateCurrentValueForMemberAttribute
- UpdateCustomerPromotionAttrValue (Available in API version 64.0 and later.)
- UpdatePointBalance
- UpdateUsageForCumulativePromotion
- UpsertRecord (Available in API version 64.0 and later.)
- VolumeDiscount
- VolumeTierDiscount





 |
| advancedCondition | 

Field Type

[ExpressionSetAdvancedCondition](#ExpSetAdvCon)

Description

Represents an advanced condition step.



 |
| aggregation | 

Field Type

[ExpressionSetAggregation](#ExpSetAggregate)

Description

Represents an aggregation step.



 |
| assignment | 

Field Type

[ExpressionSetAssignment](#ExpSetAssignment)

Description

Represents an assignment step.



 |
| conditionExpression | 

Field Type

[ExpressionSetConditionExpression](#ExpSetConExp)

Description

Represents a condition step.



 |
| customElement | 

Field Type

[ExpressionSetCustomElement](#ExpSetCustomElement)

Description

Represents a custom element step that contains the input and output mappings. Available in API version 56.0 and later.



 |
| decisionTable | 

Field Type

[ExpressionSetDecisionTable](#ExpSetDecisionTbl)

Description

Represents a decision matrix or decision table step.



 |
| description | 

Field Type

string

Description

Describes an expression set definition version step.



 |
| failed​ExplainerTemplate | 

Field Type

string

Description

The explainability message template that’s used when the result type of a condition step in an expression set is Failed.





 |
| failedMessage​TokenMappings | 

Field Type

ExplainabilityMessageTemplateTokenMapping (enumeration of type string)

Description

List of the token resource mappings of the failed explainability message template. Valid values are:

- expressionSetMessageToken
- resourceReference

Available in API version 59.0 and later.





 |
| hasNested​Explainability | 

Field Type

boolean

Description

Indicates whether the step has nested explainability (

true

) or not (

false

). Available in API version 67.0 and later.



 |
| label | 

Field Type

string

Description

Required.

The UI label of an expression set definition version step.



 |
| name | 

Field Type

string

Description

Required.

The full name of an expression set definition version step.



 |
| noResult​ExplainerTemplate | 

Field Type

string

Description

The explainability message template that’s used when the result type of a condition step in an expression set is No Result. Available in API version 59.0 and later.





 |
| noResultMessage​TokenMappings | 

Field Type

ExplainabilityMessageTemplateTokenMapping (enumeration of type string)

Description

List of the token resource mappings of the no result explainability message template. Valid values are:

- expressionSetMessageToken
- resourceReference

Available in API version 59.0 and later.





 |
| parentStep | 

Field Type

string

Description

The name of the parent step in an expression set definition version that’s associated with a step.





 |
| passedExplainer​Template | 

Field Type

string

Description

The explainability message template that’s used when the result type of a condition step in an expression set is Passed.





 |
| passedMessage​TokenMappings | 

Field Type

ExplainabilityMessageTemplateTokenMapping (enumeration of type string)

Description

List of the token resource mappings of the passed explainability message template. Valid values are:

- expressionSetMessageToken
- resourceReference

Available in API version 59.0 and later.





 |
| resultIncluded | 

Field Type

boolean

Description

Indicates whether the step output must be included in the expression result (true) or not (false).





 |
| sequenceNumber | 

Field Type

int

Description

Required.

The sequence number of a step in an expression set definition version.



 |
| shouldExposExecPathMsgOnly | 

Field Type

boolean

Description

Indicates whether the message in the explainability message template is exposed for only the branch path that was run.



 |
| shouldExposeConditionDetails | 

Field Type

boolean

Description

Indicates whether the details of the condition are shown in the decision explanation.



 |
| shouldShowExplExternally | 

Field Type

boolean

Description

Indicates whether the decision explanations are shown to external users.



 |
| stepType | 

Field Type

ExpsSetStepType (enumeration of type string)

Description

Required.

Specifies the type of step in an expression set definition version.

Valid values are:

- AdvancedCondition
- AdvancedListFilter (Available in API version 67.0 and later).
- Branch
- BusinessKnowledgeModel
- Condition
- DefaultPath
- ListFilter (Available in API version 67.0 and later).
- ListGroup (Available in API version 67.0 and later).
- SubExpression





 |
| subExpression | 

Field Type

[ExpressionSetSubExpression](#ExpSetSubExp)

Description

Represents a sub expression step.



 |

## ExpressionSetAdvancedCondition

Represents an advanced condition step.

| Field Name | Description |
| --- | --- |
| conditionLogic | 
Field Type

string

Description

Required.

The condition that’s defined for an advanced condition.



 |
| criteria | 

Field Type

[ExpressionSetConditionCriteria](#ExpSetConCriteria) \[\]

Description

Represents an array of criteria defined in the advanced condition.



 |
| errorMessage | 

Field Type

string

Description

An error message for a failed advanced condition.



 |
| resultParameter | 

Field Type

string

Description

An expression set definition version variable associated with the result of a step.



 |
| successMessage | 

Field Type

string

Description

A success message for a successful advanced condition.



 |

## ExpressionSetConditionCriteria

Represents a criterion defined in an advanced condition.

| Field Name | Description |
| --- | --- |
| operator | 
Field Type

ExpsSetConditionOperator (enumeration of type string)

Description

Required.

Specifies the operator for evaluating an expression.

Valid values are:

- Contains
- DoesNotContain
- Equals
- GreaterThan
- GreaterThanOrEquals
- IsNull
- IsNotNull
- LessThan
- LessThanOrEquals
- NoEquals





 |
| sequenceNumber | 

Field Type

int

Description

Required.

The position of the condition in a step that contains multiple conditions.



 |
| sourceFieldName | 

Field Type

string

Description

Required.

The expression set definition version variable associated with the result of a condition criterion.





 |
| value | 

Field Type

string

Description

Specifies the condition of a criterion.



 |
| valueType | 

Field Type

ExpsSetValueType (enumeration of type string)

Description

Specifies the type of value.

Valid values are:

- Formula
- Literal
- Lookup
- Parameter
- Picklist





 |

## ExpressionSetAggregation

Represents an aggregation step.

| Field Name | Description |
| --- | --- |
| aggergatedParameter | 
Field Type

string

Description

Required.

The expression set definition version variable associated with the result of a condition criterion.





 |
| aggregateFunction | 

Field Type

ExpsSetAggregationFunction (enumeration of type string)

Description

Required.

Specifies the aggregation function used in a step.

Valid values are:

- Avg
- Max
- Min
- Sum





 |
| expression | 

Field Type

string

Description

Required.

Specifies the expression of an aggregation.



 |

## ExpressionSetAssignment

Represents an assignment step.

| Field Name | Description |
| --- | --- |
| expression | 
Field Type

string

Description

Required.

The expression that’s defined for a step.



 |

## ExpressionSetConditionExpression

Represents a condition in a condition step.

| Field Name | Description |
| --- | --- |
| errorMessage | 
Field Type

string

Description

An error message for a failed condition.



 |
| expression | 

Field Type

string

Description

Required.

The expression that’s defined for a step.



 |
| resultParameter | 

Field Type

string

Description

The expression set definition version variable associated with the result of a step.



 |
| successMessage | 

Field Type

string

Description

A success message for a successful condition.



 |

## ExpressionSetCustomElement

Represents a custom element in an expression set. Available in API version 56.0 and later.

| Field Name | Description |
| --- | --- |
| parameters | 
Field Type

[ExpressionSetElementParameter](#ExpressionSetElementParameter)\[\]

Description

Represents the list of parameters in the custom element.



 |

## ExpressionSetElementParameter

Represents a parameter within a custom element of an expression set. Available in API version 56.0 and later.

| Field Name | Description |
| --- | --- |
| dataType | 
Field Type

string

Description

The data type of the custom element parameter.

Available in API version 67.0 and later.



 |
| input | 

Field Type

boolean

Description

Required.

Indicates whether the custom element parameter is input (true) or not (false).

The default value is true.



 |
| name | 

Field Type

string

Description

Required.

The name of the custom element parameter.



 |
| output | 

Field Type

boolean

Description

Required.

Indicates whether the custom element parameter is output (true) or not (false).

The default value is true.



 |
| type | 

Field Type

ExpsSetValueType (enumeration of type string)

Description

The type of custom element parameter.

Values are:

- Formula
- Literal
- Lookup
- Parameter
- PickList

The default value is Parameter.



 |
| value | 

Field Type

string

Description

Required.

The name of the expression set variable.



 |

## ExpressionSetDecisionTable

Represents a decision table or decision matrix in a step.

| Field Name | Description |
| --- | --- |
| decisionTableName | 
Field Type

string

Description

Required.

The decision matrix or decision table name used in a step.



 |
| mappings | 

Field Type

[ExpressionSetElementParameter\[\]](#ExpressionSetElementParameter)

Description

The mapping information between various parameters in an ExpressionSetDecisionTable.

Available in API version 59.0 and later.



 |
| type | 

Field Type

string

Description

Required.

The type in a step. It can be a decision table or decision matrix.



 |

## ExpressionSetSubExpression

Represents a sub expression in a step.

| Field Name | Description |
| --- | --- |
| expressionSet | 
Field Type

string

Description

Required.

The sub expression name used in a step.



 |
| mappings | 

Field Type

[ExpressionSetElementParameter\[\]](#ExpressionSetElementParameter)

Description

The mapping information between various parameters in an ExpressionSetDecisionTable.

Available in API version 61.0 and later.



 |

## ExpressionSet​​Variable

Represents a definition of an expression set variable.

| Field Name | Description |
| --- | --- |
| collection | 
Field Type

boolean

Description

Indicates whether a variable stores a collection of values (true) or not (false).



 |
| dataType | 

Field Type

ExpsSetDataType (enumeration of type string)

Description

Required.

The data type of an expression set variable.

Valid values are:

- ActionOutput
- Boolean
- Currency
- Date
- DateTime
- DecisionMatrix
- DecisionTable
- Numeric
- Percent
- Sobject
- SubExpression
- Text





 |
| decimalPlaces | 

Field Type

int

Description

The decimal digits in the currency, number, or percent data type for an expression set variable.



 |
| description | 

Field Type

string

Description

The description of the variable used in an expression set.



 |
| fields | 

Field Type

[ExpressionSetVariableField](#ExpSetVarFld) \[\]

Description

Represents an array of fields in an object that's used as a variable in an expression set.



 |
| input | 

Field Type

boolean

Description

Indicates whether an expression set variable is used as an input (true) in an expression or not (false).



 |
| lookupName | 

Field Type

string

Description

The API name of a decision matrix, a decision table, or a sub expression.



 |
| lookupType | 

Field Type

ExpsSetVariableLookupType (enumeration of type string)

Description

The type of the lookup used in an expression set definition.

Valid values are:

- DecisionMatrix
- DecisionTable
- SubExpression





 |
| name | 

Field Type

string

Description

Required.

The full name of the variable used in an expression set definition.



 |
| objectName | 

Field Type

string

Description

The name of the sObject.



 |
| output | 

Field Type

boolean

Description

Indicates whether an expression set variable is used as an output in an expression(true) or not (false).



 |
| parentContextNode | 

Field Type

string

Description

The name of the parent node in the standard context definition for the local context node or attribute.

Available in API version 67.0 and later.



 |
| parentLocalNodeName | 

Field Type

string

Description

The name of the parent local node for a local context node or attribute.

Available in API version 67.0 and later.



 |
| resultStep | 

Field Type

string

Description

The step that produces the expression set variable.



 |
| type | 

Field Type

ExpsSetVariableType (enumeration of type string)

Description

Required.

The type of variable in an expression set definition.

Valid values are:

- Constant
- ContextDynamicAttributeTag (Available in API version 62.0 and later.)
- ExecutableContextDefinitionTag (Available in API version 62.0 and later.)
- Formula
- LocalListVariable (Available in API version 67.0 and later.)
- LocalNode (Available in API version 67.0 and later.)
- Variable





 |
| value | 

Field Type

string

Description

Represents a constant value or a formula.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

It stores the default value of a variable.















 |

## ExpressionSetVariableField

Represents a definition of a field in an object that's used as a variable in an expression set.

| Field Name | Description |
| --- | --- |
| dataType | 
Field Type

ExpsSetDataType (enumeration of type string)

Description

Required.

Specifies the type of data stored in an expression set variable.

Valid values are:

- ActionOutput
- Boolean
- Currency
- Date
- DateTime
- DecisionMatrix
- DecisionTable
- Numeric
- Percent
- Sobject
- SubExpression
- Text





 |
| decimalPlaces | 

Field Type

int

Description

The decimal digits in the currency, number, or percent data type for an expression set variable.



 |
| fields | 

Field Type

[ExpressionSetVariableField](#ExpSetVarFld) \[\]

Description

Represents an array of fields in an object that's used as a variable in an expression set.



 |
| lookupName | 

Field Type

string

Description

The API name of a decision matrix, a decision table, or a sub expression.



 |
| lookupType | 

Field Type

ExpsSetVariableLookupType (enumeration of type string)

Description

Required.

The type of lookup used in an expression set definition.

Valid values are:

- DecisionMatrix
- DecisionTable
- SubExpression





 |
| name | 

Field Type

string

Description

Required.

The full name of the field used in an expression set variable.



 |
| objectName | 

Field Type

string

Description

The name of the sObject.



 |

## Declarative Metadata Sample Definition

The following is an example of an ExpressionSetDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<ExpressionSetDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <label>ExpSetWithAllSteps</label>
    <processType>Bre</processType>
    <template>false</template>
    <description></description>
    <interfaceSourceType>Sample</interfaceSourceType>
    <executionScale>Low</executionScale>
    <versions>
        <fullName>ExpSetWithAllSteps\_V1</fullName>
        <expressionSetDefinition>ExpSetWithAllSteps</expressionSetDefinition>
        <label>ExpSetWithAllSteps V1</label>
        <shouldShowExplExternally>false</shouldShowExplExternally>
        <startDate>2022-08-09T22:04:56.000Z</startDate>
        <endDate>2023-08-09T22:04:56.000Z</endDate>
        <status>Draft</status>
        <uiTier>false</uiTier>
        <rank>1</rank>
        <description>ExpSetWithAllSteps\_V1</description>
        <steps>
            <description>Aggregate</description>
            <actionType>BreAggregator</actionType>
            <aggregation>
                <aggergatedParameter>result</aggergatedParameter>
                <aggregateFunction>Avg</aggregateFunction>
                <expression>AVG ( result )</expression>
            </aggregation>
            <label>Aggregate</label>
            <name>Aggregate</name>
            <resultIncluded>true</resultIncluded>
            <sequenceNumber>5</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>BusinessKnowledgeModel</stepType>
        </steps>
        <steps>
            <label>Branch</label>
            <name>Branch</name>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>4</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>Branch</stepType>
        </steps>
        <steps>
            <actionType>AssignParameterValues</actionType>
            <assignment>
                <assignedParameter>b</assignedParameter>
                <expression>SUM ( a , 10 )</expression>
            </assignment>
            <label>Calculation</label>
            <name>Calculation</name>
            <resultIncluded>true</resultIncluded>
            <sequenceNumber>1</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>BusinessKnowledgeModel</stepType>
        </steps>
        <steps>
            <actionType>AssignParameterValues</actionType>
            <assignment>
                <assignedParameter>result</assignedParameter>
                <expression>b \* 100</expression>
            </assignment>
            <label>Calculation</label>
            <name>Calculation10</name>
            <parentStep>DefaultLane</parentStep>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>1</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>BusinessKnowledgeModel</stepType>
        </steps>
        <steps>
            <actionType>AssignParameterValues</actionType>
            <assignment>
                <assignedParameter>result</assignedParameter>
                <expression>b \* 1</expression>
            </assignment>
            <label>Calculation</label>
            <name>Calculation3</name>
            <parentStep>Condition</parentStep>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>1</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>BusinessKnowledgeModel</stepType>
        </steps>
        <steps>
            <actionType>AssignParameterValues</actionType>
            <assignment>
                <assignedParameter>result</assignedParameter>
                <expression>SUM ( b , 10 )</expression>
            </assignment>
            <label>Calculation</label>
            <name>Calculation5</name>
            <parentStep>Condition4</parentStep>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>1</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>BusinessKnowledgeModel</stepType>
        </steps>
        <steps>
            <actionType>AssignParameterValues</actionType>
            <assignment>
                <assignedParameter>result</assignedParameter>
                <expression>b \* 10</expression>
            </assignment>
            <label>Calculation</label>
            <name>Calculation8</name>
            <parentStep>Condition7</parentStep>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>1</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>BusinessKnowledgeModel</stepType>
        </steps>
        <steps>
            <conditionExpression>
                <successMessage>success</successMessage>
                <errorMessage>error</errorMessage>
                <expression>IS10 == b</expression>
                <resultParameter>condition\_output\_\_1</resultParameter>
            </conditionExpression>
            <label>Condition</label>
            <name>Condition</name>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>2</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>Condition</stepType>
        </steps>
        <steps>
            <advancedCondition>
                <successMessage>success</successMessage>
                <errorMessage>error</errorMessage>
                <conditionLogic>1</conditionLogic>
                <criteria>
                    <operator>Equals</operator>
                    <sequenceNumber>1</sequenceNumber>
                    <sourceFieldName>condition\_output\_\_1</sourceFieldName>
                    <value>true</value>
                    <valueType>Literal</valueType>
                </criteria>
                <resultParameter>condition\_output\_\_3</resultParameter>
            </advancedCondition>
            <label>Condition</label>
            <name>Condition4</name>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>3</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>AdvancedCondition</stepType>
        </steps>
        <steps>
            <conditionExpression>
                <expression>IS10 == b</expression>
                <resultParameter>condition\_output\_\_2</resultParameter>
            </conditionExpression>
            <label>Condition</label>
            <name>Condition7</name>
            <parentStep>Branch</parentStep>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>1</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>Condition</stepType>
        </steps>
        <steps>
            <label>Default Lane</label>
            <name>DefaultLane</name>
            <parentStep>Branch</parentStep>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>2</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>false</shouldShowExplExternally>
            <stepType>DefaultPath</stepType>
        </steps>
        <steps>
            <actionType>AssignParameterValues</actionType>
            <assignment>
                <assignedParameter>a</assignedParameter>
                <expression>3</expression>
            </assignment>
            <failedExplainerTemplate>CalculationFailure</failedExplainerTemplate>
            <failedMessageTokenMappings>
                <expressionSetMessageToken>y2</expressionSetMessageToken>
                <resourceReference>a</resourceReference>
            </failedMessageTokenMappings>
            <label>CalculationStepWithTokensAndMappings</label>
            <name>CalculationStepWithTokensAndMappings</name>
            <passedExplainerTemplate>CalculationSuccess</passedExplainerTemplate>
            <passedMessageTokenMappings>
                <expressionSetMessageToken>y1</expressionSetMessageToken>
                <resourceReference>a</resourceReference>
            </passedMessageTokenMappings>
            <resultIncluded>false</resultIncluded>
            <sequenceNumber>1</sequenceNumber>
            <shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
            <shouldExposeConditionDetails>false</shouldExposeConditionDetails>
            <shouldShowExplExternally>true</shouldShowExplExternally>
            <stepType>BusinessKnowledgeModel</stepType>
        </steps>
        <variables>
            <collection>false</collection>
            <dataType>Boolean</dataType>
            <description>condition\_output\_\_3</description>
            <input>false</input>
            <name>condition\_output\_\_3</name>
            <output>false</output>
            <resultStep>Condition4</resultStep>
            <type>Variable</type>
            <value>False</value>
        </variables>
        <variables>
            <collection>false</collection>
            <dataType>Numeric</dataType>
            <decimalPlaces>2</decimalPlaces>
            <description>a</description>
            <input>true</input>
            <name>a</name>
            <output>false</output>
            <type>Variable</type>
            <value>10</value>
        </variables>
        <variables>
            <collection>false</collection>
            <dataType>Boolean</dataType>
            <description>condition\_output\_\_1</description>
            <input>false</input>
            <name>condition\_output\_\_1</name>
            <output>false</output>
            <resultStep>Condition</resultStep>
            <type>Variable</type>
            <value>False</value>
        </variables>
        <variables>
            <collection>false</collection>
            <dataType>Boolean</dataType>
            <description>condition\_output\_\_2</description>
            <input>false</input>
            <name>condition\_output\_\_2</name>
            <output>false</output>
            <resultStep>Condition7</resultStep>
            <type>Variable</type>
            <value>False</value>
        </variables>
        <variables>
            <collection>false</collection>
            <dataType>Numeric</dataType>
            <decimalPlaces>2</decimalPlaces>
            <description>IS10</description>
            <input>false</input>
            <name>IS10</name>
            <output>false</output>
            <type>Constant</type>
            <value>10</value>
        </variables>
        <variables>
            <collection>false</collection>
            <dataType>Numeric</dataType>
            <decimalPlaces>2</decimalPlaces>
            <description>b</description>
            <input>false</input>
            <name>b</name>
            <output>true</output>
            <type>Variable</type>
        </variables>
        <variables>
            <collection>false</collection>
            <dataType>Numeric</dataType>
            <decimalPlaces>2</decimalPlaces>
            <description>result</description>
            <input>false</input>
            <name>result</name>
            <output>true</output>
            <type>Variable</type>
        </variables>
        <versionNumber>1</versionNumber>
    </versions>
</ExpressionSetDefinition>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>\*</members\>
		<name\>ExpressionSetDefinition</name\>
	</types\>
	<version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based.htm "HTML (New Window)").

<!-- document id=6ae7b64cdf992feee5a51d79449110bd7c74f3845da403afddd38e1ee0713865 url=/legacydeveloper/current/en-us/api_meta/meta_expressionsetmessagetoken.md -->

# ExpressionSetMessageToken

Represents an interface to retrieve, deploy, create, update, or delete information on Expression Set Message Token.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExpressionSetMessageToken components have the suffix expressionSetMessageToken and are stored in the ExpressionSetMessageToken folder.

## Version

ExpressionSetMessageToken components are available in API version 59.0 and later.

## Special Access Rules

InteractionCalculation.orgHasBREandDESAccess Org permission set license is required for users to access this metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Required.

Description of the expression set message token.



 |
| developerName | 

Field Type

string

Description

Required.

Developer name of the expression set message token.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for ExpressionSetMessageToken, which is defined when the ExpressionSetMessageToken is created.



 |

## Declarative Metadata Sample Definition

The following is an example of an ExpressionSetMessageToken component.

<?xml version="1.0" encoding="UTF-8"?>
<ExpressionSetMessageToken xmlns="http://soap.sforce.com/2006/04/metadata">
    <developerName\>token</developerName\>
    <description\>Description</description\>
    <masterLabel\>token</masterLabel\>
</ExpressionSetMessageToken\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExpressionSetMessageToken</name\>
    </types\>
    <version\>59.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=fba9cef87d5075a463d68083cc6949729e3e3ac04a962319bb89d0c29e995b3f url=/legacydeveloper/current/en-us/api_meta/meta_expressionsetobjectalias.md -->

# ExpressionSetObjectAlias

Represents information about the alias of the source object that’s used in an expression set.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExpressionSetObjectAlias components have the suffix .expressionSetObjectAlias and are stored in the expressionSetObjectAlias folder.

## Version

ExpressionSetObjectAlias components are available in API version 56.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| dataType | 
Field Type

ExpsSetObjectDataType (enumeration of type string)

Description

Required.

The data type of the object alias.

Values are:

- JSON
- sObject





 |
| mappings | 

Field Type

[ExpressionSetObjectAliasField\[\]](#ExpressionSetObjectAliasField)

Description

The mapping between a source field and its corresponding field alias.



 |
| objectApiName | 

Field Type

string

Description

Required.

The API name of the top-level object, when the data type is sObject. The key of the top-level object, when the data type is JSON.



 |
| usageType | 

Field Type

ExpsSetProcessType (enumeration of type string)

Description

Required.

The type of application associated with the industry that's using an expression set. Your Salesforce org admin can define the values.

Valid values are:

- Bre
- GpaCalculation
- InsuranceClaimProcessing—Available in API version 65.0 and later.
- ItServiceManagement—Available in API version 65.0 and later.
- PlanCostCalculation
- RatingDiscovery
- StudentInformationSystem—Available in API version 65.0 and later.
- StudentSuccess

When Business Rules Engine is enabled for a Salesforce instance, the default value is 'Bre’. Other usage types are available to you depending on your industry solution and permission sets.



 |

## ExpressionSetObjectAliasField

The fields associated with the source object for which the object alias is created.

| Field Name | Description |
| --- | --- |
| fieldAlias | 
Field Type

string

Description

Required.

The field alias associated with the source field name.



 |
| sourceFieldName | 

Field Type

string

Description

Required.

The name of the source field for which the field alias is created. The source field name under an object alias must be unique.



 |

## Declarative Metadata Sample Definition

The following is an example of an ExpressionSetObjectAlias component.

<?xml version="1.0" encoding="UTF-8"?>
<ExpressionSetObjectAlias xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataType\>sObject</dataType\>
    <mappings\>
        <fieldAlias\>dum2</fieldAlias\>
        <sourceFieldName\>CreatedBy.Contact.Name</sourceFieldName\>
    </mappings\>
    <mappings\>
        <fieldAlias\>dum3</fieldAlias\>
        <sourceFieldName\>CreatedBy.Name</sourceFieldName\>
    </mappings\>
    <mappings\>
        <fieldAlias\>dum1</fieldAlias\>
        <sourceFieldName\>Owner.Contact.Name</sourceFieldName\>
    </mappings\>
    <objectApiName\>Account</objectApiName\>
    <usageType\>Bre</usageType\>
</ExpressionSetObjectAlias\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>\*</members\>
		<name\>ExpressionSetObjectAlias</name\>
	</types\>
	<version\>69.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based.htm "HTML (New Window)").

<!-- document id=0135afe0d53765aa779fc18d983775f8c10d54c7e807ecd11c994a1b23fe73d3 url=/legacydeveloper/current/en-us/api_meta/meta_externalaimodel.md -->

# ExternalAIModel

Represents the state of a given model for an Einstein for Service feature, such as Einstein Reply Recommendations.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExternalAIModel components have the suffix .externalAIModel and are stored in the externalAIModels folder.

## Version

ExternalAIModel components are available in API version 51.0 and later.

## Special Access Rules

This type is available only when an org is configured to access the application in the applicationSourceType field. For example, if applicationSourceType is set to ARTICLE\_RECOMMENDATION, this type is available only if Einstein Article Recommendations is enabled in the org and the Main Services Agreement has been accepted.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d469166e114">Field Name</th>

              <th class="featureTableHeader  " id="d469166e117">Field Type</th>

              <th class="featureTableHeader  " id="d469166e120">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d469166e114" data-title="Field Name"><span class="keyword parmname">applicationSourceType</span></td>

              <td class="entry" headers="d469166e117" data-title="Field Type">
                <dl class="dl detailList">

                  <dd class="dd">ApplicationSourceType (enumeration of type string)</dd>


                </dl>

              </td>

              <td class="entry" headers="d469166e120" data-title="Description">Required. The target application for the configuration. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">REPLY_RECOMMENDATION</samp>— Einstein Reply
                    Recommendations
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ARTICLE_RECOMMENDATION</samp>— Einstein Article
                    Recommendations
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UTTERANCE_RECOMMENDATION</samp>— Einstein Bot
                    utterances
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FAQ</samp>— Einstein Bot frequently asked
                    questions
                  </li>

                </ul>
              </td>


            </tr>

            <tr>
              <td class="entry" headers="d469166e114" data-title="Field Name"><span class="keyword parmname">externalModelKey</span></td>

              <td class="entry" headers="d469166e117" data-title="Field Type">
                <dl class="dl detailList">

                  <dd class="dd">string</dd>


                </dl>

              </td>

              <td class="entry" headers="d469166e120" data-title="Description">
                <dl class="dl detailList">

                  <dd class="dd">Required. Unique key which identifies external model corresponding this
                    applicationType</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d469166e114" data-title="Field Name"><span class="keyword parmname">externalModelStatus</span></td>

              <td class="entry" headers="d469166e117" data-title="Field Type">
                <dl class="dl detailList">

                  <dd class="dd">ExternalModelStatus (enumeration of type string)</dd>


                </dl>

              </td>

              <td class="entry" headers="d469166e120" data-title="Description">Required. The current state of a given model. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">DISABLED</samp></li>

                  <li class="li"><samp class="codeph nolang">ENABLED</samp></li>

                  <li class="li"><samp class="codeph nolang">PAUSED</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d469166e114" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d469166e117" data-title="Field Type">
                <dl class="dl detailList">

                  <dd class="dd">string</dd>


                </dl>

              </td>

              <td class="entry" headers="d469166e120" data-title="Description">
                <dl class="dl detailList">

                  <dd class="dd">Required. A reference to the configuration.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d469166e114" data-title="Field Name"><span class="keyword parmname">threshold</span></td>

              <td class="entry" headers="d469166e117" data-title="Field Type">
                <dl class="dl detailList">

                  <dd class="dd">double</dd>


                </dl>

              </td>

              <td class="entry" headers="d469166e120" data-title="Description">
                <dl class="dl detailList">

                  <dd class="dd">Threshold override value for this model. Nillable.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d469166e114" data-title="Field Name"><span class="keyword parmname">trainingJobName</span></td>

              <td class="entry" headers="d469166e117" data-title="Field Type">
                <dl class="dl detailList">

                  <dd class="dd">string</dd>


                </dl>

              </td>

              <td class="entry" headers="d469166e120" data-title="Description">
                <dl class="dl detailList">

                  <dd class="dd">Training job path corresponding to the given model. Nillable.</dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an ExternalAIModel component.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalAIModel xmlns="http://soap.sforce.com/2006/04/metadata">
    <applicationSourceType>REPLY\_RECOMMENDATION</applicationSourceType>
    <externalModelKey>0f16dea6-b886-44df-9cfa-4d96b51d6594</externalModelKey>
    <externalModelStatus>ENABLED</externalModelStatus>
    <name>SR1601228426202</name>
    <threshold>0.9</threshold>
    <trainingJobName>TestJob</trainingJobName>
</ExternalAIModel>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>ExternalAIModel</name>
    </types>
</Package>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=bf1898d03f8c21a9c0f64039cdfd158856bfcb736b7ddf852066968968e5852a url=/legacydeveloper/current/en-us/api_meta/meta_externalauthidentityprovider.md -->

# ExternalAuthIdentityProvider

Represents an external authentication (auth) identity provider. An external auth identity provider links to an external credential and obtains OAuth tokens for outbound callouts to external systems.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExternalAuthIdentityProvider components have the suffix .externalAuthIdentityProvider and are stored in the externalAuthIdentityProviders folder.

## Version

ExternalAuthIdentityProvider components are available in API version 62.0 and later.

## Special Access Rules

Only users with the Customize Application permission or the Manage Named Credentials permission can access this type.

## Fields

| Field Name | Description |
| --- | --- |
| authenticationFlow | 
Field Type

IdentityProviderAuthFlow (enumeration of type string)

Description

Required.

Authentication flow to get tokens to call protected APIs. Values are:

- AuthorizationCode
- ClientCredentials
- SalesforceDefined





 |
| authenticationProtocol | 

Field Type

IdentityProviderAuthProtocol (enumeration of type string)

Description

Required.

The authentication protocol that’s required to access the external system. Values are:

- OAuth
- SalesforceDefined





 |
| description | 

Field Type

string

Description

A meaningful description of the external auth identity provider.



 |
| externalAuthIdentityProviderParameters | 

Field Type

[ExternalAuthIdentityProviderParameter\[\]](#ExternalAuthIdentityProviderParameter)

Description

One or more sets of parameters that further configure the external auth identity provider.



 |
| label | 

Field Type

string

Description

Required.

Name of the external auth identity provider.





 |

## ExternalAuthIdentityProviderParameter

Represents the parameters that configure an external auth identity provider.

These parameters are used internally to provide a flexible architecture and are exposed here for packaging reasons.

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

A human-readable description of this external auth identity provider parameter.



 |
| parameterName | 

Field Type

string

Description

Required.

The name of the external auth identity provider parameter.





 |
| parameterType | 

Field Type

ExtlIdentityProviderParmType (enumeration of type string)

Description

Required.

The type of external auth identity provider parameter. The value of this field drives the behavior of the parameter. Values are:

- AuthorizeRequestQueryParameter
- AuthorizeUrl
- ClientAuthentication
- CreatedByNamespace
- IdentityProviderOptions
- ManagedByComponent
- ManagedByFeature
- RefreshRequestBodyParameter
- RefreshRequestHttpHeader
- RefreshRequestQueryParameter
- StandardExternalIdentityProvider
- TokenRequestBodyParameter
- TokenRequestHttpHeader
- TokenRequestQueryParameter
- TokenUrl
- UserInfoUrl





 |
| parameterValue | 

Field Type

string

Description

If the parameterType field describes a literal value, then this field stores the literal value.



 |
| sequenceNumber | 

Field Type

int

Description

Specifies the order of parameters to apply when an external auth identity provider has more than one parameter. Priority is from lower to higher numbers (for example, 1 is the highest priority).



 |

## Declarative Metadata Sample Definition

The following is an example of an ExternalAuthIdentityProvider component.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalAuthIdentityProvider xmlns="http://soap.sforce.com/2006/04/metadata">
    <authenticationFlow\>AuthorizationCode</authenticationFlow\>
    <authenticationProtocol\>OAuth</authenticationProtocol\>
    <description\>OAuth Browser flow for connected app</description\>
    <externalAuthIdentityProviderParameter\>
        <parameterName\>TokenUrl</parameterName\>
        <parameterType\>TokenUrl</parameterType\>
        <parameterValue\>https://localhost:6101/services/oauth2/token</parameterValue\>
        <sequenceNumber\>1</sequenceNumber\>
    </externalAuthIdentityProviderParameter\>
    <externalAuthIdentityProviderParameter\>
        <parameterName\>AuthorizeUrl</parameterName\>
        <parameterType\>AuthorizeUrl</parameterType\>
        <parameterValue\>https://localhost:6101/services/oauth2/authorize</parameterValue\>
        <sequenceNumber\>2</sequenceNumber\>
    </externalAuthIdentityProviderParameter\>
    <label\>exampleExtlIdp</label\>
</ExternalAuthIdentityProvider\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExternalAuthIdentityProvider</name\>
    </types\>
    <version\>62.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=102a2b87bcb0c7c3f41c9299307dfa1d46d05fcb439d915e6f5ae57f76857a67 url=/legacydeveloper/current/en-us/api_meta/meta_externalclientapplication.md -->

# ExternalClientApplication

Represents the header file for an external client application configuration.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExternalClientApplication components have the suffix .eca and are stored in the externalClientApps folder.

## Version

ExternalClientApplication components are available in API version 59.0 and later.

## Special Access Rules

Access to the ExternalClientApplication type requires orgs to enable the Opt in to External Client Apps permission in Setup.

## Fields

| Field Name | Description |
| --- | --- |
| contactEmail | 
Field Type

string

Description

The email address that Salesforce uses to contact the external client app admin for the subscriber org.



 |
| contactPhone | 

Field Type

string

Description

The phone number that Salesforce uses to contact the external client app admin for the subscriber org.



 |
| description | 

Field Type

string

Description

A description for the app.



 |
| distributionState | 

Field Type

ExtlClntAppDistState (enumeration of type string)

Description

The distribution state of an external client app.

Values are:

- AutoInstalled. For internal use only.
- Local.
- Managed. For internal use only.
- Packaged.





 |
| iconUrl | 

Field Type

string

Description

The URL for the icon image.



 |
| infoUrl | 

Field Type

string

Description

Reserved for future use.



 |
| isProtected | 

Field Type

boolean

Description

A package construct that developers use to control the visibility of components in subscriber orgs. Default is false.



 |
| label | 

Field Type

string

Description

The label for the external client app.



 |
| logoUrl | 

Field Type

string

Description

The URL for the logo image.



 |
| managedType | 

Field Type

ExtlClntAppManagedType (enumeration of type string)

Description

For internal use only.



 |
| orgScopedExternalApp | 

Field Type

string

Description

A unique ID consisting of the org ID and the name of this external client app. Either defined by the developer or auto-generated during the first deployment. The expected value uses this format: \[Organization\_ID\]:\[External Client App Name\].



 |

## Declarative Metadata Sample Definition

This example shows an ExternalClientApplication component.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalClientApplication xmlns="http://soap.sforce.com/2006/04/metadata">
    <contactEmail\>johndoe@example.com</contactEmail\>
    <description\>Test external client app</description\>
    <distributionState\>Local</distributionState\>
    <iconUrl\>https://icon.example.com</iconUrl\>
    <infoUrl\>https://info.example.com</infoUrl\>
    <logoUrl\>https://logo.example.com</logoUrl\>
    <label\>myeca</label\>
    <isProtected\>false</isProtected\>
    <orgScopedExternalApp\>Org\_ID:External\_Client\_App\_Name</orgScopedExternalApp\> 
</ExternalClientApplication\>

This example package.xml references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExternalClientApplication</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppGlobalOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthConfigurablePolicies</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppConfigurablePolicies</name\>
    </types\>
    <version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=d50ca1ac03650788583f8f73a69b00922fc4fb5b7789d431a11522d4ab144566 url=/legacydeveloper/current/en-us/api_meta/meta_externalclientappsettings.md -->

# ExternalClientAppSettings

Represents settings to enable external client app features.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

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

## Version

ExternalClientAppSettings components are available in API version 58.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d472102e117">Field Name</th>

              <th class="featureTableHeader  " id="d472102e120">Field Type</th>

              <th class="featureTableHeader  " id="d472102e123">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d472102e117" data-title="Field Name"><span class="keyword parmname">enableClientSecretInRestApiAccess</span></td>

              <td class="entry" headers="d472102e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d472102e123" data-title="Description">Indicates whether OAuth consumer secrets can be accessed through the
                <span class="keyword parmname">credentials</span> REST API (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field is
                available in API version 62.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d472102e117" data-title="Field Name"><span class="keyword parmname">enableConsumerSecretApiAccess</span></td>

              <td class="entry" headers="d472102e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d472102e123" data-title="Description">DEPRECATED. Indicates whether OAuth consumer secrets can be accessed through
                Metadata API (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">Use the external client app OAuth UI to
                  access consumer secrets.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d472102e117" data-title="Field Name"><span class="keyword parmname">enablePackageEcaOauthFromDevOrg</span></td>

              <td class="entry" headers="d472102e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d472102e123" data-title="Description">Indicates whether you can package an external client app that is owned by an
                org, that isn't a Dev Hub org, (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). It’s recommended that you only
                package OAuth-enabled external client apps that are owned by a Dev Hub org. This
                practice maintains the integrity of the OAuth client credentials by storing them on
                an org that won't be deleted. If you have other ways to maintain the OAuth client
                credentials, you can enable this field and package an external client app form a
                different type of org. External client apps built on ephemeral orgs, like Scratch
                orgs or sandboxes, can't be packaged even with this field set to true. This field is
                available in API version 62.0 and later.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The example shows a settings file component.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalClientAppSettings xmlns="http://soap.sforce.com/2006/04/metadata">
        <enableClientSecretInRestApiAccess\>true</enableClientSecretInRestApiAccess\>
        <enableConsumerSecretApiAccess\>true</enableConsumerSecretApiAccess\>
        <enablePackageEcaOauthFromDevOrg\>false</enablePackageEcaOauthFromDevOrg\>
</ExternalClientAppSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=84e5e520b5686b4365662709b4e386267e7ca6cb72d404bd0e52b214d9229b1c url=/legacydeveloper/current/en-us/api_meta/meta_externalcredential.md -->

# ExternalCredential

Represents the details of how Salesforce authenticates to the external system.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

All credentials stored within this entity are encrypted under a framework that is consistent with other encryption frameworks on the platform. Salesforce encrypts your credentials by auto-creating org-specific keys. Credentials encrypted using the previous encryption scheme have been migrated to the new framework.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExternalCredential components have the suffix .externalCredential and are stored in the externalCredentials folder.

## Version

ExternalCredential components are available in API version 56.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| authenticationProtocol | 
Field Type

AuthenticationProtocol (enumeration of type string)

Description

Required.

The authentication protocol that’s required to access the external system. Valid values are:

- AwsSv4
- Basic
- Custom — User-created authentication. Specify the permission set, sequence number, and authentication parameters. Each authentication parameter requires a name and value.
- Jwt — Reserved for future use
- JwtExchange — Reserved for future use
- NoAuthentication —Reserved for future use
- Oauth
- Password — Reserved for future use

For connections to Amazon Web Services using Signature Version 4, use AwsSv4.

For connections using a direct token system, select Jwt.

For Simple URL data sources, select Custom with no parameters.

For cloud-based Files Connect external systems, select Oauth. For on-premises systems, select Password.





 |
| description | 

Field Type

string

Description

A meaningful description of the external credential.



 |
| externalCredentialParameters | 

Field Type

[ExternalCredentialParameter\[\]](#subtype_ExternalCredentialParameter)

Description

One or more sets of parameters that further configure the external credential.



 |
| label | 

Field Type

string

Description

Required.

Name of the external credential.





 |

## ExternalCredentialParameter

Represents the parameters that configure an external credential. External credential parameters are used to configure external credential callouts through a combination of the type, name, and value and lookup fields. Available in API version 56.0 and later.

These parameters are used internally to provide a flexible architecture and are exposed here for packaging reasons.

| Field Name | Description |
| --- | --- |
| authProvider | 
Field Type

string

Description

Reference to an authentication provider that the AuthProvider component represents, which defines the service that provides the login process and approves access to the external system.



 |
| certificate | 

Type

string

Description

If the value of parameterType is SigningCertificate, then this field references the certificate.



 |
| description | 

Field Type

string

Description

A human-readable description of this external credential parameter.



 |
| externalAuthIdentityProvider | 

Field Type

string

Description

Reference to an external authentication identity provider that the externalAuthIdentityProvider component represents. The externalAuthIdentityProvider defines the service that provides the login process and approves access to the external system.

To simplify the configuration process for the authentication providers used by your named credentials, use an externalAuthIdentityProvider instead of an authProvider. Link the external auth identity provider to an external credential.



 |
| parameterGroup | 

Field Type

string

Description

Groups a parameter along with its respective principal. For example, with dynamic scopes, the user can apply a scope AuthParameter only when authenticated against a specific principal with a matching parameterGroup value.

If a value for parameterGroup isn’t provided, parameterGroup defaults to the parameterName value for PER\_USER and NAMED\_PRINCIPAL. For all other parameters parameterGroup defaults to DEFAULT\_GROUP.





 |
| parameterName | 

Field Type

string

Description

Required.

The name of the external credential parameter.



 |
| parameterType | 

Field Type

ExternalCredentialParamType (enumeration of type string)

Description

Required.

The type of external credential parameter. The value of this field drives the behavior of the parameter. Valid values are:

- AdditionalRefreshStatusCode: Allows the user to specify 4xx, 6xx, 7xx, 8xx, and 9xx HTTP status codes that trigger Salesforce to refresh expired or invalid access tokens, in addition to the standard 401 HTTP status code response.
- AuthHeader: Allows the user to specify custom authentication headers to be added to the callout at run time. When using AuthHeader, the parameterName field must be the header name as a string, and parameterValue must be a formula of a header value that is evaluated at run time. sequenceNumber determines the order in which headers are sent out in the callout. Headers with lower numbers are sent out first.
- AuthParameter: Allows the user to add additional authentication settings. parameterName defines the parameter to set. For example, AwsRegion sets the AWS Region parameter to apply for an AWS Signature V4 authentication protocol and parameterValue is the value for the AWS Region.
- AuthProtocolVariant: Used to specify a variant of an authentication protocol. For example, Aws Sts as a variant when the ParameterName is AwsSv4 and the ParameterValue is AwsSv4\_STS.
- AuthProvider: Specifies that this parameter configures an authentication provider referenced by the authProvider field.
- AuthProviderUrl: Specifies the authentication endpoint URL. For example, if the authentication type is OAuth with JWT Bearer Flow, then parameterValue is an authentication token endpoint.
- AuthProviderUrlQueryParameter: Allows the user to specify custom query parameters to be added to the callout to the authentication provider at run time. Currently, supported only for AWS Signature V4 with STS. The allowed AuthProviderUrlQueryParameter values are AwsExternalId and AwsDuration, used with AWS STS.
- AwsStsPrincipal: Configures AWS Signature V4 along with STS. parameterName is AwsStsPrincipal and parameterValue isn’t specified.
- CreatedByNamespace: Reserved for internal use.
- CustomPrincipal: Reserved for internal use.
- ExternalAuthIdentityProvider: Specifies that this parameter configures an authentication provider referenced by the externalAuthIdentityProvider field.
- GlobalNamedPrincipal: Reserved for internal use.
- JwtBodyClaim: Specifies a JWT (JSON Web Token) body claim, where parameterName is the key and parameterValue is the value. For example, the parameter name for a JWT audience is aud.
- JwtHeaderClaim: Specifies a JWT header claim, where parameterName is the key and parameterValue is the value. For example, the parameter name for a JWT key identifier is kid.
- ManagedByComponent: Reserved for internal use.
- ManagedByFeature: Reserved for internal use.
- NamedPrincipal: Specifies that the parameter uses the same set of user credentials for all users who access the external system.
- PerUserPrincipal: Provides access control at the individual user level.
- PrincipalIdentityAlias: Reserved for internal use.
- SfHttpRequestExtensionName: Reserved for internal use.
- SigningCertificate: Specifies the certificate used for an authentication signature. Use the certificate field to specify the certificate name. Used for OAuth with JWT Bearer Flow and AwsSv4 STS with RolesAnywhere authentication.
- SystemUserPrincipal: Reserved for internal use.





 |
| parameterValue | 

Field Type

string

Description

If the parameterType field describes a literal value then the literal value is stored in this field.



 |
| principal | 

Field Type

string

Description

If the value of the parameterType field is either NamedPrincipal or PerUserPrincipal, this field points to a permission set. That value then determines the set of users that are allowed to use credentials provided by the credential provider. The value of the parameterName field specifies the name of this principal.

**First available in API version 56.0, this field is removed in API version 58.0 and later.**





 |
| sequenceNumber | 

Field Type

int

Description

Specifies the order of principals to apply when a user participates in more than one principal. For example, a user could be part of multiple permission sets that are applicable for a credential provider. Priority is from lower to higher numbers.

You can set this field only when parameterType is NamedPrincipal.





 |

## Declarative Metadata Sample Definition

The following is an example of an ExternalCredential component.

<ExternalCredential xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>SampleExternalCredential</label\>
    <authenticationProtocol\>AwsSv4</authenticationProtocol\>
    <externalCredentialParameters\>
        <parameterName\>Principal</parameterName\>
        <parameterType\>NamedPrincipal</parameterType\>
        <sequenceNumber\>1</sequenceNumber\>
    </externalCredentialParameters\>
    <externalCredentialParameters\>
        <parameterName\>AwsService</parameterName\>
        <parameterValue\>iam</parameterValue\>
        <parameterType\>AuthParameter</parameterType\>
    </externalCredentialParameters\>
    <externalCredentialParameters\>
        <parameterName\>AwsRegion</parameterName\>
        <parameterValue\>us-east-1</parameterValue\>
        <parameterType\>AuthParameter</parameterType\>
    </externalCredentialParameters\>
</ExternalCredential\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>ExternalCredential</name>
    </types>
    <version>56.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [NamedCredential](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_namedcredential.htm "Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts.")
- [_Salesforce Help_: Named Credentials](https://help.salesforce.com/s/articleView?id=xcloud.named_credentials_about.htm&type=5&language=en_US "Salesforce Help: Named Credentials - HTML (New Window)")
- [_Named Credentials Developer Guide_: Get Started with Named Credentials](https://developer.salesforce.com/docs/platform/named-credentials/guide/get-started.html "Named Credentials Developer Guide: Get Started with
    Named Credentials - HTML (New Window)")
- [_Named Credentials Developer Guide_: Named Credential API Links](https://developer.salesforce.com/docs/platform/named-credentials/references/named-credentials-reference/nc-api-links.html "Named Credentials Developer Guide: Named Credential
    API Links - HTML (New Window)")
- [_Apex Developer Guide_: Invoking Callouts Using Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_callouts.htm " Apex Developer Guide: Invoking Callouts Using
    Apex - html (New Window)")
- [_Apex Developer Guide_: Named Credentials as Callout Endpoints](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_callouts_named_credentials.htm " Apex Developer Guide: Named Credentials as Callout
    Endpoints - HTML (New Window)")

<!-- document id=661a5808bd4ed103e8d8be9c9e0a89cab7c68e93d8fd3903864db02e834bfdad url=/legacydeveloper/current/en-us/api_meta/meta_externaldataconnector.md -->

# ExternalDataConnector

Used to represent the object where the data was sourced.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

ExternalDataConnector components have the suffix externalDataConnector and are stored in the externalDataConnectors folder.

## Version

ExternalDataConnector components are available in API version 50.0 and later.

## Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d474506e90">Field Name</th>

              <th class="featureTableHeader  " id="d474506e93">Field Type</th>

              <th class="featureTableHeader  " id="d474506e96">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d474506e90" data-title="Field Name"><span class="keyword parmname">dataConnectionStatus</span></td>

              <td class="entry" headers="d474506e93" data-title="Field Type">DataConnectionStatus (enumeration of type string)</td>

              <td class="entry" headers="d474506e96" data-title="Description">Indicates whether you’re connected to a data source. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Connected</samp></li>

                  <li class="li"><samp class="codeph nolang">Disconnected</samp></li>

                  <li class="li"><samp class="codeph nolang">Failed</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d474506e90" data-title="Field Name"><span class="keyword parmname">dataConnectorConfiguration</span></td>

              <td class="entry" headers="d474506e93" data-title="Field Type">string</td>

              <td class="entry" headers="d474506e96" data-title="Description">Reference to the Data Connector Configuration that is used to retrieve or
                receive data such as DataConnectorS3.</td>

            </tr>

            <tr>
              <td class="entry" headers="d474506e90" data-title="Field Name"><span class="keyword parmname">dataConnectorType</span></td>

              <td class="entry" headers="d474506e93" data-title="Field Type">DataConnectorType (enumeration of type string)</td>

              <td class="entry" headers="d474506e96" data-title="Description">Type of connection such as AmazonS3. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ACCOUNTENGAGEMENT</samp></li>

                  <li class="li"><samp class="codeph nolang">AmazonS3</samp></li>

                  <li class="li"><samp class="codeph nolang">CuratedEntity</samp></li>

                  <li class="li"><samp class="codeph nolang">DataCloud</samp></li>

                  <li class="li"><samp class="codeph nolang">ExternalPlatform</samp></li>

                  <li class="li"><samp class="codeph nolang">GoogleCloudStorage</samp></li>

                  <li class="li"><samp class="codeph nolang">IngestApi</samp></li>

                  <li class="li"><samp class="codeph nolang">SalesforceCommerceCloud</samp></li>

                  <li class="li"><samp class="codeph nolang">SalesforceDotCom</samp></li>

                  <li class="li"><samp class="codeph nolang">SalesforceInteractionStudio</samp></li>

                  <li class="li"><samp class="codeph nolang">SalesforceMarketingCloud</samp></li>

                  <li class="li"><samp class="codeph nolang">SFTP</samp></li>

                  <li class="li"><samp class="codeph nolang">StreamingApp</samp></li>

                  <li class="li"><samp class="codeph nolang">UPLOAD</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d474506e90" data-title="Field Name"><span class="keyword parmname">dataPlatform</span></td>

              <td class="entry" headers="d474506e93" data-title="Field Type">string</td>

              <td class="entry" headers="d474506e96" data-title="Description">Reference to the Data Platform that provides or uses this data, such as
                Amazon_S3.</td>

            </tr>


            <tr>
              <td class="entry" headers="d474506e90" data-title="Field Name"><span class="keyword parmname">externalDataTranObjects</span></td>

              <td class="entry" headers="d474506e93" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_externaldatatranobject.htm" target="_blank"><u class="ph u">ExternalDataTranObject</u></a></td>

              <td class="entry" headers="d474506e96" data-title="Description">Stores the schema objects related to the data connector. Available in API
                version 56.0 and later.</td>

            </tr>


            <tr>
              <td class="entry" headers="d474506e90" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d474506e93" data-title="Field Type">string</td>

              <td class="entry" headers="d474506e96" data-title="Description">Required. The UI name for the ExternalDataConnector.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ExternalDataConnector component.

        <?xml version="1.0" encoding="UTF-8"?>
        <ExternalDataConnector xmlns="http://soap.sforce.com/2006/04/metadata">
        <dataConnectionStatus\>Connected</dataConnectionStatus\>
        <dataConnectorConfiguration\>Person</dataConnectorConfiguration\>
        <dataConnectorType\>AmazonS3</dataConnectorType\>
        <dataPlatform\>Amazon\_S3</dataPlatform\>
        <masterLabel\>AmazonS3</masterLabel\>
        </ExternalDataConnector\>

<!-- document id=d6214082bbf952dabea8feee7a72e5c65f317e96ee17e3001d53d239cc79641e url=/legacydeveloper/current/en-us/api_meta/meta_externaldatasource.md -->

# ExternalDataSource

Represents the metadata associated with an external data source. Create external data sources to manage connection details for integration with data and content that are stored outside your Salesforce org.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

All credentials stored within this entity are encrypted under a framework that is consistent with other encryption frameworks on the platform. Salesforce encrypts your credentials by auto-creating org-specific keys. Credentials encrypted using the previous encryption scheme are migrated to the new framework.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExternalDataSource components are stored in the dataSources directory of the corresponding package directory. ExternalDataSource components have the suffix .dataSource, and the prefix is the name of the external data source.

## Version

ExternalDataSource components are available in API version 28.0 and later.

## Special Access Rules

As of Spring ’20 and later, only authenticated internal and external users can access this type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d475227e114">Field Name</th>

              <th class="featureTableHeader  " id="d475227e117">Field Type</th>

              <th class="featureTableHeader  " id="d475227e120">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname" id="field_authProvider"><a name="field_authProvider"><!-- --></a>authProvider</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description"><span class="ph" id="field_authProvider_desc"><a name="field_authProvider_desc"><!-- --></a>The authentication provider represented by the
                  AuthProvider component.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">certificate</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">If you specify a certificate, your Salesforce org supplies it when establishing
                each two-way SSL connection with the external system. The certificate is used for
                digital signatures, which verify that requests are coming from your Salesforce
                org.<div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_tip.png" alt="Tip">
                        <div class="mediaBd">
                          <h4 class="mbs">Tip</h4>
                          <p>For best performance, verify that your remote HTTPS encrypted
                            sites have OCSP (Online Certificate Status Protocol) stapling turned
                            on.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname" id="field_customConfiguration"><a name="field_customConfiguration"><!-- --></a>customConfiguration</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">A string of configuration parameters that are specific to the external data
                source’s <span class="keyword parmname">type</span>.<ul class="ul bulletList">
                  <li class="li"><a class="xref" href="#section_customconfiguration_xorg">customConfiguration for Salesforce Connect—Cross-Org Adapter</a></li>

                  <li class="li"><a class="xref" href="#section_customconfiguration_odata">customConfiguration for Salesforce Connect—OData 2.0 or 4.0 Adapter</a></li>

                  <li class="li"><a class="xref" href="#section_customconfiguration_apex">customConfiguration for Salesforce Connect—Custom Adapter</a></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">customHttpHeaders</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">
                <a class="xref" href="#CustomHttpHeader">CustomHttpHeaders</a>[]
              </td>

              <td class="entry" headers="d475227e120" data-title="Description">Represents custom HTTP headers used with OData 2.0 or OData 4.0 connectors.
                Available in API version 43.0 or later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">endpoint</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">The URL of the external system, or if that URL is defined in a named
                credential, the named credential URL. Corresponds to the <span class="keyword parmname">URL</span> in the
                user interface.<p class="p">A named credential URL contains the scheme <samp class="codeph nolang">callout:</samp>, the name of the named credential, and an
                  optional path. For example: <samp class="codeph nolang">callout:</samp><var class="keyword varname">My_Named_Credential</var><samp class="codeph nolang">/</samp><var class="keyword varname">some_path</var>.</p>
                <p class="p">You can append
                  a query string to a named credential URL. Use a question mark (?) as the separator between the named
                  credential URL and the query string. For example: <samp class="codeph nolang">callout:</samp><var class="keyword varname">My_Named_Credential</var><samp class="codeph nolang">/</samp><var class="keyword varname">some_path</var><samp class="codeph nolang">?format=json</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">externalDataSrcDescriptors</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">
                <a class="xref" href="#externalDataSrcDescriptor">ExternalDataSrcDescriptors</a>[]
              </td>

              <td class="entry" headers="d475227e120" data-title="Description">Represents schema descriptors for an external data source used with the Salesforce
                Connect adapter for Amazon DynamoDB (available in API version 55.0 or later) or
                Amazon Athena (available in API version 56.0 or later).</td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">isWritable</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d475227e120" data-title="Description">
                <p class="p">Allows the Lightning Platform and users in this org to create, update, and delete
                  records for external objects associated with the external data source. The
                  external object data is stored outside the org. By default, external objects are
                  read-only. Corresponds to <span class="keyword parmname">Writable External Objects</span> in the
                  user interface.</p>

                <p class="p">Available in API version 35.0 and later. However, with the cross-org adapter for
                  Salesforce Connect, you can set this field to <samp class="codeph nolang">true</samp> only in API version 39.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">A name for the external data source. The label is displayed in
                the Salesforce user interface, such as in list views.<p class="p">Examples include Acme Team
                  Marketing Site or Acme SharePoint.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">namedCredential</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description"> Represents the definition of the referenced named credential for an external
                data source of the type Amazon DynamoDB or Amazon Athena.</td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">oauthRefreshToken</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">The OAuth refresh token. Used to obtain a new access token for an end user when
                a token expires.</td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">oauthScope</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">Specifies the scope of permissions to request for the access token. Corresponds
                to the <span class="keyword parmname">Scope</span> in the user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">oauthToken</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">The access token issued by the external system.</td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">password</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">The password your org uses to access the external system. Make sure
                that the credentials you use have adequate privileges to access the external system,
                perform searches, return data, and return information about the external system’s
                metadata.</td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">principalType</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">
                <samp class="codeph nolang">External​PrincipalType</samp>​
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d475227e120" data-title="Description">Determines whether you're using one set or multiple sets of credentials to
                access the external system. Corresponds to <span class="keyword parmname">Identity Type</span> in the
                user interface. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Anonymous</samp></li>

                  <li class="li"><samp class="codeph nolang">NamedCustomPrincipal</samp></li>

                  <li class="li"><samp class="codeph nolang">NamedUser</samp></li>

                  <li class="li"><samp class="codeph nolang">PerUser</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">protocol</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">
                <samp class="codeph nolang">Authentication​Protocol</samp>​
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d475227e120" data-title="Description">The authentication protocol that’s required to access the external system. The
                valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">NoAuthentication</samp></li>

                  <li class="li"><samp class="codeph nolang">Oauth</samp></li>

                  <li class="li"><samp class="codeph nolang">Password</samp></li>

                </ul>
                <p class="p">For cloud-based Files Connect external systems, select <strong class="ph uicontrol">Oauth
                    2.0</strong>. For on-premises systems, select <strong class="ph uicontrol">Password
                    Authentication</strong>.</p>
                <p class="p">For Simple URL data sources, select
                  <strong class="ph uicontrol">No Authentication</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">repository</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">Used for SharePoint Online. If metadata isn't accessible, use this field to
                create tables and default table fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">
                <samp class="codeph nolang">ExternalDataSourceType</samp>
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d475227e120" data-title="Description">Required. For Salesforce Connect, specifies the adapter that connects to the
                external system. The valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AmazonAthena</samp>—Amazon Athena
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AmazonDynamoDB</samp>—Amazon
                    DynamoDB
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OData</samp>—OData 2.0 adapter
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OData4</samp>—OData 4.0 adapter
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SfdcOrg</samp>—cross-org adapter
                  </li>

                  <li class="li">
                    <var class="keyword varname">ApexClassId</var>—<samp class="codeph apex_code">DataSource.Provider</samp> class that defines the custom adapter created
                    via the Apex Connector Framework
                  </li>

                </ul>
                <p class="p">For Files Connect, specifies the data source type. The valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ContentHubSharepoint</samp>—SharePoint
                    2010 or 2013
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ContentHubSharepointOffice365</samp>—SharePoint Online
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ContentHubSharepointOneDrive</samp>—OneDrive for Business
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ContentHubGDrive</samp>—Google Drive
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ContenHubIsotope</samp>—Isotope
                  </li>

                </ul>
                <p class="p">If Chatter is enabled, you can also specify <samp class="codeph nolang">SimpleURL</samp> to access data hosted on a web server that doesn’t require
                  authentication.</p>
                <ul class="ul bulletList">
                  <li class="li"><span class="ph" id="outgoingemail_desc"><a name="outgoingemail_desc"><!-- --></a><samp class="codeph nolang">outgoingemail</samp>—A data source used for sending an email through a
                      quick action.</span></li>

                </ul>

                <p class="p">For Digital Lending Configurator, the valid value is:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AFPPAttribute</samp>—The data source name for the
                    Application Form Product Proposal Attribute virtual object.
                  </li>

                </ul>

                <p class="p">For the federated search external data source type, the valid value is:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">OpenSearch</samp></li>

                </ul>

                <p class="p">For Transaction Management in Revenue Cloud, the valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ASPAttribute</samp>—The data source name
                    for the Asset State Period Attribute virtual object. Available in API version
                    63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OIAttribute</samp>—The data source name for the Order Item Attribute virtual
                    object. Available in API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">QLIAttribute</samp>—The data source name for the Quote Line Item Attribute virtual
                    object. Available in API version 63.0 and later.
                  </li>

                </ul>
                <p class="p">For
                  SalesAgreement in Manufacturing Cloud, the valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">SAPAttribute</samp>—The data source name
                    for the SalesAgreement Product Attribute virtual object. Available in API
                    version 60.0 and later.
                  </li>

                </ul>
                <p class="p">These values are reserved for internal use:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">AssetAttribute</samp></li>

                  <li class="li"><samp class="codeph nolang">ClaimAttributeDS</samp></li>

                  <li class="li"><samp class="codeph nolang">ClaimItemAttributeDS</samp></li>

                  <li class="li"><samp class="codeph nolang">CryptoTrEnvChgLogSnp</samp></li>

                  <li class="li"><samp class="codeph nolang">CtrtGrpPlnAttr</samp></li>

                  <li class="li"><samp class="codeph nolang">CtrtGrpPlnGrpClsAttr</samp></li>

                  <li class="li"><samp class="codeph nolang">FAAttribute</samp></li>

                  <li class="li"><samp class="codeph nolang">FLAttribute</samp></li>

                  <li class="li"><samp class="codeph nolang">IAItemProdtAttr</samp></li>

                  <li class="li"><samp class="codeph nolang">Identity</samp></li>

                  <li class="li"><samp class="codeph nolang">InsPolicyAttribute</samp></li>

                  <li class="li"><samp class="codeph nolang">IPAAttribute</samp></li>

                  <li class="li"><samp class="codeph nolang">IPCAttribute</samp></li>

                  <li class="li"><samp class="codeph nolang">IPCvrBnftAttribute</samp></li>

                  <li class="li"><samp class="codeph nolang">IPPAttribute</samp></li>

                  <li class="li"><samp class="codeph nolang">SdbOvenPODataSource</samp></li>

                  <li class="li"><samp class="codeph nolang">Wrapper</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">username</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">The user name that your org uses to access the external system. Make sure that
                the credentials you use have adequate privileges to access the external system,
                perform searches, return data, and return information about the external system’s
                metadata.</td>

            </tr>

            <tr>
              <td class="entry" headers="d475227e114" data-title="Field Name"><span class="keyword parmname">version</span></td>

              <td class="entry" headers="d475227e117" data-title="Field Type">string</td>

              <td class="entry" headers="d475227e120" data-title="Description">Reserved for future use.</td>

            </tr>

          </tbody>

        </table>

## CustomHttpHeaders

Represents a custom HTTP header used with OData 2.0 or OData 4.0 connectors. Available in API version 43.0 or later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | A text description of the header field’s purpose. |
| headerFieldName | string | Required. Name of the header field. The name must contain at least one alphanumeric character or underscore. It can also include these characters: ! # $ % & ' \* + - . ^ \_ \` | ~. |
| headerFieldValue | string | Required. A formula that resolves to the value for the header. The values in the formula must evaluate to a string. If the formula resolves to null and an empty string, the header isn’t sent. |
| isActive | boolean | Indicates whether the custom HTTP header is available to use (true) or unavailable (false). |

## customConfiguration for Salesforce Connect—Cross-Org Adapter

This sample JSON-encoded configuration string defines parameters that apply when the external data source’s type is set to SfdcOrg.

{"apiVersion":"32.0","environment":"CUSTOM",
"searchEnabled":"true","timeout":"120"}

The parameters correspond to these fields in the user interface:

- apiVersion—API Version
- environment—Connect to
- searchEnabled—Enable Search
- timeout—Connection Timeout

## customConfiguration for Salesforce Connect—OData 2.0 or 4.0 Adapter

This JSON-encoded configuration string defines parameters that apply when the external data source’s type is set to OData or OData4.

{"inlineCountEnabled":"true","csrfTokenName":"X-CSRF-Token",
"requestCompression":"false","pagination":"CLIENT",
"noIdMapping":"false","format":"ATOM",
"searchFunc":"","compatibility":"DEFAULT",
"csrfTokenEnabled":"true","timeout":"120",
"searchEnabled":"true"}

The parameters correspond to these fields in the user interface.

- compatibility—Special Compatibility
- csrfTokenEnabled—Cross-Site Request Forgery (CSRF) Protection
- csrfTokenName—Anti-CSRF Token Name
- format—Format
- inlineCountEnabled—Request Row Counts
- noIdMapping—High Data Volume
- pagination—Server Driven Pagination
- requestCompression—Compress Requests
- searchEnabled—Enable Search
- searchFunc—Custom Query Option for Salesforce Search
- timeout—Connection Timeout

Declarative Metadata Sample Definition: OData 2.0 or 4.0

The following is the definition of an external data source for Salesforce Connect—OData 2.0 or 4.0 adapter.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalDataSource xmlns="http://soap.sforce.com/2006/04/metadata">
    <authProvider\>FacebookAuth</authProvider\>
    <customConfiguration\>{"compatibility":"DEFAULT",
    "noIdMapping":"false","inlineCountEnabled":"true",
    "searchEnabled":"true","format":"ATOM",
    "requestCompression":"false","pagination":"SERVER",
    "timeout":"120"}</customConfiguration\>
    <customHttpHeaders\>
        <headerFieldName\>X-User</headerFieldName\>
        <headerFieldValue\>$User.Username</headerFieldValue\>
    </customHttpHeaders\>
    <endpoint\>http://myappname.herokuapp.com/DataHub.svc</endpoint\>   
    <label\>DataHub</label\>
    <principalType\>NamedUser</principalType\>
    <protocol\>Oauth</protocol\>
    <type\>OData</type\>
</ExternalDataSource\>

## customConfiguration for Salesforce Connect—Custom Adapter

This sample JSON-encoded configuration string defines the parameter that applies when the external data source’s type is set to the ID of a DataSource.Provider class.

{"noIdMapping":"false"}

The noIdMapping parameter corresponds to the High Data Volume field in the user interface.

## ExternalDataSrcDescriptors for Salesforce Connect Adapter for Amazon DynamoDB and for Amazon Athena

Represents schema descriptors for an external data source used with the Salesforce Connect adapter. The schema descriptors are for Amazon DynamoDB (available in API version 55.0 or later) or Amazon Athena (available in API version 56.0 or later).

<table class="featureTable sort_table" summary="">



            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d475227e1035">Field Name</th>

                <th class="featureTableHeader  " id="d475227e1038">Field Type</th>

                <th class="featureTableHeader  " id="d475227e1041">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d475227e1035" data-title="Field Name"><span class="keyword parmname">customObject</span></td>

                <td class="entry" headers="d475227e1038" data-title="Field Type">string</td>

                <td class="entry" headers="d475227e1041" data-title="Description">If set, the external object associated with the descriptor.</td>

              </tr>

              <tr>
                <td class="entry" headers="d475227e1035" data-title="Field Name"><span class="keyword parmname">descriptor</span></td>

                <td class="entry" headers="d475227e1038" data-title="Field Type">string</td>

                <td class="entry" headers="d475227e1041" data-title="Description">Required. The descriptor document that contains the metadata
                  information.</td>

              </tr>

              <tr>
                <td class="entry" headers="d475227e1035" data-title="Field Name"><span class="keyword parmname">descriptorVersion</span></td>

                <td class="entry" headers="d475227e1038" data-title="Field Type">string</td>

                <td class="entry" headers="d475227e1041" data-title="Description">If the external system supports schema versioning for the data source, the
                  optional descriptor document version tracks the external system's schema version.
                  Several descriptors with different document versions can be active.</td>

              </tr>

              <tr>
                <td class="entry" headers="d475227e1035" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

                <td class="entry" headers="d475227e1038" data-title="Field Type">string</td>

                <td class="entry" headers="d475227e1041" data-title="Description">Required. The unique name of the child-level setup entity.</td>

              </tr>

              <tr>
                <td class="entry" headers="d475227e1035" data-title="Field Name"><span class="keyword parmname">externalDataSource</span></td>

                <td class="entry" headers="d475227e1038" data-title="Field Type">string</td>

                <td class="entry" headers="d475227e1041" data-title="Description">Required. The name of the external data source associated with the
                  descriptor.</td>

              </tr>

              <tr>
                <td class="entry" headers="d475227e1035" data-title="Field Name"><span class="keyword parmname">subtype</span></td>

                <td class="entry" headers="d475227e1038" data-title="Field Type">ExternalDataSrcDescSubtype (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                  string)</td>

                <td class="entry" headers="d475227e1041" data-title="Description">Required. The subtype of the descriptor.<p class="p">Values are:</p>
                  <ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">SchemaTableMetadata</samp>— Used to cache
                      information about the external system.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">SchemaTableQualifiers</samp>— Used to
                      customize the data retrieval query to the external system.
                    </li>

                  </ul>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d475227e1035" data-title="Field Name"><span class="keyword parmname">systemVersion</span></td>

                <td class="entry" headers="d475227e1038" data-title="Field Type">int</td>

                <td class="entry" headers="d475227e1041" data-title="Description">Required. The version that defines the descriptor format and provides
                  compatibility with descriptor formats between Salesforce releases.</td>

              </tr>

              <tr>
                <td class="entry" headers="d475227e1035" data-title="Field Name"><span class="keyword parmname">type</span></td>

                <td class="entry" headers="d475227e1038" data-title="Field Type">ExternalDataSrcDescType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                  string)</td>

                <td class="entry" headers="d475227e1041" data-title="Description">Required. The type of the descriptor.<p class="p">Valid value:</p>
                  <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">Schema</samp></li>

                  </ul>
                </td>

              </tr>

            </tbody>

          </table>

Declarative Metadata Sample Definition: Amazon DynamoDB

The following is an example of an external data source for the Salesforce Connect adapter for Amazon DynamoDB that uses ExternalDataSrcDescriptor component.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalDataSource xmlns="http://soap.sforce.com/2006/04/metadata">
    <customConfiguration\>{"timeout":"120"}</customConfiguration\>
    <externalDataSrcDescriptors\>
        <fullName\>MyQualifierName</fullName\>
        <customObject\>MyExternalObject\_\_x</customObject\>
        <descriptor\>
        {
          "tableName": "MyDynamoDBTable",
          "columns": {
            "MyField": {"presence": "exists"}
          }
        }
        </descriptor\>
        <developerName\>MyQualifierName</developerName\>
        <externalDataSource\>MyDataSource</externalDataSource\>
        <subtype\>SchemaTableQualifiers</subtype\>
        <systemVersion\>0</systemVersion\>
        <type\>Schema</type\>
    </externalDataSrcDescriptors\>
    <isWritable\>true</isWritable\>
    <label\>MyDataSource</label\>
    <namedCredential\>MyNamedCredential</namedCredential\>
    <principalType\>Anonymous</principalType\>
    <protocol\>NoAuthentication</protocol\>
    <type\>AmazonDynamoDb</type\>
</ExternalDataSource\>

Declarative Metadata Sample Definition: Amazon Athena

The following is an example of an external data source for the Salesforce Connect adapter for Amazon Athena that uses ExternalDataSrcDescriptor component.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalDataSource xmlns="http://soap.sforce.com/2006/04/metadata">
    <customConfiguration\>
    {
      "DataCatalog": "AwsDataCatalog",
      "timeout": "120"
    }
    </customConfiguration\>
    <externalDataSrcDescriptors\>
        <fullName\>MyAthenaQualifierName</fullName\>
        <customObject\>MyAthenaExternalObject\_\_x</customObject\>
        <descriptor\>
        {
          "tableName": "myathenadatabase.myathenatable",
          "extendedQualifiers": {"workgroup": "primary"},
          "keyColumns": \["ExternalIdComponent", "OtherExternalIdComponent"\]
        }
        </descriptor\>
        <developerName\>MyAthenaQualifierName</developerName\>
        <externalDataSource\>MyAthenaDataSource</externalDataSource\>
        <subtype\>SchemaTableQualifiers</subtype\>
        <systemVersion\>0</systemVersion\>
        <type\>Schema</type\>
    </externalDataSrcDescriptors\>
    <isWritable\>false</isWritable\>
    <label\>MyAthenaDataSource</label\>
    <namedCredential\>MyAthenaNamedCredential</namedCredential\>
    <principalType\>Anonymous</principalType\>
    <protocol\>NoAuthentication</protocol\>
    <type\>AmazonAthena</type\>
</ExternalDataSource\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=d62bf21479e2fd95a63cbcf99d7fa4506a02d1d8eb3d15ac099544ab7e1a303f url=/legacydeveloper/current/en-us/api_meta/meta_externaldatatranobject.md -->

# ExternalDataTranObject

Represents a definition of a Data 360 schema object. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

ExternalDataTranObject components have the suffix .externalDataTranObject and are stored in the externalDataTranObjects folder.

## Version

ExternalDataTranObject components are available in API version 55.0 and later.

## Special Access Rules

ExternalDataTranObject is available only if Data 360 is provisioned.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d478716e111">Field Name</th>

              <th class="featureTableHeader  " id="d478716e114">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d478716e111" data-title="Field Name"><span class="keyword parmname">availabilityStatus</span></td>

              <td class="entry" headers="d478716e114" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">AvailabilityStatus (enumeration of type string)</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Required.</p>
                    Represents the availability of the object. Valid values are:<ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Available</samp></li>

                      <li class="li"><samp class="codeph nolang">In_Use</samp></li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e111" data-title="Field Name"><span class="keyword parmname">creationType</span></td>

              <td class="entry" headers="d478716e114" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">DefinitionCreationType (enumeration of type string)</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Required.</p>
                    Describes whether this object was added by the Customer or
                    as part of a Standard Taxonomy or by the System. Valid values are: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Segment_Membership</samp></li>

                      <li class="li">
                        <samp class="codeph nolang">Activation_Audience</samp> (Reserved for
                        internal use only)
                      </li>

                      <li class="li"><samp class="codeph nolang">Custom</samp></li>

                      <li class="li"><samp class="codeph nolang">Standard</samp></li>

                      <li class="li"><samp class="codeph nolang">System</samp></li>

                      <li class="li"><samp class="codeph nolang">Derived</samp></li>

                      <li class="li"><samp class="codeph nolang">Bridge</samp></li>

                      <li class="li"><samp class="codeph nolang">Curated</samp></li>

                      <li class="li"><samp class="codeph nolang">Standard</samp></li>

                    </ul>
                    <p class="p">Valid values available in API version 62.0 and later are: </p>
                    <a name="ul_yrr_bb2_t2c"><!-- --></a>
                    <ul class="ul bulletList" id="ul_yrr_bb2_t2c">
                      <li class="li"><samp class="codeph nolang">ADG</samp></li>

                      <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                      <li class="li"><samp class="codeph nolang">CG_Audience</samp></li>

                      <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                      <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                      <li class="li"><samp class="codeph nolang">External</samp></li>

                      <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                      <li class="li"><samp class="codeph nolang">Transform</samp></li>

                      <li class="li"><samp class="codeph nolang">Vector_Embedding </samp></li>

                    </ul>
                  </dd>


                </dl>
                <p class="p">Valid values available in API version 67.0 and later are: </p>
                <a name="ul_wqh_ys3_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_wqh_ys3_tjc">
                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                  <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                  <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e111" data-title="Field Name"><span class="keyword parmname">extDataTranObjectTemplate</span></td>

              <td class="entry" headers="d478716e114" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Reserved for internal use and read-only. Reference to the associated
                    ExtDataTranObjectTemplate data kit object. The system populates this field
                    when a data kit that contains a data stream is deployed.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e111" data-title="Field Name"><span class="keyword parmname">externalDataTranFields</span></td>

              <td class="entry" headers="d478716e114" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd"><a class="xref" href="#subtype_ExternalDataTranField">ExternalDataTranField</a></dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    Stores the fields related to that schema object.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e111" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d478716e114" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Required.</p>
                    The UI name for the object.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e111" data-title="Field Name"><span class="keyword parmname">mktDataTranObject</span></td>

              <td class="entry" headers="d478716e114" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mktdatatranobject.htm" title="An entity that is used to deliver (aka transport) information from the source to a target (target will be called a landing entity).This can be the schema of a file, API, Event, or other means of transporting data, such as SubscriberFile1.csv, or SubscriberCDCEvent.">MktDataTranObject</a></dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    An entity that is used to transport information from the
                    source to a target.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e111" data-title="Field Name"><span class="keyword parmname">objectCategory</span></td>

              <td class="entry" headers="d478716e114" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Required.</p>
                    Reference to the Object Category. For Transport, they're
                    Profile, Engagement, or Other.
                  </dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## ExternalDataTranField

Stores the fields related to ExternalDataTranObject schema.

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d478716e498">Field Name</th>

              <th class="featureTableHeader  " id="d478716e501">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">creationType</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">DefinitionCreationType (enumeration of type string).</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Required.</p>
                    Describes whether this object was added by the Customer or
                    as part of a Standard Taxonomy or by the System. Valid values are: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Segment_Membership</samp></li>

                      <li class="li"><samp class="codeph nolang">Custom</samp></li>

                      <li class="li"><samp class="codeph nolang">Standard</samp></li>

                      <li class="li"><samp class="codeph nolang">System</samp></li>

                      <li class="li"><samp class="codeph nolang">Derived</samp></li>

                      <li class="li"><samp class="codeph nolang">Bridge</samp></li>

                      <li class="li"><samp class="codeph nolang">Curated</samp></li>

                    </ul>
                  </dd>


                </dl>
                <p class="p">Valid values available in API version 67.0 and later are: </p>
                <a name="ul_mmn_zs3_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_mmn_zs3_tjc">
                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                  <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                  <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">datatype</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Required.</p>
                    Phone, currency, number, or other assigned type.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">dateFormat</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    The Date format of date, time, date/time fields in this
                    Transport field.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">extDataTranFieldTemplate</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Reserved for internal use and read-only. Reference to the associated
                    ExtDataTranFieldTemplate data kit object. The system populates this field when
                    a data kit that contains a data stream is deployed.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">externalName</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    Name of the object in the external system (different from
                    Developer Name).
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">isCurrencyIsoCode</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    If true, this field is a currency ISO code.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">isDataRequired</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    If true, data is required for this field.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">length</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    Length of a string column.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">Optional. Field label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">mktDataTranField</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd"><a class="xref" href="#subytype_MktDataTranField">mktDataTranFieldType</a></dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>

                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">precision</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    Used for currency and numeric accuracy.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">primaryIndexOrder</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    If supplied, indicates this field is part of the primary key
                    where the number value (starting at 1) indicates the order of attributes if
                    it's a compound primary key. Missing value means this field isn’t part of the
                    primary key.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">scale</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    Used for currency and numbers.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e498" data-title="Field Name"><span class="keyword parmname">sequence</span></td>

              <td class="entry" headers="d478716e501" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    The sequence of this source schema.
                  </dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## MktDataTranField

Stores fields related to [MktDataTranObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mktdatatranobject.htm "An entity that is used to deliver (aka transport) information from the source to a target (target will be called a landing entity).This can be the schema of a file, API, Event, or other means of transporting data, such as SubscriberFile1.csv, or SubscriberCDCEvent.").

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d478716e1036">Field Name</th>

              <th class="featureTableHeader  " id="d478716e1039">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">creationType</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">DefinitionCreationType (enumeration of type string).</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Required.</p>
                    Describes whether this object was added by the Customer or
                    as part of a Standard Taxonomy or by the System. Valid values are: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Segment_Membership</samp></li>

                      <li class="li"><samp class="codeph nolang">Custom</samp></li>

                      <li class="li"><samp class="codeph nolang">Standard</samp></li>

                      <li class="li"><samp class="codeph nolang">System</samp></li>

                      <li class="li"><samp class="codeph nolang">Derived</samp></li>

                      <li class="li"><samp class="codeph nolang">Bridge</samp></li>

                      <li class="li"><samp class="codeph nolang">Curated</samp></li>

                      <li class="li">
                        <p class="p">Valid values available in API version 62.0 and later are: </p>

                        <a name="ul_rjt_r2n_52c"><!-- --></a>
                        <ul class="ul bulletList" id="ul_rjt_r2n_52c">
                          <li class="li"><samp class="codeph nolang">ADG</samp></li>

                          <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                          <li class="li"><samp class="codeph nolang">CG_Audience</samp></li>

                          <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                          <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                          <li class="li"><samp class="codeph nolang">External</samp></li>

                          <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                          <li class="li"><samp class="codeph nolang">Transform</samp></li>

                          <li class="li"><samp class="codeph nolang">Vector_Embedding </samp></li>

                        </ul>

                      </li>

                    </ul>
                  </dd>


                </dl>

                <p class="p">Valid values available in API version 67.0 and later are: </p>

                <a name="ul_tbp_ls3_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_tbp_ls3_tjc">
                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                  <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                  <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">datatype</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Required.</p>
                    Phone, currency, number, or other assigned type.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">dateFormat</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    The Date format of date, time, date/time fields in this
                    Transport field.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">externalName</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    Name of the object in the external system (different from
                    Developer Name).
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">isDataRequired</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    If true, data is required for this field.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">length</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    Length of a string column.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">Optional. Field label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">precision</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    Used for currency and numeric accuracy.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">primaryIndexOrder</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    If supplied, indicates this field is part of the primary key
                    where the number value (starting at 1) indicates the order of attributes if
                    it's a compound primary key. Missing value means this field isn’t part of the
                    primary key.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">scale</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    Used for currency and numbers.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d478716e1036" data-title="Field Name"><span class="keyword parmname">sequence</span></td>

              <td class="entry" headers="d478716e1039" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Optional.</p>
                    The sequence of this source schema.
                  </dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ExternalDataTranObject component.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalDataTranObject xmlns="http://soap.sforce.com/2006/04/metadata">
        <fullName\>PlatformTraces</fullName\>
        <availabilityStatus\>Available</availabilityStatus\>
        <creationType\>Custom</creationType\>
        <masterLabel\>PlatformTraces</masterLabel\>
        <objectCategory\>Salesforce\_SFDCReferenceModel\_0\_93.Engagement</objectCategory\>
</ExternalDataTranObject\>

The following is an example package.xml that references the previous definition.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExternalDataTranObject</name\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a3385732fa2a0e614def4ead086cbec945d775abb35c3f129da8180ea92efa18 url=/legacydeveloper/current/en-us/api_meta/meta_externaldatatransportfieldtemplate.md -->

# ExternalDataTransportFieldTemplate

For internal use only.

<!-- document id=e295ec77b23e5305a25ed2d4caa18586651fd53432e3bc5bd4fc263fc1eac372 url=/legacydeveloper/current/en-us/api_meta/meta_externaldatatransportobjecttemplate.md -->

# ExternalDataTransportObjectTemplate

For internal use only.

<!-- document id=dd9e3691e58ba07e150a77567d278e2155e9fdf46b4678d17db1cd2b41390c32 url=/legacydeveloper/current/en-us/api_meta/meta_externalserviceregistration.md -->

# ExternalServiceRegistration

Represents the external service configuration for an org.

## File Suffix and Directory Location

ExternalServiceRegistration components have the suffix .externalServiceRegistration and are stored in the externalServiceRegistrations folder.

## Version

ExternalServiceRegistration components are available in API version 39.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d481846e81">Field Name</th>

              <th class="featureTableHeader  " id="d481846e84">Field Type</th>

              <th class="featureTableHeader  " id="d481846e87">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">catalogedApiVersion</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">A version of an API brought into API Catalog from an external source and
                managed for consumption in Salesforce. Available in API version 65.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">The external service description defined when the service is created.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">Required. The service name as it appears on the External Services
                wizard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">namedCredential</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">The reference by name to be used for the service.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">namedCredentialReference</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">reference</td>

              <td class="entry" headers="d481846e87" data-title="Description">The reference by ID to be used for the named credential. When used, supersedes
                <samp class="codeph nolang">namedCredential</samp>. Available in API version
                57.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">operations</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">
                <a class="xref" href="#ExternalServiceOperation">ExternalServiceOperation</a>[]
              </td>

              <td class="entry" headers="d481846e87" data-title="Description">Items defined for this operation.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">registrationProvider</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">A reference to the registration provider.<ul class="ul bulletList">
                  <li class="li">If the registrationProviderType is <samp class="codeph nolang">ExternalConnector</samp>, this field contains the external connector
                    name.</li>

                  <li class="li">If the registrationProviderType is <samp class="codeph nolang">Heroku</samp>, this field contains the HerokuAppLink ID.</li>

                  <li class="li">For any other registrationProviderType value, this field is blank and reserved
                    for future use.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">registrationProviderAsset</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">A polymorphic foreign key field that contains the name of the asset related to
                the external service registration.<ul class="ul bulletList">
                  <li class="li">For an external service registration created for a named query, this field
                    contains the named query API name.</li>

                  <li class="li">For an external service registration created for an Apex class that has
                    methods exposed as REST resources or methods that are Aura-enabled. This field
                    contains the Apex class name.</li>

                </ul>
                Available in API version 66.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">registrationProviderType</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">ExternalServiceRegistrationProviderType (enumeration of type string)</td>

              <td class="entry" headers="d481846e87" data-title="Description">Indicates the source of the API specification registered with the External
                Services wizard. Valid values include:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AgentActionOutputs</samp>—Reserved for internal
                    use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AgentToAgent</samp>—The API specification
                    represents the external service schemas that enable communication between AI
                    agents. Available in API version 66.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Anypoint</samp>—The API specification is managed
                    in the MuleSoft Anypoint Platform. Available in API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AnypointPublic</samp>—Reserved for internal use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ApexRest</samp>—The API specification was
                    created from an Apex REST class. Available in API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AuraEnabled</samp>—The API specification was
                    created from an Apex class that has AuraEnabled methods. Available in API
                    version 65.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CodeExtension</samp>—Reserved for internal use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Commerce</samp>—The API specification was
                    configured for custom Salesforce Commerce APIs. Available in API version 67.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ContextDef</samp>—The API specification used to
                    create dynamic Apex classes for the related context definition structure.
                    Available in API version 66.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Custom</samp>—The API specification was manually
                    configured.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomExternalConnector</samp>—The API
                    specification represents a custom partner-created version of an external
                    connection. Available in API version 66.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DocumentProcessing</samp>—Reserved for internal
                    use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ExternalConnector</samp>—The API specification
                    represents an external connection.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Heroku</samp>—The API specification represents a
                    Heroku app.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MuleSoft</samp>—The API specification was
                    selected from MuleSoft. Use Anypoint for MuleSoft for Agentforce: API Catalog
                    MuleSoft sources.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NamedQuery</samp>—The API specification
                    represents a named query REST endpoint. Available in API version 64.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SchemaInferred</samp>—The API specification was
                    provided during the HTTP Callout configuration process. Available in API version
                    57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Standard</samp>—The API specification was
                    defined when an external service was created.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">schema</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">The content of the OpenAPI 2.0.x or OpenAPI 3.0.x schema in JSON or YAML
                format. Nillable.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">schemaAbsoluteUrl</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">The full, absolute URL to the schema. Populated when a user selects
                <strong class="ph uicontrol">Absolute URL</strong> during registration.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">schemaType</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">The schema format. OpenAPI for OpenAPI 2.0.x or OpenAPI 3.0.x. If not
                specified, the schema type is derived based on the schema content. Nillable.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">schemaUploadFileExtension</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">The file’s extension. Populated when a user selects <strong class="ph uicontrol">Upload from
                  local</strong> during registration.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">schemaUploadFileName</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">The file’s name without the file extension. Populated when a user selects
                <strong class="ph uicontrol">Upload from local</strong> during registration.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">schemaUrl</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">The path must begin with "/" and be relative to the named credential
                endpoint.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">serviceBinding</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">Used to map non-supported media types for this external service registration to
                supported media types. Nillable. Available in API version 53.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">serviceName</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">The name of the cataloged API service that this external service registration
                belongs to. Available in API version 63.0 and later. This field was removed in API
                version 65.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">string</td>

              <td class="entry" headers="d481846e87" data-title="Description">Required. Indicates service registration status. Valid values include:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">complete</samp>—The API spec is valid and the
                    registration is ready to use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">incomplete</samp>—The service registration
                    hasn’t completed.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d481846e81" data-title="Field Name"><span class="keyword parmname">systemVersion</span></td>

              <td class="entry" headers="d481846e84" data-title="Field Type">int</td>

              <td class="entry" headers="d481846e87" data-title="Description">The internal version of External Services that is used to register the API
                specification. Available in API version 55.0 and later. The system versions are
                independent of API versions.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">1</samp>—Retired legacy External Services.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">2</samp>—External Services with limitations on
                    object and operation name length.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">3</samp>—External Services automatically derives
                    developer names fitting within 80 characters.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">4</samp>—Removed the default character set when
                    making a callout to an external service. To specify a character set, include it
                    in the OpenAPI specification, for example: <samp class="codeph nolang">contentType: application/xml; charset=utf-8</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">5</samp>—Introduced asynchronous callouts with
                    callbacks from Apex.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">6</samp>—Added support for OpenAPI Specification
                    (OAS) discriminator mapping.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">7</samp>—Added support for property names that
                    begin with a number. <p class="p">For input parameters on invocable actions, encodes the
                      keyword <span class="keyword parmname">connection</span> as
                      <span class="keyword parmname">reconnection</span>.
                    </p>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">8</samp>—Internal changes.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">9</samp>—Current version. Added support for
                    enums in the OpenAPI spec.
                  </li>

                </ul>
                This field is read-only. You can’t upgrade an external service to a newer
                system version. To take advantage of functionality in a newer system version, you
                must create an external service by using the same OpenAPI spec and then replace any
                references to the old external service. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.external_services_register.htm&amp;language=en_US" target="_blank">Register an External Service</a> in Salesforce
                Help.</td>

            </tr>

          </tbody>

        </table>

## ExternalServiceOperation

| Field Name | Field Type | Description |
| --- | --- | --- |
| active | boolean | Required. Indicates whether the operation is active (true), or inactive (false). |
| name | string | Required. The operation’s name. |

## Declarative Metadata Sample Definition

The following is an example of an ExternalServiceRegistration component that references an external credit service.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalServiceRegistration xmlns="http://soap.sforce.com/2006/04/metadata">
  <label\>BankService</label\>
  <namedCredential\>Bank</namedCredential\>
  <schema\>{
  "swagger": "2.0",
  "basePath": "/",
  "info": {
    "version": "1.0",
    "title": "External Service for demo bank",
    "description": "### External Service for demo bank",
    "x-vcap-service-name": "DemoBankRestServices"
  },
  ...
  "paths": {
  "/accounts/{accountName}": {
      ...
    }
  },
  "definitions": {
    "accountDetails": {
      ...
    },
    "errorModel": {
      ...
    }
  }
}</schema\>
  <schemaType\>OpenApi</schemaType\>
  <schemaUrl\>/accounts/schema</schemaUrl\>
  <status\>Complete</status\>
</ExternalServiceRegistration\>

## serviceBinding

The following JSON-encoded string defines the mapping of a non-supported media type to a supported media type for external service request and response body serialization.

{"compatibleMediaTypes":{
    "application/x-acme-json":"application/json"
}}

The non-supported media type application/x-acme-json is mapped to the supported media type application/json for this External Services registration. The External Services runtime considers the non-supported media type for request and response header processing. It serializes the request and response content by the mapped supported media type.

#### See Also

- [_Salesforce Help_: Media Type Mapping in External Service Registrations](https://help.salesforce.com/s/articleView?id=platform.external_services_mime_type_mapping.htm&type=5&language=en_US "Salesforce Help: Media Type Mapping in External
    Service Registrations - HTML (New Window)")

<!-- document id=64d0984e437a89e2b1414f548ffa50b6dee55990cafde69d32ea0ccc16a37975 url=/legacydeveloper/current/en-us/api_meta/meta_externalservicessettings.md -->

# ExternalServicesSettings

Represents settings for an External Services registration.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

ExternalServicesSettings values are stored in the externalServicesSettings.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

ExternalServicesSettings components are available in API version 47.0 to 55.0. This metadata type is removed in version 56.0 and later.

As of Winter ’23, External Services automatically validates the schema and provides detailed messages for any errors in the UI at registration time so that you can make corrections. See [Register an External Service](https://help.salesforce.com/s/articleView?id=platform.external_services_register.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help.

## Fields

| Field Name | Description |
| --- | --- |
| enableIgnoreUnsupportedOperations | 
Field Type

boolean

Description

Indicates whether your registration should ignore and filter out unsupported schema operations rather than fail the entire registration (true), or whether a specification with invalid schema operations can't be registered successfully (false). Detailed schema errors pertaining to unsupported operations are shown only if this flag is false.



 |

## Declarative Metadata Sample Definition

The following is an example of an ExternalServicesSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ExternalServicesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <enableIgnoreUnsupportedOperations\>true</enableIgnoreUnsupportedOperations\>
</ExternalServicesSettings\>

The following is an example package.xml that references the previous definition.

<types\>
    <members\>ExternalServices</members\>
    <name\>Settings</name\>
  </types\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=3ac1d6ef5bae432a2291710a5d12631f9545bf8683a42606a4067292c0cb1619 url=/legacydeveloper/current/en-us/api_meta/meta_extlclntappcanvassettings.md -->

# ExtlClntAppCanvasSettings

Represents an external client app’s canvas app settings.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppCanvasSettings components have the suffix .ecaCanvas and are stored in the extlClntAppCanvasSettings folder.

## Version

ExtlClntAppCanvasSettings components are available in API version 66.0 and later.

## Special Access Rules

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

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d484132e114">Field Name</th>

              <th class="featureTableHeader  " id="d484132e117">Field Type</th>

              <th class="featureTableHeader  " id="d484132e120">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d484132e114" data-title="Field Name"><span class="keyword parmname">accessMethod</span></td>

              <td class="entry" headers="d484132e117" data-title="Field Type">AccessMethod (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d484132e120" data-title="Description">Required. Indicates how the canvas app initiates the OAuth authentication flow. The
                valid values are:<a name="ul_jg3_d3t_4hc"><!-- --></a>
                <ul class="ul bulletList" id="ul_jg3_d3t_4hc">
                  <li class="li">
                    <samp class="codeph nolang">Get</samp>—OAuth
                    authentication is used, and the user is prompted to allow
                    the third-party application to access their information.
                    When you use this access method, the canvas app must
                    initiate the OAuth authentication flow.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Post</samp>—OAuth
                    authentication is used, but when the administrator installs
                    the canvas app, they implicitly allow access for users.
                    Therefore, the user isn’t prompted to allow the third party
                    to access their user information. When you use this access
                    method, the authentication is posted directly to the canvas
                    app URL.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d484132e114" data-title="Field Name"><span class="keyword parmname">canvasLocationOptions</span></td>

              <td class="entry" headers="d484132e117" data-title="Field Type">CanvasLocationOptions (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)[]</td>

              <td class="entry" headers="d484132e120" data-title="Description">Indicates where the canvas app can appear to the user. The valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Aura</samp>—The canvas
                    app can appear in a custom Lightning component.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ChatterFeed</samp>—The
                    canvas app can appear as a Chatter feed item.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MobileNav</samp>—The
                    canvas app can appear in a mobile card in the Salesforce
                    mobile app.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">None</samp>—The canvas
                    app can appear only in the Canvas App Previewer.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PageLayout</samp>—The
                    canvas app can appear on a page layout. When viewed in the
                    Salesforce mobile app, the canvas app appears in the record
                    detail page.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Publisher</samp>—The
                    canvas app can appear as a global action.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Visualforce</samp>—The
                    canvas app can appear on a Visualforce page.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d484132e114" data-title="Field Name"><span class="keyword parmname">canvasOptions</span></td>

              <td class="entry" headers="d484132e117" data-title="Field Type">CanvasOptions (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)[]</td>

              <td class="entry" headers="d484132e120" data-title="Description">Indicates whether to hide the <strong class="ph uicontrol">Share</strong> button
                and header in the publisher for your canvas app. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">HideShare</samp>—The
                    <strong class="ph uicontrol">Share</strong> button is hidden in the
                    publisher for the related canvas app.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HideHeader</samp>—The
                    header is hidden in the publisher for the related canvas
                    app.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d484132e114" data-title="Field Name"><span class="keyword parmname">canvasUrl</span></td>

              <td class="entry" headers="d484132e117" data-title="Field Type">string</td>

              <td class="entry" headers="d484132e120" data-title="Description">Required. The URL of the third-party app that’s exposed as a
                canvas app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d484132e114" data-title="Field Name"><span class="keyword parmname">externalClientApplication</span></td>

              <td class="entry" headers="d484132e117" data-title="Field Type">string</td>

              <td class="entry" headers="d484132e120" data-title="Description">Required. The name of the associated external client app.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d484132e114" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d484132e117" data-title="Field Type">string</td>

              <td class="entry" headers="d484132e120" data-title="Description">The name of the app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d484132e114" data-title="Field Name"><span class="keyword parmname">lifeCycleHandler</span></td>

              <td class="entry" headers="d484132e117" data-title="Field Type">string</td>

              <td class="entry" headers="d484132e120" data-title="Description">The name of the lifecycle handler Apex class.</td>

            </tr>

            <tr>
              <td class="entry" headers="d484132e114" data-title="Field Name"><span class="keyword parmname">samlInitiationMethod</span></td>

              <td class="entry" headers="d484132e117" data-title="Field Type">SamlInitiationMethod (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d484132e120" data-title="Description">If you’re using SAML single sign-on (SSO), indicates which
                provider initiates the SSO flow.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">IdpInitiated</samp>—Identity provider initiated.
                    Salesforce makes the initial request to start the SSO
                    flow.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SpInitiated</samp>—Service provider initiated. The
                    canvas app starts the SSO flow after it’s invoked.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">None</samp>—The canvas
                    app isn’t using SAML SSO.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ExtlClntAppCanvasSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ExtlClntAppCanvasSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <accessMethod\>Post</accessMethod\>
    <canvasUrl\>https://www.example.com</canvasUrl\>
    <canvasLocationOptions\>Aura</canvasLocationOptions\>
    <canvasLocationOptions\>Visualforce</canvasLocationOptions\>
    <canvasOptions\>HideHeader</canvasOptions\>
    <label\>My external client app settings for canvas</label\>
    <samlInitiationMethod\>None</samlInitiationMethod\>
    <externalClientApplication\>testCanvasECA</externalClientApplication\>
</ExtlClntAppCanvasSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExternalClientApplication</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppCanvasSettings</name\>
    </types\>
    <version\>66.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=0f5e731304c53d4f9d201540fc33eeedcc6e827516b8dde5b3f52275c6855606 url=/legacydeveloper/current/en-us/api_meta/meta_extlclntappconfigurablepolicies.md -->

# ExtlClntAppConfigurablePolicies

Represents the policies for an external client app to disable or enable plugins.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppConfigurablePolicies components have the suffix .ecaPlcy and are stored in the extlClntAppPolicies folder.

## Version

ExtlClntAppConfigurablePolicies components are available in API version 60.0 and later.

## Special Access Rules

The View all External Client Apps, view their settings, and edit their policies user permission is required for users with admin roles to configure OAuth policies.

## Fields

| Field Name | Description |
| --- | --- |
| externalClientApplication | 
Field Type

string

Description

Required.

The name of the external client app associated with the plugins.



 |
| isEnabled | 

Field Type

boolean

Description

Required.

If true, all plugins are enabled unless individually disabled. If false, all plugins are disabled. The default value is true. Available in API version 60.0 and later.



 |
| isCanvasPluginEnabled | 

Field Type

boolean

Description

If true, the Canvas app plugin is enabled. If false, the Canvas app plugin is disabled. The default value is true. Available in API version 66.0 and later.



 |
| isMobilePluginEnabled | 

Field Type

boolean

Description

If true, the Mobile plugin is enabled. If false, the Mobile plugin is disabled. The default value is true. Available in API version 63.0 and later.



 |
| isNotificationPluginEnabled | 

Field Type

boolean

Description

If true, the Notification plugin is enabled. If false, the Notification plugin is disabled. The default value is true. Available in API version 63.0 and later.



 |
| isOauthPluginEnabled | 

Field Type

boolean

Description

If true, the OAuth plugin is enabled. If false, the OAuth plugin is disabled. The default value is true. Available in API version 60.0 and later.



 |
| isPushPluginEnabled | 

Field Type

boolean

Description

If true, the Push Notification plugin is enabled. If false, the Push Notification plugin is disabled. The default value is true. Available in API version 63.0 and later.



 |
| isSamlPluginEnabled | 

Field Type

boolean

Description

If true, the SAML plugin is enabled. If false, the SAML plugin is disabled. The default value is true. Available in API version 63.0 and later.



 |
| label | 

Field Type

string

Description

The OAuth policies name for the external client app.



 |
| startPage | 

Field Type

ExtlClntAppStartPage (enumeration type of string)

Description

Determines which URL to use for the start page.

- Custom
- None
- OAuth

Available in API version 63.0 and later.



 |
| startUrl | 

Field Type

string

Description

The custom URL where users are directed after they authenticate. For example, direct users to a specific page in the service provider app. Available in API version 63.0 and later.



 |

## Declarative Metadata Sample Definition

This example shows an ExtlClntAppConfigurablePolicies component.

<?xml version="1.0" encoding="UTF-8"?>
<ExtlClntAppConfigurablePolicies xmlns="http://soap.sforce.com/2006/04/metadata">
    <externalClientApplication>myeca</externalClientApplication>
    <isEnabled>true</isEnabled>
....<isCanvasPluginEnabled>true</isCanvasPluginEnabled>
    <isMobilePluginEnabled>true</isMobilePluginEnabled>
    <isNotificationPluginEnabled>true</isNotificationPluginEnabled>    
    <isOauthPluginEnabled>true</isOauthPluginEnabled>
    <isPushPluginEnabled>true</isPushPluginEnabled>
    <isSamlPluginEnabled>true</isSamlPluginEnabled>
    <label>myecapolicy</label>
    <startPage>OAuth</startPage>
    <startUrl>https://example.org</startUrl>
</ExtlClntAppConfigurablePolicies>

This example package.xml references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExternalClientApplication</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppGlobalOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthConfigurablePolicies</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppConfigurablePolicies</name\>
    </types\>
    <version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=f67b67f83eae8134f9dd3d360e2468a8a78252abc3c2cb554d0377ce9978a5ce url=/legacydeveloper/current/en-us/api_meta/meta_extlclntappglobaloauthsettings.md -->

# ExtlClntAppGlobalOauthSettings

Represents the global settings for the OAuth plugin in an external client app. These settings include private and sensitive OAuth consumer information that can’t be packaged and must not be added to source control.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppGlobalOauthSettings components have the suffix .ecaGlblOauth and are stored in the extlClntAppGlobalOauthSets folder.

## Version

ExtlClntAppGlobalOauthSettings components are available in API version 59.0 and later.

## Special Access Rules

Access to the OAuth plugin requires orgs to enable the Allow Access to OAuth Consumer Secrets via Metadata API permission in Setup. The View External Client Apps Consumer Secrets in Metadata user permission is required for users with developer roles to configure global OAuth settings.

## Fields

| Field Name | Description |
| --- | --- |
| callbackUrl | 
Field Type

string

Description

The endpoint that Salesforce calls back to your external client app during OAuth. It’s the OAuth redirect\_uri.



 |
| certificate | 

Field Type

string

Description

If the app uses a certificate, the PEM-encoded certificate string. When provided, it enables the JWT Bearer flow. Available in API version 60.0 and later.



 |
| consumerKey | 

Field Type

string

Description

A value used by the consumer for identification to Salesforce. Referred to as client\_id in OAuth 2.0.



 |
| consumerSecret | 

Field Type

string

Description

A value that is combined with the consumerKey and used by the consumer for identification to Salesforce. Referred to as client\_secret in OAuth 2.0.



 |
| externalClientApplication | 

Field Type

string

Description

Required.

Name of the external client application.



 |
| idTokenConfig | 

Field Type

[ExternalAppIdTokenConfig](#ExternalAppIdTokenConfig)

Description

The settings for the ID token.



 |
| isClientCredentialsFlowEnabled | 

Field Type

boolean

Description

If set to true, the OAuth 2.0 client credentials flow is enabled. Available in API version 60.0 and later.



 |
| isCodeCredFlowEnabled | 

Field Type

boolean

Description

If set to true, the external client app can use the Authorization Code and Credentials Flow and its variations for headless login, passwordless login, and guest user identity services in an off-platform app. Headless registration isn’t currently supported for external client apps. The default value is false.

To use this field, the Authorization Code and Credentials Flow must be enabled for your org in OAuth and OpenID Connect settings.

Available in API version 61.0 and later.





 |
| isCodeCredPostOnly | 

Field Type

boolean

Description

If set to true, for the Authorization Code and Credentials Flow, the external client app is required to send the user’s credentials to the Salesforce services/oauth2/authorize endpoint in the body of a POST request. If set to false, the app can send a POST or GET request with the user’s credentials in the request body or in a Basic authorization header. The default value is false.

To use this field, the Authorization Code and Credentials Flow must be enabled for your external client app. Headless registration, a variation of this flow, isn’t currently supported for external client apps.

Available in API version 61.0 and later.





 |
| isConsumerSecretOptional | 

Field Type

boolean

Description

If set to false (default), the external app’s client secret is required in exchange for an access token in the OAuth 2.0 web server flow. If set to true, the external app’s client secret is optional.



 |
| isDeviceFlowEnabled | 

Field Type

boolean

Description

If set to true, the external client app can use the OAuth 2.0 device flow. Available in API version 60.0 and later.



 |
| isIntrospectAllTokens | 

Field Type

boolean

Description

If set to true, authorizes the external app to introspect all access and refresh all tokens. If set to false (default), the external client app can introspect its own tokens.



 |
| isNamedUserJwtEnabled | 

Field Type

boolean

Description

If set to true, the external client app issues JSON Web Token (JWT)-based access tokens. If set to false, it issues opaque access tokens. The default value is false

Available in API version 61.0 and later.





 |
| isPkceRequired | 

Field Type

boolean

Description

If set to true (default) Proof Key for Code for Exchange (PKCE) is required for OAuth integration. If set to false, PKCE is optional.



 |
| isRefreshTokenRotationEnabled | 

Field Type

boolean

Description

If set to true, the refresh token rotation is enabled. Available in API version 60.0 and later.



 |
| isSecretRequiredForRefreshToken | 

Field Type

boolean

Description

If set to true (default), the app’s client secret is required in the authorization request of a refresh token and hybrid refresh token flow. If set to false and an app sends the client secret in the authorization request, Salesforce still validates it.



 |
| isSecretRequiredForTokenExchange | 

Field Type

boolean

Description

If set to true, the app’s client secret is required for token exchange. Available in API version 60.0 and later.



 |
| isTokenExchangeEnabled | 

Field Type

boolean

Description

If set to true, token exchange is enabled. Available in API version 60.0 and later.



 |
| label | 

Field Type

string

Description

External Client Application Global OAuth Settings name.



 |
| shouldRotateConsumerKey | 

Field Type

boolean

Description

If set to true, the OAuth external client app's consumer key is replaced with a newly generated key on metadata deploy.. To maintain security, if this field is set to true, you must include the ignore warnings attribute in the deploy command. Default is false.



 |
| shouldRotateConsumerSecret | 

Field Type

boolean

Description

If set to true, the OAuth external client app’s consumer secret is replaced with a newly generated secret on metadata deploy. To maintain security, if this field is set to true, you must include the ignore warnings attribute in the deploy command. Default is false.



 |

## ExternalAppIdTokenConfig

Represents configurations that determine the ID token attributes.

| Field Name | Description |
| --- | --- |
| idTokenAudience | 
Field Type

string

Description

The audience that this ID token is intended for. The value is an array of case-sensitive strings. If no audiences are specified, the client\_id of the relying party is returned as the default audience. Otherwise, the other audiences are returned with the client\_id in the aud value.



 |
| idTokenIncludeAttributes | 

Field Type

boolean

Description

Indicates whether attributes are included in the ID token (true) or not (false).



 |
| idTokenIncludeStandardClaims | 

Field Type

boolean

Description

Indicates whether standard claims about the authentication event are included in the ID token (true) or not (false).



 |
| idTokenValidityInMinutes | 

Field Type

int

Description

The length of time that the ID token is valid for after it’s issued. The value can be 1–720 minutes. The default value is 2 minutes.



 |

## Declarative Metadata Sample Definition

This example shows an ExtlClntAppGlobalOauthSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ExtlClntAppGlobalOauthSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <callbackUrl>https://www.example.com</callbackUrl>
    <externalClientApplication>myeca</externalClientApplication>
    <idTokenConfig>
        <idTokenAudience>SalesforceAudience</idTokenAudience>
        <idTokenIncludeStandardClaims>true</idTokenIncludeStandardClaims>
        <idTokenValidityInMinutes>0</idTokenValidityInMinutes>
    </idTokenConfig>
    <isConsumerSecretOptional>false</isConsumerSecretOptional>
    <isIntrospectAllTokens>false</isIntrospectAllTokens>
    <isPkceRequired>true</isPkceRequired>
    <isSecretRequiredForRefreshToken>false</isSecretRequiredForRefreshToken>
    <label>myecaglobalset</label>
    <shouldRotateConsumerKey>false</shouldRotateConsumerKey>
    <shouldRotateConsumerSecret>false</shouldRotateConsumerSecret>
</ExtlClntAppGlobalOauthSettings>

This example package.xml references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExternalClientApplication</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppGlobalOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthConfigurablePolicies</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppConfigurablePolicies</name\>
    </types\>
    <version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=b6514c67da1b9044d7055aa65663fbc7f9150c75efa099317baf839393b4fbf1 url=/legacydeveloper/current/en-us/api_meta/meta_extlclntappmobileconfigurablepolicies.md -->

# ExtlClntAppMobileConfigurablePolicies

Represents an external client app’s mobile policies configuration.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppMobileConfigurablePolicies components have the suffix .ecaMobilePlcy and are stored in the extlClntAppMobilePolicies folder.

## Version

ExtlClntAppMobileConfigurablePolicies components are available in API version 64.0 and later.

## Special Access Rules

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

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d488230e107">Field Name</th>

              <th class="featureTableHeader  " id="d488230e110">Field Type</th>

              <th class="featureTableHeader  " id="d488230e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d488230e107" data-title="Field Name">externalClientApplication</td>

              <td class="entry" headers="d488230e110" data-title="Field Type">string</td>

              <td class="entry" headers="d488230e113" data-title="Description">Required. The name of the associated external client app.</td>
            </tr>

            <tr>
              <td class="entry" headers="d488230e107" data-title="Field Name">label</td>

              <td class="entry" headers="d488230e110" data-title="Field Type">string</td>

              <td class="entry" headers="d488230e113" data-title="Description">Label for the external client app’s mobile policies
                configuration. </td>

            </tr>

            <tr>
              <td class="entry" headers="d488230e107" data-title="Field Name">screenLockTimeout</td>

              <td class="entry" headers="d488230e110" data-title="Field Type">ScreenLockTimeout (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title" target="_blank"><u class="ph u">enumeration</u></a> of type
                string)</td>

              <td class="entry" headers="d488230e113" data-title="Description">When <span class="keyword parmname">isScreenLockEnabled</span> is true in the associated ExtlClntAppMobileSettings metadata type, <span class="keyword parmname">screenLockTimeout</span> represents the amount of time after which the mobile app locks and requires the app user to reauthenticate. Valid values include:
                <ul class="ul bulletList">
                  <li class="li"><kbd class="ph userinput">Never</kbd></li>

                  <li class="li">
                    <kbd class="ph userinput">One</kbd> (1 minute)
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">Five</kbd> (5 minutes)
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">Ten</kbd> (10 minutes)
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">Thirty</kbd> (30 minutes)
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">Sixty</kbd> (60 minutes)
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">OneTwenty</kbd> (120 minutes)
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">OneEighty</kbd> (180 minutes)
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">TwoForty</kbd> (240 minutes)
                  </li>
                </ul>
              </td>

            </tr>


          </tbody>

        </table>

<!-- document id=c5af69514975092e480e8ad3c5238db72b495ff527741f278a74ba8268254aa2 url=/legacydeveloper/current/en-us/api_meta/meta_extlclntappmobilesettings.md -->

# ExtlClntAppMobileSettings

Represents an external client app’s mobile app settings, such as screen lock on a mobile device.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The ExtlClntAppMobileSettings metadata type is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/ "HTML (New Window)") or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/ "HTML (New Window)"). Use of this pilot or beta service is at the Customer's sole discretion.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppMobileSettings components have the suffix .ecaMobile and are stored in the extlClntAppMobileSettings folder.

## Version

ExtlClntAppMobileSettings components are available in API version 64.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| externalClientApplication | string | Required. The name of the associated external client app. |
| isScreenLockEnabled | boolean | Required. Indicates whether the mobile app locks the screen after a specified timeout value. |
| label | string | Label for the external client app’s mobile app settings configuration. |

<!-- document id=9b9127e9da48fbbcbc666ee5d85e6d3428a7dcb8acaa67b0e39eef5a586fb24a url=/legacydeveloper/current/en-us/api_meta/meta_extlclntappnotificationsettings.md -->

# ExtlClntAppNotificationSettings

Represents an external client app’s notification subscriptions for mobile.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The ExtlClntAppNotificationSettings metadata type is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/ "HTML (New Window)") or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/ "HTML (New Window)"). Use of this pilot or beta service is at the Customer's sole discretion.

The ExtlClntAppNotificationSettings metadata type requires the OAuth plugin for External Client Apps. See [OAuth Plugin Enablement with Metadata API](https://help.salesforce.com/s/articleView?id=xcloud.meta_enable_oauth_plugin.htm&type=5&language=en_US) in Salesforce Help.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppNotificationSettings components have the suffix .ecaNotifications and are stored in the extlClntAppNotifSettings folder.

## Version

ExtlClntAppNotificationSettings components are available in API version 64.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| externalClientApplication | string | Required. The name of the associated external client app. |
| label | string | Label for the external client app’s notification settings configuration. |
| notificationTypes | [ExtlClntAppNotificationType](#ExtlClntAppNotificationType)\[\] | A list of notification types the external client app is subscribed to. Only notifications of these types are returned to the associated external client app via API or sent as push notifications. |

## ExtlClntAppNotificationType

Represents a notification type that an external client app is subscribed to. Only custom notification types enabled for the mobile delivery channel are supported.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can use Notification Builder in Setup to configure a notification type for the mobile delivery channel. See [Manage Notification Delivery Settings](https://help.salesforce.com/s/articleView?id=platform.notif_builder_delivery_settings.htm&type=5&language=en_US) in Salesforce Help.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d489045e212">Field Name</th>

              <th class="featureTableHeader  " id="d489045e215">Field Type</th>

              <th class="featureTableHeader  " id="d489045e218">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d489045e212" data-title="Field Name">notificationType</td>

              <td class="entry" headers="d489045e215" data-title="Field Type">string</td>

              <td class="entry" headers="d489045e218" data-title="Description">Required. The API name of the notification type.</td>
            </tr>

            <tr>
              <td class="entry" headers="d489045e212" data-title="Field Name">pushByDefault</td>

              <td class="entry" headers="d489045e215" data-title="Field Type">boolean</td>

              <td class="entry" headers="d489045e218" data-title="Description">Required. Indicates whether the notification type is
                sent as a push notification on mobile devices.
                <p class="p">To send a notification type as a push notification, you
                  must also configure the ExtlClntAppPushSettings metadata
                  type.</p>

              </td>

            </tr>

          </tbody>

        </table>

<!-- document id=a0a8c0699527760a0ef07fb005dfd2a43ea89144795a6646249f8dcd0295b6b7 url=/legacydeveloper/current/en-us/api_meta/meta_extlclntappoauthconfigurablepolicies.md -->

# ExtlClntAppOauthConfigurablePolicies

Represents the policies configured by the admin for an OAuth-enabled external client app.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppOauthConfigurablePolicies components have the suffix .ecaOauthPlcy and are stored in the extlClntAppOauthPolicies folder.

## Version

ExtlClntAppOauthConfigurablePolicies components are available in API version 59.0 and later.

## Special Access Rules

The View all External Client Apps, view their settings, and edit their policies user permission is required for users with admin roles to configure OAuth policies.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d489630e101">Field Name</th>

              <th class="featureTableHeader  " id="d489630e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">apexHandler</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Name of the Apex handler. Available in API version 61.0
                    and later.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">clientCredentialsFlowUser</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The execution user for the OAuth 2.0 client credentials
                    flow. Salesforce returns access tokens on behalf of this
                    user. This user must have the API Only permission.
                    Available in API version 60.0 and later.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">commaSeparatedCustomScopes</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Custom scope names in a comma-separated list. Available
                    in API version 61.0 and later.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">commaSeparatedPermissionSet</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Permission set IDs in a comma-separated list. This field
                    or commaSeparatedProfile is used when
                    permittedUsersPolicyType is set to
                    AdminApprovedPreAuthorized.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">commaSeparatedProfile</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <a name="dl_m2t_dsp_3fc"><!-- --></a>
                <dl class="dl detailList" id="dl_m2t_dsp_3fc">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Profiles in a comma-separated list. This field or
                    commaSeparatedPermissionSet is used when
                    permittedUsersPolicyType is set to
                    AdminApprovedPreAuthorized.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">customAttributes</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd"><a class="xref" href="#ExtlClntAppOauthPoliciesAttribute">ExtlClntAppOauthPoliciesAttribute[]</a></dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Unique attributes to be included as admin defaults. The
                    maximum number accepted is 128. Each custom attribute
                    must have a unique key and use an available field.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">executeHandlerAs</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Username of the Apex handler's execution user. Available
                    in API version 61.0 and later.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">externalClientApplication</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">Required.</p>
                    The name of the external client app
                    associated with this OAuth policies file.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">guestJwtTimeout</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">If <span class="keyword parmname">guestJwtSessionTimeoutType</span> is
                    set to <samp class="codeph nolang">Custom</samp>, this
                    field defines the amount of time before a JWT-based
                    access token issued to a guest user expires. Values are
                    in minutes.<p class="p">These values are available in API version
                      61.0 and later.</p>
                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">1</samp>—1
                        Minute
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">5</samp>—5
                        Minutes
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">10</samp>—10
                        Minutes
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">15</samp>—15
                        Minutes
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">30</samp>—30
                        Minutes
                      </li>

                    </ul>
                    These values are available in API version 65.0 and later.<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">60</samp>—1
                        Hour
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">90</samp>—90
                        Minutes
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">120</samp>—2
                        Hours
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">240</samp>—4
                        Hours
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">480</samp>—8
                        Hours
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">720</samp>—12
                        Hours
                      </li>

                    </ul>
                    <p class="p">If
                      <span class="keyword parmname">guestJwtSessionTimeoutType</span> is
                      set to <samp class="codeph nolang">UserSession</samp>, omit this field.
                    </p>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">guestJwtSessionTimeoutType</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">JWTSessionTimeoutType (enumeration of type string)</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Specifies how the JWT-based access token timeout is
                    defined for guest users. Valid values are:<ul class="ul bulletList">
                      <li class="li">
                        <span class="keyword parmname">UserSession</span>—Salesforce uses the value from the
                        <span class="keyword parmname">sessionTimeout</span> field in the
                        <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_profilesessionsetting.htm" target="_blank">ProfileSessionSetting</a> type for the <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.rss_config_guest_user_profile.htm&amp;language=en_US" target="_blank">Experience Cloud
                          guest user profile</a>.<p class="p">If there's no profile
                          session timeout for the user, Salesforce uses the
                          <span class="keyword parmname">sessionTimeout</span> value from the
                          <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_securitysettings.htm" target="_blank">SessionSettings</a> type.
                        </p>
                        <p class="p">If both are
                          defined, Salesforce defaults to the profile
                          session timeout.</p>
                      </li>

                      <li class="li">
                        <span class="keyword parmname">Custom</span>—Salesforce uses the
                        value from the
                        <span class="keyword parmname">guestJwtTimeout</span> field.
                      </li>

                    </ul>
                    <p class="p">Available in API version 65.0 and
                      later.</p>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">ipRelaxationPolicyType</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <p class="p">The policy that determines IP restrictions.</p>

                    <p class="p">Values are:</p>

                    <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Enforce</samp></li>

                      <li class="li"><samp class="codeph nolang">Bypass</samp></li>

                      <li class="li"><samp class="codeph nolang">Bypass_2factor</samp></li>

                      <li class="li"><samp class="codeph nolang">Enforce_RelaxRefresh</samp></li>

                    </ul>

                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">isClientCredentialsFlowEnabled</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">If <samp class="codeph nolang">true</samp>, the client
                    credentials flow is enabled. The default value is
                    <samp class="codeph nolang">false</samp>.
                    Available in API version 60.0 and later.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">isGuestCodeCredFlowEnabled</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">If <samp class="codeph nolang">true</samp>, the
                    external client app can use the guest user variation of
                    the Authorization Code and Credentials Flow. To use this
                    flow variation, the external client app must also be
                    configured to issue JWT-based access tokens. The default
                    value is <samp class="codeph nolang">false</samp>.
                    Available in API version 61.0 and later.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">isNamedUserJwtEnabled</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Deprecated.</dd>

                  <dd class="dd">If <samp class="codeph nolang">true</samp>, the
                    external client app issues JWT-based access tokens
                    instead of opaque access tokens. If this field is
                    available, it means that the
                    <span class="keyword parmname">isNamedUserJwtEnabled</span> field in
                    the ExtlClntAppGlobalOauthSettings type is set to
                    <samp class="codeph nolang">true</samp>.
                  </dd>

                  <dd class="dd">The default value is <samp class="codeph nolang">false</samp>. Removed in API
                    version 64.0 and later.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">isTokenExchangeFlowEnabled</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">If <samp class="codeph nolang">true</samp><strong class="ph uicontrol">true</strong>, the token
                    exchange flow is enabled. The default value is <samp class="codeph nolang">false</samp>. Available in API
                    version 60.0 and later.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The OAuth policies name for the external client
                    app.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">namedUserJwtTimeout</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">If <span class="keyword parmname">namedUserJwtSessionTimeoutType</span>
                    is set to <samp class="codeph nolang">Custom</samp>,
                    the amount of time before a JWT-based access token
                    issued to a named user expires. Values are in
                    minutes.<p class="p">These values are available in API version
                      61.0 and later.</p>
                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">1</samp>—1
                        Minute
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">5</samp>—5
                        Minutes
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">10</samp>—10
                        Minutes
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">15</samp>—15
                        Minutes
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">30</samp>—30
                        Minutes
                      </li>

                    </ul>
                    These values are available in API version 65.0 and later.<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">60</samp>—1
                        Hour
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">90</samp>—90
                        Minutes
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">120</samp>—2
                        Hours
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">240</samp>—4
                        Hours
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">480</samp>—8
                        Hours
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">720</samp>—12
                        Hours
                      </li>

                    </ul>
                  </dd>


                </dl>

                <p class="p">If <span class="keyword parmname">namedUserJwtSessionTimeoutType</span> is set to
                  <samp class="codeph nolang">UserSession</samp>, omit this
                  field.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">namedUserJwtSessionTimeoutType</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">JWTSessionTimeoutType (enumeration of type string)</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Specifies how the JWT-based access token timeout is
                    defined for named users. Valid values are:<ul class="ul bulletList">
                      <li class="li">
                        <span class="keyword parmname">UserSession</span>—Salesforce uses
                        the value from the
                        <span class="keyword parmname">sessionTimeout</span> field in the
                        <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_profilesessionsetting.htm" target="_blank">ProfileSessionSetting</a> type for the named
                        user's profile.<p class="p">If there's no profile session
                          timeout for the user, Salesforce uses the
                          <span class="keyword parmname">sessionTimeout</span> value from the
                          <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_securitysettings.htm" target="_blank">SessionSettings</a> type.
                        </p>
                        <p class="p">If both are
                          defined, Salesforce defaults to the profile
                          session timeout.</p>
                      </li>

                      <li class="li">
                        <span class="keyword parmname">Custom</span>—Salesforce uses the
                        value from the
                        <span class="keyword parmname">namedUserJwtTimeout</span>
                        field.
                      </li>

                    </ul>
                    <p class="p">Available in API version 65.0 and
                      later.</p>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">permittedUsersPolicyType</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">PermittedUsersPolicyType (enumeration of type
                    string)</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The policy that determines which users are allowed in
                    the external client app.<p class="p">Values are:</p>
                    <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">AdminApprovedPreAuthorized</samp></li>

                      <li class="li"><samp class="codeph nolang">AllSelfAuthorized</samp></li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">policyAction</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">PolicyAction (enumeration of type string)</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Requires users to verify their identity with two-factor
                    authentication when they log in to the external client
                    app. Use <samp class="codeph nolang">RaiseSessionLevel</samp> along with
                    <span class="keyword parmname">requiredSessionLevel</span> to
                    determine the security posture. <p class="p">Values are:</p>
                    <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Block</samp></li>

                      <li class="li"><samp class="codeph nolang">RaiseSessionLevel</samp></li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">refreshTokenPolicyType</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">RefreshTokenPolicyType (enumeration of type string)</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The type of policy that determines when a token must be
                    refreshed.<p class="p">Values are:</p>
                    <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Infinite</samp></li>

                      <li class="li"><samp class="codeph nolang">SpecificInactivity</samp></li>

                      <li class="li"><samp class="codeph nolang">SpecificLifetime</samp></li>

                      <li class="li"><samp class="codeph nolang">Zero</samp></li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">refreshTokenValidityPeriod</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The number of units of measure used to specify validity
                    when refresh token policy type is set to <samp class="codeph nolang">SpecificInactivity</samp> or
                    <samp class="codeph nolang">SpecificLifetime</samp>.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">refreshTokenValidityUnit</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The unit of measurement that is used to specify validity
                    when refresh token policy type is set to <samp class="codeph nolang">SpecificInactivity</samp> or
                    <samp class="codeph nolang">SpecificLifetime</samp>.<p class="p">Values are:</p>
                    <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Days</samp></li>

                      <li class="li"><samp class="codeph nolang">Hours</samp></li>

                      <li class="li"><samp class="codeph nolang">Months</samp></li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">requiredSessionLevel</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">SessionSecurityLevel (enumeration of type string)</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Defines the security posture.<p class="p">Values are:</p>
                    <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">HIGH_ASSURANCE</samp></li>

                      <li class="li"><samp class="codeph nolang">LOW</samp></li>

                      <li class="li"><samp class="codeph nolang">STANDARD</samp></li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">sessionTimeoutInMinutes</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">int</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Length of time the external client app’s session lasts.
                    This field applies only if the app issues opaque
                    tokens.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">singleLogoutUrl</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">URL where Salesforce sends a logout request when users
                    log out of Salesforce.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d489630e101" data-title="Field Name"><span class="keyword parmname">startUrl</span></td>

              <td class="entry" headers="d489630e104" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">URL where users are directed after they
                    authenticate.</dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## ExtlClntAppOauthPoliciesAttribute

Represents admin-defined attributes that provide personal information to customize the external client app for a specific use case.

| Field Name | Description |
| --- | --- |
| formula | 
Field Type

string

Description

Required.

The existing field that includes the desired information. For example, Organization.Country.



 |
| key | 

Field Type

string

Description

Required.

A unique name for the attribute. For example, country.



 |

## Declarative Metadata Sample Definition

This example shows an ExtlClntAppOauthConfigurablePolicies component.

<?xml version="1.0" encoding="UTF-8"?>
<ExtlClntAppOauthConfigurablePolicies xmlns="http://soap.sforce.com/2006/04/metadata">
    <externalClientApplication>myeca</externalClientApplication>
    <label>myecapolicy</label>
    <apexHandler>MyEcaOauthApexHandler</apexHandler>
    <executeHandlerAs>admin@example.org</executeHandlerAs>
    <refreshTokenPolicyType>SpecificLifetime</refreshTokenPolicyType>
    <refreshTokenValidityPeriod>1</refreshTokenValidityPeriod>
    <refreshTokenValidityUnit>Days</refreshTokenValidityUnit>
    <ipRelaxationPolicyType>Enforce</ipRelaxationPolicyType>
    <permittedUsersPolicyType>AdminApprovedPreAuthorized</permittedUsersPolicyType>
    <commaSeparatedPermissionSet>PermSetExample</commaSeparatedPermissionSet>
    <commaSeparatedCustomScopes>CustomScopeExample</commaSeparatedCustomScopes>
    <sessionTimeoutInMinutes>1</sessionTimeoutInMinutes>
    <requiredSessionLevel>HIGH\_ASSURANCE</requiredSessionLevel>
    <policyAction>RaiseSessionLevel</policyAction>
    <singleLogoutUrl>https://www.example.com</singleLogoutUrl>
    <startUrl>https://www.example.com</startUrl>
    <guestJwtSessionTimeoutType>UserSession</guestJwtSessionTimeoutType>
    <namedUserJwtSessionTimeoutType>Custom</namedUserJwtSessionTimeoutType>
    <namedUserJwtTimeout>10</namedUserJwtSessionTimeout>
</ExtlClntAppOauthConfigurablePolicies>

This example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExternalClientApplication</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppGlobalOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthConfigurablePolicies</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppConfigurablePolicies</name\>
    </types\>
    <version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=c9e784b459258df98a7038b95bb013ca1611c1f4a479fd175e6364d4d3c38a89 url=/legacydeveloper/current/en-us/api_meta/meta_extlclntappoauthsettings.md -->

# ExtlClntAppOauthSettings

Represents the settings configuration for the external client app’s OAuth plugin.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppOauthSettings components have the suffix .ecaOauth and are stored in the extlClntAppOauthSettings folder.

## Version

ExtlClntAppOauthSettings components are available in API version 59.0 and later.

## Special Access Rules

Access to the OAuth plugin requires orgs to enable the Allow Access to OAuth Consumer Secrets via Metadata API permission in Setup. The View External Client Apps Consumer Secrets in Metadata user permission is required for users with developer roles to configure OAuth settings.

## Fields

| Field Name | Description |
| --- | --- |
| areAttributesIncludedInAssetToken | 
Field Type

boolean

Description

Indicates whether custom attributes associated with the external client app are included in the JSON Web Token (JWT) payload of an asset token issued as a result of the asset token flow. The default value is false.

Available in API version 61.0 and later.





 |
| areCustomPermsIncludedInAssetToken | 

Field Type

boolean

Description

Indicates whether custom permissions associated with the external client app are included in the JWT payload of an asset token issued as a result of the asset token flow. The default value is false.

Available in API version 61.0 and later.





 |
| assetTokenAudiences | 

Field Type

string

Description

Required for the OAuth asset token flow. The audience (aud) claim in the JWT payload of an asset token issued by the external client app. This claim identifies who the asset token is intended for. The value must be an array of case-sensitive strings, each containing a StringOrURI value. Specify an audience for each intended consumer of the asset token.

Available in API version 61.0 and later.





 |
| assetTokenSigningCertificate | 

Field Type

string

Description

Required for the asset token flow. The ID of the self-signed certificate used to sign asset tokens issued by the external client app. The certificate size is limited to 4 KB. If your certificate is too large, try using a DER-encoded file to reduce the size.

Available in API version 61.0 and later.





 |
| assetTokenValidity | 

Field Type

int

Description

Required for the asset token flow. The period of time for which the asset token is valid after it’s issued, expressed as the number of seconds from 1970-01-01T0:0:0Z measured in UTC. The validity period must be within 3 minutes of the expiration time of the assertion.

Available in API version 61.0 and later.





 |
| clientAssertionCertificate | 

Field Type

string

Description

A certificate that's used to sign a client attestation JSON Web Token (JWT), which is required for requests to the OAuth 2.0 authorization challenge endpoint for headless identity flows for first-party apps. To confirm that the app that sent the request is your first-party app, Salesforce validates the client attestation JWT against this certificate.



 |
| commaSeparatedOauthScopes | 

Field Type

string

Description

OAuth scopes for the external client app, written as a comma-separated list.

- Basic—Allows access to your identity URL service (the same behavior as deploying Address, Email, Phone, and Profile).
- Api—Allows access to the logged-in user's account over the APIs.
- Web—Allows use of the access\_token on the web. This usage also includes visualforce, allowing access to Visualforce pages.
- Full—Allows access to all data accessible by the logged-in user.
- Chatter—Allows access to only the Connect REST API resources.
- CustomApplications—Provides access to custom applications, such as those using Visualforce.
- RefreshToken—Allows a refresh token to be returned if you’re eligible to receive one (the same behavior as deploying OfflineAccess).
- OpenID—Allows access to the logged-in user's unique identifier for OpenID Connect apps.
- Profile—Allows access to the logged-in user's profile (the same behavior as deploying Basic).
- Email—Allows access to the logged-in user's email address (the same behavior as deploying Basic).
- Address—Allows access to the logged-in user's street address (the same behavior as deploying Basic).
- Phone—Allows access to the logged-in user's phone number value (the same behavior as deploying Basic).
- OfflineAccess—Allows the app to interact with the user's data while the user is offline and get a refresh token (the same behavior as deploying RefreshToken).
- CustomPermissions—Allows access to the custom permissions in an organization associated with the external client app and shows whether the current user has each permission enabled.
- Wave—Allows access to the Analytics REST API resources.
- Eclair—Allows access to the Analytics REST API Charts Geodata resource.
- Pardot—Allows access to Pardot API services on behalf of the user. The full extent of accessible services is managed by the Pardot account.
- Lightning—Allows hybrid apps to directly obtain Lightning child sessions through the OAuth 2.0 hybrid app token flow and hybrid app refresh token flow.
- Content—Allows hybrid apps to directly obtain content child sessions through the OAuth 2.0 hybrid app token flow and hybrid app refresh token flow.
- CDPIngest—Allows access to Data Cloud ingest API services. Customers use these API services to upload and maintain external datasets in the Data 360.
- CDPProfile—Allows access to Data 360 profile.
- CDPQuery—Allows access to Data 360 metadata and query data.
- Chatbot—Allows access to Einstein Bot API services.
- CDPSegment—Allows access to Data 360 segments.
- CDPIdentityResolution—Allows access to Data 360 identity resolution.
- CDPCalculatedInsight—Allows access to Data 360 calculated insights.
- SFApiPlatform—Allows access to the Salesforce API Platform.
- Interaction—Allows access to Interaction Service API.
- EinsteinGPT—Allows access to Einstein Generative AI features in an org.
- PwdlessLogin—Allows access to Headless Passwordless Login API. Assign to an internal integration user to get an access token for authenticated requests to this API.
- ForgotPassword—Allows access to Headless Forgot Password API. Assign to an internal integration user to get an access token for authenticated requests to this API.
- UserRegistration—Allows access to Headless Registration API. Assign to an internal integration user to get an access token for authenticated requests to this API.
- MCP—Allows access to Model Context Protocol (MCP).
- SCRT—Allows access to Service Cloud Real-Time features.





 |
| customAttributes | 

Field Type

[ExtlClntAppOauthSettingsAttribute\[\]](#ExtlClntAppOauthSettingsAttribute)

Description

Unique attributes to be included as developer defaults. The maximum number accepted is 128. Each custom attribute must have a unique key and use an available field.



 |
| externalClientApplication | 

Field Type

string

Description

Required.

The external client app associated with this OAuth plugin.





 |
| isFirstPartyAppEnabled | 

Field Type

boolean

Description

Determines whether a first-party app can send requests to the OAuth 2.0 authorization challenge endpoint on this Experience Cloud site. This endpoint support headless identity flows using the OAuth 2.0 for First-Party Applications draft protocol.



 |
| label | 

Field Type

string

Description

Label for the external client app.



 |
| oauthLink | 

Field Type

string

Description

An auto-generated value that combines the org ID and the OAuth Consumer ID.



 |
| singleLogoutUrl | 

Field Type

string

Description

URL where Salesforce sends a logout request when users log out of Salesforce.



 |
| trustedIpRanges | 

Field Type

[ExtlClntAppOauthIpRange\[\]](#ExtlClntAppOauthIpRange)

Description

Specifies the ranges of IP addresses that can access the app without requiring the user to authenticate with the external client app. The maximum number of IP ranges is 128.



 |

## ExtlClntAppOauthSettingsAttribute

Represents developer-defined attributes that are used to include additional information in the external client apps. Developers use these attributes to customize the app for specific use cases.

| Field Name | Description |
| --- | --- |
| formula | 
Field Type

string

Description

Required.

The existing field that includes the desired information. For example, Organization.Country.





 |
| key | 

Field Type

string

Description

Required.

A unique name for the attribute. For example, country.



 |

## ExtlClntAppOauthIpRange

Represents the range of IP addresses that are trusted by the external client app.

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Identifies the purpose of the range, such as which part of a network corresponds to this range.



 |
| endIpAddress | 

Field Type

string

Description

Required.

Last address in the IP range, inclusive. Required with start address.





 |
| startIpAddress | 

Field Type

string

Description

Required.

First address in the IP range, inclusive. Required with end address.





 |

## Declarative Metadata Sample Definition

The following is an example of an ExtlClntAppOauthSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ExtlClntAppOauthSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <externalClientApplication\>myeca</externalClientApplication\>
    <label\>My Oauth Settings</label\>
    <trustedIpRanges\>
        <startIpAddress\>10.55.2.0</startIpAddress\>
        <endIpAddress\>10.55.2.255</endIpAddress\>
        <description\>Building 6</description\>
    </trustedIpRanges\>
    <trustedIpRanges\>
        <startIpAddress\>10.55.12.0</startIpAddress\>
        <endIpAddress\>10.55.12.255</endIpAddress\>
    </trustedIpRanges\>
    <customAttributes\>
        <key\>userattribute</key\>
        <formula\>User.Country</formula\>
    </customAttributes\>
    <commaSeparatedOauthScopes\>Basic, Web</commaSeparatedOauthScopes\>
</ExtlClntAppOauthSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExternalClientApplication</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppGlobalOauthSettings</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppOauthConfigurablePolicies</name\>
    </types\>
    <version\>59.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=16bab8a51cf848a89310bfbcddda2f9bd04149a45e4a80b2accd9f30afda8fc8 url=/legacydeveloper/current/en-us/api_meta/meta_extlclntapppushconfigurablepolicies.md -->

# ExtlClntAppPushConfigurablePolicies

Represents an external client app’s push notification policies configuration.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The ExtlClntAppPushConfigurablePolicies metadata type is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/ "HTML (New Window)") or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/ "HTML (New Window)"). Use of this pilot or beta service is at the Customer's sole discretion.

The ExtlClntAppPushConfigurablePolicies metadata type requires the OAuth plugin for External Client Apps. See [OAuth Plugin Enablement with Metadata API](https://help.salesforce.com/s/articleView?id=xcloud.meta_enable_oauth_plugin.htm&type=5&language=en_US) in Salesforce Help.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppPushConfigurablePolicies components have the suffix .ecaPushPlcy and are stored in the extlClntAppPushPolicies folder.

## Version

ExtlClntAppPushConfigurablePolicies components are available in API version 64.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| externalClientApplication | string | Required. The name of the associated external client app. |
| isFullContent | boolean | Required. Indicates if push notifications display the full notification title and body text (true). When set to false, standard notifications display a generic message and custom notifications display only the notification title. |
| label | string | Label for the external client app’s push notification policies configuration. |

<!-- document id=260fce1fa7687a7fd6c5bf8b37eb18376bd61a659f884e0c70f602ed908c50df url=/legacydeveloper/current/en-us/api_meta/meta_extlclntapppushsettings.md -->

# ExtlClntAppPushSettings

Represents an external client app’s push notification settings.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The ExtlClntAppPushSettings metadata type is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/ "HTML (New Window)") or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/ "HTML (New Window)"). Use of this pilot or beta service is at the Customer's sole discretion.

The ExtlClntAppPushSettings metadata type requires the OAuth plugin for External Client Apps. See [OAuth Plugin Enablement with Metadata API](https://help.salesforce.com/s/articleView?id=xcloud.meta_enable_oauth_plugin.htm&type=5&language=en_US) in Salesforce Help.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppPushSettings components have the suffix .ecaPush and are stored in the extlClntAppPushSettings folder.

## Version

ExtlClntAppPushSettings components are available in API version 64.0 and later.

## Special Access Rules

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

## Fields

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

You can configure the ExtlClntAppPushSettings metadata type with either androidPushConfig or applePushConfig, but not both. You can configure pushConfigLink instead to refer to an existing androidPushConfig or applePushConfig record.

Of the three push notification configuration options (androidPushConfig, applePushConfig, or pushConfigLink), you must only have one of the options within the same record. If you create a record with androidPushConfig or applePushConfig, the pushConfigLink is automatically generated and retrievable from the metadata.

If you retrieve the ExtlClntAppPushSettings metadata of an existing packageable external client app to install in another org, delete the androidPushConfig or applePushConfig information from the record, if present. To make sure that the destination org refers to the information in the source org, keep the pushConfigLink field as the only push notification configuration in the record.

If the pushServiceType is Android, you must configure ​​androidPushConfig or configure a pushConfigLink that refers to an existing androidPushConfig record. If the pushServiceType is Apple, you must configure ​​applePushConfig or configure a pushConfigLink that refers to an existing applePushConfig record.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d494896e210">Field Name</th>

              <th class="featureTableHeader  " id="d494896e213">Field Type</th>

              <th class="featureTableHeader  " id="d494896e216">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d494896e210" data-title="Field Name">androidPushConfig</td>

              <td class="entry" headers="d494896e213" data-title="Field Type"><a class="xref" href="#ExtlClntAppAndroidPushConfig">ExtlClntAppAndroidPushConfig</a></td>

              <td class="entry" headers="d494896e216" data-title="Description">Represents the push notification configuration of an Android mobile app.</td>
            </tr>

            <tr>
              <td class="entry" headers="d494896e210" data-title="Field Name">applePushConfig</td>

              <td class="entry" headers="d494896e213" data-title="Field Type"><a class="xref" href="#ExtlClntAppApplePushConfig">ExtlClntAppApplePushConfig</a></td>

              <td class="entry" headers="d494896e216" data-title="Description">Represents the push notification configuration of an
                iOS mobile app. </td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e210" data-title="Field Name">externalClientApplication</td>

              <td class="entry" headers="d494896e213" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e216" data-title="Description">Required. The name of the associated external client
                app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e210" data-title="Field Name">label</td>

              <td class="entry" headers="d494896e213" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e216" data-title="Description">Label for the external client app’s push notifications
                configuration. </td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e210" data-title="Field Name">pushConfigLink</td>

              <td class="entry" headers="d494896e213" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e216" data-title="Description">Identifies the push notification credentials used by the app. Valid format is the org ID (for example, <kbd class="ph userinput">00D000000000001</kbd>) and an <span class="keyword parmname">ExtlClntAppApplePushConfig</span> or <span class="keyword parmname">ExtlClntAppAndroidPushConfig</span> record ID (for example, <kbd class="ph userinput">1Dh000000000001</kbd>) separated by a colon. For example: <kbd class="ph userinput">00D000000000001:1Dh000000000001</kbd>
                <p class="p">If you configure <span class="keyword parmname">pushConfigLink</span>, you can’t also have <span class="keyword parmname">androidPushConfig </span>or <span class="keyword parmname">applePushConfig</span> in the same record.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e210" data-title="Field Name">pushServiceType</td>

              <td class="entry" headers="d494896e213" data-title="Field Type">PushServiceType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title" target="_blank"><u class="ph u">enumeration</u></a> of type
                string)</td>

              <td class="entry" headers="d494896e216" data-title="Description">Required. Identifies the mobile operating system of the mobile app. Valid values are:
                <ul class="ul bulletList">
                  <li class="li"><kbd class="ph userinput">Apple</kbd></li>

                  <li class="li"><kbd class="ph userinput">Android</kbd></li>
                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ExtlClntAppAndroidPushConfig

Represents the push notification configuration of an Android mobile app.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d494896e365">Field Name</th>

              <th class="featureTableHeader  " id="d494896e368">Field Type</th>

              <th class="featureTableHeader  " id="d494896e371">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">

            <tr>
              <td class="entry" headers="d494896e365" data-title="Field Name">fcmProject</td>

              <td class="entry" headers="d494896e368" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e371" data-title="Description">Required. The ID of the Google Firebase project associated with the mobile app. </td>
            </tr>

            <tr>
              <td class="entry" headers="d494896e365" data-title="Field Name">serviceAccount</td>

              <td class="entry" headers="d494896e368" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e371" data-title="Description">Required. The Base64-encoded Admin SDK private key for your Google Firebase service account. You can generate this key from the Service accounts tab in the Google Firebase console.
                <p class="p">The maximum length of the string is 8000 characters.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ExtlClntAppApplePushConfig

Represents the push notification configuration of an iOS mobile app. To configure the required authentication for iOS push notifications, you submit either a private key (.p8 file) or a TLS certificate (.p12 file).

To configure push notifications with a private key (.p8 file), complete the signingKey, keyIdentifier, and teamIdentifier fields.

To configure push notifications with a TLS certificate (.p12 file), complete the certificate and password fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d494896e447">Field Name</th>

              <th class="featureTableHeader  " id="d494896e450">Field Type</th>

              <th class="featureTableHeader  " id="d494896e453">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d494896e447" data-title="Field Name">applicationBundle</td>

              <td class="entry" headers="d494896e450" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e453" data-title="Description">The bundle ID of the iOS mobile app from Apple App Store
                Connect.</td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e447" data-title="Field Name">certificate</td>

              <td class="entry" headers="d494896e450" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e453" data-title="Description">The Base64-encoded TLS certificate with Apple Push Notification service (APNs)
                enabled. To generate and export this certificate, see <a class="xref" href="https://developer.apple.com/help/account/capabilities/communicate-with-apns-using-a-tls-certificate/" target="_blank">Communicate with APNs using a TLS
                  certificate</a> in Apple Developer documentation.</td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e447" data-title="Field Name">environment</td>

              <td class="entry" headers="d494896e450" data-title="Field Type">ApplePushEnvironmentType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title" target="_blank"><u class="ph u">enumeration</u></a> of type
                string)</td>

              <td class="entry" headers="d494896e453" data-title="Description">Required. The Apple Push Notification service environment. Valid
                values are: <ul class="ul bulletList">
                  <li class="li"><kbd class="ph userinput">Production</kbd></li>

                  <li class="li"><kbd class="ph userinput">Sandbox</kbd></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e447" data-title="Field Name">keyIdentifier</td>

              <td class="entry" headers="d494896e450" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e453" data-title="Description">The key identifier for the private key entered in the <span class="keyword parmname">signingKey</span>
                field. See <a class="xref" href="https://developer.apple.com/help/account/keys/get-a-key-identifier/" target="_blank">Get a key identifier </a> in
                Apple Developer documentation.</td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e447" data-title="Field Name">password</td>

              <td class="entry" headers="d494896e450" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e453" data-title="Description">The password for the TLS certificate entered in the <span class="keyword parmname">certificate</span>
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e447" data-title="Field Name">signingKey</td>

              <td class="entry" headers="d494896e450" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e453" data-title="Description">The Base64-encoded private key with Apple Push Notification service (APNs) enabled. To
                generate and download this key, see <a class="xref" href="https://developer.apple.com/help/account/keys/create-a-private-key" target="_blank">Create a private key to access a
                  service</a> in Apple Developer documentation. </td>

            </tr>

            <tr>
              <td class="entry" headers="d494896e447" data-title="Field Name">teamIdentifier</td>

              <td class="entry" headers="d494896e450" data-title="Field Type">string</td>

              <td class="entry" headers="d494896e453" data-title="Description">The team ID listed in the membership details of the Apple
                Developer account associated with the iOS mobile app. </td>

            </tr>

          </tbody>

        </table>

<!-- document id=9da32eb9d4962cc2466abb4a01f47e009b943e8ed09416fd339ab84928193372 url=/legacydeveloper/current/en-us/api_meta/meta_extlclntappsamlconfigurablepolicies.md -->

# ExtlClntAppSamlConfigurablePolicies

Represents SAML configuration policies for an external client app. Use this type to configure Salesforce as an identity provider for SAML single sign-on (SSO). In this type of SSO configuration, users log in to a third-party service provider, such as Google, using their Salesforce credentials.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ExtlClntAppSamlConfigurablePolicies components have the suffix .ecaSamlPlcy and are stored in the extlClntAppSamlConfigurablePolicies folder.

## Version

ExtlClntAppSamlConfigurablePolicies components are available in API version 63.0 and later.

## Special Access Rules

To use the ExtlClntAppSamlConfigurablePolicies type, you must have the View all External Client Apps, view their settings, and edit their policies user permission.

This type must be related to a parent [ExternalClientApplication](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_externalclientapplication.htm). Because external client apps with SAML configurations can't be packaged, the distributionState for the parent external client app must be set to Local.

The parent external client app must also have an associated [ExtlClntAppConfigurablePolicies](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_extlclntappconfigurablepolicies.htm) metadata type where the isSamlPluginEnabled field is set to true.

## Fields

| Field Name | Description |
| --- | --- |
| acsUrl | 
Field Type

string

Description

Required. The assertion consumer service (ACS) URL from the third-party service provider. The ACS URL is the endpoint where the service provider receives SAML responses from Salesforce.





 |
| certificate | 

Field Type

string

Description

A security certificate that the third-party service provider uses to sign SAML requests. Include this field only if your service provider signs SAML requests and you also want to use a [service provider-initiated SAML flow](https://help.salesforce.com/s/articleView?id=xcloud.identity_provider_about.htm&type=5&language=en_US).

If you include a certificate, Salesforce requires that all SAML requests from the service provider are signed. If you don't include a certificate, Salesforce accepts all SAML requests, whether or not they're signed.





 |
| commaSeparatedPermissionSet | 

Field Type

string

Description

A comma-separated list of permission set IDs that defines the user permissions required for an end user to use the SAML SSO flow. The permission sets that you specify here apply to the entire app, not just its SAML configuration.



 |
| commaSeparatedProfile | 

Field Type

string

Description

A comma-separated list of profile IDs that defines the profiles required for an end user to use the SAML SSO flow. Like permission sets, profiles define user permissions. The profiles that you specify here apply to the entire app, not just its SAML configuration. We recommend that you use permission sets to manage user permissions instead of profiles.



 |
| customAttributes | 

Field Type

[ExtlClntAppSamlConfigurablePoliciesAttribute\[\]](#ExtlClntAppSamlConfigurablePoliciesAttribute)

Description

Custom attributes that you can use to send more information about the user in SAML responses. For example, send information about the user's country. The service provider can use the information to validate the user's identity.



 |
| encryptionCertificate | 

Field Type

string

Description

A certificate that's used to encrypt SAML assertions that Salesforce sends to the service provider. Use an X.509 certificate that's saved in your Certificate and Key Management settings. To get the certificate, work with a certificate provider. If you include an encryptionCertificate, make sure that your service provider is configured to decrypt SAML assertions.



 |
| encryptionType | 

Field Type

ExtlClntAppSamlEncryptType

Description

If you include an encryptionCertificate to encrypt SAML assertions, the encryptionType field specifies the encryption method. When the service provider receives SAML assertions from Salesforce, it detects this method and decrypts it.

These values are valid.

- AES\_128—Advanced Encryption Standard (AES) encryption algorithm with a 128-bit cryptographic key.
- AES\_256—AES encryption algorithm with a 256-bit cryptographic key.

For more information about AES encryption from the National Institute of Standards and Technology, see [https://www.nist.gov/publications/advanced-encryption-standard-aes-0](https://www.nist.gov/publications/advanced-encryption-standard-aes-0 "HTML (New Window)").



 |
| entityUrl | 

Field Type

string

Description

Required. The entity ID from the third-party service provider. The entity ID is a globally unique ID that Salesforce uses to recognize the service provider.





 |
| externalClientApplication | 

Field Type

string

Description

Required. The label for the parent ExternalClientApplication.





 |
| issuer | 

Field Type

string

Description

Specifies the URI from which Salesforce sends SAML responses. The service provider uses this value to confirm that the response came from Salesforce. If you don't include this field, Salesforce uses your My Domain by default. Include this field to specify a different value, such as an Experience Cloud site URL.



 |
| label | 

Field Type

string

Description

A name for your external client app SAML policies configuration.



 |
| nameIdFormat | 

Field Type

ExtlClntAppNameIdFormatType

Description

Specifies the format of the user's SSO identifier (dictated by the value of the subjectType field) in SAML messages. So that the service provider can recognize the user, the name ID format that Salesforce uses for SAML responses must match the format that the service provider uses. Get this value from your service provider.

These values are valid.

- Unspecified (default)—No format.
- EmailAddress—The user's identifier is formatted as an email address.
- Persistent—The user's identifier is in an opaque format. Only Salesforce and the service provider can recognize it. The identifier doesn't change based on context.
- Transient—Like the Persistent identifier, the user's identifier is in an opaque format. But Transient identifiers are temporary values that can change.





 |
| signingAlgorithmType | 

Field Type

ExtlClntAppSamlSignAlgoType

Description

The signing algorithm that Salesforce uses to secure SAML messages. The signing algorithm generates a signature by hashing the private key that's stored in the certificate. Salesforce includes this signature in the SAML response—in both the response body and in the SAML assertion. When the service provider receives SAML responses, it validates the signature. Salesforce also applies this algorithm to single logout requests and responses.

These values are valid.

- SHA1—Secure Hash Algorithm (SHA) 1 algorithm, which generates a 160-bit hash value.
- SHA256—SHA-256 algorithm,which generates a 256-bit hash value.





 |
| singleLogoutBindingType | 

Field Type

ExtlClntAppSamlBindingType

Description

The SAML HTTP binding type that the service provider uses when it initiates single logout. The binding type determines how the service provider transfers HTTP information to Salesforce. These values are valid.

- PostBinding–The service provider uses POST requests for single logout.
- RedirectBinding—The service provider sends single logout requests through the browser via GET requests.





 |
| singleLogoutUrl | 

Field Type

string

Description

The SAML single logout endpoint on the service provider. When Salesforce initiates single logout, it sends logout requests to this endpoint.



 |
| startUrl | 

Field Type

string

Description

A URL where users are directed after they authenticate. For example, direct users to a specific page in the service provider app.

Deprecated in API version 64.0 and later. Use the startUrl field on the [ExtlClntAppConfigurablePolicies](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_extlclntappconfigurablepolicies.htm) metadata type instead.



 |
| subjectCustomAttribute | 

Field Type

string

Description

If the subjectType is CustomAttribute, specify which field you want to use to identify the user. Choose an existing field on the User object, or create a custom User field.



 |
| subjectType | 

Field Type

ExtlClntAppSamlSubjectType

Description

Specifies the user's SSO identifier. These values are valid.

- Username—The user's Salesforce username.
- FederationId—The user's federation ID, which maps to the FederationIdentifier—A field on the User object. The federation ID can be any value as long as both Salesforce and the service provider can recognize it. For example, get a value from the service provider and then specify it in Salesforce.
- UserId—The user's 15-character Salesforce user ID.
- CustomAttribute—An identifier that's taken from a custom field value. Specify the custom field in the subjectCustomAttribute field.
- PersistentId—An opaque identifier that only Salesforce and the service provider recognize.





 |

## ExtlClntAppSamlConfigurablePoliciesAttribute

Represents custom attributes that provide more information about the user. The attributes are included in SAML assertions in SAML responses that Salesforce sends to the service provider.

| Field Name | Description |
| --- | --- |
| formula | 
Field Type

string

Description

Required.

A field that stores the user information that you want to send. Format the value as $<object name>.<field>.

For example: $Organization.Country to indicate the Country field on the Organization object.





 |
| key | 

Field Type

string

Description

Required.

A unique name for the attribute to help you and the service provider recognize it in SAML responses.



 |

## Declarative Metadata Sample Definition

The following is an example of an ExtlClntAppSamlConfigurablePolicies component.

<?xml version="1.0" encoding="UTF-8"?>
<ExtlClntAppSamlConfigurablePolicies xmlns="http://soap.sforce.com/2006/04/metadata">
    <acsUrl\>https://www.<serviceprovideracsurl\>.com</acsUrl\>
    <entityUrl\>https://www.<serviceproviderentityid\>.com</entityUrl\>
    <externalClientApplication\>mySamlEca</externalClientApplication\>
    <issuer\>https://mydomainname.my.salesforce.com</issuer\>
    <label\>myeca\_samlpolicies</label\>
    <nameIdFormat\>Unspecified</nameIdFormat\>
    <singleLogoutUrl\>https://www.<serviceprovidersinglelogouturl\>.com</singleLogoutUrl\>
    <singleLogoutBindingType\>RedirectBinding</singleLogoutBindingType\>
    <subjectType\>CustomAttribute</subjectType\>
    <subjectCustomAttribute\>MyCustomField</subjectCustomAttribute\>
    <certificate\>MIIDzDCCArQCCQCFaZKGsGqZ...</certificate\>
    <encryptionCertificate\>MIIDzDCCArQCCQCFaZKGsGqZ...</encryptionCertificate\>
    <encryptionType\>AES\_128</encryptionType\>
    <signingAlgorithmType\>SHA1</signingAlgorithmType\>
    <customAttributes\>
        <key\>User Firstname</key\>
        <formula\>$User.FirstName</formula\>
    </customAttributes\>
    <customAttributes\>
        <key\>User Country</key\>
        <formula\>$User.Country</formula\>
    </customAttributes\>
</ExtlClntAppSamlConfigurablePolicies\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ExternalClientApplication</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppConfigurablePolicies</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>ExtlClntAppSamlConfigurablePolicies</name\>
    </types\>
    <version\>63.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=b4a9f5d11e2aea663c7579752133ea34cd46b173ecbb2940a15056ce8b1d8efc url=/legacydeveloper/current/en-us/api_meta/meta_featureparameterboolean.md -->

# FeatureParameterBoolean

Represents a boolean feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

FeatureParameterBoolean components have the suffix .featureParameterBoolean. The components are stored in the featureParameters folder, which contains components for all the feature parameter metadata types.

## Version

FeatureParameterBoolean components are available in API version 41.0 and later.

## Special Access Rules

Available to package developers who have access to the Feature Management App (FMA). For details, see [Manage Features](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/fma_manage_features.htm "HTML (New Window)") in the Second-Generation Managed Packaging Developer Guide.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| dataFlowDirection | [FeatureParameterDataFlowDirection](#FeatureParameterDataFlowDirection) | After a package containing the components is installed, indicates whether the feature parameter’s value is editable in your License Management Org (LMO) and read-only in your customer’s org or the other way around. |
| masterLabel | string | The feature parameter name that appears in the user interface. |
| value | boolean | The default value for this feature parameter. You can reference this value in your code, just like you reference other values in a subscriber’s org. |

## FeatureParameterDataFlowDirection

Represents the direction of the data flow between your License Management Org (LMO) and the customer’s org.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d498298e190">Field Name</th>

              <th class="featureTableHeader  " id="d498298e193">Field Type</th>

              <th class="featureTableHeader  " id="d498298e196">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d498298e190" data-title="Field Name"><span class="keyword parmname">FeatureParameterDataFlowDirection</span></td>

              <td class="entry" headers="d498298e193" data-title="Field Type">string</td>

              <td class="entry" headers="d498298e196" data-title="Description">
                <p class="p">After a package containing the components is installed, indicates whether
                  the feature parameter’s value is editable in your License Management Org (LMO) and
                  read-only in your customer’s org or the other way around.</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">LmoToSubscriber</samp></li>

                  <li class="li"><samp class="codeph nolang">SubscriberToLmo</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a FeatureParameterBoolean component.

<?xml version="1.0" encoding="UTF-8"?>
<FeatureParameterBoolean xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataflowDirection\>SubscriberToLmo</dataflowDirection\>
    <masterLabel\>Budget Tracking Enabled</masterLabel\>
    <value\>false</value\>
</FeatureParameterBoolean\>

The following is an example package.xml that references the previous definition (and the definitions for the other feature parameter types).

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>FeatureParameterBoolean</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>FeatureParameterDate</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>FeatureParameterInteger</name\>
    </types\>
    <version\>41.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ad1d75c55af0e941ddb8e4809e0de47b1df4f5ef263055da37f643c8e34a6694 url=/legacydeveloper/current/en-us/api_meta/meta_featureparameterdate.md -->

# FeatureParameterDate

Represents a date feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

FeatureParameterDate components have the suffix .featureParameterDate. The components are stored in the featureParameters folder, which contains components for all the feature parameter metadata types.

## Version

FeatureParameterDate components are available in API version 41.0 and later.

## Special Access Rules

Available to package developers who have access to the Feature Management App (FMA). For details, see [Manage Features](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/fma_manage_features.htm "HTML (New Window)") in the Second-Generation Managed Packaging Developer Guide.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| dataFlowDirection | [FeatureParameterDataFlowDirection](#FeatureParameterDataFlowDirection) | After a package containing the components is installed, indicates whether the feature parameter’s value is editable in your License Management Org (LMO) and read-only in your customer’s org or the other way around. |
| masterLabel | string | The feature parameter name that appears in the user interface. |
| value | date | The default value for this feature parameter. You can reference this value in your code, just like you reference other values in a subscriber’s org. |

## FeatureParameterDataFlowDirection

Represents the direction of the data flow between your License Management Org (LMO) and the customer’s org.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d498875e190">Field Name</th>

              <th class="featureTableHeader  " id="d498875e193">Field Type</th>

              <th class="featureTableHeader  " id="d498875e196">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d498875e190" data-title="Field Name"><span class="keyword parmname">FeatureParameterDataFlowDirection</span></td>

              <td class="entry" headers="d498875e193" data-title="Field Type">string</td>

              <td class="entry" headers="d498875e196" data-title="Description">
                <p class="p">After a package containing the components is installed, indicates whether
                  the feature parameter’s value is editable in your License Management Org (LMO) and
                  read-only in your customer’s org or the other way around.</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">LmoToSubscriber</samp></li>

                  <li class="li"><samp class="codeph nolang">SubscriberToLmo</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a FeatureParameterDate component.

<?xml version="1.0" encoding="UTF-8"?>
<FeatureParameterDate xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataflowDirection\>SubscriberToLmo</dataflowDirection\>
    <masterLabel\>Activation Date</masterLabel\>
    <value\>2017-10-23</value\>
</FeatureParameterDate\>

The following is an example package.xml that references the previous definition (and the definitions for the other feature parameter types).

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>FeatureParameterBoolean</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>FeatureParameterDate</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>FeatureParameterInteger</name\>
    </types\>
    <version\>41.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=4992302b22716a20b3cfca59007681bfa9ee732e0b7df3decca25cd5c8e184a8 url=/legacydeveloper/current/en-us/api_meta/meta_featureparameterinteger.md -->

# FeatureParameterInteger

Represents an integer feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

FeatureParameterInteger components have the suffix .featureParameterInteger. The components are stored in the featureParameters folder, which contains components for all the feature parameter metadata types.

## Version

FeatureParameterInteger components are available in API version 41.0 and later.

## Special Access Rules

Available to package developers who have access to the Feature Management App (FMA). For details, see [Manage Features](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/fma_manage_features.htm "HTML (New Window)") in the Second-Generation Managed Packaging Developer Guide.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| dataFlowDirection | [FeatureParameterDataFlowDirection](#FeatureParameterDataFlowDirection) | After a package containing the components is installed, indicates whether the feature parameter’s value is editable in your License Management Org (LMO) and read-only in your customer’s org or the other way around. |
| masterLabel | string | The feature parameter name that appears in the user interface. |
| value | int | The default value for this feature parameter. You can reference this value in your code, just like you reference other values in a subscriber’s org. |

## FeatureParameterDataFlowDirection

Represents the direction of the data flow between your License Management Org (LMO) and the customer’s org.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d499452e190">Field Name</th>

              <th class="featureTableHeader  " id="d499452e193">Field Type</th>

              <th class="featureTableHeader  " id="d499452e196">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d499452e190" data-title="Field Name"><span class="keyword parmname">FeatureParameterDataFlowDirection</span></td>

              <td class="entry" headers="d499452e193" data-title="Field Type">string</td>

              <td class="entry" headers="d499452e196" data-title="Description">
                <p class="p">After a package containing the components is installed, indicates whether
                  the feature parameter’s value is editable in your License Management Org (LMO) and
                  read-only in your customer’s org or the other way around. </p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">LmoToSubscriber</samp></li>

                  <li class="li"><samp class="codeph nolang">SubscriberToLmo</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a FeatureParameterInteger component.

<?xml version="1.0" encoding="UTF-8"?>
<FeatureParameterInteger xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataflowDirection\>SubscriberToLmo</dataflowDirection\>
    <masterLabel\>Current Project Count</masterLabel\>
    <value\>42</value\>
</FeatureParameterInteger\>

The following is an example package.xml that references the previous definition (and the definitions for the other feature parameter types).

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>FeatureParameterBoolean</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>FeatureParameterDate</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>FeatureParameterInteger</name\>
    </types\>
    <version\>41.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=75278d1909b34657c41dfa66daa30184fb1f0b6978b70f40e1605aeaf52fce85 url=/legacydeveloper/current/en-us/api_meta/npc_fundraising_api_objects_fieldmappingconfig.md -->

# FieldMappingConfig

Represents the configuration for fields mapped between a source object and one or more destination objects and fields. This object is available in API version 63.0 and later.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

## Special Access Rules

This object is available only if the Fundraising Access license is enabled and the Fundraising User system permission is assigned to users.

## Fields

### Description

- **Type**: textarea
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
- **Description**: The description of the field mapping configuration.

### DeveloperName

- **Type**: string
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The unqiue name for FieldMappingConfig.

### Language

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: The language of the FieldMappingConfig.
- **Possible values**:
    - da—Danish
    - de—German
    - en\_US—English
    - es—Spanish
    - es\_MX—Spanish (Mexico)
    - fi—Finnish
    - fr—French
    - it—Italian
    - ja—Japanese
    - ko—Korean
    - nl\_NL—Dutch
    - no—Norwegian
    - pt\_BR—Portuguese (Brazil)
    - ru—Russian
    - sv—Swedish
    - th—Thai
    - zh\_CN—Chinese (Simplified)
    - zh\_TW—Chinese (Traditional)

### MasterLabel

- **Type**: string
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: Label for the FieldMappingConfig.

### NamespacePrefix

- **Type**: string
- **Properties**: Filter, Group, Nillable, Sort
- **Description**: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values:
    - In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
    - In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

### ProcessType

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: Specifies the type of process that the field mapping configuration supports.
- **Default value**: GiftEntry
- **Possible values are**:
    - ChangeRequest
    - GiftEntry
    - Incident
    - Problem
    - MessagingSubscriber

### SourceObjectId

- **Type**: picklist
- **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update
- **Description**: The ID of the source object for all of the fields mapped in the configuration.
- **Possible values are**:
    - Case
    - MessagingSubscriber

<!-- document id=5b45d8bf9485377ed259be0930305a9e62ca37ca7f5a9ea02bbaf22125d9b279 url=/legacydeveloper/current/en-us/api_meta/meta_fieldrestrictionrule.md -->

# FieldRestrictionRule

Represents a field visibility rule that controls whether a field is visible to a user, based on the field’s inclusion in a field set. If Enhanced Personal Information Management setting was enabled before Spring ’22, field visibility is based on the field’s compliance categorization. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

FieldRestrictionRule components have the suffix .rule and are stored in the fieldRestrictionRules folder.

## Version

FieldRestrictionRule components are available in API version 52.0 and later.

## Special Access Rules

- To access this type, you must have the Manage Sharing permission.
- To create and manage Employee field visibility rules, you must be assigned a Workplace Command Center permission set license and the Provides access to Workplace Command Center features system permission.
- To create and manage User field visibility rules, you must enable Digital Experiences and the Enhanced Personal Information Management feature.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d502160e112">Field Name</th>

              <th class="featureTableHeader  " id="d502160e115">Field Type</th>

              <th class="featureTableHeader  " id="d502160e118">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d502160e118" data-title="Description">Indicates whether the rule is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">classification</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">string[]</td>

              <td class="entry" headers="d502160e118" data-title="Description">Required. The data classification compliance categorization or field set that
                is targeted by the rule. The rule applies to fields that are marked with this
                categorization or included in this field set. If you enabled Enhanced Personal
                Information Management before Spring ‘22 (API version 54.0), you can use
                Salesforce's default compliance categorization values or values that you add
                yourself. If you enabled Enhanced Personal Information Management after Spring ‘22
                (API version 54.0), use the PersonalInfo_EPIM field set or a field set that you add
                yourself.</td>

            </tr>

            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">classificationType</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">ClassificationType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d502160e118" data-title="Description">The type of classification method used in your org. If you enabled Enhanced
                Personal Information Management before Spring ‘22 (API version 54.0), use <samp class="codeph nolang">ComplianceCategory</samp>. If you enabled Enhanced Personal
                Information Management after Spring ‘22, use <samp class="codeph nolang">FieldSet</samp>.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ComplianceCategory</samp>—
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FieldSet</samp>—
                  </li>

                </ul>
                The default value is <samp class="codeph nolang">ComplianceCategory</samp>.
                Available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">string</td>

              <td class="entry" headers="d502160e118" data-title="Description">Required. The description of the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">enforcementType</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">EnforcementType (enumeration of type string)</td>

              <td class="entry" headers="d502160e118" data-title="Description">Required. The type of rule. Possible values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">FieldRestrict</samp>—Field visibility
                    rule. Only this value is valid.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Restrict</samp>—Do not use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Scoping</samp>—Do not use.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">string</td>

              <td class="entry" headers="d502160e118" data-title="Description">Required. The name of the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">recordFilter</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">string</td>

              <td class="entry" headers="d502160e118" data-title="Description">Required. The criteria that determine which fields are visible to the specified
                users. For example, the field can check if the logged-in user matches the Employee’s
                ID.</td>

            </tr>

            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">targetEntity</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">string</td>

              <td class="entry" headers="d502160e118" data-title="Description">Required. The object for which you're creating the rule. Only the Employee and
                User objects are supported.</td>

            </tr>

            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">userCriteria</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">string</td>

              <td class="entry" headers="d502160e118" data-title="Description">Required. The users that this rule applies to, such as all active users or
                users with a specified role or profile.</td>

            </tr>

            <tr>
              <td class="entry" headers="d502160e112" data-title="Field Name"><span class="keyword parmname">version</span></td>

              <td class="entry" headers="d502160e115" data-title="Field Type">int</td>

              <td class="entry" headers="d502160e118" data-title="Description">Required. The rule's version number.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a FieldRestrictionRule component, which uses the ComplianceCategory classification type. The classification value is one of Salesforce's default compliance categorization values, but you can create a custom compliance categorization value to use instead.

<?xml version="1.0" encoding="UTF-8"?>
<FieldRestrictionRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <classification\>PII</classification\>
    <classificationType\>ComplianceCategory</classificationType\>
    <description\>Is Owner of Employee</description\>
    <enforcementType\>FieldRestrict</enforcementType\>
    <masterLabel\>Is Owner Field Restriction Rule</masterLabel\>
    <recordFilter\>OwnerId = $User.Id</recordFilter\>
    <targetEntity\>Employee</targetEntity\>
    <userCriteria\>$User.IsActive = true</userCriteria\>
    <version\>1</version\>
</FieldRestrictionRule\>

The following is an example of a FieldRestrictionRule component, which uses the FieldSet classification type. The classification value is Salesforce's default field set for personal information, but you can create a field set to use instead.

<?xml version="1.0" encoding="UTF-8"?>
<FieldRestrictionRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <classification\>PersonalInfo\_EPIM</classification\>
    <classificationType\>FieldSet</classificationType\>
    <description\>Is Owner of Employee</description\>
    <enforcementType\>FieldRestrict</enforcementType\>
    <masterLabel\>Is Owner Field Restriction Rule</masterLabel\>
    <recordFilter\>OwnerId = $User.Id</recordFilter\>
    <targetEntity\>Employee</targetEntity\>
    <userCriteria\>$User.IsActive = true</userCriteria\>
    <version\>1</version\>
</FieldRestrictionRule\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>FieldRestrictionRule</name\>
    </types\>
    <version\>52.0</version\>
</Package\>

<!-- document id=d5fc5bb159751987e78442856f947332c9e8ce979b1a8ce72aa056e53a210b7f url=/legacydeveloper/current/en-us/api_meta/meta_fieldservicesettings.md -->

# FieldServiceSettings

Represents an organization’s Field Service settings.

To learn more about Field Service settings, see [Enable Field Service](https://help.salesforce.com/articleView?id=fs_enable.htm&language=en_US) in Salesforce Help.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## Version

FieldServiceSettings is available in API version 40.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d503097e82">Field</th>

              <th class="featureTableHeader  " id="d503097e85">Field Type</th>

              <th class="featureTableHeader  " id="d503097e88">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">apptAssistantExpiration</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">int</td>

              <td class="entry" headers="d503097e88" data-title="Description">The expiration time of <span class="keyword parmname">apptAssistantInfoUrl</span> after which
                the customer stops seeing the mobile worker's location and estimated time of
                arrival. Available in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">apptAssistantInfoUrl</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The tracking URL that helps a customer see the mobile worker's estimated time
                of arrival and tracking information. Available in API version 50.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">apptAssistantRadiusUnitValue</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">ApptAssistantRadiusUnit (enumeration of type string)</td>

              <td class="entry" headers="d503097e88" data-title="Description">The units for specifying the geofence radius. When the mobile worker enters
                this area, a Last Mile notification is automatically sent. Valid values are:<ul class="ul bulletList">
                  <li class="li">Kilometer</li>

                  <li class="li">Meter</li>

                  <li class="li">Mile</li>

                  <li class="li">Yard</li>

                </ul>
                <p class="p">Available in API version 50.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">apptAssistantRadiusValue</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">int</td>

              <td class="entry" headers="d503097e88" data-title="Description">The geofence radius from the service appointment's address used for sending a
                notification to the customer when the mobile worker approaches the address.
                Available in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">apptAssistantStatus</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The status on the service appointment used to trigger En Route notification.
                The value has to match one of the service appointment's Status field options. When
                the mobile worker selects this status on a service appointment, the customer
                receives the En Route notification with tracking details. Available in API version
                50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">canceledDefaultStatus</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The default status value when a service appointment is canceled. Available in
                API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">cannotCompleteDefaultStatus</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The default status value when a service appointment can't be completed.
                Available in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">canPopulateGoogleAddress</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Allows desktop and mobile to send geolocation and map data to Google and Apple.
                Available in API version 57.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">canSendAppCenterCrashReports</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Allows Salesforce to send crash reports to Microsoft App Center. Available in
                API version 57.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">canStoreMobileAnalytics</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Allows third parties to store mobile analytics. Available in API version 57.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">completedDefaultStatus</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The default status value when a service appointment is completed. Available in
                API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field">
                <span class="keyword parmname">deepLinkPublicSecurityKey</span>
              </td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">Provides a public security key for users accessing a deep link action in the
                Field Service mobile app. Hide the redirection warning by configuring the deep link
                URL with a security key. The deep link URL then processes the security check.
                Available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">dispatchedDefaultStatus</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The default status value when a service appointment is dispatched. Available in
                API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">doesAllowEditSaForCrew</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Lets service crew members edit their service appointments.<p class="p">This setting
                  applies only if <span class="keyword parmname">doesShareSaWithAr</span> is selected. For assigned
                  resources of type Crew, crew members get Read-Write access to their service
                  appointment and, if <span class="keyword parmname">doesShareSaParentWoWithAr</span> is selected, to
                  their service appointments’ parent work orders.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">doesShareSaParentWoWithAr</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Shares service appointments’ parent work orders with their assigned
                resources.<p class="p">This setting applies only if <span class="keyword parmname">doesShareSaWithAr</span>
                  is selected and sharing access for work orders is set to Private or Public Read
                  Only. Technician assigned resources get Read-Write access to their work orders.
                  For assigned resources of type Crew, the crew leader gets Read-Write access and
                  crew members get Read access. If the service appointment’s parent is a work order
                  line item, assigned resources get access to the associated work order.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">doesShareSaWithAr</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Shares dispatched service appointments with their assigned resources.<p class="p">This
                  setting applies only if sharing access for service appointments is set to Private
                  or Public Read Only. Technician assigned resources get Read-Write access to their
                  service appointments. For assigned resources of type Crew, the crew leader gets
                  Read-Write access and crew members get Read access.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">enableDocumentBuilder</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Enables access to Document Builder feature.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">enableFloatingWorkOrder</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Enables floating work orders for the org.<p class="p">Allows users to create work orders
                  with a floating recurrence cadence based on the previous work order's
                  completion.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">enableLsdkMode</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Enables Lightning SDK in the Field Service mobile app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">enablePopulateWorkOrderAddress</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Allows the address to be populated when work orders are generated from a
                maintenance plan.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">enableStandbyMode</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Turns on standby mode in the Field Service mobile app. When enabled, it helps
                mobile workers conserve battery and reduce distractions by pausing notifications and
                disabling data syncs when not actively working. </td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">enableWorkOrders</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Enables Work Orders for the org.<p class="p">This setting allows users to use the Work
                  Order object, whether or not Field Service is enabled. When Field Service is
                  enabled, you can’t turn off Work Orders.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">enableWorkPlansAutoGeneration</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Allows work plans and their work steps to be generated automatically when a
                work order or a work order line item is newly created. The specific work plans and
                work steps to be generated depends on matching criteria specified in Work Plan
                Selection Rules. Available in API version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">enableWorkStepManualStatusUpdate</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Allows a work step status to be updated manually. A prompt suggests a status
                update that users can accept or defer.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">fieldServiceNotificationsOrgPref</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Turns on in-app notifications for the Salesforce mobile app and Lightning
                Experience users. Notifications are sent when any of the following actions occurs on
                a work order or work order line item that they own or follow:<ul class="ul bulletList">
                  <li class="li">A text or file post is added</li>

                  <li class="li">A tracked field is updated</li>

                  <li class="li">The record owner changes</li>

                  <li class="li">The resource assignments change on a related service appointment</li>

                </ul>
                If the option to track all related objects is selected in the feed tracking
                settings for work orders, users are also notified when child records of work
                orders—such as service appointments—are created or deleted.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">fieldServiceOrgPref</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Indicates whether Field Service is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">inProgressDefaultStatus</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The default status value when a service appointment is in progress. Available
                in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">isGeoCodeSyncEnabled</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Syncs the location of a Service Resource to an Inventory object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">isLocationHistoryEnabled</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Tracks the location history of a Service Resource.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">mobileFeedbackEmails</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">Stores an email address to which a feedback email is sent when users leave
                feedback from the Field Service mobile app. Available in API version 54.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">noneDefaultStatus</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The default status value when a service appointment has no specific status.
                Available in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">o2EngineEnabled</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Enables Field Service Enhanced Scheduling and Optimization. The default value
                is false. Available in API version 55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">objectMappingItem</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type"><a class="xref" href="#ObjectMappingItem">ObjectMappingItem</a></td>

              <td class="entry" headers="d503097e88" data-title="Description">Represents an organization's custom field mapping for Work
                Plan or Work Step generation. Custom Fields can be mapped from WorkPlanTemplate to
                WorkPlan, WorkStepTemplate to WorkStep, or WorkPlanTemplateEntry to WorkStep. Available in
                API version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">optimizationServiceAccess</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Allows the optimization service to access data in your Salesforce org.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">overrideDefaultLwcStyling</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d503097e88" data-title="Description">Allows the Field Service mobile app to override the default Lightning Web
                Component (LWC) styling with custom or branded styles. When enabled, it applies
                custom styling configurations (such as brand colors, themes, and visual elements) to
                LWCs within the mobile application. </td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">scheduledDefaultStatus</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The default status value when a service appointment is scheduled. Available in
                API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">serviceAppointmentsDueDateOffsetOrgValue</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">int</td>

              <td class="entry" headers="d503097e88" data-title="Description">Indicates the number of days past the Created Date that the Due Date on
                auto-created service appointments should fall. Work types include an option to
                automatically add a service appointment to new work orders or work order line items
                using the work type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">workOrderDurationSource</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">WorkOrderDurationSource (enumeration of type string)</td>

              <td class="entry" headers="d503097e88" data-title="Description">The source for the work order duration value. Possible values are:<ul class="ul bulletList">
                  <li class="li">WorkType</li>

                  <li class="li">TotalFromWorkPlan</li>

                  <li class="li">Custom</li>

                </ul>
                Available in API version 55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">workOrderLineItemSearchFields</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The work order line item fields that the search engine should scan to suggest
                knowledge articles on work order line items.</td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e82" data-title="Field"><span class="keyword parmname">workOrderSearchFields</span></td>

              <td class="entry" headers="d503097e85" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e88" data-title="Description">The work order fields that the search engine should scan to suggest knowledge
                articles on work orders.</td>

            </tr>

          </tbody>

        </table>

## ObjectMappingItem

Represents an organization's custom field mapping for Work Plan or Work Step generation. Custom Fields can be mapped from WorkPlanTemplate to WorkPlan, WorkStepTemplate to WorkStep, or WorkPlanTemplateEntry to WorkStep. Available in API version 52.0 and later.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d503097e710">Field Name</th>

              <th class="featureTableHeader  " id="d503097e713">Field Type</th>

              <th class="featureTableHeader  " id="d503097e716">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d503097e710" data-title="Field Name"><span class="keyword parmname">mappingType</span></td>

              <td class="entry" headers="d503097e713" data-title="Field Type">string</td>

              <td class="entry" headers="d503097e716" data-title="Description">The type of object mapping. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">WorkPlans_WorkPlanTemplate_WorkPlan</samp> —
                    Maps a WorkPlanTemplate to a WorkPlan
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WorkPlans_WorkStepTemplate_WorkStep</samp> —
                    Maps a WorkStepTemplate to a WorkStep
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WorkPlans_WorkPlanTemplateEntry_WorkStep</samp>
                    — Maps a WorkPlanTemplateEntry to a WorkStep
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d503097e710" data-title="Field Name"><span class="keyword parmname">objectMapping</span></td>

              <td class="entry" headers="d503097e713" data-title="Field Type"><a class="xref" href="#ObjectMapping">ObjectMapping</a></td>

              <td class="entry" headers="d503097e716" data-title="Description">The object mapping details.</td>

            </tr>

          </tbody>

        </table>

## ObjectMapping

Represents a map of fields in the input object to fields in the output object.

<table class="featureTable sort_table" summary="">
            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d503097e784">Field Name</th>

                <th class="featureTableHeader  " id="d503097e787">Field Type</th>

                <th class="featureTableHeader  " id="d503097e790">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d503097e784" data-title="Field Name"><span class="keyword parmname">inputObject</span></td>

                <td class="entry" headers="d503097e787" data-title="Field Type">string</td>

                <td class="entry" headers="d503097e790" data-title="Description">Required. The name of the object type containing the source fields for mapping.
                  Valid values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">WorkPlanTemplate</samp></li>

                    <li class="li"><samp class="codeph nolang">WorkStepTemplate</samp></li>

                    <li class="li"><samp class="codeph nolang">WorkPlanTemplateEntry</samp></li>

                  </ul>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d503097e784" data-title="Field Name"><span class="keyword parmname">mappingFields</span></td>

                <td class="entry" headers="d503097e787" data-title="Field Type">[<a class="xref" href="#ObjectMappingField">ObjectMappingField</a>]</td>

                <td class="entry" headers="d503097e790" data-title="Description">Required. The mapping of source object fields to target object fields.</td>

              </tr>

              <tr>
                <td class="entry" headers="d503097e784" data-title="Field Name"><span class="keyword parmname">outputObject</span></td>

                <td class="entry" headers="d503097e787" data-title="Field Type">string</td>

                <td class="entry" headers="d503097e790" data-title="Description">Required. The name of the object type that receives data from the source
                  fields. Valid values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">WorkPlan</samp></li>

                    <li class="li"><samp class="codeph nolang">WorkStep</samp></li>

                  </ul>
                </td>

              </tr>

            </tbody>

          </table>

## ObjectMappingField

A field name in the input object and the corresponding field name in the output object.

| Field Name | Field Type | Description |
| --- | --- | --- |
| inputField | string | Required. The name of a custom field supplying source data. This field is from the object specified in inputObject. |
| outputField | string | Required. The name of a custom field that receives data from the source field specified in inputField. This field is from the object specified in outputObject. |

## Declarative Metadata Sample Definition

This sample file shows a subset of the possible field service settings that you can customize.

<?xml version="1.0" encoding="UTF-8"?>
<FieldServiceSettings xmlns="http://soap.sforce.com/2006/04/metadata"\>
   <doesAllowEditSaForCrew>false</doesAllowEditSaForCrew>
   <doesShareSaParentWoWithAr>false</doesShareSaParentWoWithAr>
   <doesShareSaWithAr>false</doesShareSaWithAr>
   <enableWorkOrders>false</enableWorkOrders>
   <enableWorkPlansAutoGeneration>true</enableWorkPlansAutoGeneration>
   <fieldServiceNotificationsOrgPref>false</fieldServiceNotificationsOrgPref>
   <fieldServiceOrgPref>true</fieldServiceOrgPref>
   <isGeoCodeSyncEnabled>false</isGeoCodeSyncEnabled>
   <isLocationHistoryEnabled>false</isLocationHistoryEnabled>
   <o2EngineEnabled>false</o2EngineEnabled>
   <objectMappingItem>
      <mappingType>WorkPlans\_WorkPlanTemplate\_WorkPlan</mappingType>
      <objectMapping>
         <inputObject>WorkPlanTemplate</inputObject>
         <mappingFields>
            <inputField>WorkPlanTemplate\_CustomNumberField\_\_c</inputField>
            <outputField>WorkPlan\_CustomNumberField\_\_c</outputField>
         </mappingFields>
         <mappingFields>
            <inputField>WorkPlanTemplate\_CustomTextField\_\_c</inputField>
            <outputField>WorkPlan\_CustomPicklistField\_\_c</outputField>
         </mappingFields>
         <outputObject>WorkPlan</outputObject>
      </objectMapping>
   </objectMappingItem>
   <objectMappingItem>
      <mappingType>WorkPlans\_WorkStepTemplate\_WorkStep</mappingType>
      <objectMapping>
         <inputObject>WorkStepTemplate</inputObject>
         <mappingFields>
            <inputField>WokStepTemplate\_CustomNumberField\_\_c</inputField>
            <outputField>WokStep\_CustomNumberField\_\_c</outputField>
         </mappingFields>
         <mappingFields>
            <inputField>WokStepTemplate\_CustomTextField\_\_c</inputField>
            <outputField>WokStep\_CustomTextField\_\_c</outputField>
         </mappingFields>
         <outputObject>WorkStep</outputObject>
      </objectMapping>
   </objectMappingItem>
   <objectMappingItem>
      <mappingType>WorkPlans\_WorkPlanTemplateEntry\_WorkStep</mappingType>
      <objectMapping>
         <inputObject>WorkPlanTemplateEntry</inputObject>
         <mappingFields>
            <inputField>WorkPlanTemplateEntry\_CustomDateField\_\_c</inputField>
            <outputField>WokStep\_CustomDateField\_\_c</outputField>
         </mappingFields>
         <outputObject>WorkStep</outputObject>
      </objectMapping>
   </objectMappingItem>
   <optimizationServiceAccess>false</optimizationServiceAccess>
   <serviceAppointmentsDueDateOffsetOrgValue>7</serviceAppointmentsDueDateOffsetOrgValue>
   <workOrderLineItemSearchFields>Subject</workOrderLineItemSearchFields>
   <workOrderSearchFields>Subject</workOrderSearchFields>
</FieldServiceSettings>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e592045a7d389c7188c2f80e462ec4663a3a5d55a55e557694cdb57501494216 url=/legacydeveloper/current/en-us/api_meta/meta_fieldset.md -->

# FieldSet

Represents a field set. A field set is a grouping of fields. For example, you could have a field set that contains fields describing a user's first name, middle name, last name, and business title.

Field sets can be referenced on Visualforce pages dynamically. If the page is added to a managed package, administrators can add, remove, or reorder fields in a field set to modify the fields presented on the Visualforce page without modifying any code.

## Version

FieldSet components are available in API version 21.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| availableFields | [FieldSetItem](#FieldSetItem)\[\] | An array containing all the possible fields in the field set. |
| description | string | Required. A description provided by the developer that describes the field set. This is required. |
| displayedFields | [FieldSetItem](#FieldSetItem)\[\] | An array containing all the fields that are presented on the Visualforce page. The order in which a field is listed determines the order of appearance on the page. |
| label | string | Required. The label used to reference the field set. |

## FieldSetItem

FieldSetItem represents an individual field in a field set.

| Field | Field Type | Description |
| --- | --- | --- |
| field | string | Required. The name of a field in a standard or custom object. |
| isFieldManaged | boolean | Read-only. Denotes whether the field was added to the field set via a managed or unmanaged package. |
| isRequired | boolean | Read-only. Indicates whether the field is universally required (true) or not (false). |

## Declarative Metadata Sample Definition

A sample XML definition of a FieldSet component is shown below.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <fieldSets\>
        <fullName\>FieldSetNames</fullName\>
        <availableFields\>
            <field\>MiddleName\_\_c</field\>
        </availableFields\>
        <availableFields\>
            <field\>Title\_\_c</field\>
        </availableFields\>
        <description\>FieldSet containing how to properly address someone</description\>
        <displayedFields\>
            <field\>FirstName\_\_c</field\>
        </displayedFields\>
        <displayedFields\>
            <field\>LastName\_\_c</field\>
        </displayedFields\>
        <label\>FieldSet Names</label\>
    </fieldSets\>
</CustomObject\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm "CustomField")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_historyretentionpolicy.htm "HistoryRetentionPolicy")

<!-- document id=08e86641feaa2a27e99d1f6f79128a122abccdb3c4855643c24bb6d2af7e1efb url=/legacydeveloper/current/en-us/api_meta/meta_fieldsrctrgtrelationship.md -->

# FieldSrcTrgtRelationship

Stores the relationships between a data model object (DMO) and its fields. For example, the Individual.Id field has a one-to-many relationship (1:M) with the ContactPointEmail.PartyId field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

FieldSrcTrgtRelationship components have the suffix .fieldSrcTrgtRelationship and are stored in the fieldSrcTrgtRelationships folder.

## Version

FieldSrcTrgtRelationship components are available in API version 51.0 and later.

## Special Access Rules

To access this metadata type, you must have the Customize Application user permission.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d507163e118">Field Name</th>

              <th class="featureTableHeader  " id="d507163e121">Field Type</th>

              <th class="featureTableHeader  " id="d507163e124">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d507163e118" data-title="Field Name"><span class="keyword parmname">definitionCreationType</span></td>

              <td class="entry" headers="d507163e121" data-title="Field Type">DefinitionCreationType (enumeration of type string)</td>

              <td class="entry" headers="d507163e124" data-title="Description">Required. Describes whether this object was added by the user or as part of a standard
                taxonomy.<p class="p">Values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ADG</samp></li>

                  <li class="li"><samp class="codeph nolang">Activation_Audience</samp></li>

                  <li class="li"><samp class="codeph nolang">Bridge</samp></li>

                  <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                  <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                  <li class="li"><samp class="codeph nolang">Curated</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom</samp></li>

                  <li class="li"><samp class="codeph nolang">Derived</samp></li>

                  <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                  <li class="li"><samp class="codeph nolang">External</samp></li>

                  <li class="li"><samp class="codeph nolang">Ml_Prediction</samp></li>

                  <li class="li"><samp class="codeph nolang">Segment_Membership</samp></li>

                  <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                  <li class="li"><samp class="codeph nolang">Standard</samp></li>

                  <li class="li"><samp class="codeph nolang">System</samp></li>

                  <li class="li"><samp class="codeph nolang">Transform</samp></li>

                  <li class="li"><samp class="codeph nolang">Vector_Embedding</samp></li>

                </ul>
                <p class="p">Valid values available in API version 67.0 and later are: </p>
                <a name="ul_vyb_bt3_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_vyb_bt3_tjc">
                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                  <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                  <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d507163e118" data-title="Field Name"><span class="keyword parmname">lookupFieldName</span></td>

              <td class="entry" headers="d507163e121" data-title="Field Type">string</td>

              <td class="entry" headers="d507163e124" data-title="Description">Reference to the DMO lookup field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d507163e118" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d507163e121" data-title="Field Type">string</td>

              <td class="entry" headers="d507163e124" data-title="Description">Required. The UI name for the field relationship.</td>

            </tr>

            <tr>
              <td class="entry" headers="d507163e118" data-title="Field Name"><span class="keyword parmname">owner</span></td>

              <td class="entry" headers="d507163e121" data-title="Field Type">FieldSrcTrgtRelationshipOwner (enumeration of type string)</td>

              <td class="entry" headers="d507163e124" data-title="Description">Optional. The type of relationship that exists between the source and the target.
                <p class="p">Values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">SObject</samp> - The source of the relationship
                    is a DMO and the target is a standard or custom SObject.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DataCloud</samp> - Both the source and the target
                    of the relationship are DMOs.
                  </li>

                </ul>

                <p class="p">The field is needed only when the target is an SObject. The system can infer the
                  value when the target is a DMO.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d507163e118" data-title="Field Name"><span class="keyword parmname">relationshipCardinality</span></td>

              <td class="entry" headers="d507163e121" data-title="Field Type">RelationshipCardinality (enumeration of type string)</td>

              <td class="entry" headers="d507163e124" data-title="Description">Required. Cardinality of the relationship between the source and target fields.
                <p class="p">Values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ManyToOne</samp></li>

                  <li class="li"><samp class="codeph nolang">OneToOne</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d507163e118" data-title="Field Name"><span class="keyword parmname">sourceFieldName</span></td>

              <td class="entry" headers="d507163e121" data-title="Field Type">string</td>

              <td class="entry" headers="d507163e124" data-title="Description">Required. Name of the field that represents the source side of the
                relationship.</td>

            </tr>

            <tr>
              <td class="entry" headers="d507163e118" data-title="Field Name"><span class="keyword parmname">targetEntity</span></td>

              <td class="entry" headers="d507163e121" data-title="Field Type">string</td>

              <td class="entry" headers="d507163e124" data-title="Description">Optional. Name of the entity that represents the target side of the
                relationship. The target entity can be a DMO or a standard or custom SObject.
                The field is needed only when the target entity is an SObject. The system can
                infer the value when the target entity is a DMO.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d507163e118" data-title="Field Name"><span class="keyword parmname">targetFieldName</span></td>

              <td class="entry" headers="d507163e121" data-title="Field Type">string</td>

              <td class="entry" headers="d507163e124" data-title="Description">Required. Name of the field that represents the target side of the
                relationship.</td>

            </tr>

          </tbody>

        </table>

<!-- document id=364638c6ba641620dad41760fbe57ed1673ddca93a82cdb49a7a27123a2666b4 url=/legacydeveloper/current/en-us/api_meta/meta_file_based_calls_intro.md -->

# File-Based Calls

Use file-based calls to deploy or retrieve XML components.

- [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.")
- [deployRecentValidation()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployRecentValidation.htm "Deploys a recently validated component set without running Apex tests.")
- [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.")

<!-- document id=5ea2d89f2e7b6436e1b6de41fe47368304d5fc47d9cbd72d4bfda8a44e54cbad url=/legacydeveloper/current/en-us/api_meta/meta_filesconnectsettings.md -->

# FilesConnectSettings

Represents the settings that modify the Files Connect feature.This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

FilesConnectSettings values are stored in the FilesConnect.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

FilesConnectSettings components are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableContentHubAllowed | boolean | Indicates whether Files Connect is enabled (true) or not (false). |
| enableContentHubCvtLinksAllowed | boolean | Indicates whether the ability to link conversions in the feed publisher is enabled (true) or not (false) for Google Drive and Quip links. |
| enableContentHubEOSearchLayout | boolean | Indicates whether the external object’s search layout can be used in Global Search (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example of a FilesConnectSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<FilesConnectSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableContentHubAllowed\>false</enableCurrencyEffectiveDates\>
    <enableContentHubCvtLinksAllowed\>false</enableCurrencySymbolWithMultiCurrency\>
    <enableContentHubEOSearchLayout\>false</enableMultiCurrency\>
</FilesConnectSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>FilesConnect</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=077943ab646ea5af21a413b3376c7778acb0708b587f6300be27f155d43d95c1 url=/legacydeveloper/current/en-us/api_meta/meta_fileuploadanddownloadsecuritysettings.md -->

# FileUploadAndDownloadSecuritySettings

Represents the security settings for uploading and downloading files. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

FileUploadAndDownloadSecuritySettings components have the suffix .settings and are stored in the settings folder.

## Version

FileUploadAndDownloadSecuritySettings components are available in API version 39.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| dispositions | [FileTypeDispositionAssignmentBean\[\]](#FileTypeDispositionAssignmentBean) | Represents the metadata used to manage filetype behavior. This field is available in API version 39.0 and later. |
| noHtmlUploadAsAttachment | boolean | Indicates whether to allow HTML uploads as attachments or document records. This field is available in API version 39.0 and later. |

## FileTypeDispositionAssignmentBean

Represents the metadata used to manage filetype behavior.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d508598e153">Field Name</th>

              <th class="featureTableHeader  " id="d508598e156">Field Type</th>

              <th class="featureTableHeader  " id="d508598e159">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d508598e153" data-title="Field Name"><span class="keyword parmname">behavior</span></td>

              <td class="entry" headers="d508598e156" data-title="Field Type">FileDownloadBehavior (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d508598e159" data-title="Description">One of the following values:<ul class="ul bulletList">
                  <li class="li">DOWNLOAD</li>

                  <li class="li">EXECUTE</li>

                  <li class="li">HYBRID</li>

                </ul>
                The following filetypes are a security risk and can not have
                EXECUTE behavior:<ul class="ul bulletList">
                  <li class="li">EXE</li>

                  <li class="li">FLASH</li>

                  <li class="li">HTML</li>

                  <li class="li"> RFC822</li>

                  <li class="li">SVG</li>

                  <li class="li">TXML</li>

                  <li class="li">UNKNOWN</li>

                  <li class="li">WEBVIEW</li>

                  <li class="li">XHTML</li>

                  <li class="li">XML</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d508598e153" data-title="Field Name"><span class="keyword parmname">filetype</span></td>

              <td class="entry" headers="d508598e156" data-title="Field Type">FileType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d508598e159" data-title="Description">Although more filetypes exist, these are the only ones supported
                by FileTypeDispositionAssignmentBean <ul class="ul bulletList">
                  <li class="li">AVI</li>

                  <li class="li">EXCEL</li>

                  <li class="li">EXCEL_X</li>

                  <li class="li">EXE</li>

                  <li class="li">FLASH</li>

                  <li class="li">HTML</li>

                  <li class="li">INSIGHT</li>

                  <li class="li">MOV</li>

                  <li class="li">MP3</li>

                  <li class="li">MP4</li>

                  <li class="li">MPEG</li>

                  <li class="li">PDF</li>

                  <li class="li">POWER_POINT</li>

                  <li class="li">POWER_POINT_X</li>

                  <li class="li">RFC822</li>

                  <li class="li">SVG</li>

                  <li class="li">TXML</li>

                  <li class="li">UNKNOWN</li>

                  <li class="li">WAV</li>

                  <li class="li">WEBVIEW</li>

                  <li class="li">WMA</li>

                  <li class="li">WMV</li>

                  <li class="li">WORD</li>

                  <li class="li">WORD_X</li>

                  <li class="li">XHTML</li>

                  <li class="li">XML</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d508598e153" data-title="Field Name"><span class="keyword parmname">securityRiskFileType</span></td>

              <td class="entry" headers="d508598e156" data-title="Field Type">boolean</td>

              <td class="entry" headers="d508598e159" data-title="Description">Indicates filetypes that cannot have behavior set to EXECUTE, due
                to security risks. This field is read-only.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a FileUploadAndDownloadSecuritySettings component.

<FileUploadAndDownloadSecuritySettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>AVI</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>WORD</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>WORD\_X</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>EXE</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>HTML</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>WEBVIEW</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>RFC822</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>MOV</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>MP3</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>MP4</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>MPEG</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>PDF</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>POWER\_POINT</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>POWER\_POINT\_X</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>SVG</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>FLASH</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>TXML</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>UNKNOWN</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>WAV</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>WMA</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>WMV</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>XHTML</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>EXCEL</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>HYBRID</behavior\>
        <fileType\>EXCEL\_X</fileType\>
        <securityRiskFileType\>false</securityRiskFileType\>
    </dispositions\>
    <dispositions\>
        <behavior\>DOWNLOAD</behavior\>
        <fileType\>XML</fileType\>
        <securityRiskFileType\>true</securityRiskFileType\>
    </dispositions\>
    <noHtmlUploadAsAttachment\>false</noHtmlUploadAsAttachment\>
</FileUploadAndDownloadSecuritySettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
       <members\>FileUploadAndDownloadSecurity</members\>
       <name\>Settings</name\>
   </types\>
   <version\>39.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=f15364da977e90e0180c354f49e4e34e07a7838cc000fdfca98ee08999529cdd url=/legacydeveloper/current/en-us/api_meta/meta_flexipage.md -->

# FlexiPage

Represents the metadata associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

These pages are known as FlexiPages in the API, but are referred to as Lightning pages in the rest of the Salesforce documentation and UI.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

In API version 49.0 and later, arrays in a FlexiPage are represented as valueList. Each array element is represented as valueListItem, and the element name is represented as value. In API version 48.0 and earlier, arrays are represented as value and array elements are formatted as a comma-separated list. Any FlexiPage retrieved using API version 49.0 or later uses valueList to represent component property array values, regardless of which API version was used to create the FlexiPage.

Lightning pages are used in several places.

- In the Salesforce mobile app, a Lightning page is the home page for an app that appears in the navigation menu.
- In Lightning Experience, Lightning pages can be used:
    - To customize the layout of record pages, the Salesforce Home page, and the Email Application pane in the Outlook and Gmail integrations.
    - As the home page for an app.
    - As the utility bar for a Lightning app.

For more information on Lightning pages, see Salesforce Help.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The namespace prefix is important to help identify the source of items like fields, custom objects, and more. For example, when working with FlexiPages, we recommend keeping namespaces for object fields, because removing them can cause unexpected results such as name collisions.

## File Suffix and Directory Location

FlexiPage components have the suffix .flexipage and are stored in the flexipages folder.

## Version

FlexiPage components are available in API version 29.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e155">Field Name</th>

              <th class="featureTableHeader  " id="d509382e158">Field Type</th>

              <th class="featureTableHeader  " id="d509382e161">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e161" data-title="Description"><span class="ph" id="flexipage_description_field_desc"><a name="flexipage_description_field_desc"><!-- --></a>The optional description text
                  of the Lightning page.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name">events</td>

              <td class="entry" headers="d509382e158" data-title="Field Type">
                <a class="xref" href="#FlexiPageEvent">FlexiPageEvent</a>[]
              </td>

              <td class="entry" headers="d509382e161" data-title="Description">The list of events associated with the Lightning page.<p class="p">This field is
                  available in API version 53.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname">flexiPageRegions</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type">
                <a class="xref" href="#FlexiPageRegion">FlexiPageRegion</a>[]
              </td>

              <td class="entry" headers="d509382e161" data-title="Description">The list of regions of a page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e161" data-title="Description">Required. The label for the Lightning page, which displays in
                Setup.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname">pageTemplate</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e161" data-title="Description">Deprecated. Use this field in API versions 33.0 to 38.0 only. In later
                versions, use <span class="keyword parmname">template</span>.<p class="p">Required. <span class="ph" id="flexipage_pagetemplate_field_desc"><a name="flexipage_pagetemplate_field_desc"><!-- --></a>The template associated with
                    the Lightning page.</span></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname">parentFlexiPage</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e161" data-title="Description">The name of the Lightning page that this page inherits behavior
                from.<p class="p">This field is available in API version 37.0 or later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname">platformActionlist</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type"><a class="xref" href="#PlatformActionList">PlatformActionList</a></td>

              <td class="entry" headers="d509382e161" data-title="Description">The list of all actions, and their order, that display on a Lightning
                app page. In the Salesforce mobile app, the actions appear in the action
                bar.<p class="p">This field is available in API version 34.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname">quickActionList</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_layouts.htm#QuickActionList">QuickActionList</a></td>

              <td class="entry" headers="d509382e161" data-title="Description">The list of quick actions associated with the Lightning page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname">sobjectType</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e161" data-title="Description">
                <span class="ph" id="flexipage_sobjecttype_defn"><a name="flexipage_sobjecttype_defn"><!-- --></a>The object the Lightning page is
                  associated with. For Lightning pages of type <samp class="codeph nolang">AppPage</samp> or <samp class="codeph nolang">HomePage</samp>,
                  this field is <samp class="codeph nolang">null</samp>.</span>
                <p class="p">After the
                  value of this field is set, it can’t be changed.</p>
                <p class="p">This field is
                  available in API version 37.0 or later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname" id="field_template_name"><a name="field_template_name"><!-- --></a>template</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type"><a class="xref" href="#FlexiPageTemplateInstance">FlexiPageTemplateInstance</a></td>

              <td class="entry" headers="d509382e161" data-title="Description">
                <span class="ph" id="field_template_desc"><a name="field_template_desc"><!-- --></a>Required. The template associated with the
                  Lightning page.</span>
                <p class="p">This field is available in API version 39.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e155" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d509382e158" data-title="Field Type">FlexiPageType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e161" data-title="Description">
                <span class="ph" id="rn_192_flexipage_type_defn"><a name="rn_192_flexipage_type_defn"><!-- --></a>Required. The type of a page. In API
                  versions 32.0 through 36.0, this field can only have a value of <samp class="codeph nolang">AppPage</samp>.</span>
                <div class="p">Valid values are:<a name="flexipage_type_valid_values"><!-- --></a>
                  <ul class="ul bulletList" id="flexipage_type_valid_values">
                    <li class="li">
                      <samp class="codeph nolang">CdpRecordPage</samp>—A Lightning
                      page that is used to override a CDPNearCoreObject record page in
                      Lightning Experience. This value is available in API version 54.0
                      and later for orgs that have <span class="ph">Data 360</span>
                      enabled.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">AppPage</samp>—A Lightning page that
                      is used as the home page for a custom app.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommAppPage</samp>—A Lightning page
                      that is used to represent a custom page, as created in the
                      Experience Builder. This value is available in API version 37.0 and
                      later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommContractDetailViewPage</samp>—This value is available in API
                      version 64.0 and later.
                    </li>

                    <li class="li">
                      <span class="ph" id="CommCheckoutPage_desc"><a name="CommCheckoutPage_desc"><!-- --></a><samp class="codeph nolang">CommCheckoutPage</samp>—A Lightning page that is used to
                        create a B2B Commerce checkout, as created in the Experience
                        Builder.</span> This value is available in API version 46.0 and
                      later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommFlowPage</samp> A Lightning page
                      used to override a flow page, as created in the Experience Builder.
                      This value is available in API version 45.0 and later.
                    </li>

                    <li class="li">
                      <span class="ph" id="CommForgotPasswordPage_desc"><a name="CommForgotPasswordPage_desc"><!-- --></a><samp class="codeph nolang">CommForgotPasswordPage</samp>—A Lightning page that’s used
                        to override a forgot-password page, as created in Experience
                        Builder.</span> This value is available in API version 39.0 and
                      later.
                    </li>

                    <li class="li">
                      <span class="ph" id="CommFlowPage_desc"><a name="CommFlowPage_desc"><!-- --></a><samp class="codeph nolang">CommFlowPage</samp>—An out-of-the-box flow page, as
                        created in Experience Builder</span>. This value is available in
                      API version 45.0 and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommGlobalSearchResultPage</samp> A
                      Lightning page used to override the global search result page, as
                      created in Experience Builder. This value is available in API
                      version 41.0 and later.
                    </li>

                    <li class="li">
                      <span class="ph" id="CommLoginPage_desc"><a name="CommLoginPage_desc"><!-- --></a><samp class="codeph nolang">CommLoginPage</samp>—A Lightning page that’s used to
                        override the login page, as created in Experience Builder.</span>
                      This value is available in API version 39.0 and later.
                    </li>

                    <li class="li">
                      <span class="ph" id="CommNoSearchResultsPage_desc"><a name="CommNoSearchResultsPage_desc"><!-- --></a><samp class="codeph nolang">CommNoSearchResultsPage</samp>—An Experience Builder site
                        page for B2B searches that return no results. The URL for this
                        page is <span class="ph filepath">no-results/:term</span>. The page starts
                        out empty. You can add any component to it that accepts
                        parameters to achieve the desired “no results” experience. For
                        example, you can place an HTML Editor component or CMS
                        components for recommendations, banners, help, and support.</span>
                      This value is available in API version 48.0 and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommObjectPage</samp>—A Lightning
                      page used to override an object page, as created in Experience
                      Builder. This value is available in API version 38.0 and
                      later.
                    </li>

                    <li class="li">
                      <span class="ph" id="CommOrderComfirmationPage_desc"><a name="CommOrderComfirmationPage_desc"><!-- --></a><samp class="codeph nolang">CommOrderComfirmationPage</samp>—A
                        Lightning page that is used to create a B2B Commerce order
                        confirmation page in checkout, as created in the Experience
                        Builder.</span> This value is available in API version 46.0 and
                      later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommQuickActionCreatePage</samp>—A
                      Lightning page used to override the create record page, as created
                      in Experience Builder. This value is available in API version 38.0
                      and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommRecordPage</samp>—A Lightning
                      page used to override a record page, as created in the Experience
                      Builder. This value is available in API version 38.0 and
                      later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommRelatedListPage</samp>—A
                      Lightning page used to override a related list page, as created in
                      the Experience Builder. This value is available in API version 38.0
                      and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommSearchResultPage</samp>—A
                      Lightning page used to override the search result page, as created
                      in Experience Builder. This value is available in API version 38.0
                      and later.
                    </li>

                    <li class="li">
                      <span class="ph" id="commSelfRegisterPage_desc"><a name="commSelfRegisterPage_desc"><!-- --></a><samp class="codeph nolang">CommSelfRegisterPage</samp>—A Lightning page used to
                        override the self-registration page, as created in Experience
                        Builder.</span> This value is available in API version 39.0 and
                      later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">CommThemeLayoutPage</samp>—A
                      Lightning page used to override a theme layout page, as created in
                      the Experience Builder. This value is available in API version 38.0
                      and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">EmbeddedServicePage</samp> This
                      value is available in API version 45.0 and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">EmailContentPage</samp> — A page
                      that contains the builder markup for your email content. When you
                      edit email content in the builder, the FlexiPage object remembers
                      where you put the components. <p class="p">Because they include builder
                        markup, you can't retrieve or deploy FlexiPages when type is
                        EmailContentPage.</p>
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">EmailTemplatePage</samp> — A page
                      that contains the builder markup for your email template. When you
                      edit an email template in the builder, the FlexiPage object
                      remembers where you put the components. <p class="p">Because they include
                        builder markup, you can't retrieve or deploy FlexiPages when
                        type is EmailTemplatePage or EmailContentPage.</p>
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">ForecastingPage</samp> —A Lightning
                      page that is used to override the default forecasts page in
                      Lightning Experience. This value is available in API version 57.0
                      and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">HomePage</samp>—A Lightning page
                      that is used to override the Home page in Lightning Experience.
                      This value is available in API version 37.0 and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">MailAppAppPage</samp>—An email
                      application pane used to override the default layout in the Outlook
                      and Gmail integrations. This value is available in API version 38.0
                      and later.
                    </li>
                    <li class="li">
                      <samp class="codeph nolang">OmniSupervisorPageType—</samp>A
                      Lightning page used to customize the user interface on the
                      Omni-Channel Supervisor page. This value is available in API
                      version 60.0 and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">QuickAction</samp>—A Lightning page
                      used to customize the fields and layout for a quick action. This
                      value is available as a Beta in API version 68.0 and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">RecordPage</samp>—A Lightning page
                      used to override an object record page in Lightning Experience.
                      This value is available in API version 37.0 and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">RecordPreview</samp>—A Lightning
                      page used to override standard lookup previews when hovering over
                      previewable records in Lightning Experience. This value is
                      available in API version 45.0 and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">UtilityBar</samp>—A Lightning page
                      used as the utility bar in Lightning Experience apps. This value is
                      available in API version 38.0 and later.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">VoiceExtension</samp>—A Lightning
                      page used to customize user interfaces and agent actions in the
                      Omni-Channel widget for Service Cloud Voice. This value is
                      available in API version 57.0 and later.
                    </li>

                  </ul>
                </div>
                <p class="p">This field is available in API version 32.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlexiPageEvent

An event associated with the Lightning page. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e580">Field Name</th>

              <th class="featureTableHeader  " id="d509382e583">Field Type</th>

              <th class="featureTableHeader  " id="d509382e586">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e580" data-title="Field Name"><span class="keyword parmname">sourceName</span></td>

              <td class="entry" headers="d509382e583" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e586" data-title="Description">Required. The name of the event source item. If the source is a custom
                Lightning web component, this field is the name of the component.<p class="p">In API
                  53.0, a source can be only a Lightning web component.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e580" data-title="Field Name"><span class="keyword parmname">sourceProperties</span></td>

              <td class="entry" headers="d509382e583" data-title="Field Type">
                <a class="xref" href="#FlexiPageEventSourceProperty">FlexiPageEventSourceProperty</a>[]
              </td>

              <td class="entry" headers="d509382e586" data-title="Description">The list of properties associated with the event source.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e580" data-title="Field Name"><span class="keyword parmname">sourceType</span></td>

              <td class="entry" headers="d509382e583" data-title="Field Type">FlexipageEventSourceTypeEnum (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e586" data-title="Description">Required. The type of item assigned as the event source. <p class="p">In API
                  version 53.0, this field can have only a value of <samp class="codeph nolang">Component</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e580" data-title="Field Name"><span class="keyword parmname">targets</span></td>

              <td class="entry" headers="d509382e583" data-title="Field Type">
                <a class="xref" href="#FlexiPageEventTarget">FlexiPageEventTarget</a>[]
              </td>

              <td class="entry" headers="d509382e586" data-title="Description">The list of targets associated with the event source.</td>

            </tr>

          </tbody>

        </table>

## FlexiPageEventSourceProperty

A property associated with an event. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e689">Field Name</th>

              <th class="featureTableHeader  " id="d509382e692">Field Type</th>

              <th class="featureTableHeader  " id="d509382e695">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e689" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d509382e692" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e695" data-title="Description">Required. In API version 53.0 and later, the value of this field can be
                only <samp class="codeph nolang">eventName</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e689" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d509382e692" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e695" data-title="Description">Required. If the <span class="keyword parmname">name</span> field value is <samp class="codeph nolang">eventName</samp>, this field is the name of the
                event.<p class="p">If the event source is a Lightning web component, this value
                  must be the same as the event name defined in the source component’s
                  <span class="ph filepath">js-meta.xml</span> file.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## FlexiPageEventTarget

A target associated with an event source on the Lightning page. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e769">Field Name</th>

              <th class="featureTableHeader  " id="d509382e772">Field Type</th>

              <th class="featureTableHeader  " id="d509382e775">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e769" data-title="Field Name"><span class="keyword parmname">mappings</span></td>

              <td class="entry" headers="d509382e772" data-title="Field Type">
                <a class="xref" href="#FlexiPageEventPropertyMapping">FlexiPageEventPropertyMapping</a>[]
              </td>

              <td class="entry" headers="d509382e775" data-title="Description">A list of key-value pairs for an event’s source-to-target
                bindings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e769" data-title="Field Name"><span class="keyword parmname">method</span></td>

              <td class="entry" headers="d509382e772" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e775" data-title="Description">Required. <p class="p">The only valid value is <samp class="codeph nolang">updateProperties</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e769" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d509382e772" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e775" data-title="Description">Required. The name of the event target. <div class="p">Valid values are: <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">flexipage:componentService</samp></li>

                  </ul>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e769" data-title="Field Name"><span class="keyword parmname">properties</span></td>

              <td class="entry" headers="d509382e772" data-title="Field Type">
                <a class="xref" href="#FlexiPageEventTargetProperty">FlexiPageEventTargetProperty</a>[]
              </td>

              <td class="entry" headers="d509382e775" data-title="Description">List of properties of the event target.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e769" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d509382e772" data-title="Field Type">FlexiPageEventTargetTypeEnum (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e775" data-title="Description">Required. The type of item assigned as the event target. <div class="p">Valid values are:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">FlexipageServices</samp>—A
                      component on the Lightning page.
                    </li>
                  </ul>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## FlexiPageEventPropertyMapping

A key-value pair for an event’s source-to-target bindings. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e906">Field Name</th>

              <th class="featureTableHeader  " id="d509382e909">Field Type</th>

              <th class="featureTableHeader  " id="d509382e912">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e906" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d509382e909" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e912" data-title="Description">Required. Name of the target property that changes when the event is
                triggered.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e906" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d509382e909" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e912" data-title="Description">Value of the target property when the event occurs. <p class="p">For properties of
                  type string, integer, and boolean, you can use an expression to define
                  their value. Valid expression format is <samp class="codeph nolang">{!Event.eventPropertyName}</samp>. Event is the only context
                  supported for expressions in interactions.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlexiPageEventTargetProperty

A property on the event source’s target represented as a key-value pair. Available in API version 53.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. In API version 53.0 and later, the value of this field can be only componentIdentifier |
| value | string | Required. The [ComponentInstance](#ComponentInstance) identifier value for the component. |

## FlexiPageRegion

FlexiPage Region represents the properties of a region of a page. A region can contain a record list component or a recent items component that can be scoped to a set of entities.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

A Lightning page region can contain up to 100 components.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e1055">Field Name</th>

              <th class="featureTableHeader  " id="d509382e1058">Field Type</th>

              <th class="featureTableHeader  " id="d509382e1061">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e1055" data-title="Field Name"><span class="keyword parmname">appendable</span></td>

              <td class="entry" headers="d509382e1058" data-title="Field Type">RegionFlagStatus (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e1061" data-title="Description">This field is available in Digital Experiences in API 45.0 or later, but
                is reserved for future use for all other areas.<div class="p">Valid values are: <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">disabled</samp></li>

                    <li class="li"><samp class="codeph nolang">enabled</samp></li>

                  </ul>
                </div>
                <div class="p">This field is assessed in combination with
                  <span class="keyword parmname">replaceable</span> and <span class="keyword parmname">prependable</span>
                  <ul class="ul bulletList">
                    <li class="li">If all the properties are set to <samp class="codeph nolang">enabled</samp>, the region is unlocked</li>

                    <li class="li">If all the properties are set to <samp class="codeph nolang">disabled</samp>, the region is locked</li>

                    <li class="li"> If none of the properties are specified OR any of these three
                      properties are missing, the region is unlocked.</li>

                  </ul>
                </div>
                <p class="p">This field is available in API version 35.0 or
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1055" data-title="Field Name"><span class="keyword parmname">componentInstances</span></td>

              <td class="entry" headers="d509382e1058" data-title="Field Type">
                <a class="xref" href="#ComponentInstance">ComponentInstance</a>[]
              </td>

              <td class="entry" headers="d509382e1061" data-title="Description">
                <span class="ph" id="component_instance_descr"><a name="component_instance_descr"><!-- --></a>Properties and name of the component
                  instance.</span>
                <p class="p">This field was removed in API version 49.0. In API
                  version 49.0 and later, use the <span class="keyword parmname">itemInstances</span> field
                  instead.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1055" data-title="Field Name"><span class="keyword parmname">itemInstances</span></td>

              <td class="entry" headers="d509382e1058" data-title="Field Type">
                <a class="xref" href="#ItemInstance">ItemInstance</a>[]
              </td>

              <td class="entry" headers="d509382e1061" data-title="Description">Array of item instances, which can contain components and fields.<p class="p">This
                  field is available in API version 49.0 or later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1055" data-title="Field Name"><span class="keyword parmname">mode</span></td>

              <td class="entry" headers="d509382e1058" data-title="Field Type">FlexiPageRegionMode (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e1061" data-title="Description">This field is reserved for future use.<div class="p">Valid values are: <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">Append</samp></li>

                    <li class="li"><samp class="codeph nolang">Prepend</samp></li>

                    <li class="li"><samp class="codeph nolang">Replace</samp></li>

                  </ul>
                </div>
                <p class="p">This field is available in API version 35.0 or
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1055" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d509382e1058" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e1061" data-title="Description">Required. Unique name of the FlexiPage region.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1055" data-title="Field Name"><span class="keyword parmname">prependable</span></td>

              <td class="entry" headers="d509382e1058" data-title="Field Type">RegionFlagStatus (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e1061" data-title="Description">This field is available in Digital Experiences in API 45.0 or later, but
                is reserved for future use for all other areas.<div class="p">Valid values are: <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">disabled</samp></li>

                    <li class="li"><samp class="codeph nolang">enabled</samp></li>

                  </ul>
                </div>
                <div class="p">This field is assessed in combination with
                  <span class="keyword parmname">appendable</span> and <span class="keyword parmname">replaceable</span>.<ul class="ul bulletList">
                    <li class="li">If all the properties are set to <samp class="codeph nolang">enabled</samp>, the region is unlocked</li>

                    <li class="li">If all the properties are set to <samp class="codeph nolang">disabled</samp>, the region is locked</li>

                    <li class="li"> If none of the properties are specified OR any of these three
                      properties are missing, the region is unlocked.</li>

                  </ul>
                </div>
                <p class="p">This field is available in API version 35.0 or
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1055" data-title="Field Name"><span class="keyword parmname">replaceable</span></td>

              <td class="entry" headers="d509382e1058" data-title="Field Type">RegionFlagStatus (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e1061" data-title="Description">This field is available in Digital Experiences in API 45.0 or later, but
                is reserved for future use for all other areas.<div class="p">Valid values are: <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">disabled</samp></li>

                    <li class="li"><samp class="codeph nolang">enabled</samp></li>

                  </ul>
                </div>
                <div class="p">This field is assessed in combination with
                  <span class="keyword parmname">appendable</span> and <span class="keyword parmname">prependable</span>.<ul class="ul bulletList">
                    <li class="li">If all the properties are set to <samp class="codeph nolang">enabled</samp>, the region is unlocked</li>

                    <li class="li">If all the properties are set to <samp class="codeph nolang">disabled</samp>, the region is locked</li>

                    <li class="li"> If none of the properties are specified OR any of these three
                      properties are missing, the region is unlocked.</li>

                  </ul>
                </div>
                <p class="p">This field is available in API version 35.0 or
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1055" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d509382e1058" data-title="Field Type">FlexiPageRegionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e1061" data-title="Description">Required. The type of FlexiPage region.<div class="p">Valid values are: <ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">Background</samp>—Represents
                      a region for background utility items, which aren’t visible in the
                      UI. Supported for utility bars only.
                    </li>

                    <li class="li"><samp class="codeph nolang">Facet</samp></li>

                    <li class="li"><samp class="codeph nolang">Region</samp></li>

                  </ul>
                </div>
                <p class="p">This field is available in API version 35.0 or
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ItemInstance

Instance of a component or field on a Lightning page. Available in API version 49.0 or later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| componentInstance | [ComponentInstance](#ComponentInstance) | Properties and name of the component instance. |
| fieldInstance | [FieldInstance](#FieldInstance) | API name, label, and visibility rule information of the field component. This field is available only on Lightning pages that use Dynamic Forms. |

## ComponentInstance

Instance of a component in a page, such as a filter list.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e1458">Field Name</th>

              <th class="featureTableHeader  " id="d509382e1461">Field Type</th>

              <th class="featureTableHeader  " id="d509382e1464">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e1458" data-title="Field Name"><span class="keyword parmname">componentInstanceProperties</span></td>

              <td class="entry" headers="d509382e1461" data-title="Field Type">
                <a class="xref" href="#ComponentInstanceProperty">ComponentInstanceProperty</a>[]
              </td>

              <td class="entry" headers="d509382e1464" data-title="Description">The value of a single property in a component instance.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1458" data-title="Field Name"><span class="keyword parmname">componentName</span></td>

              <td class="entry" headers="d509382e1461" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e1464" data-title="Description">Required. The name of a single instance of a component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1458" data-title="Field Name"><span class="keyword parmname">identifier</span></td>

              <td class="entry" headers="d509382e1461" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e1464" data-title="Description">Required. The unique name of the ComponentInstance. Provides a way to
                uniquely identify an individual instance of a component on a Lightning page.
                This field has a maximum limit of 120 characters.<p class="p">This field is available
                  in API version 53.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1458" data-title="Field Name"><span class="keyword parmname">visibilityRule</span></td>

              <td class="entry" headers="d509382e1461" data-title="Field Type"><a class="xref" href="#UiFormulaRule">UiFormulaRule</a></td>

              <td class="entry" headers="d509382e1464" data-title="Description">
                <span class="ph" id="visibility_rule_descr"><a name="visibility_rule_descr"><!-- --></a>A set of one or more filters that define
                  the conditions under which the component displays on the page.</span>
                <p class="p" id="visibility_rule_descr2"><a name="visibility_rule_descr2"><!-- --></a>If the rule evaluates to <samp class="codeph nolang">true</samp>, the component displays on the page.
                  If <samp class="codeph nolang">false</samp>, it doesn't display. If
                  this field is <samp class="codeph nolang">null</samp>, the component
                  displays by default.</p>
                <p class="p">This field is available in API version 41.0
                  and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ComponentInstanceProperty

Value of a single property in a component instance. ComponentInstanceProperty has a maximum limit of 10,000 characters.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e1571">Field Name</th>

              <th class="featureTableHeader  " id="d509382e1574">Field Type</th>

              <th class="featureTableHeader  " id="d509382e1577">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e1571" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d509382e1574" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e1577" data-title="Description">Name of the property, unique within the component instance. For
                Lightning components, this value is the
                <span class="ph filepath">&lt;aura:attribute&gt;</span> as defined in the
                <span class="ph filepath">.cmp</span> file.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1571" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d509382e1574" data-title="Field Type">ComponentInstancePropertyTypeEnum (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e1577" data-title="Description">
                <span class="ph" id="componentinstanceproperty_type_field_desc1"><a name="componentinstanceproperty_type_field_desc1"><!-- --></a>If this field value
                  is <samp class="codeph nolang">null</samp>, then the
                  ComponentInstanceProperty values apply to the Lightning component. If
                  this field value is <samp class="codeph nolang">decorator</samp>, then
                  the ComponentInstanceProperty values apply to the <dfn class="term">component
                    decorator</dfn> for the Lightning component.</span>
                <p class="p" id="componentinstanceproperty_type_field_desc2"><a name="componentinstanceproperty_type_field_desc2"><!-- --></a>The component decorator
                  is a wrapper around a Lightning component. The decorator can apply more
                  capabilities to the component when it renders on a specific page in
                  Lightning Experience. For example, you can configure a component
                  decorator around a component on the Lightning Experience utility bar to
                  set the component’s height or width when opened. The <samp class="codeph nolang">UtilityBar</samp> is the only page type that
                  supports component decorators.</p>
                <div class="p" id="componentinstanceproperty_type_field_valid_values">
                  <a name="componentinstanceproperty_type_field_valid_values"><!-- --></a>Valid values are: <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">decorator</samp></li>

                  </ul>
                </div>
                <p class="p">This field is available in API version 38.0 or
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1571" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d509382e1574" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e1577" data-title="Description">Reference or value of the property.<p class="p">When defining a Related List
                  component, to use a parent record set the <samp class="codeph nolang">parentFieldApiName</samp> value to <samp class="codeph nolang"><var class="keyword varname">object</var>.<var class="keyword varname">field_name</var></samp>.
                  If you don’t want to use a parent record, set the value to <samp class="codeph nolang"><var class="keyword varname">object</var>.Id</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1571" data-title="Field Name"><span class="keyword parmname">valueList</span></td>

              <td class="entry" headers="d509382e1574" data-title="Field Type"><a class="xref" href="#ComponentInstancePropertyList">ComponentInstancePropertyList</a></td>

              <td class="entry" headers="d509382e1577" data-title="Description">An array of values in a component instance. Available in API version
                49.0 and later.</td>

            </tr>

          </tbody>

        </table>

**Tabs**

When you give a standard label to a tab in a Tabs component—such as Activity, Collaborate, or Details—and when the name field is set to title, the value field uses a system-defined value instead of the label. Here are some examples of the system-defined values:

- Standard.Tab.activity
- Standard.Tab.collaborate
- Standard.Tab.detail
- Standard.Tab.feed
- Standard.Tab.preview
- Standard.Tab.relatedLists

For example, let’s say you have a Lightning page that contains a tab with the standard label “Activity”. If you query the definition that page, you see the system-defined name of the tab, not the label, in value.

<componentInstances>
  <componentInstanceProperties>
    <name>title</name>
    <value>Standard.Tab.activity</value>
  </componentInstanceProperties>
    <componentName>flexipage:tab</componentName>
</componentInstances>

**Save Options**

Save options are available on pages of type RecordPage only, when users edit an account or when they create, edit, or clone a case or lead. Save options are configured as a ComponentInstanceProperty under FlexiPageTemplateInstance.

Set the ComponentInstanceProperty name to saveOptions and use value to define the checkbox values. The value field in this case is not a ComponentInstancePropertyList, but instead is a string representation of a JSON array of name and value pairs representing each checkbox name and its value.

<table class="featureTable sort_table" summary="">




          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e1786">API Name</th>

              <th class="featureTableHeader  " id="d509382e1789">Available Objects</th>

              <th class="featureTableHeader  " id="d509382e1792">Available Values</th>

              <th class="featureTableHeader  " id="d509382e1795">UI Label</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e1786" data-title="API Name">UseDefaultAssignmentRule</td>

              <td class="entry" headers="d509382e1789" data-title="Available Objects">Account</td>

              <td class="entry" headers="d509382e1792" data-title="Available Values">
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">NONE</samp></li>

                  <li class="li"><samp class="codeph nolang">APPLY_OPTION_WITHOUT_CHECKBOX_DISPLAY</samp></li>

                  <li class="li"><samp class="codeph nolang">SHOW_CHECKBOX_WITH_DEFAULT_OFF</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">SHOW_CHECKBOX_WITH_DEFAULT_ON</samp>
                  </li>

                </ul>

              </td>

              <td class="entry" headers="d509382e1795" data-title="UI Label">Evaluate this account against territory rules on save</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1786" data-title="API Name">UseDefaultAssignmentRule</td>

              <td class="entry" headers="d509382e1789" data-title="Available Objects">Lead</td>

              <td class="entry" headers="d509382e1792" data-title="Available Values">
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">NONE</samp></li>

                  <li class="li"><samp class="codeph nolang">SHOW_CHECKBOX_WITH_DEFAULT_OFF</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">SHOW_CHECKBOX_WITH_DEFAULT_ON</samp>
                  </li>

                </ul>

              </td>

              <td class="entry" headers="d509382e1795" data-title="UI Label">Assign using active assignment rule</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1786" data-title="API Name">UseDefaultAssignmentRule</td>

              <td class="entry" headers="d509382e1789" data-title="Available Objects">Case</td>

              <td class="entry" headers="d509382e1792" data-title="Available Values">
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">NONE</samp></li>

                  <li class="li"><samp class="codeph nolang">APPLY_OPTION_WITHOUT_CHECKBOX_DISPLAY</samp></li>

                  <li class="li"><samp class="codeph nolang">SHOW_CHECKBOX_WITH_DEFAULT_OFF</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">SHOW_CHECKBOX_WITH_DEFAULT_ON</samp>
                  </li>

                </ul>

              </td>

              <td class="entry" headers="d509382e1795" data-title="UI Label">Assign using active assignment rule</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e1786" data-title="API Name">triggerOtherEmail</td>

              <td class="entry" headers="d509382e1789" data-title="Available Objects">Case</td>

              <td class="entry" headers="d509382e1792" data-title="Available Values">
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">NONE</samp></li>

                  <li class="li"><samp class="codeph nolang">SHOW_CHECKBOX_WITH_DEFAULT_OFF</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">SHOW_CHECKBOX_WITH_DEFAULT_ON</samp>
                  </li>

                </ul>

              </td>

              <td class="entry" headers="d509382e1795" data-title="UI Label">Send notification email to Contact</td>

            </tr>

          </tbody>

        </table>

| Value | UI Result |
| --- | --- |
| NONE | Don’t display the checkbox and don’t apply any save options during save. |
| APPLY\_OPTION\_WITHOUT\_CHECKBOX\_DISPLAY | Don’t display the checkbox, but apply the save option value during save. |
| SHOW\_CHECKBOX\_WITH\_DEFAULT\_OFF | Display the checkbox, unchecked by default. |
| SHOW\_CHECKBOX\_WITH\_DEFAULT\_ON | Display the checkbox, checked by default. |

For example, you can set cases, when saved, to run the **Assign using active assignment rule** without displaying a checkbox, and display the **Send notification email to Contact** checkbox, checked by default.

saveOptions = \[{"name":"UseDefaultAssignmentRule","value":"APPLY\_OPTION\_WITHOUT\_CHECKBOX\_DISPLAY"}, {"name":"triggerOtherEmail","value":"SHOW\_CHECKBOX\_WITH\_DEFAULT\_ON"}\]

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Set assignment rules, territory rules, and email templates before configuring them as save options.

## ComponentInstancePropertyList

Value of an element in an array in a component instance.

| Field Name | Field Type | Description |
| --- | --- | --- |
| valueListItems | [ComponentInstancePropertyListItem](#ComponentInstancePropertyListItem)\[\] | An array of elements in a component instance. |

## ComponentInstancePropertyListItem

Name of an element in an array in a component instance.

| Field Name | Field Type | Description |
| --- | --- | --- |
| value | string | Name of an element in an array in a component instance. |

In API version 49.0 and later, arrays in a FlexiPage are represented as valueList. Each array element is represented as valueListItem, and the element name is represented as value.

For example, if you have an array of actions with API names Clone and Edit, the array is represented as valueList, with two valueListItems. One valueListItems has the value Clone, and one valueListItems has the value Edit.

<componentInstances>
  <componentInstanceProperties> 
    <name>actionApiName</name>
    <valueList>
      <valueListItems>
        <value>Clone</value>
      </valueListItems>
      <valueListItems>
        <value>Edit</value>
      </valueListItems>
    </valueList>
  </componentInstanceProperties>
</componentInstances>

## UiFormulaRule

A set of one or more filters that define the conditions under which a component displays on a Lightning page. For example, you could construct a filter that causes a rich text component on an opportunity page to display only when the Amount is greater than $1,000,000. Available in API version 41.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| booleanFilter | string | Specifies advanced filter conditions such as 1 AND 2. |
| criteria | [UiFormulaCriterion\[\]](#UiFormulaCriterion) | List of one or more filters that, when evaluated, determine component visibility. |

## UiFormulaCriterion

A single filter that when evaluated, helps define component visibility on a Lightning page. Available in API version 41.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e2272">Field Name</th>

              <th class="featureTableHeader  " id="d509382e2275">Field Type</th>

              <th class="featureTableHeader  " id="d509382e2278">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e2272" data-title="Field Name"><span class="keyword parmname">leftValue</span></td>

              <td class="entry" headers="d509382e2275" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2278" data-title="Description">Required. The field upon which the filter is based. For example, <samp class="codeph xml">AMOUNT</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2272" data-title="Field Name"><span class="keyword parmname">operator</span></td>

              <td class="entry" headers="d509382e2275" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2278" data-title="Description">Required. Defines the operator used to filter the data. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CONTAINS</samp></li>

                  <li class="li"><samp class="codeph nolang">EQUAL</samp></li>

                  <li class="li">
                    <samp class="codeph soql">NE</samp>—not equal
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">GT</samp>—greater than
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">GE</samp>—greater than or
                    equal
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LE</samp>—less than or
                    equal
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LT</samp>—less than
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2272" data-title="Field Name"><span class="keyword parmname">rightValue</span></td>

              <td class="entry" headers="d509382e2275" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2278" data-title="Description">The value by which you want to evaluate the component’s visibility. For
                example, <samp class="codeph xml">1000000</samp>.</td>

            </tr>

          </tbody>

        </table>

You can use these expressions in the leftValue field when setting filters for component visibility.

- {!$Client.FormFactor}—Use this expression to control component visibility based on the device the page is being rendered on. Valid values are Small (phone), Medium (tablet), and Large (Lightning Experience desktop). Setting the value to Small for record pages is supported only in orgs that are enabled for the new Salesforce mobile app. This expression is supported for app pages in API version 41.0 and later, and record pages in API version 47.0 and later.
- {!$Permission.CustomPermission.permissionName}—Use this expression to control component visibility based on the custom permissions of the user viewing the Lightning page. Supported for app, Home, and record pages only.
- {!$Permission.StandardPermission.permissionName}—Use this expression to control component visibility based on the standard permissions of the user viewing the Lightning page. Supported for app, Home, and record pages only.
- {!Record.field}—Supported for record pages only.
- {!$User.field}—Supported for app, Home, and record pages only.

For example, to display a component only when it renders on a phone, add this filter: {!$Client.FormFactor} EQUAL "SMALL". Or, to display a component only to the System Administrator, use {!$User.Profile.Name} EQUAL "System Administrator".

Expressions in component visibility rules can span no more than five fields. For example, {!Record.Account.Owner.Manager.Manager.Manager.LastName} has six spans and therefore isn’t supported.

## FieldInstance

Represents a single field component that resides on a Lightning page. Available in API version 49.0 and later. This subtype is available only on Lightning Pages that have enabled Dynamic Forms.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e2466">Field Name</th>

              <th class="featureTableHeader  " id="d509382e2469">Field Type</th>

              <th class="featureTableHeader  " id="d509382e2472">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e2466" data-title="Field Name"><span class="keyword parmname">fieldInstanceProperties</span></td>

              <td class="entry" headers="d509382e2469" data-title="Field Type">
                <a class="xref" href="#FieldInstanceProperty">FieldInstanceProperty</a>[]
              </td>

              <td class="entry" headers="d509382e2472" data-title="Description">Properties of the field instance. Contains a name and value pair for
                each property associated with the field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2466" data-title="Field Name"><span class="keyword parmname">fieldItem</span></td>

              <td class="entry" headers="d509382e2469" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2472" data-title="Description">The API name of the field, prefixed with its context. For example,
                record fields are prefixed with <samp class="codeph nolang">Record.</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2466" data-title="Field Name"><span class="keyword parmname">identifier</span></td>

              <td class="entry" headers="d509382e2469" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2472" data-title="Description">Required. The unique name of the FieldInstance. Provides a way to
                uniquely identify an individual instance of a field on a Dynamic
                Forms-enabled Lightning page. This field has a maximum limit of 120
                characters.<p class="p">This field is available in API version 53.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2466" data-title="Field Name"><span class="keyword parmname">visibilityRule</span></td>

              <td class="entry" headers="d509382e2469" data-title="Field Type"><a class="xref" href="#UiFormulaRule">UiFormulaRule</a></td>

              <td class="entry" headers="d509382e2472" data-title="Description">A set of one or more filters that define the conditions under which the
                component displays on the page. If the rule evaluates to <samp class="codeph nolang">true</samp>, the component displays on the page. If
                <samp class="codeph nolang">false</samp>, it doesn't display. If this
                field is <samp class="codeph nolang">null</samp>, the component displays
                by default.
              </td>

            </tr>

          </tbody>

        </table>

## FieldInstanceProperty

Represents a single property of a field instance. Available in API version 49.0 and later. This subtype is available only on Lightning pages that have enabled Dynamic Forms.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e2577">Field Name</th>

              <th class="featureTableHeader  " id="d509382e2580">Field Type</th>

              <th class="featureTableHeader  " id="d509382e2583">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e2577" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d509382e2580" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2583" data-title="Description">Name of the property, unique within the field instance.<p class="p">Valid values
                  are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">conditionalFormatRuleset</samp>
                    <p class="p">Available in API version 62.0
                      and later.</p>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">uiBehavior</samp>
                    <p class="p">Available in API
                      version 49.0 and later.</p>
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2577" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d509382e2580" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2583" data-title="Description">Reference or value of the property.<p class="p">When the <span class="keyword parmname">name</span>
                  value is <samp class="codeph nolang">uiBehavior</samp>, valid values
                  for this field are: </p>
                <a name="ul_bsh_yyw_jcc"><!-- --></a>
                <ul class="ul bulletList" id="ul_bsh_yyw_jcc">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Readonly</samp></li>

                  <li class="li"><samp class="codeph nolang">Required</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## FlexiPageTemplateInstance

FlexiPageTemplateInstance represents an instance of a Lightning page template.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e2682">Field Name</th>

              <th class="featureTableHeader  " id="d509382e2685">Field Type</th>

              <th class="featureTableHeader  " id="d509382e2688">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e2682" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="name"><a name="name"><!-- --></a>name</span></span></td>

              <td class="entry" headers="d509382e2685" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2688" data-title="Description"><span class="ph" id="name_descr"><a name="name_descr"><!-- --></a>Required. The name of a single instance of a
                  template.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2682" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="properties"><a name="properties"><!-- --></a>properties</span></span></td>

              <td class="entry" headers="d509382e2685" data-title="Field Type">
                <a class="xref" href="#ComponentInstanceProperty">ComponentInstanceProperty</a>[]
              </td>

              <td class="entry" headers="d509382e2688" data-title="Description">
                <span class="ph" id="properties_descr"><a name="properties_descr"><!-- --></a>The value of a single property in a template
                  instance.</span>
                <div class="p">Valid only for: <ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">CommThemeLayoutPage</samp></li>

                    <li class="li">Dynamic Forms-enabled pages of type <samp class="codeph nolang">RecordPage</samp> that are associated with account, case, or
                      lead objects</li>

                  </ul>
                </div>
                <p class="p"> Contains a name and value pair for each theme layout
                  property associated with the page template. In Experience Builder, the
                  theme layout and its properties appear in the Theme area.</p>
              </td>

            </tr>

          </tbody>

        </table>

## PlatformActionList

PlatformActionList represents the list of actions, and their order, that display on a Lightning app page. Available in API version 34.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e2771">Field Name</th>

              <th class="featureTableHeader  " id="d509382e2774">Field Type</th>

              <th class="featureTableHeader  " id="d509382e2777">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e2771" data-title="Field Name"><span class="keyword parmname">actionListContext</span></td>

              <td class="entry" headers="d509382e2774" data-title="Field Type">PlatformActionListContext (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e2777" data-title="Description">Required. The context of the action list. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Assistant</samp></li>

                  <li class="li"><samp class="codeph nolang">BannerPhoto</samp></li>

                  <li class="li"><samp class="codeph nolang">Chatter</samp></li>

                  <li class="li"><samp class="codeph nolang">Dockable</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedElement</samp></li>

                  <li class="li"><samp class="codeph nolang">Flexipage</samp></li>

                  <li class="li"><samp class="codeph nolang">Global</samp></li>

                  <li class="li"><samp class="codeph nolang">ListView</samp></li>

                  <li class="li"><samp class="codeph nolang">ListViewDefinition</samp></li>

                  <li class="li"><samp class="codeph nolang">ListViewRecord</samp></li>

                  <li class="li"><samp class="codeph nolang">Lookup</samp></li>

                  <li class="li"><samp class="codeph nolang">MruList</samp></li>

                  <li class="li"><samp class="codeph nolang">MruRow</samp></li>

                  <li class="li"><samp class="codeph nolang">ObjectHomeChart</samp></li>

                  <li class="li"><samp class="codeph nolang">Photo</samp></li>

                  <li class="li"><samp class="codeph nolang">Record</samp></li>

                  <li class="li"><samp class="codeph nolang">RecordEdit</samp></li>

                  <li class="li"><samp class="codeph nolang">RelatedList</samp></li>

                  <li class="li"><samp class="codeph nolang">RelatedListRecord</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2771" data-title="Field Name"><span class="keyword parmname">platformActionListItems</span></td>

              <td class="entry" headers="d509382e2774" data-title="Field Type">
                <a class="xref" href="#PlatformActionListItem">PlatformActionListItem</a>[]
              </td>

              <td class="entry" headers="d509382e2777" data-title="Description">The actions in the PlatformActionList.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2771" data-title="Field Name"><span class="keyword parmname">relatedSourceEntity</span></td>

              <td class="entry" headers="d509382e2774" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2777" data-title="Description">When the <span class="keyword parmname">ActionListContext</span> is RelatedList or
                RelatedListRecord, this field represents the API name of the related list
                to which the action belongs.</td>

            </tr>

          </tbody>

        </table>

## PlatformActionListItem

PlatformActionListItem represents an action in the PlatformActionList. Available in API version 34.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d509382e2942">Field Name</th>

              <th class="featureTableHeader  " id="d509382e2945">Field Type</th>

              <th class="featureTableHeader  " id="d509382e2948">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d509382e2942" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d509382e2945" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2948" data-title="Description">Required. The API name for the action in the list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2942" data-title="Field Name"><span class="keyword parmname">actionType</span></td>

              <td class="entry" headers="d509382e2945" data-title="Field Type">PlatformActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d509382e2948" data-title="Description">Required. The type of action. Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ActionLink</samp>—An indicator
                    on a feed element that targets an API, a web page, or a file,
                    represented by a button in the Salesforce Chatter feed UI.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomButton</samp>—When
                    clicked, opens a URL or a Visualforce page in a window or executes
                    JavaScript.
                  </li>

                  <li class="li"><samp class="codeph nolang">InvocableAction</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ProductivityAction</samp>—Productivity actions are
                    predefined and attached to a limited set of objects. Productivity
                    actions include Send Email, Call, Map, View Website, and Read News.
                    Except for the Call action, you can’t edit productivity actions.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">QuickAction</samp>—A global or
                    object-specific action.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">StandardButton</samp>—A
                    predefined Salesforce button such as New, Edit, and Delete.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2942" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d509382e2945" data-title="Field Type">int</td>

              <td class="entry" headers="d509382e2948" data-title="Description">Required. The placement of the action in the list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d509382e2942" data-title="Field Name"><span class="keyword parmname">subtype</span></td>

              <td class="entry" headers="d509382e2945" data-title="Field Type">string</td>

              <td class="entry" headers="d509382e2948" data-title="Description">The subtype of the action. For quick actions, the subtype is <samp class="codeph nolang">QuickActionType</samp>. For custom buttons, the
                subtype is <samp class="codeph nolang">WebLinkTypeEnum</samp>. For
                action links, subtypes are <samp class="codeph nolang">Api</samp>,
                <samp class="codeph nolang">ApiAsync</samp>, <samp class="codeph nolang">Download</samp>, and <samp class="codeph nolang">Ui</samp>. Standard buttons and productivity actions have no
                subtype.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s a sample XML FlexiPage component definition for a custom opportunity record page. It includes a tab set and a rich text component with visibility rules assigned to it.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

As an Experience Builder site page, three initial regions in the definition show the header region as locked, the content region as unlocked, and the footer region as unlocked.

<?xml version="1.0" encoding="UTF-8"?>
<FlexiPage xmlns="http://soap.sforce.com/2006/04/metadata">
    <flexiPageRegions\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>collapsed</name\>
                    <value\>false</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>hideChatterActions</name\>
                    <value\>false</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>numVisibleActions</name\>
                    <value\>3</value\>
                </componentInstanceProperties\>
                <componentName\>force:highlightsPanel</componentName\>
            </componentInstance\>
        </itemInstances\>
        <name\>header</name\>
        <type\>Region</type\>
    </flexiPageRegions\>
    <flexiPageRegions\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>hideUpdateButton</name\>
                    <value\>false</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>variant</name\>
                    <value\>linear</value\>
                </componentInstanceProperties\>
                <componentName\>runtime\_sales\_pathassistant:pathAssistant</componentName\>
            </componentInstance\>
        </itemInstances\>
        <name\>subheader</name\>
        <type\>Region</type\>
    </flexiPageRegions\>
    <flexiPageRegions\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>entityNames</name\>
                    <valueList\>
                        <valueListItems\>
                            <value\>Opportunity</value\>
                        </valueListItems\>
                    </valueList\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>maxRecords</name\>
                    <value\>3</value\>
                </componentInstanceProperties\>
                <componentName\>flexipage:recentItems</componentName\>
            </componentInstance\>
        </itemInstances\>
        <name\>Facet-afbed70e-277a-41f5-9919-34651ff97773</name\>
        <type\>Facet</type\>
    </flexiPageRegions\>
    <flexiPageRegions\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>relatedListComponentOverride</name\>
                    <value\>NONE</value\>
                </componentInstanceProperties\>
                <componentName\>force:relatedListContainer</componentName\>
            </componentInstance\>
        </itemInstances\>
        <name\>facet-77f21b6f-ad73-4d79-838a-79e0df27cc63</name\>
        <type\>Facet</type\>
    </flexiPageRegions\>
    <flexiPageRegions\>
        <itemInstances\>
            <componentInstance\>
                <componentName\>force:detailPanel</componentName\>
            </componentInstance\>
        </itemInstances\>
        <name\>facet-c22fcfa7-d6f2-46ab-ac03-6c92e7398da1</name\>
        <type\>Facet</type\>
    </flexiPageRegions\>
    <flexiPageRegions\>
        <itemInstances\>
            <componentInstance\>
                <componentName\>runtime\_sales\_activities:activityPanel</componentName\>
            </componentInstance\>
        </itemInstances\>
        <name\>Facet-u9v2x6h8u4k</name\>
        <type\>Facet</type\>
    </flexiPageRegions\>
    <flexiPageRegions\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>body</name\>
                    <value\>Facet-afbed70e-277a-41f5-9919-34651ff97773</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>title</name\>
                    <value\>Recent Items</value\>
                </componentInstanceProperties\>
                <componentName\>flexipage:tab</componentName\>
            </componentInstance\>
        </itemInstances\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>active</name\>
                    <value\>true</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>body</name\>
                    <value\>facet-77f21b6f-ad73-4d79-838a-79e0df27cc63</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>title</name\>
                    <value\>Standard.Tab.relatedLists</value\>
                </componentInstanceProperties\>
                <componentName\>flexipage:tab</componentName\>
            </componentInstance\>
        </itemInstances\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>body</name\>
                    <value\>facet-c22fcfa7-d6f2-46ab-ac03-6c92e7398da1</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>title</name\>
                    <value\>Standard.Tab.detail</value\>
                </componentInstanceProperties\>
                <componentName\>flexipage:tab</componentName\>
            </componentInstance\>
        </itemInstances\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>body</name\>
                    <value\>Facet-u9v2x6h8u4k</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>title</name\>
                    <value\>Standard.Tab.activity</value\>
                </componentInstanceProperties\>
                <componentName\>flexipage:tab</componentName\>
            </componentInstance\>
        </itemInstances\>
        <name\>facet-27334405-c871-463f-bc20-b3713bbb4884</name\>
        <type\>Facet</type\>
    </flexiPageRegions\>
    <flexiPageRegions\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>tabs</name\>
                    <value\>facet-27334405-c871-463f-bc20-b3713bbb4884</value\>
                </componentInstanceProperties\>
                <componentName\>flexipage:tabset</componentName\>
            </componentInstance\>
        </itemInstances\>
        <name\>main</name\>
        <type\>Region</type\>
    </flexiPageRegions\>
    <flexiPageRegions\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>decorate</name\>
                    <value\>true</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>richTextValue</name\>
                    <value\>&lt;p style=&quot;text-align: center;&quot;&gt;&lt;span style=&quot;background-color: rgb(255, 255, 255); font-size: 18px; color: rgb(11, 11, 11);&quot;&gt;A million dollar opportunity closed! Oh yeah!&lt;/span&gt;&lt;/p&gt;</value\>
                </componentInstanceProperties\>
                <componentName\>flexipage:richText</componentName\>
                <visibilityRule\>
                    <booleanFilter\>1 AND 2</booleanFilter\>
                    <criteria\>
                        <leftValue\>{!Record.Amount}</leftValue\>
                        <operator\>GE</operator\>
                        <rightValue\>1000000</rightValue\>
                    </criteria\>
                    <criteria\>
                        <leftValue\>{!Record.StageName}</leftValue\>
                        <operator\>EQUAL</operator\>
                        <rightValue\>Closed Won</rightValue\>
                    </criteria\>
                </visibilityRule\>
            </componentInstance\>
        </itemInstances\>
        <itemInstances\>
            <componentInstance\>
                <componentInstanceProperties\>
                    <name\>decorate</name\>
                    <value\>true</value\>
                </componentInstanceProperties\>
                <componentInstanceProperties\>
                    <name\>richTextValue</name\>
                    <value\>&lt;p style=&quot;text-align: center;&quot;&gt;&lt;span style=&quot;background-color: rgb(255, 255, 255); font-size: 16px; color: rgb(244, 0, 0);&quot;&gt;This component is for mobile users only.&lt;/span&gt;&lt;/p&gt;</value\>
                </componentInstanceProperties\>
                <componentName\>flexipage:richText</componentName\>
                <visibilityRule\>
                    <criteria\>
                        <leftValue\>{!$Client.formFactor}</leftValue\>
                        <operator\>EQUAL</operator\>
                        <rightValue\>Small</rightValue\>
                    </criteria\>
                </visibilityRule\>
            </componentInstance\>
        </itemInstances\>
        <itemInstances\>
            <componentInstance\>
                <componentName\>forceChatter:recordFeedContainer</componentName\>
            </componentInstance\>
        </itemInstances\>
        <name\>sidebar</name\>
        <type\>Region</type\>
    </flexiPageRegions\>
    <masterLabel\>New Opportunity Page</masterLabel\>
    <sobjectType\>Opportunity</sobjectType\>
    <template\>
        <name\>flexipage:recordHomeWithSubheaderTemplateDesktop</name\>
    </template\>
    <type\>RecordPage</type\>
</FlexiPage\>

And, here’s the sample package.xml file that references the FlexiPage component definition:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>New Opportunity Page</fullName\>
    <types\>
        <members\>New\_Opportunity\_Page</members\>
        <name\>FlexiPage</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=f23c441a0dfe10d51983f8689937715a538194dd23cfe9d0fa993764124ec083 url=/legacydeveloper/current/en-us/api_meta/meta_visual_workflow.md -->

# Flow

Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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

Here are the limitations related to how you can use Metadata API to work with flows:

- You can’t use Metadata API to access a flow installed from a managed package unless the flow is a template.
- Spaces in a flow file name can lead to errors when you deploy the flow. You can include spaces at the beginning or end of a name, but these spaces are removed when you deploy the flow.
- You can deploy changes to an active flow if in a non-production org, such as a scratch or sandbox org. To deploy changes in a production org, you must enable the **Deploy processes and flows as active** preference. After you deploy changes to an active flow, the flow’s detail page shows a new flow version that’s active. The new version includes your changes.
- You can delete a flow version if it isn’t active and doesn’t have any paused interviews. If the flow version has paused interviews, wait for those interviews to resume and finish, or delete them.

![Warning](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_warning.png)

#### Warning

Don’t edit the metadata of retrieved Process Builder processes, such as flow components whose processType is Workflow or InvocableProcess. If you deploy process metadata that you edited, you can’t open the process in the target org.

## Declarative Metadata File Suffix and Directory Location

Flows are stored in the Flow directory of the corresponding package directory. The file name matches the flow’s unique full name, and the extension is .flow.

## Version

The flow Metadata API is available in API version 24.0 and later.

## Flow

This metadata type represents a valid definition of a flow. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e133">Field Name</th>

              <th class="featureTableHeader  " id="d950606e136">Field Type</th>

              <th class="featureTableHeader  " id="d950606e139">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">actionCalls</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowActionCall">FlowActionCall</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">
                <span class="ph" id="actionCalls-desc"><a name="actionCalls-desc"><!-- --></a>An array of nodes that defines calls to
                  action.</span> This field is available in API version 31.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">apexPluginCalls</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowApexPluginCall">FlowApexPluginCall</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of nodes that defines calls to Apex plug-ins.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">apiVersion</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">number</td>

              <td class="entry" headers="d950606e139" data-title="Description">The API version that defines the execution behavior of the flow.
                This field is available in API version 50.0 and later. Flows created
                before API version 50.0 show an API version of 0 on the Flows list
                view in Setup. To show the correct API version number, create
                another version of the flow, and set the API version for running the
                flow to 49.0 or later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">areMetricsLoggedToDataCloud</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e139" data-title="Description">Indicates whether the flow's metrics are logged to Data Cloud.
                The default value is <samp class="codeph nolang">false</samp>.
                This field is available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">assignments</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowAssignment">FlowAssignment</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of assignment nodes.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">choices</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowChoice">FlowChoice</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of static choice options.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">collectionFilterCriteria</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">FlowCollectionFilterCriteria[]</td>

              <td class="entry" headers="d950606e139" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">collectionProcessors</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowCollectionProcessor">FlowCollectionProcessor</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of nodes that process collections. This field is
                available in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">constants</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowConstant">FlowConstant</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of constants.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">customErrors</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowCustomError">FlowCustomError</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of custom errors.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">customProperties</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowCustomProperty">FlowCustomProperty</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of custom properties that specify flow properties such
                as the option to show a progress indicator in a screen flow. This
                field is available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">decisions</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowDecision">FlowDecision</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of decision nodes.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e139" data-title="Description">Description of the flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">dynamicChoiceSets</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowDynamicChoiceSet">FlowDynamicChoiceSet</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array that constructs a set of choice options based on a
                database lookup.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">ends</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowEnd">FlowEnd</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of end nodes. This field is available in API version
                68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">environments</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">FlowEnvironment (enumeration of type
                string)</td>

              <td class="entry" headers="d950606e139" data-title="Description">The environment in which the flow can run. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Default</samp>—The flow can
                    run from a Visualforce component, Lightning page, flow
                    action, or custom Aura component.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Offline</samp>—The flow can
                    run only offline. Flow types that support offline flows must
                    set this value. This value is available in API version 62.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Slack</samp>—The flow can run
                    in Slack and the default environment. You specify the Slack
                    flow environment when you save the flow.
                  </li>

                </ul>
                <p class="p">This field is available in API version 55.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">exitRules</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowExitRule">FlowExitRule</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of exit rules that determine when to end the flow for a
                user in a segment-triggered flow. This field is available in API
                version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">experiments</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowExperiment">FlowExperiment</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of experiments. This field is available in API version
                61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">formulas</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowFormula">FlowFormula</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of formulas.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">groups</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowNodeGroup">FlowNodeGroup</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An
                array of group
                nodes.
                Available in API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname" id="field_fullName_flow_name"><a name="field_fullName_flow_name"><!-- --></a>fullName</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e139" data-title="Description">Required. Inherited from the Metadata component. Name of the file
                in Metadata API. <p class="p" id="flow_fullname_syntax"><a name="flow_fullname_syntax"><!-- --></a>A unique name for the
                  flow that contains only underscores and alphanumeric characters.
                  The name must be unique across the org, begin with a letter, not
                  include spaces, not end with an underscore, and not contain two
                  consecutive underscores.</p>
                <p class="p">To deploy or retrieve a version,
                  you can specify the version number. For example, <samp class="codeph nolang">sampleFlow-3</samp> specifies version
                  3 of the flow whose unique name is sampleFlow. If you don’t
                  specify a version number, the flow is the latest
                  version.</p>
                <p class="p">In API version 43.0 and earlier, this field
                  included the version number. In API version 44 and later, this
                  field no longer includes the version number.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname" id="interviewLabel"><a name="interviewLabel"><!-- --></a>interviewLabel</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e139" data-title="Description">
                <span class="ph" id="interviewLabel_desc"><a name="interviewLabel_desc"><!-- --></a>Label for the interview. This label
                  helps users and administrators differentiate interviews from the
                  same flow.</span>
                <p class="p" id="interviewLabel_desc2"><a name="interviewLabel_desc2"><!-- --></a>In the user
                  interface, this label appears in the Paused Flow Interviews
                  component on the user’s Home tab and in the list of paused flow
                  interviews in Setup.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">isAdditionalPermissionRequiredToRun</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e139" data-title="Description">Override the default behavior and restrict access to enabled
                profiles or permission sets by setting this property to <samp class="codeph nolang">true</samp>. The default value is <samp class="codeph nolang">false</samp>. This field is available in
                API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname" id="isTemplate"><a name="isTemplate"><!-- --></a>isTemplate</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e139" data-title="Description">
                <span class="ph" id="isTemplate_desc"><a name="isTemplate_desc"><!-- --></a>Indicates whether the process or flow is
                  a template. The default value is <samp class="codeph nolang">false</samp>. When installed from managed packages,
                  subscribers can’t view or clone processes or flows because of
                  intellectual property (IP) protection. But when those processes
                  and flows are templates, subscribers can open them in a builder,
                  clone them, and customize the clones.</span> This field is
                available in API version 45.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e139" data-title="Description">Required. Label for the flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">loops</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowLoop">FlowLoop</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of nodes for iterating through collections. This field
                is available in API version 30.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">migratedFromWorkflowRuleName</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e139" data-title="Description">The name of the workflow rule that the flow was migrated from.
                This field is available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">orchestratedStages</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#subtype_FlowOrchestratedStage">FlowOrchestratedStage</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of stage nodes in an orchestration. This field is
                available in API version 53.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">processMetadataValues</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowMetadataValue">FlowMetadataValue</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">Metadata values for the flow. <p class="p">This field is
                  available in API version 31.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">processType</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">FlowProcessType (enumeration of type string)</td>

              <td class="entry" headers="d950606e139" data-title="Description">
                <span class="ph" id="processType-desc"><a name="processType-desc"><!-- --></a>The type of the flow, as determined by the
                  active version, or the latest version, if there’s no active
                  version.</span>
                <span class="ph" id="processType-valid-intro"><a name="processType-valid-intro"><!-- --></a>Valid values are:</span><a name="processType-values"><!-- --></a>
                <ul class="ul bulletList" id="processType-values">
                  <li class="li">
                    <samp class="codeph nolang">ActionableEventManagementFlow</samp>—A flow that
                    triggers an actionable event orchestration process in the
                    background and automatically executes different types of
                    actions based on the event type. This value is available in
                    API version 62.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ActionCadenceAutolaunchedFlow</samp>—A flow that’s
                    executed when a user completes a cadence step. This value is
                    available in API version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ActionCadenceStepFlow</samp>—A
                    screen flow used as a cadence step. This value is available
                    in API version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ActivityObjectMatchingFlow</samp>—A flow that
                    launches when Einstein Activity Capture detects and captures
                    a new activity, such as an email. This type of flow runs in
                    the background without user interaction. This value is
                    available with Sync Email as Salesforce Activity in API
                    version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Appointments</samp>—A flow for
                    Lightning Scheduler. This value is available in API version
                    44.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ApprovalWorkflow</samp>—An
                    orchestration that’s used for an approval process. This
                    value is available in API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="processtype_autolaunched"><a name="processtype_autolaunched"><!-- --></a>AutoLaunchedFlow</samp>—A flow that doesn’t require
                    user interaction.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CheckoutFlow</samp>—A flow
                    used in Lightning B2B Commerce to create a checkout in a
                    store. This value is available in API version 48.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ContactRequestFlow</samp>—A
                    flow that lets customers request to be contacted by customer
                    support. This flow is used to create contact request
                    records. This value is available in API version 45.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomerLifecycle</samp>—A
                    Salesforce Surveys flow that lets you associate survey
                    questions with different stages in customer lifecycles.
                    This value is available in API version 49.0 and later
                    and only when the Customer Lifecycle Designer license is
                    enabled.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomEvent</samp>—A
                    process that is invoked when it receives a platform
                    event message. In the UI, it’s an event process. This
                    value is available in API version 41.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DataCaptureFlow</samp>— In the
                    UI, Data Capture flows configure the Form tab in the Field
                    Service mobile app. When the Data Capture flow is launched,
                    its Flow metadata is publicly available in JavaScript
                    format. This value is available in API version 62.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DcvrFrameworkDataCaptureFlow</samp>—A screen flow
                    that presents assessment questions from Discovery Framework.
                    Launches when invoked by a user on a mobile device. This
                    type of flow collects or displays information, requires user
                    interaction, and works offline or online. This value is
                    available in API version 62.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EvaluationFlow</samp>—A flow
                    for evaluating custom entry and exit conditions in an
                    orchestration. Uses the <samp class="codeph nolang">isOrchestrationConditionMet</samp> output variable
                    and discards values from any other output variables. This
                    value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FieldServiceMobile</samp>—A
                    flow for the Field Service mobile app. This value is
                    available in API version 39.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FieldServiceWeb</samp>—A flow
                    for embedded Appointment Booking. Its UI label is Field
                    Service Embedded Flow. This value is available in API
                    version 41.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="processtype_flow"><a name="processtype_flow"><!-- --></a>Flow</samp>—A flow that requires user interaction
                    because it contains one or more screens or local actions,
                    choices, or dynamic choices. In the UI and Salesforce Help,
                    it’s a screen flow. Screen flows can be launched from the
                    UI, such as with a flow action, Lightning page, or web
                    tab.
                  </li>

                  <li class="li"><span class="ph" id="enumprocesstype_fsclending"><a name="enumprocesstype_fsclending"><!-- --></a><samp class="codeph nolang" id="processtype_fsclending"><a name="processtype_fsclending"><!-- --></a>FSCLending</samp>—A flow for Financial Services
                      Cloud Mortgage. This value is available in API version
                      46.0 and later.</span></li>

                  <li class="li">
                    <samp class="codeph nolang">IdentityUserRegistrationFlow</samp>—A flow to
                    handle user registration and updates for single sign-on
                    with the authentication provider framework. Available in
                    API version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IndicatorResultFlow</samp>—A
                    flow for Outcome Management that calculates and creates
                    indicator results for a selected indicator performance
                    period. This value is available with the Outcome Management
                    license in API version 60.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IndividualObjectLinkingFlow</samp>—A flow that
                    associates individuals with interactions such as voice
                    calls, messaging sessions, or case-related emails. This
                    value is available in API version 58.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">InvocableProcess</samp>—A
                    process that another process or the Invocable Actions
                    resource in REST API invokes. This value is available in
                    API version 38.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Journey</samp>—An
                    audience-driven flow for Marketing Cloud. This value is
                    available in API version 57.0 and later.
                  </li>

                  <li class="li"><span class="ph" id="loginflow"><a name="loginflow"><!-- --></a><samp class="codeph nolang">LoginFlow</samp>—A flow for login. This value is
                      available in API version 51.0 and later.</span></li>

                  <li class="li">
                    <samp class="codeph nolang">LoyaltyManagementFlow</samp>—A flow for the
                    Loyalty Management app that’s invokable by loyalty
                    program processes. This value is available in API
                    version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Orchestrator</samp>—An
                    orchestration that organizes flows into groups of steps
                    contained in a series of stages. This value is available in
                    API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PromptFlow</samp>—A flow for
                    Prompt Builder. Pass data between Prompt Builder and the
                    flow. This value is available in API version 60.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RecommendationStrategy</samp>—Build recommendations for
                    your users. A recommendation launches its assigned flow.
                    This value is available in API version 54.0 and later. See
                    <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.nba_building_flow_builder_strategy.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Flow Builder
                      Strategies</a>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RoutingFlow</samp>—A flow
                    for Salesforce Omni-Channel routing and other business
                    logic. This value is available in API version 52.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Survey</samp>—A flow for
                    Salesforce Surveys. From the UI, this type of flow is
                    created in Survey Builder. This value is available in
                    API version 42.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SurveyEnrich</samp>—A
                    Salesforce Surveys flow that uses the Survey Data
                    Mapper. From the UI, this type of flow is created in the
                    Survey Builder and requires an associated survey flow
                    type. This value is available in API version 49.0 or
                    later and only when the Customer Lifecycle Designer
                    license is enabled.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Workflow</samp>—A process that
                    is invoked when a record is created or edited. In the UI and
                    Salesforce Help, it’s a record change process.
                  </li>

                </ul>
                <p class="p" id="processTypes_change"><a name="processTypes_change"><!-- --></a>Across flow versions, you can
                  change the type only from <samp class="codeph nolang">Flow</samp> to <samp class="codeph nolang">AutoLaunchedFlow</samp> or vice versa. Before you change
                  the flow type, make sure that the flow contains only the
                  elements, resources, and functionality that the new flow type
                  supports.</p>
                <p class="p">These values are reserved for future or
                  Salesforce internal use.</p>
                <a name="processTypes_futureUse"><!-- --></a>
                <ul class="ul bulletList" id="processTypes_futureUse">
                  <li class="li"><samp class="codeph nolang">ActionPlan</samp></li>

                  <li class="li"><samp class="codeph nolang">AppProcess</samp></li>

                  <li class="li"><samp class="codeph nolang">ApprovalWorkflow</samp></li>

                  <li class="li"><samp class="codeph nolang">CartAsyncFlow</samp></li>

                  <li class="li"><samp class="codeph nolang">DigitalForm</samp></li>

                  <li class="li"><samp class="codeph nolang">JourneyBuilderIntegration</samp></li>

                  <li class="li"><samp class="codeph nolang" id="flow_process_loginflow"><a name="flow_process_loginflow"><!-- --></a>LoginFlow</samp></li>

                  <li class="li"><samp class="codeph nolang">ManagedContentFlow</samp></li>

                  <li class="li"><samp class="codeph nolang">OrchestrationFlow</samp></li>

                  <li class="li"><samp class="codeph nolang">SalesEntryExperienceFlow</samp></li>

                  <li class="li"><samp class="codeph nolang">TransactionSecurityFlow</samp></li>

                  <li class="li"><samp class="codeph nolang">UserProvisioningFlow</samp></li>

                </ul>
                <p class="p">This
                  field is available in API version 31.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">recordCreates</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowRecordCreate">FlowRecordCreate</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of nodes for creating records in the database.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">recordDeletes</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowRecordDelete">FlowRecordDelete</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of nodes for deleting records in the database.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">recordLookups</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowRecordLookup">FlowRecordLookup</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of nodes for looking up records in the database.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">recordRollbacks</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowRecordRollback">FlowRecordRollback</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of nodes for rolling back transactions in the screen
                flow. This field is available in API version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">recordUpdates</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowRecordUpdate">FlowRecordUpdate</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of nodes for updating records in the database.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">runInMode</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">FlowRunInMode (enumeration of type string)</td>

              <td class="entry" headers="d950606e139" data-title="Description">The context that the flow runs in. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">DefaultMode</samp>—How the
                    flow is launched determines whether the flow runs in user
                    context or in system context. In the UI, this value appears
                    as <strong class="ph uicontrol">User or System Context—Depends on How Flow is
                      Launched</strong>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SystemModeWithSharing</samp>—The flow respects org-wide
                    default settings, role hierarchies, sharing rules, manual
                    sharing, teams, and territories. The flow doesn’t respect
                    object permissions, field-level access, or other permissions
                    of the running user. In the UI, this value appears as
                    <strong class="ph uicontrol">System Context with Sharing—Enforces
                      Record-Level Access</strong>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SystemModeWithoutSharing—</samp>The flow can access
                    all data. In the UI, this value appears as <strong class="ph uicontrol">System
                      Context without Sharing—Access All Data</strong>.
                    This value is available in API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UserMode</samp>—The flow runs
                    with the user's security context explicitly enforced,
                    without inheriting sharing settings from the calling
                    context. In the UI, this value appears as <strong class="ph uicontrol">User
                      Context—Enforces User Permissions</strong>. This
                    value is available in API version 68.0 and later.
                  </li>

                </ul>
                <p class="p">This field is available in API version 48.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">screens</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowScreen">FlowScreen</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of screen nodes.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">segment</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e139" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">stages</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowStage">FlowStage</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of stage resources that you can use throughout the flow.
                This field is available in API version 42.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">start</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowStart">FlowStart</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">The flow’s Start element, which specifies how and when the flow
                starts. This field is available in API version 47.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">startElementReference</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e139" data-title="Description">Specifies which node or element is the starting point in the
                flow.<p class="p">This field isn’t used in flows created or saved in Flow
                  Builder in Winter ’20 and later. Those flows use the
                  <span class="keyword parmname">start</span> field instead to specify how the
                  flow starts.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">FlowVersionStatus (enumeration of type string)</td>

              <td class="entry" headers="d950606e139" data-title="Description">The activation status of the flow. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Active</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Draft</samp>—In the UI,
                    this status appears as
                    <samp class="ph systemoutput">Inactive</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Obsolete</samp>—In the UI,
                    this status appears as
                    <samp class="ph systemoutput">Inactive</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">InvalidDraft</samp>—In the
                    UI, this status appears as
                    <samp class="ph systemoutput">Draft</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UnderReview</samp>—In the
                    UI, this status appears as <samp class="ph systemoutput">Under
                      Review</samp>.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">steps</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowStep">FlowStep</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of step nodes.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname" id="field_subflows_name"><a name="field_subflows_name"><!-- --></a>subflows</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowSubflow">FlowSubflow</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">
                <span class="ph" id="field_subflows_desc"><a name="field_subflows_desc"><!-- --></a>An array of subflows.</span> This
                field is available in API version 25.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">textTemplates</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowTextTemplate">FlowTextTemplate</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of text templates.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">timeZoneSidKey</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e139" data-title="Description">The ID that defines the time zone in which the flow runs. This
                field is available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">transforms</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowTransform">FlowTransform</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of data transformations. This field is available in API
                version 59.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">triggerOrder</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e139" data-title="Description">The run order of a record-triggered flow, from 1 to 2,000. See
                <a class="xref" href="https://help.salesforce.com/s/articleView?id=flow_concepts_trigger_guidelines.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Guidelines for Defining the Run Order of
                  Record-Triggered Flows for an Object</a> in Salesforce Help.
                This field is available in API version 54.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname">variables</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowVariable">FlowVariable</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">An array of variable definitions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e133" data-title="Field Name"><span class="keyword parmname" id="waits-name"><a name="waits-name"><!-- --></a>waits</span></td>

              <td class="entry" headers="d950606e136" data-title="Field Type">
                <a class="xref" href="#FlowWait">FlowWait</a>[]
              </td>

              <td class="entry" headers="d950606e139" data-title="Description">
                <span class="ph" id="waits-desc"><a name="waits-desc"><!-- --></a>An array of wait nodes.</span> This field is
                available in API version 32.0 and later.
              </td>

            </tr>

          </tbody>

        </table>

## FlowActionCall

Defines a call to an action from the flow. It extends [FlowNode](#FlowNode).

This metadata type is available in API version 31.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e1341">Field Name</th>

              <th class="featureTableHeader  " id="d950606e1344">Field Type</th>

              <th class="featureTableHeader  " id="d950606e1347">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">actionCallPaths</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">
                <a class="xref" href="#FlowStep">ActionCallPath</a>[]
              </td>

              <td class="entry" headers="d950606e1347" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Required. Name for the action. Must be unique across actions with
                the same <span class="keyword parmname">actionType</span>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">actionType</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">
                <span class="ph" id="InvocableActionType_desc"><a name="InvocableActionType_desc"><!-- --></a>InvocableActionType</span>
                (enumeration of type string)
              </td>

              <td class="entry" headers="d950606e1347" data-title="Description">Required. See <a class="xref" href="#InvocableActionType">InvocableActionType</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e1347" data-title="Description">Specifies which node to execute after this action call.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">dataTypeMappings</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">
                <a class="xref" href="#FlowDataTypeMapping">FlowDataTypeMapping</a>[]
              </td>

              <td class="entry" headers="d950606e1347" data-title="Description">
                <span class="ph" id="datatypemappings_desc"><a name="datatypemappings_desc"><!-- --></a>An array of data type mappings for
                  input and output values that have the generic sObject data
                  type.</span> This field is available in API version 48.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">einsteinDecidePath</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Reserved for future use.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">faultConnector</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e1347" data-title="Description">Specifies which node to execute if the action call results in an
                error.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">flowTransactionModel</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">
                <span class="ph" id="FlowTransactionModel_desc"><a name="FlowTransactionModel_desc"><!-- --></a>FlowTransactionModel</span>
                (enumeration of type string)
              </td>

              <td class="entry" headers="d950606e1347" data-title="Description">Required. Specifies the transactional model for flows that
                execute invocable actions. Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Automatic</samp>— Creates
                    a transaction if the invocable action supports it and
                    there’s pending DML.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CurrentTransaction</samp>—
                    Keeps the invocable action running in the same
                    transaction.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NewTransaction</samp>—
                    Creates a transaction before the invocable action is
                    executed.
                  </li>

                </ul>
                This field is available in API version 51.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">inputParameters</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">
                <a class="xref" href="#FlowActionCallInputParameter">FlowActionCallInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e1347" data-title="Description">An array of input parameters from the flow to the action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">isWaitUntilCompleted</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Specifies whether to pause the flow until the action is
                completed. This field is available in API version 61.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">nameSegment</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Specifies the name of the versioned action. Supported only when
                nameSegment is specified. This field is available in API version
                58.0 to 61.0. This field is deprecated in API version 62.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">offset</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Specify the number of months, days, hours, or minutes to pause
                the flow while it waits for the action to be completed. This field
                is available in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">offsetUnit</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">FlowScheduledPathOffsetUnit (enumeration of type string)</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Specify the time unit used to wait when the async action
                executes. Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Months</samp></li>

                  <li class="li"><samp class="codeph nolang">Days</samp></li>

                  <li class="li"><samp class="codeph nolang">Hours</samp></li>

                  <li class="li"><samp class="codeph nolang">Minutes</samp></li>

                </ul>
                This field is available in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">outputParameters</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">
                <a class="xref" href="#FlowActionCallOutputParameter">FlowActionCallOutputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e1347" data-title="Description">An array of output parameters from the action to the
                flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">storeOutputAutomatically</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Indicates whether the action’s output parameters are
                automatically available in the flow without creating any variables.
                When the value is <samp class="codeph nolang">true</samp>, you can
                reference an output parameter by specifying the API name of the
                Action element in the flow. The default value is <samp class="codeph nolang">false</samp>. When the value is <samp class="codeph nolang">false</samp>, create variables manually to
                store output values from the action. <p class="p">This field is available in
                  API version 48.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">timeoutConnector</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e1347" data-title="Description">Specifies which node to execute if an async action execution is
                timed out. This field is available in API version 62.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">timeoutPathUsage</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">FlowActionCallTimeoutPath (enumeration of type string)</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Include or exclude a timeout path for an asynchronous action in a
                flow. Valid values are:<a name="ul_mmb_s3j_g3c"><!-- --></a>
                <ul class="ul bulletList" id="ul_mmb_s3j_g3c">
                  <li class="li"><samp class="codeph nolang">DisableTimeoutPath</samp></li>

                  <li class="li"><samp class="codeph nolang">EnableTimeoutPath</samp></li>

                </ul>
                This field is available in API version 66.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">versionSegment</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Specifies the version of the versioned action. By default, the
                value is 1. Supported only when versionSegment is specified. This
                field is available in API version 58.0 to 61.0. This field is
                deprecated in API version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1341" data-title="Field Name"><span class="keyword parmname">versionString</span></td>

              <td class="entry" headers="d950606e1344" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e1347" data-title="Description">Reserved for future use.</td>

            </tr>

          </tbody>

        </table>

## InvocableActionType

The valid values in the required actionType on [FlowActionCall](#FlowActionCall).

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e1731">Valid Value</th>

              <th class="featureTableHeader  " id="d950606e1734">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">activateSessionPermSet</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Activates a session-based permission set for the running
                user.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">activationSchema</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Gets the activation schema for the specified activation. This
                value is available in API version 64.0 and later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">addMessageToChat</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adds a message to an existing Salesforce Anywhere chat. This
                value is available in API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">addMessageToQuipChat</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adds a Quip message to an existing chat room. This value is
                available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">addMessageToQuipDocument</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adds a Quip message to an existing Quip document, spreadsheet, or
                slide. This value is available in API version 46.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">addQuipDocumentToFolder</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adds an existing Quip document, spreadsheet, or slide to an
                existing folder. This value is available in API version 46.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">addUsersToChat</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adds users to an existing Salesforce Anywhere chat. This value is
                available in API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">addUsersToQuipDocument</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adds users, identified by their email addresses, to an existing
                Quip document, spreadsheet, or slide. This value is available in API
                version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">addUsersToQuipChat</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adds users, identified by their email addresses, to an existing
                Quip chat room. This value is available in API version 46.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">adjustPartnerInvShipAndDebit</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adjusts the point of sales record during ship and debit claim
                pocessing to a different partner unsold inventory. Available in API
                version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">adjustPartnerUnsoldInventory</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adjusts the partner unsold inventory quantities and prices.
                Available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">answerQuestionsWithSalesforceDocumentation</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Searches Salesforce documentation to provide answer to questions,
                as well as links to relevant articles.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">analyticsSendDigestAsSlackMsg</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends an Analytics digest to a Slack channel. This value is
                available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">attachQuipDocumentToRecord</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Attaches a Quip document, spreadsheet, or slide to a Salesforce
                record. This value is available in API version 46.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">apex</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Invokes an Apex method that has the @invocableMethod
                annotation.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">archiveKnowledgeArticles</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Archives a list of published Knowledge articles. This value is
                available in API version 45.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">assignApptForServiceResourceForFieldService</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Assigns the service appointment selected by the dispatcher to a
                service resource, in the gap identified in the service resource’s
                schedule on a specific date. This value is available in API version
                63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">assignKnowledgeArticles</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Mass assigns knowledge articles from article list views. This
                value is available in API version 44.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">automateRefund</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Initiate a refund to the customer. This value is available in API
                version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">buildIdentityVerification</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Calls an action that builds the identity verification context
                using the identity verification process definition specified in
                IdVerfProcessDefinition and information passed into the flow. Stores
                the result in the VerificationContext variable. This value is
                available in API version 55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">cdpGetDataGraph</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Query a data graph in Data Cloud by data graph API name, data
                space name, and record ID. This resource is available in API version
                61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">cdpGetDataGraphByLookup</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Get data of a data graph in Data Cloud by data graph API name,
                data space name, and lookup key. This resource is available in API
                version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">cdpGetDataGraphMetadata</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Get metadata of a data graph in Data Cloud by data graph API name
                and data space name. If the data space name isn't provided, the API
                uses the default value. This resource is available in API version
                64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">cdpPublishCalculatedInsight</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Run the calculated insight in Data Cloud. Available in API
                version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">cdpPublishSegment</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Publish a segment in Data Cloud. Available in API version 60.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">cdpRefreshDataStream</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Refresh a data stream in Data Cloud. Available in API version
                60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">cdpRunIdentityResolution</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Runs a Data Cloud identity resolution process. This value is
                available in API version 57.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">cdpValidateSegmentMember</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Validate a segment in Data Cloud. Available in API version 60.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">calcPriceProtectPayoutAmt</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Calculates the payout after a price protection adjustment or
                execution is made. This value is available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">chat</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a Salesforce Anywhere chat. This value is available in
                API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">chatterPost</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Posts to Chatter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">choosePricebook</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Selects a price book.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">component</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Invokes the Aura component that implements the
                lightning:availableForFlowActions interface and that is referenced
                by actionName. This value is available in API version 43.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">computeConsumption</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Computes usage for all consumption cards. This value is available
                in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">contactRequestAction</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a contact request record. This value is available in API
                version 45.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">contentWorkspaceEnableFolders</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Enables folders in a library.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">convertAttributesToJson</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Converts the given attributes into a JSON string format. This
                value is available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">copyQuipDocument</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a copy of an existing Quip document, spreadsheet, or
                slide, and gives it a new title. This value is available in API
                version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">createConsumptionAlert</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends a notification if usage for a consumption card crosses a
                specified threshold. This value is available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">createDraftFromOnlineKnowledgeArticle</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a draft from a published knowledge article. This value is
                available in API version 45.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">createFieldGnrnPromptTmplResp</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a field generation prompt template response. This value
                is available in API version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">createInvoiceFromFulfillmentOrder</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates an invoice from a purchase order. Available to B2B
                Commerce. This value is available in API version 49.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">createLicenseUtilizationAlert</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends a notification to specified users when license utilization
                reaches or exceeds a specified threshold. This object is available
                in API version 67.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">createProductLimitAlert</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates alerts when product limit utilization reaches or exceeds
                configured threshold percentages. This action evaluates current
                utilization against specified thresholds and creates Utilization
                Alert (TenantConsumptionAlert) records for crossed thresholds. This
                value is available in API version 67.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">createQuipChat</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a Quip chat room. This value is available in API version
                46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">createQuipDocument</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a Quip document, spreadsheet, or slide. This value is
                available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">createQuipFolder</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a Quip folder. This value is available in API version
                46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">customNotificationAction</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends a custom notification. This value is available in API
                version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">dataCloudIngestionApi</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Send data to Data Cloud using Ingestion API. This value is
                available in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">deactivateSessionPermSet</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Deactivates a session-based permission set for the running
                user.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">deleteKnowledgeArticle</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Deletes a draft version (translation or master-language) or an
                entire archived knowledge article. This value is available in API
                version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">dynamicSendSurveyInvitation</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends customized notifications to users about important events or
                updates to the records that they're working on. This value is
                available in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">editQuipDocument</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Modifies the contents of an existing Quip document, spreadsheet,
                or slide. This value is available in API version 46.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">einsteinDecidePath</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Determines a user's level of email engagement using Einstein
                Engagement Frequency or Einstein Engagment Scoring, and route users
                through the flow based on that engagement. This value is available
                in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">emailAlert</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends an email by referencing a workflow email alert</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">emailSimple</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends an email by using flow resources. This action isn't
                available for flows with a processType of Workflow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">exploreConversation</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Retrieves insights from a conversation. This value is available
                in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">externalConnector</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Executes a process or method exposed via a connector to an
                external system. This value is available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">externalService</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Invokes an External Service operation that makes an HTTP request
                to an external system made available by an External Service schema
                registered through Setup. This value is available in API version
                46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">findMatchingIndividuals</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Finds contact, lead, or employee records that match a search
                term.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">findPastCollaborators</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Leverages insights from Einstein Activity Capture to identify
                individuals with past collaborative ties, aiding in securing
                introductions to relevant parties in ongoing or future deals. This
                value is available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">flow</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Invokes an autolaunched flow. This action type isn't available
                for flows with a processType of Flow or AutolaunchedFlow. To invoke
                an autolaunched flow from one of those types, use FlowSubflow. This
                value is available in API version 32.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">generateAiAgentResponse</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Generates a response from the AI agent based on input and
                instructions to support intelligent, conversational experiences.
                This value is available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">generateAnalyticsAssetsContent</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Generates Analytics assets content. This value is available in
                API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">generateVerificationCode</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends a verification code to the customer's email to verify their
                identity. This value is available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getActivitySummary</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Gets a summary of activity data associated with a specified
                record, including emails, calls, and meetings. This value is
                available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getArticleSmartLinkUrl</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Gets the Smart Link URL of the Salesforce Knowledge article.
                Smart links go to the right article and version, even when a new
                version is published or the URL name changes. This value is
                available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getNrbyScvTerritories</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Queries for active service territories within a specified radius
                of given geographic coordinates using database-level DISTANCE
                filtering. Available in API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getPoliciesByObject</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Gets Policy Center policies that contain a given object and
                returns a list of matching policy names.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getPoliciesByPolicyType</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Gets Policy Center policies of the type specified in the user
                input, such as Data Backup or Data Archive.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getPolicyDetails</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Gets details about a policy in Policy Center, such as the policy
                type and the objects the policy targets.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getProductPricing</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Gets the pricing information of a product, including relevant
                historical sale price data from previous won deals involving the
                same product. This value is available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getResourcesForMnlScheduling</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Recommends resources to use to manually schedule the start of a
                care visit or recurring visits. You must enable Home Health to use
                this action. This value is available in API version 61.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getSalesAgreementDetails</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Retrieves a comprehensive collection of all required data (spread
                across multiple entities like SalesAgreement, Product2,
                SalesAgreementProduct, etc.) for a given Sales Agreement. Available
                in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getSearchConfigurationMetadata</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Retrieves all metadata details and search configurations for a
                given searchable object. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getTranscriptForConversation</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Gets the transcript for a specified conversation record such as
                voice call, messaging session, or chat transcript. This value is
                available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">getVerificationData</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Calls an invocable action to get verification data for
                selectedPrimaryVerificationContext and adds the results to
                selectedPrimaryVerificationContext. This value is available in API
                version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">goToCadenceStep</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Jumps to the specified step in the Sales cadence. This value is
                available in API version 57.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">groupClaimsByFields</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Groups open claims by configurable fields and returns counts per
                group. Available in API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">ingestManualAgentScores</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Ingests external agent evaluation scores (annotations) into the
                Agentforce scoring pipeline. This value is available in API version
                66.0 and later</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">limitRepetitions</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Limit the number of times the same recommendation or offer
                appears on the same record or for the same user during a time period
                in a recommendation strategy flow. This value is available in API
                version 55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">lockRecord</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Lock or unlock a workflow-enabled or approval-enabled record for
                editing during an approval and specify who can edit the record while
                it's locked.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">lwcComponent</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Triggers the LWC component that targets the lightning__FlowAction
                target in the XML configuration file and that's referenced by
                actionName. This value is available in API version 63.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">massUpdateAccountForecast</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Bulk updates forecasts asynchronously. This value is available in
                API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">massUpdateSalesAgreement</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Bulk updates sales agreements asynchronously. This value is
                available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">processAccessDelegationRequest</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Processes the specified access delegation request. Available in
                API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">processDataUsingGenAi</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Using Einstein generative AI, performs NLP to summarize text,
                extract key phrases, analyze sentiment, and unlock valuable
                insights. This value is available in API version 61.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">publishActionableOrchSrcEvent</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Publishes events triggered by an external system. This value is
                available in API version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">publishKnowledgeArticles</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Mass publishes knowledge articles from article list views. This
                value is available in API version 44.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">quickAction</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Invokes a Quick Action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">recalculateHouseholdNames</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Recalculates the names and greetings of the specified households
                based on the active household naming configurations. Available in API
                version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">replenishInventoryUsingPolicy</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Executes inventory policy to identify stock shortages, determine
                the optimal source location, and automate replenishment. Available
                in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">rescheduleRecurringHomeVisits</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Reschedules all the home visits based on the recurrence pattern
                and scheduling policy provided. This value is available in API
                version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">restoreKnowledgeArticleVersion</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Restores an archived version of a knowledge article. This value
                is available in API version 45.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">reviewBuyingCommittee</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">
                <p dir="ltr" class="p">Identifies and reviews key contacts associated with a
                  deal, their influence on that deal, and other deals that they’ve
                  impacted. This value is available in API version 63.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">rpa</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Performs a set of actions in a defined scope outside the flow,
                such as operating a session or using an application on a on-premises
                computer via an RPA robot. This value is available in API version
                63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">scheduleGroupVisits</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Create visiting records for patient home visits by bundling them
                into a group and scheduling either a single start-of-care visit or a
                series of recurring visits associated with the bundled records. This
                value is available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">scheduleSvcApptActnblEvntOrch</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates service appointments in response to actionable events by
                identifying work type and assigning service territories. This value
                is available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">sendAlert</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends Salesforce Anywhere alerts to users. This value is
                available in API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">sendNotification</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends an available notification type. This value is available in
                API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">sendSurveyInvitation</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends email survey invitations to leads, contacts, and users in
                your org based on an action, such as when a customer support case
                closes. This value is available in API version 47.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">pardotSlackCompletionActionNotification</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Sends a user a Slack notification when a prospect completes an
                activity in Account Engagement.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">performSurveySentimentAnalysis</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Perform survey sentiment analysis to create or update the AI
                Sentiment Result records. This value is available in API version
                55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">skillsBasedRouting</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a PendingServiceRouting record used for Omni-Channel
                skills-based routing. This value is available in version 44.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">slackArchiveChannel</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Archives a Slack channel in a Slack workspace. This value is
                available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">slackCheckUsersAreConnectedToSlack</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Indicates whether a collection of Salesforce users is connected
                to a given Slack app. This value is available in API version 54.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">slackCreateChannel</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Creates a Slack channel in a Slack workspace. This value is
                available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">slackGetConversationInfo</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Retrieves the name of a Slack channel or group direct message and
                finds out whether it's archived. This value is available in API
                version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">slackInviteUsersToChannel</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Adds users who are connected to a given Slack app to a Slack
                channel or group direct message. This value is available in API
                version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">slackPinMessage</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Pin or unpin a message in a Slack channel or group direct
                message. This value is available in API version 54.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">slackPostMessage</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Send a message to a Slack channel or group direct message. This
                value is available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">slackSendMessageToLaunchFlow</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Send a message to a Slack channel, direct message, or the
                Messages tab of a Slack app that includes a button that a recipient
                can use to launch a screen flow. This value is available in API
                version 55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">slackUpdateMessage</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Edits a message that was previously sent to a Slack channel or
                group direct message. This value is available in API version 54.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">submitKnowledgeArticleForTranslation</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Submits a published or draft knowledge article for translation.
                This value is available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">submitOrderEnrollment</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Submits order enrollment information to the processing queue for
                tariff comparison calculations.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">submit</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Submits a record for approval.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">transformMfgProgramForecasts</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Transform an AI Natural Language Processing (NLP) result created
                by using Einstein Generative AI into an Apex Object record. This
                value is available in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">transformNlpActionResult</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Transform an AI Natural Language Processing (NLP) result created
                by using Einstein Generative AI into an Apex Object record. This
                value is available in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">triggerAgentBulkScoring</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Triggers Agentforce Scorer processing on specified inputs using
                scorer API names and entity IDs. This value is available in API
                version 66.0 and later</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">triggerJourney</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Send an individual to a specified journey. This value is
                available in API version 64.0 and later</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">triggerAgentBulkScoring</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Triggers Agentforce Scorer processing on specified inputs using
                scorer API names and entity IDs. This value is available in API
                version 66.0 and later</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e1731" data-title="Valid Value"><samp class="codeph nolang">verifyCustomerCode</samp></td>

              <td class="entry" headers="d950606e1734" data-title="Description">Verifies the code entered by the customer to complete identity
                verification. This value is available in API version 63.0 and
                later.</td>

            </tr>

          </tbody>

        </table>

These values are used in Omnichannel Inventory. If no version is specified, the value is available in API version 51.0 and later.

| Valid Value | Description |
| --- | --- |
| ociCreateReservation | Creates one or more inventory reservations at a location or location group. |
| ociFulfillReservation | Fulfills one or more inventory reservations at a location. |
| ociGetAvailability | Gets inventory availability data for one or more products at one or more inventory locations or location groups. |
| ociReleaseReservation | Releases one or more inventory reservations. |
| ociTransferReservation | Transfers one or more inventory reservations between locations or location groups. |

These values are used in the B2B Commerce Checkout Flow. If no version is specified, the value is available in API version 47.0 and later.

| Valid Value | Description |
| --- | --- |
| updateCheckoutSessionStateAction | Updates the checkout session next state for checkout flows. This value is available in API version 49.0 and later. |
| priceCart | Requests prices for all items in a cart during B2B Commerce checkout. This value is available in API version 47.0 and later. |
| checkoutSessionAction | Initiates or retrieves an existing Checkout Session for Checkout Flows. Available to B2B Commerce. This value is available in API version 49.0 and later. |
| cancelCartAsyncOperation | Cancels a WebCart's async operation. Available to B2B Commerce. This value is available in API version 49.0 and later. |
| calcCartPromotionsAction | Requests a full cart promotion calculation of all applicable line items in the Web Cart during B2B Commerce checkout. This value is available in API version 52.0 and later. |
| checkCartInventoryAction | Requests an inventory for all items in a Web Cart during B2B Commerce checkout. This value is available in API version 47.0 and later. |
| calcCartShipmentAction | Calculates the shipping cost for all items in a Web Cart during B2B Commerce checkout. This value is available in API version 47.0 and later. |
| cartToOrderAction | Creates a Salesforce Standard Order in draft mode. This value is available in API version 47.0 and later. |
| activateOrderAction | Activates a draft order, which creates an order summary. This value is available in API version 47.0 and later. |

These values are used in the B2B Commerce and D2C Commerce.

| Valid Value | Description |
| --- | --- |
| recordTaxReversal | Reverses the recorded tax transactions in an external system. This value is available in API version 62.0 and later. |
| recordTaxTransaction | Records tax transactions from an order summary to an external system. This value is available in API version 62.0 and later. |

These values are used in Data Cloud.

| Valid Value | Description |
| --- | --- |
| dataKitGetComponentAction | Gets the deployment status of data kit deployment jobs. This value is available in API version 64. |
| dataKitDeployComponentAction | Deploys data kit components in a target org. This value is available in API version 64. |

These values are used in Tableau Next.

| Valid Value | Description |
| --- | --- |
| analyticsSendDigestAsSlackMsg | Sends the generated Tableau Next asset content as a Slack message. This value is available in API version 64.0 and later. |
| generateAnalyticsAssetsContent | Creates the content of the email or slack body for a Tableau Next asset, which is used by other actions to send to the appropriate channels. This value is available in API version 64.0 and later. |

These values are used in Education Cloud.

| Valid Value | Description |
| --- | --- |
| getAcademicTermData | Gets the details of the academic term that the specified learner is enrolled in. This value is available in API version 65.0. |
| getBatchJobIds | Gets the identifiers of batch jobs. This value is available in API version 64. |
| getLearningProgramData | Gets the learning program data based on the learning program name. This value is available in API version 65.0. |
| getProgramTermApplTimelineData | Gets the program term application timeline data based on the academic term ID and learning program ID. This value is available in API version 65.0. |
| getRestrictionsAsgnToStudent | Gets the details of the restrictions (business process operations) assigned to a student. This value is available in API version 65.0. |

These values are used in the Commerce Checkout Flow. If no version is specified, the value is available in API version 55.0 and later.

| Valid Value | Description |
| --- | --- |
| addCartItem | Adds an item to a cart during Commerce checkout. |
| createCart | Creates a cart during Commerce checkout. |
| deleteCart | Deletes a cart during Commerce checkout. |
| b2cGetShippingMethods | Gets the available shipping methods for the default shipment of a B2C Commerce basket. This value is available in API version 68.0 and later. |
| b2cSetShippingAddress | Sets the shipping address on the default shipment of a B2C Commerce basket. This value is available in API version 68.0 and later. |
| b2cSetShippingMethod | Sets the shipping method on the default shipment of a B2C Commerce basket. This value is available in API version 68.0 and later. |
| b2cInitiatePayment | Validates that the basket is ready for checkout and initiates an Apple Pay payment request. This value is available in API version 68.0 and later. |
| b2cPreProcessPayment | Runs a pre-payment hook that lets Apex run pre-payment logic, such as creating a draft order, during B2C Commerce checkout. This value is available in API version 68.0 and later. |
| b2cPostProcessPayment | Runs a post-payment hook that lets Apex run post-payment logic, such as updating order state, during B2C Commerce checkout. This value is available in API version 68.0 and later. |

These values are used in Salesforce CMS Workflows and Approvals. If no version is specified, the value is available in API version 58.0 and later.

| Valid Value | Description |
| --- | --- |
| managedContentPublishVariant | Publishes a content variant associated with a flow. This value is available in API version 59.0 and later. |
| managedContentRoleStepInteractive | Assigns a content variant review to a CMS role. |
| managedContentUnpublishVariant | Unpublishes a published content variant associated with a flow. This value is available in API version 59.0 and later. |
| managedContentVariantSetLockStatus | Sets the locked status of a content variant. |
| managedContentVariantSetReadyStatus | Sets the ready for publication status of a content variant. |

These values are used in Order Management. If no version is specified, the value is available in API version 48.0 and later.

| Valid Value | Description |
| --- | --- |
| addOrderItemSummarySubmit | Adds order item summaries to an order summary. This value is available in API version 54.0 and later. |
| adjustOrderItemSummariesPreview | Previews the expected results of applying a price adjustment to order item summaries from an order summary without actually applying it. This value is available in API version 49.0 and later. |
| adjustOrderItemSummariesSubmit | Applies a price adjustment to order item summaries from an order summary. This value is available in API version 49.0 and later. |
| authorizePayment | Authorizes a card payment. This value is available in API version 55.0 and later. |
| cancelFulfillmentOrderItem | Removes items from a fulfillment order. |
| cancelOrderItemSummariesPreview | Previews the expected results of canceling order item summaries from an order summary without actually canceling them. |
| cancelOrderItemSummariesSubmit | Cancels order item summaries from an order summary. |
| confirmHeldFulfillmentOrderCapacity | Confirms held fulfillment order capacity. This value is available in API version 55.0 and later. |
| createCreditMemoOrderSummary | Creates a credit memo for an order summary. |
| createFulfillmentOrder | Creates one or more fulfillment orders and fulfillment order products for an order delivery group summary, which defines a recipient and delivery method. |
| createFulfillmentOrders | Creates fulfillment orders and fulfillment order products for multiple order delivery group summaries, each of which defines a recipient and delivery method. This value is available in API version 51.0 and later. |
| createInvoiceFromChangeOrders | Creates an invoice for one or more change orders. This value is available in API version 56.0 and later. |
| createInvoiceFromFulfillmentOrder | Creates an invoice for a fulfillment order. |
| createOrderPaymentSummary | Creates an order payment summary for an authorization or payments belonging to an order summary. |
| createOrderSummary | Creates an order summary for an order. |
| createReturnOrder | Creates a return order and return order items for an order. |
| ensureFundsOrderSummaryAsync | Triggers an asynchronous background process to ensure funds through a payment provider for an invoice belonging to an order summary. |
| ensureRefundsOrderSummaryAsync | Triggers an asynchronous background process to ensure refunds through a payment provider for an invoice belonging to an order summary. |
| getFulfillmentOrderCapacityValues | Gets fulfillment order capacity information. This value is available in API version 55.0 and later. |
| holdFulfillmentOrderCapacity | Holds fulfillment order capacity. This value is available in API version 55.0 and later. |
| orderRoutingFindRoutesWithFewestSplits | Evaluates ordered product quantities against available inventory to determine the smallest combination of locations that can fulfill the order. This value is available in API version 51.0 and later. |
| orderRoutingFindRoutesWithFewestSplitsUsingOCI | Evaluates ordered product quantities against available inventory at specified location groups and locations to determine the smallest combination of locations that can fulfill the order. This value is available in API version 54.0 and later. |
| orderRoutingRankByAverageDistance | Calculates the average distance from sets of inventory locations to an order recipient, and returns the sets sorted by that average distance. This value is available in API version 51.0 and later. |
| releaseHeldFulfillmentOrderCapacity | Releases held fulfillment order capacity. This value is available in API version 55.0 and later. |
| returnOrderItemSummariesPreview | Previews the expected results of returning order item summaries from an order summary without actually returning them. |
| returnOrderItemSummariesSubmit | Returns order item summaries from an order summary. |
| returnReturnOrderItems | Processes return order line items. |

These values are used in the Employee Service. If no version is specified, the value is available in API version 63.0 and later.

| Valid Value | Description |
| --- | --- |
| createServiceRequestCase | Creates a case or incident for the requested service. |
| getDirectDepositDetails | Gets the direct deposit details for the specified record ID. |
| getLeaveBalance | Gets the leave balance of a specific employee. |

These values are used in Rebate Management.

| Valid Value | Description |
| --- | --- |
| addRebateMemberList | Adds a list of members to a rebate program. This value is available in API version 51.0 and later. |
| calculateProjectedRebateAmount | Calculates the projected rebate amount for rebate types associated with a specified transaction ID. This value is available in API version 54.0 and later. |
| calculateRebateAmountAndUpsertPayout | Calculates the rebate amount and upserts the rebate payout for the specified aggregate record. This value is available in API version 51.0 and later. |
| getBenefitAndCalculateRebateAmount | Gets benefit details, and optionally calculates the rebate amount for the specified aggregate record. This value is available in API version 51.0 and later. |
| getEligibleProgramRebateTypes | Retrieves the eligible program rebate types for a mapped object. This value is available in API version 52.0 and later. |
| generateRebatePayoutPeriods | Generates payout periods for a rebate program based on the frequency specified in the program. This value is available in API version 51.0 and later. |
| processRebatesBatchCalculationJob | Processes a rebate batch calculation job from the Data Processing Engine. This value is available in API version 51.0 and later. |
| processProgramRebateTypeProducts | Insert or delete records in the Program Rebate Type Product object. This value is available in API version 53.0 and later. |
| rebatesProcessCSV | Processes an uploaded CSV file using Bulk API 2.0 and converts the file’s data into records in the target object. This value is available in API version 51.0 and later. |
| upsertCustomRebatePayout | Upserts the custom calculated rebate payout for the specified aggregate record. This value is available in API version 51.0 and later. |

These values are for Decision Table. If no version is specified, the value is available in API version 51.0 and later.

| Valid Value | Description |
| --- | --- |
| decisionTableAction | Runs an active decision table definition. |
| refreshDecisionTable | Refreshes the decision table cache. |

These values are used in Einstein generative AI features.

| Valid Value | Description |
| --- | --- |
| generatePromptResponse | Generates a response based on the large language model (LLM) response for the specified prompt template and inputs. This value is available in API version 60.0 and later. |
| transformQueryForCase | Generates a natural language query for retrieval based on the specified case details, language, and additional context. This value is available in API version 62.0 and later. |
| transformQueryForConversation | Generates a natural language query for retrieval based on the specified conversation text, language, and additional context. This value is available in API version 62.0 and later. |
| transformQueryForEmail | Generates a natural language query for retrieval based on the specified email details, language, and additional context. This value is available in API version 62.0 and later. |

These values are used in flows for Engagement.

| Valid Value | Description |
| --- | --- |
| createEngagementsDetailsRep | Creates a JSON representation. Use the details of Engagement Interaction, Messaging Session, and Voice Call records; the related Engagement Topic and Note records; and transcripts from the conversation to create a JSON representation. This value is available in API version 64.0 and later. |
| getConversationTranscripts | Gets the list of transcripts of the conversations between an agent and a customer. |
| getEngagements | Gets engagement interaction, messaging session, and voice call records associated with a specified account record. |
| getRecordDetails | Gets the details of specified records, including the name of the parent record. |

These values are used in Field Service. If no version is specified, the value is available in API version 52.0 and later.

| Valid Value | Description |
| --- | --- |
| addWorkPlans | Creates work plan and work step objects from the work plan library. |
| cancelWorkOrder | Cancels a work order. |
| completeWorkOrder | Completes a work order. |
| createWorkOrder | Creates a work order. |
| createWorkOrderLineItem | Creates a work order line item. |
| createWorkPlan | Creates a work plan. |
| createWorkStep | Creates a work step. |
| getWorkOrderDetails | Gets work order details. |
| getWorkPlanDetails | Gets work plan details. |
| getWorkStepDetails | Gets work step details. |
| updateWorkOrder | Updates a work order. |
| updateWorkOrderLineItem | Updates a work order line item. |
| updateWorkPlan | Updates a work plan. |
| updateWorkStep | Updates a work step. |
| addWorkSteps | Creates work step objects from the work plan library. |
| deleteWorkPlans | Deletes all the work plans and work steps associated with a work order or work order line item. |
| generateWorkPlans | Generates work plans based off rules defined in the work plan library. |

These values are used in Einstein Bots. If no version is specified, the value is available in API version 56.0 and later.

| Valid Value | Description |
| --- | --- |
| getDataCategoryDetails | Gets the labels and API names for a specified data category associated with the knowledge base. This value is available in API version 56.0 and later. |
| getDataCategoryGroups | Gets the labels and API names of the active data category groups associated with the Knowledge object that’s visible to the current user. |
| searchKnowledgeArticles | Searches for knowledge articles with specified search terms, language, data category group, and data category. |

This value is used for Einstein Initiate Language Processing Action.

| Valid Value | Description |
| --- | --- |
| initiateNaturalLangProcessing | Create a record for the AI natural language processing result and initiate text processing by using the service specified in the related record. This value is available in API version 60.0 and later. |

These values are used in Einstein Work summaries. If no version is specified, the value is available in API version 63.0 and later.

| Valid Value | Description |
| --- | --- |
| getCaseInfoToSummarize | Gets case field details like subject, description, comments, emails, and conversation transcripts for use with prompt templates in Prompt Studio. |
| getConvTrscpForRecord | Gets the conversation transcript associated with a VoiceCall, MessagingSession, or LiveChatTranscript record. |

This value is used in Media Cloud.

| Valid Value | Description |
| --- | --- |
| vlocity\_cmt\_\_MediaIntegrationProcedureInvocable | Call an Integration Procedure from a Salesforce Flow to process media content. This value is available in API version 60.0 and later. |

These values are used in the Get Forecast Guidance flow.

| Valid Value | Description |
| --- | --- |
| getForecastContext | Gets the forecast context for a specified user. This value is available in API version 61.0 and later. |
| getForecastOpportunities | Gets forecast opportunities for a user that matches the specified criteria. This value is available in API version 61.0 and later. |

This value is used in the Get Opportunity Grounding Data flow.

| Valid Value | Description |
| --- | --- |
| getOpportunityContentNote | Gets the content note data for a specified opportunity record. This value is available in API version 64.0 and later. |

This value is used in the Process Field Update Suggestions flow.

| Valid Value | Description |
| --- | --- |
| getOrExecFieldUpdtSuggestion | Enqueues requests to get a field update suggestion from a field generation prompt template. Also enqueues requests to update a field based on the generated suggestion. This value is available in API version 64.0 and later. |

This value is used in Einstein Case Classification flow.

| Valid Value | Description |
| --- | --- |
| applyCaseClassificationRecommendations | Takes a Case ID as input and outputs a case SObject with recommendations applied. This value is available in API version 57.0 and later. |

These values are used in the Activities: Match Email to Records flow. Sync Email as Salesforce Activity must be enabled.

| Valid Value | Description |
| --- | --- |
| associateRecordsWithActivity | Updates the specified email message to associate it with specified records. This value is available in API version 64.0 and later. |
| getAcctOpptyFromEmailAddr | Gets an account record associated with one of the specified contacts or unmatched email addresses and also gets an opportunity record related to the account. This value is available in API version 63.0 and later. |
| getContcLeadsFromEmailAddr | Matches email addresses to contact and lead records related to specified active user records. This value is available in API version 63.0 and later. |
| getUsersFromEmailAddresses | Gets user records with email addresses that match those specified in the To, From, or CC address field after a sent email is captured by Einstein Activity Capture. This value is available in API version 63.0 and later. |

These values are used in the Identity User Registration flow.

| Valid Value | Description |
| --- | --- |
| generateUserData | Generates placeholder user data for the fields that are required to create a user. Available in API version 64.0 and later. |
| getUserDataFromJsonString | Gets an attribute value from a JSON object that has been serialized into a string. Use this action to retrieve user information from the identity provider's ID token and user info response. Available in API version 64.0 and later. |

These values are used in the Contracts flow.

| Valid Value | Description |
| --- | --- |
| checkInContractDocumentVersion | Check-in a contract document version. Available in API version 64.0 and later. |
| checkOutContractDocumentVersion | Check-out a contract document version. Available in API version 64.0 and later. |
| createContractDocumentVersion | Creates a contract document version. Available in API version 64.0 and later. |
| deleteContractDocumentVersion | Deletes a contract document version. Available in API version 64.0 and later. |
| getContractDocumentVersion | Gets a contract document version. Available in API version 64.0 and later. |
| updateContractDocumentVersion | Updates a contract document version. Available in API version 64.0 and later. |
| checkOutContractDocVersion | Check-out a contract document version. Available in API version 64.0 and later. |
| createClmContract | Create a contract for a specified record. Available in API version 64.0 and later. |
| getCntntDocDtlForCntrDocVer | Get content document details for the contract document version. Available in API version 64.0 and later. |
| getContractDocumentVersions | Get contract document versions. Available in API version 64.0 and later. |
| performContractAction | Perform actions on a contract based on its status. Available in API version 64.0 and later. |
| sendContractForESignature | Send a contract to specified recipients for e-signature. Available in API version 64.0 and later. |
| unlockContractDocumentVersion | Unlock an active contract document version that the user previously locked. Available in API version 64.0 and later. |
| updateClmContracts | Update contract for a specified record and update or create associated contract documents. Available in API version 64.0 and later. |

These values are used in the Einstein GPT Usecases flow.

| Valid Value | Description |
| --- | --- |
| createCaseForFinclAcctAddrUpdt | Create a case to update the financial account address. Available in API version 64.0 and later. |
| createVisitForContextRecord | Create a visit to record context. Available in API version 64.0 and later. |
| draftAGiftProposal | Create a gift proposal for an account. Available in API version 64.0 and later. |
| getCardDetailsForAccount | Get card details for an account. Available in API version 64.0 and later. |
| getFinancialAccountAddresses | Get financial account address details for an account. Available in API version 64.0 and later. |
| getFinancialTransactions | Get all financial account transactions associated with a specific financial account. Available in API version 64.0 and later. |
| summarizeMedicalHistoryForPatient | Summarize medical history of a specified patient. Available in API version 64.0 and later. |
| summarizeMedicationDetailsForPatient | Summarize medication details of a specified patient. Available in API version 64.0 and later. |

This value is used in the Grantmaking flow.

| Valid Value | Description |
| --- | --- |
| getActiveApplicationReviewerIds | Retrieves the user IDs of all active users who have the ReviewApplication user permission. This value is available in API version 64.0 and later. |

These values are used in Unified Catalog. If no version is specified, the value is available in API version 64.0 and later.

| Valid Value | Description |
| --- | --- |
| checkProductEligibility | Determines whether a user is eligible for a list of products, which represent service processes, based on predefined criteria. |
| checkSvcPrcActionEligibility | Determines whether an AI agent is eligible for a list of products, which represent service processes, and if the list is linked to a service process. |

These values are for the Batch Management jobs.

| Valid Value | Description |
| --- | --- |
| batchJobAction | Runs the batch management jobs definitions. This value is available in API version 51.0 and later. |
| submitFailedRecordsBatchJob | Resubmits an existing batch job with failed records for processing. This value is available in API version 52.0 and later. |

This value is for Data Processing Engine.

| Valid Value | Description |
| --- | --- |
| dataProcessingEngineAction | Runs the data processing engine definitions. This value is available in API version 51.0 and later. |

This value is used for Einstein Visit Recommendation.

| Valid Value | Description |
| --- | --- |
| saveRecommendationDecision | Save visit and task recommendation decisions. This value is available in API version 51.0 and later. |

These values are used with Inbox. If no version is specified, the values are available in API version 66.0 and later.

| Valid Value | Description |
| --- | --- |
| confirmSalesMeeting | Confirms a meeting time that's part of a request to get available meeting time slots. |
| getAvailableMeetingTimes | Retrieves the time slots available for booking a meeting. |

These values are used in Public Sector Solutions.

| Valid Value | Description |
| --- | --- |
| bulkEnqueuePostingsToGenLeads | Enqueues active recruitment postings so that matching candidates are sourced as lead records. This value is available in API version 68.0 and later. |
| createBenefitDisbursement | Creates a benefit disbursement for an eligible benefit assignment. This value is available in API version 57.0 and later. |
| invocableCallContentSearch | Searches file content stored in Amazon S3, including images, audio, video, and PDFs, and returns matching files with citations. This value is available in API version 68.0 and later. |
| runRecordAggrBatchProcDef | Runs a Data Processing Engine definition to process an asynchronous batch job that creates or updates record aggregation results. This value is available in API version 59.0 and later. |

These values are used in Einstein Conversation Insights.

| Valid Value | Description |
| --- | --- |
| getConversationIntelligence | Gets the conversation intelligence information about a voice or video call, including any insights and the conversation summary. This value is available in API version 65.0 and later. |
| getConversationTranscript | Gets the conversation transcript for the specified voice or video call record. This value is available in API version 63.0 and later. |

This value is used in the Get Opportunity Details flow.

| Valid Value | Description |
| --- | --- |
| getRecPrioData | Gets the record data and field metadata required to prioritize records. This value is available in API version 62.0 and later. |

These values are used in Agentforce Sales Management flows.

| Valid Value | Description |
| --- | --- |
| getContentNote | Gets the most recent content note data for a specified record. This value is available in API version 64.0 and later. |
| getRelatedEmails | Gets a list of emails that are related to a specific record and that were logged within a specified date range. This value is available in API version 66.0 and later. |
| sendSalesAgentNtfcnInSlack | Sends notifications from the Sales Management Agent to a user in Slack. This value is available in API version 65.0 and later. |

These values are reserved for future use.

- exportSurveyResponses
- metricRefresh
- thanks

These values are reserved for internal use.

- addAgentsToContactCenter
- fetchSegmentsSchedule
- getSegMemberAbsenceContainers
- getSegmentBillingEstimate
- getSecurityConnectedTenants
- getSession
- internalTestAction
- internalTestConnectApiAction
- respondToPartnerOffer
- revokeEcaSessions
- summarizeOauthTokensForApp

For values used in other products or features, see:

- [Flow for Asset Lifecycle](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/asset_lifecycle_flow_metadata_api.htm "HTML (New Window)")
- [Flow for B2B Referral Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.referral_marketing.meta/referral_marketing/b2b_referral_management_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Billing](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/billing_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Business Rules Engine](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/bre_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Context Service](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/context_service_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Digital Lending.](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/digital_lending_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Dynamic Revenue Orchestrator](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/dynamic_revenue_orchestrator_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Financial Services Cloud](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/fsc_meta_visual_workforce.htm "HTML (New Window)")
- [Flow for Fundraising](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/fundraising_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Health Cloud](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/health_cloud_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Insurance Brokerage](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Insurance Claims](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Insurance Group Benefits](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Insurance Policy Administration](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_administration_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Insurance Quoting](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/insurance_quoting_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Intelligent Document Reader](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/intelligent_document_reader_standard_actions_parent.htm "HTML (New Window)")
- [Flow for Intelligent Form Reader](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/form_reader_standard_actions_parent.htm "HTML (New Window)")
- [Flow for Life Sciences Cloud](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Loyalty Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.loyalty.meta/loyalty/loyalty_management_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Manufacturing Cloud](https://developer.salesforce.com/docs/atlas.en-us.264.0.mfg_api_devguide.meta/mfg_api_devguide/mfg_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Net Zero Cloud](https://developer.salesforce.com/docs/atlas.en-us.264.0.netzero_cloud_dev_guide.meta/netzero_cloud_dev_guide/net_zero_cloud_invocable_actions_parent.htm "HTML (New Window)")
- [Flow for Omnistudio](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/omnistudio_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Process Compliance Navigator](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/process_compliance_navigator_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Product Configurator](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/product_configurator_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Product Discovery](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/product_discovery_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Quote and Order Capture](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/qoc_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Rate Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/rate_management_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Referral Marketing](https://developer.salesforce.com/docs/atlas.en-us.264.0.referral_marketing.meta/referral_marketing/referral_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Salesforce Pricing](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/pricing_flow_metadata_api.htm "HTML (New Window)")
- [Flow for Usage Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/usage_management_flow_metadata_api.htm "HTML (New Window)")

## FlowActionCallInputParameter

Defines an input parameter from the flow to the action. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 31.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Unique name for the input parameter. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value of the input parameter. |

## FlowActionCallOutputParameter

Defines an output parameter from the action to the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 31.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToReference | string | Required. Specifies the variable that you want to assign the target output value to. |
| name | string | Required. Unique name for the output parameter. |

## FlowActionCallPath

A path determines which node of the flow is executed after the Einstein Decision element. A path defines and links to the subsequent node. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 63.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| connector | [FlowConnector](#FlowConnector) | Required. Which node to execute after completing the current node. |
| pathName | string | Required. Unique name for the path. |

## FlowApexPluginCall

Defines a call to an Apex plug-in from the flow. It extends [FlowNode](#FlowNode) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| apexClass | string | Required. The name of the Apex class. |
| connector | [FlowConnector](#FlowConnector) | Specifies which node to execute after this Apex plug-in call. |
| faultConnector | [FlowConnector](#FlowConnector) | Specifies which node to execute if the Apex plug-in call results in an error. |
| inputParameters | [FlowApexPluginCallInputParameter](#FlowApexPluginCallInputParameter)\[\] | An array of input parameters from the flow to the Apex plug-in. |
| outputParameters | [FlowApexPluginCallOutputParameter](#FlowApexPluginCallOutputParameter)\[\] | An array of output parameters from the Apex plug-in to the flow. |

## FlowApexPluginCallInputParameter

Defines an input parameter from the flow to the Apex plug-in. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Unique name for the input parameter. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value of the input parameter. |

## FlowApexPluginCallOutputParameter

Defines an output parameter from the Apex plug-in to the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToReference | string | Required. Specifies the variable that you want to assign the target output value to. |
| name | string | Required. Unique name for the output parameter. |

## FlowAssignment

Defines an assignment node that can dynamically change the value of a variable in the flow. It extends [FlowNode](#FlowNode) and inherits all of its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignmentItems | [FlowAssignmentItem](#FlowAssignmentItem)\[\] | An array of assignment operations that’s executed in the given order, starting from the index 0. |
| connector | [FlowConnector](#FlowConnector) | Specifies which node to execute after this assignment node. |

## FlowAssignmentItem

Defines an operation to apply to a variable. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToReference | string | Specifies the variable that you want to assign the target output value to. |
| operator | [FlowAssignmentOperator](#FlowAssignmentOperator) (enumeration of type string) | Operation to apply to the variable reference in the assignToReference field. For valid values, see [FlowAssignmentOperator](#FlowAssignmentOperator). |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value that you want the operator to apply to the variable reference in the assignToReference field. |

## FlowAssignmentOperator

An enumeration of type string that specifies the operation to apply to the variable in the assignToReference field. See “[Flow Operators in Assignment Elements](https://help.salesforce.com/articleView?id=flow_ref_operators_assignment.htm&language=en_US "HTML (New Window)")” in Salesforce Help.

These values are valid.

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e6600">Enumeration Value</th>

              <th class="featureTableHeader  " id="d950606e6603">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">Add</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">When the <span class="keyword parmname">assignToReference</span> field is a
                variable of type number or currency, this operator adds the
                <span class="keyword parmname">value</span> to the variable.<p class="p">When the
                  <span class="keyword parmname">assignToReference</span> field is a variable
                  of type date, this operator adds the <span class="keyword parmname">value</span>
                  in days to the variable.
                </p>
                <p class="p">When the
                  <span class="keyword parmname">assignToReference</span> field is a variable
                  of type string, this operator appends the
                  <span class="keyword parmname">value</span> to the end of the
                  string.
                </p>
                <p class="p">When the <span class="keyword parmname">assignToReference</span>
                  field is a variable of type picklist, this operator appends the
                  <span class="keyword parmname">value</span> to the end of the last item in
                  the picklist.
                </p>
                <p class="p">When the
                  <span class="keyword parmname">assignToReference</span> field is a variable
                  of type multipicklist, this operator appends the
                  <span class="keyword parmname">value</span> to the end of the last item in
                  the multi-select picklist. To instead add an item to the end of
                  the multi-select picklist, use the <samp class="codeph nolang">AddItem</samp> operator.
                </p>
                <p class="p">When the
                  <span class="keyword parmname">assignToReference</span> field is the
                  <span class="keyword parmname">$Flow.ActiveStages</span> global variable,
                  this operator appends the <span class="keyword parmname">value</span> as a new
                  item at the end of
                  <span class="keyword parmname">$Flow.ActiveStages</span>.
                </p>
                <p class="p">When the
                  <span class="keyword parmname">assignToReference</span> field is a collection
                  variable, this operator appends the <span class="keyword parmname">value</span>
                  to the end of the collection. Support for a collection variable
                  as the <span class="keyword parmname">value</span> is available in API version
                  43.0 and later, but only via Metadata API. From Flow Builder,
                  you can’t save an Assignment element that contains a collection
                  variable in the Value column for the <samp class="codeph nolang">Add</samp> operator.
                </p>
                <p class="p">The <samp class="codeph nolang">Add</samp> operator isn’t supported
                  when the <span class="keyword parmname">assignToReference</span> field is a
                  variable of type boolean, dateTime, or sObject.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">AddAtStart</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when the <span class="keyword parmname">assignToReference</span>
                field is a collection variable or the
                <span class="keyword parmname">$Flow.ActiveStages</span> global variable. Adds
                the <span class="keyword parmname">value</span> as a new item at the beginning of the
                collection. When the <span class="keyword parmname">value</span> is a collection
                variable, the operator adds all items at the beginning of the
                collection. This operator is available in API version 43.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">AddItem</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when the <span class="keyword parmname">assignToReference</span>
                field is a variable of type multipicklist. Adds the
                <span class="keyword parmname">value</span> to the picklist, including the
                semicolon that’s required to mark a <span class="keyword parmname">value</span> as a
                separate item. This operator is available in API version 34.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">Assign</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Assigns the <span class="keyword parmname">value</span> to the variable in the
                <span class="keyword parmname">assignToReference</span> field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">AssignCount</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when the <span class="keyword parmname">value</span> is a
                collection variable or the <span class="keyword parmname">$Flow.ActiveStages</span>
                global variable. Counts the number of stages or items in the
                collection, and assigns that number to the variable in the
                <span class="keyword parmname">assignToReference</span> field. Corresponds to
                <span class="keyword parmname">equals count</span> in the user interface. This
                operator is available in API version 43.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">RemoveAfterFirst</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when the <span class="keyword parmname">assignToReference</span>
                field is a collection variable or the
                <span class="keyword parmname">$Flow.ActiveStages</span> global variable. Finds
                the first instance of the <span class="keyword parmname">value</span> within the
                variable in the <span class="keyword parmname">assignToReference</span> field.
                Removes everything after that first instance from the variable. This
                operator is available in API version 43.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">RemoveAll</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when the <span class="keyword parmname">assignToReference</span>
                field is a collection variable or the
                <span class="keyword parmname">$Flow.ActiveStages</span> global variable. Removes
                all instances of the <span class="keyword parmname">value</span> from the variable in
                the <span class="keyword parmname">assignToReference</span> field. When the
                <span class="keyword parmname">value</span> is a collection variable, the
                operator removes all instances of each item from the variable in the
                <span class="keyword parmname">assignToReference</span> field. This operator is
                available in API version 43.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">RemoveBeforeFirst</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when the <span class="keyword parmname">assignToReference</span>
                field is a collection variable or the
                <span class="keyword parmname">$Flow.ActiveStages</span> global variable. Finds
                the first instance of the <span class="keyword parmname">value</span> within the
                variable in the <span class="keyword parmname">assignToReference</span> field.
                Removes everything before that first instance from the variable.
                This operator is available in API version 43.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">RemoveFirst</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when the <span class="keyword parmname">assignToReference</span>
                field is a collection variable or the
                <span class="keyword parmname">$Flow.ActiveStages</span> global variable. Removes
                the first instance of the <span class="keyword parmname">value</span> from the
                variable in the <span class="keyword parmname">assignToReference</span> field. This
                operator is available in API version 43.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">RemovePosition</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when the <span class="keyword parmname">assignToReference</span>
                field is a collection variable or the
                <span class="keyword parmname">$Flow.ActiveStages</span> global variable. Removes
                the item at the specified position. For example, if the collection
                contains three items, such as Red, Green, and Blue, and the
                <span class="keyword parmname">value</span> is 2, the second item, Green, is
                removed from the collection variable. This operator is available in
                API version 43.0 and later.<p class="p">Make sure that the
                  <span class="keyword parmname">value</span> at run time is a positive integer
                  within the range of the number of items in the collection
                  variable.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">RemoveUncommon</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when <span class="keyword parmname">assignToReference</span> and
                <span class="keyword parmname">value</span> are both collection variables. Keeps
                items that are in both collections and removes the rest from the
                collection variable in the <span class="keyword parmname">assignToReference</span>
                field. This operator is available in API version 43.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e6600" data-title="Enumeration Value"><samp class="codeph nolang">Subtract</samp></td>

              <td class="entry" headers="d950606e6603" data-title="Description">Supported only when the <span class="keyword parmname">assignToReference</span>
                field is a variable of type currency, date, or number.<p class="p">When the
                  <span class="keyword parmname">assignToReference</span> field is a variable
                  of type number or currency, this operator subtracts the
                  <span class="keyword parmname">value</span> from the variable.
                </p>
                <p class="p">When the
                  <span class="keyword parmname">assignToReference</span> field is a variable
                  of type date, this operator subtracts the
                  <span class="keyword parmname">value</span> in days from the
                  variable.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowBaseElement

Base class for all flow elements that require contextual information in metadata values. This class is an abstract class. FlowBaseElement is available in API version 32.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| processMetadataValues | [FlowMetadataValue](#FlowMetadataValue)\[\] | Contextual information for the element. |

## FlowChoice

A choice resource is a standalone choice option that you can reference or reuse throughout the flow. It extends [FlowElement](#FlowElement) and inherits all of its fields. See [Salesforce Help: Flow Resource: Choice](https://help.salesforce.com/s/articleView?id=platform.flow_ref_resources_choice.htm&language=en_US).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e7038">Field Name</th>

              <th class="featureTableHeader  " id="d950606e7041">Field Type</th>

              <th class="featureTableHeader  " id="d950606e7044">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e7038" data-title="Field Name"><span class="keyword parmname">choiceIcon</span></td>

              <td class="entry" headers="d950606e7041" data-title="Field Type"><a class="xref" href="#FlowIcon">FlowIcon</a></td>

              <td class="entry" headers="d950606e7044" data-title="Description">The icon to display for the choice in the screen. This field is
                available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7038" data-title="Field Name"><span class="keyword parmname">choiceText</span></td>

              <td class="entry" headers="d950606e7041" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7044" data-title="Description">Required. Choice label to display in the screen.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7038" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d950606e7041" data-title="Field Type">FlowDataType (enumeration of type string)</td>

              <td class="entry" headers="d950606e7044" data-title="Description">Required. Valid types are:<a name="FlowDataType_std_values"><!-- --></a>
                <ul class="ul bulletList" id="FlowDataType_std_values">
                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Time</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7038" data-title="Field Name"><span class="keyword parmname">userInput</span></td>

              <td class="entry" headers="d950606e7041" data-title="Field Type"><a class="xref" href="#FlowChoiceUserInput">FlowChoiceUserInput</a></td>

              <td class="entry" headers="d950606e7044" data-title="Description">Enables the choice to allow user input when the choice is
                selected. Not supported for choices in multi-select fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7038" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d950606e7041" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e7044" data-title="Description">Actual value that’s used during flow execution, for example, in
                assignments, calls to Apex plug-ins, and record elements. If null,
                this choice always has the value of null.</td>

            </tr>

          </tbody>

        </table>

## FlowChoiceUserInput

Allows the choice to include a user input field that appears when the user selects a choice. User input isn’t supported for choices in multi-select fields. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| isRequired | boolean | Indicates whether users are required to enter something into the field when they select the choice. |
| promptText | string | Text that’s displayed to prompt the user for input at runtime. Supports merge fields. |
| validationRule | [FlowInputValidationRule](#FlowInputValidationRule) | A rule used at runtime to validate the user input. |

## FlowCollectionProcessor

Defines a node that processes the contents of a collection, depending on the collectionProcessorType. FlowCollectionProcessor is available in API version 50.0 and later. FlowCollectionProcessor extends FlowNode and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e7262">Field Name</th>

              <th class="featureTableHeader  " id="d950606e7265">Field Type</th>

              <th class="featureTableHeader  " id="d950606e7268">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">assignNextValueToReference</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7268" data-title="Description">The name of the variable that’s assigned to the next value of the
                collection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">collectionProcessorType</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">FlowCollectionProcessorType</td>

              <td class="entry" headers="d950606e7268" data-title="Description">The type of the collection processor. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">SortCollectionProcessor</samp>—This value is available in
                    API version 50.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RecommendationMapCollectionProcessor</samp>— This
                    value is available in API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FilterCollectionProcessor</samp>— This value is
                    available in API version 53.0 and later.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">collectionReference</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7268" data-title="Description">The collection being sorted, filtered, or assigned to
                recommendations.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">conditionLogic</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7268" data-title="Description">Defines how the filtering conditions are evaluated. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">And</samp></li>

                  <li class="li"><samp class="codeph nolang">Or</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom logic, such as (1 AND (2
                      OR 3))</samp></li>

                  <li class="li"><samp class="codeph nolang">Formula</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">conditions</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e7268" data-title="Description">An array of conditions for the input collection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e7268" data-title="Description">Specifies which node to execute after processing the
                collection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">formula</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7268" data-title="Description">The formula expression that filters the input collection. If the
                formula evaluates to <samp class="codeph nolang">true</samp>, the
                record is added to the output collection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">limit</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e7268" data-title="Description">The maximum number of records to include in the generated
                collection. There’s no default value. All items of the collection
                are kept if it’s greater than the size of the collection. <p class="p">If
                  sortField and sortOrder are also specified, the records are
                  sorted before the limit takes effect.</p>

                <p class="p">This field is available in API version 51.0 and later.</p>

                <p class="p">This field is nillable in API version 51.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">mapItems</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">
                <a class="xref" href="#FlowCollectionMapItem">FlowCollectionMapItem</a>[]
              </td>

              <td class="entry" headers="d950606e7268" data-title="Description">The rules to map each field of the collection variable.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">outputSObjectType</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7268" data-title="Description">The sObject type of the output collection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7262" data-title="Field Name"><span class="keyword parmname">sortOptions</span></td>

              <td class="entry" headers="d950606e7265" data-title="Field Type">
                <a class="xref" href="#FlowCollectionSortOption">FlowCollectionSortOption</a>[]
              </td>

              <td class="entry" headers="d950606e7268" data-title="Description">An array of options to sort the items in the collection. This
                field is available in API version 51.0 and later.</td>

            </tr>

          </tbody>

        </table>

## FlowCollectionSortOption

Sets the sorting field, sort order, and placement of empty or null values in the sorted collection. This metadata type is available in API version 51.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e7503">Field Name</th>

              <th class="featureTableHeader  " id="d950606e7506">Field Type</th>

              <th class="featureTableHeader  " id="d950606e7509">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e7503" data-title="Field Name"><span class="keyword parmname">doesPutEmptyStringAndNullFirst</span></td>

              <td class="entry" headers="d950606e7506" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e7509" data-title="Description">Place empty or null values first in the sorted list by setting
                this value to <samp class="codeph nolang">true</samp>. The default
                value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7503" data-title="Field Name"><span class="keyword parmname">sortField</span></td>

              <td class="entry" headers="d950606e7506" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7509" data-title="Description">Determines the sorting of records that meet the filter criteria.
                Required for record collections and collections of Apex-defined
                variables. <p class="p">If the collection is a primitive data type, such as a
                  list of string or integer values, <span class="keyword parmname">sortField</span>
                  isn’t supported.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7503" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d950606e7506" data-title="Field Type">SortOrder (enumeration of type string)</td>

              <td class="entry" headers="d950606e7509" data-title="Description">The order that the collection is sorted in. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Asc</samp>—Ascending
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Desc</samp>—Descending
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## FlowCustomError

Defines a custom error element to roll back a change that triggered a flow and inform the user exactly what caused the error. It extends [FlowNode](#FlowNode) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Describes the error message. |
| connector | [FlowConnector](#FlowConnector) | Required. Which node to execute after completing the current node. |
| customErrorMessages | [FlowCustomErrorMessage](#FlowCustomErrorMessage)\[\] | An array of custom error messages. |

## FlowCustomErrorMessage

Defines a custom error message for a custom error element. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| errorMessage | string | Required. Specifies the custom error message. |
| fieldSelection | string | References the erroneous field that’s associated with the custom error message. |
| isFieldError | boolean | Required. When this field is set to true, indicates that the custom error message displays inline on a field. When it is set to false, it displays in a window on a record page. The default value is false. |

## FlowCondition

Defines a condition for a rule. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e7788">Field Name</th>

              <th class="featureTableHeader  " id="d950606e7791">Field Type</th>

              <th class="featureTableHeader  " id="d950606e7794">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e7788" data-title="Field Name"><span class="keyword parmname">aggregationOperator</span></td>

              <td class="entry" headers="d950606e7791" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7794" data-title="Description">Operation to apply to the variable reference in the
                <span class="keyword parmname">assignToReference</span> field. The valid value is:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Count</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7788" data-title="Field Name"><span class="keyword parmname">conditionLogic</span></td>

              <td class="entry" headers="d950606e7791" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7794" data-title="Description">Specifies logic for the conditions. Value can be:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">and</samp>—Evaluates to
                    <samp class="codeph nolang">true</samp> only if all
                    its conditions evaluate to true
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">or</samp>—Evaluates to <samp class="codeph nolang">true</samp> if any of its
                    conditions evaluate to true
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7788" data-title="Field Name"><span class="keyword parmname">conditionType</span></td>

              <td class="entry" headers="d950606e7791" data-title="Field Type">FlowWaitConditionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e7794" data-title="Description">The type of condition that a requirement in an automation is used
                for. Valid values are:<ul class="ul bulletList">
                  <li class="li">Container</li>

                  <li class="li">EntryCondition</li>

                  <li class="li">ExitCondition</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7788" data-title="Field Name"><span class="keyword parmname">conditions</span></td>

              <td class="entry" headers="d950606e7791" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e7794" data-title="Description">An array of conditions that must be <samp class="codeph nolang">true</samp> for the flow to execute the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7788" data-title="Field Name"><span class="keyword parmname">leftValueReference</span></td>

              <td class="entry" headers="d950606e7791" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e7794" data-title="Description">Required. Unique name of the element that serves as the left side
                of the condition expression.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7788" data-title="Field Name"><span class="keyword parmname">operator</span></td>

              <td class="entry" headers="d950606e7791" data-title="Field Type">FlowComparisonOperator (enumeration of type string)</td>

              <td class="entry" headers="d950606e7794" data-title="Description">Required. Comparison operators in conditions for flow elements
                and resources. The date comparison operators, such as <samp class="codeph nolang">IsAfter</samp>, <samp class="codeph nolang">IsBefore</samp>, and <samp class="codeph nolang">IsOn</samp>, apply to
                <span class="keyword parmname">Date</span> fields only, not
                <span class="keyword parmname">DateTime</span> fields. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Contains</samp></li>

                  <li class="li"><samp class="codeph nolang">EndsWith</samp></li>

                  <li class="li"><samp class="codeph nolang">EqualTo</samp></li>

                  <li class="li"><samp class="codeph nolang">GreaterThan</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">GreaterThanLastNumberOfDays</samp>—Returns <samp class="codeph nolang">true</samp> if the date value is
                    more than N days before today. If N is a decimal, only the
                    integer portion is used. This value is available in API
                    version 67.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">GreaterThanOrEqualTo</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">HasError</samp>—This value is
                    available in API version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HasNoValue</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value has no value. This value is available in API version
                    67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">HasValue</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value has a value. This value is available in API version
                    67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">In</samp>— This value is
                    available in API version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsAfter</samp>—Returns <samp class="codeph nolang">true</samp> if the date value is
                    after the specified date. This value is available in API
                    version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsAnniversaryOfToday</samp>—Returns <samp class="codeph nolang">true</samp> if the month and day
                    of the date value match today's month and day. This value is
                    available in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsBefore</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value is before the specified date. This value is available
                    in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsBlank</samp>—A text value
                    with zero characters or with only whitespace. Use to
                    determine whether a text field or variable is blank. For
                    other data type values, use to determine whether a field or
                    variable is null. This value is available in API version
                    61.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsChanged—</samp> This value
                    is available in API version 52.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsEmpty</samp>—An empty
                    collection. This value is available in API version 61.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsLastMonth</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value falls within the previous calendar month. This value
                    is available in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsNextMonth</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value falls within the next calendar month. This value is
                    available in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsNotAnniversaryOfToday</samp>—Returns <samp class="codeph nolang">true</samp> if the month and day
                    of the date value don't match today's month and day. This
                    value is available in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsNull</samp>—A value that is
                    either not set or references no value. Use to determine
                    whether a field or variable value is set to no value.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsOn</samp>—Returns <samp class="codeph nolang">true</samp> if the date value is
                    the same as the specified date. This value is available in
                    API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsThisMonth</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value falls within the current calendar month. This value is
                    available in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsToday</samp>—Returns <samp class="codeph nolang">true</samp> if the date value is
                    today's date. This value is available in API version 67.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsTomorrow</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value is tomorrow's date. This value is available in API
                    version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IsYesterday</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value is yesterday's date. This value is available in API
                    version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LastNumberOfDays</samp>—Returns <samp class="codeph nolang">true</samp> if the date value
                    falls within the last N days, including today. If N is a
                    decimal, only the integer portion is used. This value is
                    available in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LastNumberOfMonths</samp>—Returns <samp class="codeph nolang">true</samp> if the date value
                    falls within the last N calendar months, excluding the
                    current month. If N is a decimal, only the integer portion
                    is used. This value is available in API version 67.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LastNumberOfYears</samp>—Returns <samp class="codeph nolang">true</samp> if the date value
                    falls within the last N calendar years, excluding the
                    current year. If N is a decimal, only the integer portion is
                    used. This value is available in API version 67.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LastYear</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value falls within the previous calendar year. This value is
                    available in API version 67.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">LessThan</samp></li>

                  <li class="li"><samp class="codeph nolang">LessThanOrEqualTo</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">NextNumberOfDays</samp>—Returns <samp class="codeph nolang">true</samp> if the date value
                    falls within the next N days, including today. If N is a
                    decimal, only the integer portion is used. This value is
                    available in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NextNumberOfMonths</samp>—Returns <samp class="codeph nolang">true</samp> if the date value
                    falls within the next N calendar months, excluding the
                    current month. If N is a decimal, only the integer portion
                    is used. This value is available in API version 67.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NextYear</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value falls within the next calendar year. This value is
                    available in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">None</samp>— Save a flow with
                    an incomplete condition, so you can finish building the flow
                    later. This value is available in API version 58.0 and
                    later.
                  </li>

                  <li class="li"><samp class="codeph nolang">NotEqualTo</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">NotIn</samp>— This value is
                    available in API version 56.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">StartsWith</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ThisYear</samp>—Returns
                    <samp class="codeph nolang">true</samp> if the date
                    value falls within the current calendar year. This value is
                    available in API version 67.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WasSelected</samp>— Requires a
                    choice on the left side.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WasSet</samp>— This value is
                    available in API version 30.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WasVisited</samp>— Requires a
                    node on the left side.
                  </li>

                </ul>
                See <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.flow_ref_operators.htm&amp;language=en_US" target="_blank">Flow Operators</a>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e7788" data-title="Field Name"><span class="keyword parmname">rightValue</span></td>

              <td class="entry" headers="d950606e7791" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e7794" data-title="Description">Unique name of an element or the actual value, such as text or a
                number, for the right side of the condition expression.</td>

            </tr>

          </tbody>

        </table>

## FlowDataLookup

Defines a data lookup in the flow's Start element. It extends [FlowElement](#FlowElement) and inherits all its fields. This metadata type is available in API version 68.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| lookupField | string | Required. The field on the object specified by sourceApiName to use for the lookup join. |
| lookupReference | string | Required. A reference expression for the lookup relationship from the primary record. |
| sourceApiName | string | Required. The API name of the object on which the data lookup is defined. |
| sourceType | string | Required. The type of the object specified by sourceApiName. Valid value is DataModelObject. |

## FlowCustomProperty

Defines the name and value of a custom property in a flow. This metadata type is available in API version 63.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e8366">Field Name</th>

              <th class="featureTableHeader  " id="d950606e8369">Field Type</th>

              <th class="featureTableHeader  " id="d950606e8372">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e8366" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d950606e8369" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e8372" data-title="Description">Required. Unique name for the custom property associated with the
                flow.</td>


            </tr>

            <tr>
              <td class="entry" headers="d950606e8366" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d950606e8369" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e8372" data-title="Description">Defines the value of the custom property associated with the
                flow. When the FlowCustomProperty’s name is set to<samp class="codeph nolang"> ScreenProgressIndicator</samp>, valid
                values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">“Location":"Top","Type":"Simple”</samp></li>

                  <li class="li"><samp class="codeph nolang">"Location":"Footer","Type":"Simple"</samp></li>

                  <li class="li"><samp class="codeph nolang">"Location":"Top","Type":"Path”</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## FlowConnector

Connectors determine the order in which the nodes of the flow are executed. A connector defines and links to the subsequent node. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| isGoTo | boolean | Make the connector a Go To Connector by setting this value to true. The default value is false. This value is available in API version 53.0 and later. See [Flow Connectors](https://help.salesforce.com/s/articleView?id=platform.flow_ref_connectors.htm&type=5&language=en_US). |
| targetReference | string | Required. Which node to execute after completing the current node. |

## FlowCollectionMapItem

Defines the rule to assign a value to the field reference. This metadata type is available in API version 51.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToFieldReference | string | Required. Specifies the reference to the field to which the specified operator is applied. |
| operator | [FlowAssignmentOperator](#FlowAssignmentOperator) (enumeration of type string) | Required. Applies to the variable reference in the assignToFieldReference field. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Required. Defines the value that the operator applies to the variable reference in the assignToFieldReference field. |

## FlowDataTypeMapping

This data type mapping defines the specific sObject data type for input and out values that have the generic sObject data type. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 48.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| apexClass | string | The name of the Apex class. This field is available in API version 61.0 and later. |
| typeName | string | Required. API name of the input or output variable. The T\_\_ prefix is required for input variables. The U\_\_ prefix is required for output variables. For example, T\_\_inputCollection represents the API name of the input variable inputCollection. |
| typeValue | string | API name of the specific sObject data type that this value maps to. For example, Account. |

## FlowConstant

A constant resource defines a fixed value that can be used throughout your flow. It extends [FlowElement](#FlowElement) and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e8720">Field Name</th>

              <th class="featureTableHeader  " id="d950606e8723">Field Type</th>

              <th class="featureTableHeader  " id="d950606e8726">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e8720" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d950606e8723" data-title="Field Type">FlowDataType (enumeration of type string)</td>

              <td class="entry" headers="d950606e8726" data-title="Description">Required. Valid types are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Time</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e8720" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d950606e8723" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e8726" data-title="Description">Default value of the constant. This field can’t have merge
                fields, nor can it reference another resource besides
                <span class="keyword parmname">$GlobalConstant.EmptyString</span>.
              </td>

            </tr>

          </tbody>

        </table>

## FlowDecision

A node that evaluates a set of rules and routes the flow execution based on the first rule that evaluates to true. It extends [FlowNode](#FlowNode) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| attributes | [FlowAttribute](#FlowAttribute)\[\] | An array of attributes for the decision. This field is available in API version 65.0 and later. |
| defaultConnector | [FlowConnector](#FlowConnector) | Specifies which node to execute if none of the rules evaluate to true. |
| defaultConnectorLabel | string | Label for the default connector. |
| rules | [FlowRule](#FlowRule)\[\] | An array of rules for the decision. The rules are evaluated in the order that they’re listed, and the connector of the first true rule is used. If no rules are true, then the default connector is used. In Flow Builder, rules are referred to as decision outcomes. |

## FlowAttribute

Defines an attribute that's shared across multiple Flow metadata subtypes. Available in API version 65.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e8920">Field Name</th>

              <th class="featureTableHeader  " id="d950606e8923">Field Type</th>

              <th class="featureTableHeader  " id="d950606e8926">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e8920" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d950606e8923" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e8926" data-title="Description">The value of the flow attribute.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e8920" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d950606e8923" data-title="Field Type">FlowAttributeType (enumeration of type string)</td>

              <td class="entry" headers="d950606e8926" data-title="Description">Specifies the type of the flow attribute value. Valid values are:<ul class="ul bulletList">
                  <li class="li">LlmDescription</li>

                  <li class="li">LlmPrompt</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## FlowDynamicChoiceSet

Retrieves data or metadata from an object and dynamically generates a set of choices at run time. It extends [FlowElement](#FlowElement) and inherits all its fields. Depending on the fields that are set, this element represents a record choice or a picklist choice.

- A record choice dynamically generates choices based on records that meet specified filter criteria. If a dynamic choice doesn’t have the picklistField and picklistObject parameters set, it’s a record choice and it can’t have a data type of Picklist or Multipicklist.
- A picklist choice dynamically generates choices based on the available values for a picklist or multi-select picklist field. If a dynamic choice has the picklistField and picklistObject parameters set, it’s a picklist choice and it must have a data type of Picklist or Multipicklist.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e9036">Field Name</th>

              <th class="featureTableHeader  " id="d950606e9039">Field Type</th>

              <th class="featureTableHeader  " id="d950606e9042">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname">collectionReference</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9042" data-title="Description">The collection that’s used to generate choices. This field is
                available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">FlowDataType (enumeration of type string)</td>

              <td class="entry" headers="d950606e9042" data-title="Description">Required. Valid types are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Multipicklist</samp>—Picklist
                    choices only
                  </li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Picklist</samp>—Picklist
                    choices only
                  </li>

                  <li class="li"><samp class="codeph nolang">Record</samp></li>

                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li"><samp class="codeph nolang">Time</samp></li>

                </ul>
                <p class="p"><span class="keyword parmname">Picklist</span> and
                  <span class="keyword parmname">Multipicklist</span> are available in API
                  version 35.0 and later. <span class="keyword parmname">Record</span> is available
                  in API version 54.0 and later.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname">displayField</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9042" data-title="Description">Required for record choices. Specifies the object field. The
                values of the object field are displayed to the user as choice
                labels for selecting a record.<p class="p">For example, for an account, if you
                  want the dynamically generated choices to be displayed as the
                  account names from the records that are retrieved from the
                  database, specify <samp class="codeph nolang">Name</samp> in
                  <span class="keyword parmname">displayField</span>.
                </p>
                <p class="p">Not supported for
                  picklist choices. Picklist choices always display the labels for
                  the retrieved picklist values.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">
                <a class="xref" href="#FlowRecordFilter">FlowRecordFilter</a>[]
              </td>

              <td class="entry" headers="d950606e9042" data-title="Description">An array of filters to apply to the records retrieved from the
                database. For example, filter accounts to include only the accounts
                that were created in the past three months.<p class="p">Not supported for
                  picklist choices.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname" id="field_limit_name"><a name="field_limit_name"><!-- --></a>limit</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e9042" data-title="Description">
                <span class="ph" id="field_limit_desc"><a name="field_limit_desc"><!-- --></a>Maximum number of choices to include in
                  the generated set of choices. Maximum and default:
                  200.</span>
                <p class="p">If <span class="keyword parmname">sortField</span> and
                  <span class="keyword parmname">sortOrder</span> are also specified, the
                  records are sorted before the <span class="keyword parmname">limit</span> takes
                  effect.
                </p>
                <p class="p">This field is available in API version 25.0 and
                  later.</p>
                <p class="p">This field is nillable in API version 45.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname">object</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9042" data-title="Description">Required for record choices. The object whose fields you want to
                retrieve from the database and use to generate the set of choices.
                For example, use “Account” to dynamically generate choices from the
                information in account records in the database.<p class="p">Not supported for
                  picklist choices.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname">outputAssignments</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">
                <a class="xref" href="#FlowOutputFieldAssignment">FlowOutputFieldAssignment</a>[]
              </td>

              <td class="entry" headers="d950606e9042" data-title="Description">An array that assigns fields from the user-selected record to
                variables that can be used elsewhere in the flow. For example, when
                the user selects an account name from the dynamically generated list
                of choice options, outputAssignments can assign the ID and
                AnnualRevenue from the user-selected account to variables that you
                specify.<p class="p">Not supported for picklist choices.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname" id="picklistField_name"><a name="picklistField_name"><!-- --></a>picklistField</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9042" data-title="Description">
                <span class="ph" id="picklistField_desc"><a name="picklistField_desc"><!-- --></a>Required for picklist choices. The
                  field whose available values you want to retrieve from the
                  database and use to generate the picklist choice. For example,
                  use “Industry” to dynamically generate one choice for each
                  available value on the Industry picklist field.</span>
                <p class="p">Not supported for record choices.</p>
                <p class="p">This field is available
                  in API version 35.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname" id="picklistObject_name"><a name="picklistObject_name"><!-- --></a>picklistObject</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9042" data-title="Description">
                <span class="ph" id="picklistObject_desc"><a name="picklistObject_desc"><!-- --></a>Required for picklist choices. The
                  object whose field metadata you want to retrieve from the
                  database and use to generate the picklist choice. For example,
                  use “Account” to dynamically generate choices from a picklist
                  field on the Account object.</span>
                <p class="p">Not supported for record
                  choices.</p>
                <p class="p">This field is available in API version 35.0 and
                  later. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname" id="field_sortField_name"><a name="field_sortField_name"><!-- --></a>sortField</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9042" data-title="Description">
                <span class="ph" id="field_sortField_desc"><a name="field_sortField_desc"><!-- --></a>Field that’s used for sorting
                  records that meet the filter criteria. If this field isn’t
                  specified, the returned records aren’t sorted.</span>
                <p class="p"><span class="ph" id="field_sortField_sortable"><a name="field_sortField_sortable"><!-- --></a>You can only sort records by
                    fields that have the <span class="keyword parmname">Sort</span> API field
                    property, as specified in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/" target="_blank" title="HTML (New Window)">SOAP
                      API</a>.</span></p>
                <p class="p">Not supported for picklist
                  choices.</p>
                <p class="p">This field is available in API version 25.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname" id="field_sortOrder_name"><a name="field_sortOrder_name"><!-- --></a>sortOrder</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">SortOrder (enumeration of type string)</td>

              <td class="entry" headers="d950606e9042" data-title="Description">
                <span class="ph" id="field_sortOrder_desc"><a name="field_sortOrder_desc"><!-- --></a>Order in which to sort the records.
                  If this field isn’t specified, then the results aren’t
                  sorted.</span>
                <p class="p" id="field_sortOrder_values"><a name="field_sortOrder_values"><!-- --></a>Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Asc</samp>—Ascending
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Desc</samp>—Descending
                  </li>

                </ul>
                <p class="p">Not supported for picklist choices.</p>
                <p class="p">This field is
                  available in API version 25.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9036" data-title="Field Name"><span class="keyword parmname">valueField</span></td>

              <td class="entry" headers="d950606e9039" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9042" data-title="Description">Stored value for the choice, which can differ from what is
                displayed to the user as the choice options
                (<span class="keyword parmname">displayField</span>). For example, the
                <span class="keyword parmname">displayField</span> could be the account “Name”
                while the valueField is the account “Id.”<p class="p">Not supported for
                  picklist choices. Picklist choices always store the API value
                  for the retrieved picklist values.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowElement

Base class for all flow elements. This class is an abstract class. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Description of the flow element. |
| name | string | Unique name of the flow element. |

## FlowElementReferenceOrValue

Defines a reference to an existing element or a particular value that you specify. Make sure that you specify only _one_ of the fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e9448">Field Name</th>

              <th class="featureTableHeader  " id="d950606e9451">Field Type</th>

              <th class="featureTableHeader  " id="d950606e9454">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">apexValue</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify a JSON response value of an
                Apex-defined record. Use this field only for
                <span class="keyword parmname">FlowScreenFieldInputParameter</span> and
                <span class="keyword parmname">FlowActionCallInputParameter</span>. If you want
                to specify a different data type or element reference, don’t use
                this field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">booleanValue</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify a boolean value. If you want to specify
                a different data type or element reference, don’t use this
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">complexValue</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9454" data-title="Description">When <span class="keyword parmname">complexValueType</span> is specified, use this
                field to specify flow resources and fields in the data structure.
                Use these fields to describe the data structure: <a name="ul_rq3_p44_1fc"><!-- --></a>
                <ul class="ul bulletList" id="ul_rq3_p44_1fc">
                  <li class="li">
                    <samp class="codeph nolang">fieldReference</samp>—The list
                    of field API names.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">objectType</samp>—The object
                    type, sObject or Apex.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">type</samp>—The API name of
                    the sObject or Apex class.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">elementReference</samp>—The
                    API name of the flow resource that contains the list of
                    fields specified in <samp class="codeph nolang">fieldReference</samp>.
                  </li>

                </ul>
                This field is available in API version 63.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">complexValueType</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type"> FlowComplexValueType (enumeration of type string)</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify the type of data structure to
                reference. Valid values are:<a name="ul_gkt_14t_tdc"><!-- --></a>
                <ul class="ul bulletList" id="ul_gkt_14t_tdc">
                  <li class="li">
                    <samp class="codeph nolang">ComplexObjectFieldDetails</samp>—Use when referencing
                    a field and need the label and type in addition to the API
                    name.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">JoinDefinition</samp>—When
                    <samp class="codeph nolang">InnerJoin</samp> is
                    specified in <span class="keyword parmname">transformType</span>, indicates
                    flow resources for source and target collections, join keys,
                    selected fields to join. and field mappings in a join
                    transformation. <samp class="codeph nolang">JoinDefinition</samp> isn't a valid value for <a class="xref" href="#FlowInlineTransform">FlowInlineTransform</a>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FieldReference</samp>—Use this
                    field to define the flow resource and its fields referenced
                    in the flow.
                  </li>

                </ul>
                This field is available in API version 63.0 and later. Use
                <span class="keyword parmname">complexValue</span> to specify the data
                structure.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">dateTimeValue</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">dateTime</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify a dateTime value. If you want to
                specify a different data type or element reference, don’t use this
                field. This field is available in API version 30.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">dateValue</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">date</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify a date value. If you want to specify a
                different data type or element reference, don’t use this
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">elementReference</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify the name of an existing flow resource.
                If you want to specify a value instead of an element reference,
                don’t use this field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">formulaDataType</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">FlowDataType (enumeration of type string)</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify the formula result’s data type of the
                transformed data. Corresponds to the target data field in Flow
                Builder. This field requires the
                <span class="keyword parmname">formulaExpression</span> field. This field is
                available in API version 59.0 and later. See <a class="xref" href="#FlowTransform">FlowTransform</a>
                <p class="p">Valid values are:</p>
                <a name="ul_tzf_dmw_xcc"><!-- --></a>
                <ul class="ul bulletList" id="ul_tzf_dmw_xcc">
                  <li class="li"><samp class="codeph nolang">Apex</samp></li>

                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">sObject</samp>—This value
                    corresponds to a record variable.
                  </li>

                  <li class="li"><samp class="codeph nolang">Time</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">formulaExpression</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify the formula expression that transforms
                the data in the flow. In Flow Builder, it corresponds to the target
                data field in the Transform element. This field requires the
                <span class="keyword parmname">formulaDataType</span> field. This field is
                available in API version 59.0 and later. See <a class="xref" href="#FlowTransform">FlowTransform</a>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">numberValue</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">double</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify a double value. If you want to specify
                a different data type or element reference, don’t use this
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">setupReference</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify the name of an existing setup
                reference. Required for Omni-Channel elements. If you want to
                specify a value instead of a setup reference, don’t use this field.
                Required when <span class="keyword parmname">setupReferenceType</span> is
                specified.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">setupReferenceType</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify the type of setup reference. Required
                when setupReference is specified.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">sobjectValue</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify a JSON response value of an sObject
                record. Use this field only for
                <span class="keyword parmname">FlowScreenFieldInputParameter</span> and
                <span class="keyword parmname">FlowActionCallInputParameter</span>. If you want
                to specify a different data type or element reference, don’t use
                this field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">stringValue</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify a string value. If you want to specify
                a different data type or element reference, don’t use this
                field.<p class="p">When the <a class="xref" href="#FlowMetadataValue">FlowMetadataValue</a>'s
                  <span class="keyword parmname">name</span> field is set to <samp class="codeph nolang">SendNoApproverEmails</samp>, valid
                  values are <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp> and are
                  case-insensitive.
                </p>
                <p class="p">When the <a class="xref" href="#FlowMetadataValue">FlowMetadataValue</a>'s
                  <span class="keyword parmname">name</span> field is set to <samp class="codeph nolang">BuilderType</samp> or <samp class="codeph nolang">OriginalBuilderType</samp>, the valid
                  value is <samp class="codeph nolang">LightningFlowBuilder</samp>. The value is reserved for
                  internal use.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">transform</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type"><a class="xref" href="#FlowInlineTransform">FlowInlineTransform</a></td>

              <td class="entry" headers="d950606e9454" data-title="Description">Use this field to specify a value for an inline data
                transformation. This field is available in API version 62.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9448" data-title="Field Name"><span class="keyword parmname">transformValueReference</span></td>

              <td class="entry" headers="d950606e9451" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9454" data-title="Description">Reserved for future use. </td>

            </tr>

          </tbody>

        </table>

## FlowEnd

Marks where a path in a flow ends. Corresponds to the End element in Flow Builder. Available only in flows that use the Auto-Layout canvas.

FlowEnd extends [FlowNode](#FlowNode) and inherits all its fields. This metadata type is available in API version 68.0 and later.

If a flow has 1 or more End elements, every path in the flow must end with an End element.

## FlowExitRule

Defines the conditions and logic that enables an exit rule to evaluate to true. It extends [FlowElement](#FlowElement) and inherits all of its fields. This metadata type is available in API version 62.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e9893">Field Name</th>

              <th class="featureTableHeader  " id="d950606e9896">Field Type</th>

              <th class="featureTableHeader  " id="d950606e9899">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e9893" data-title="Field Name"><span class="keyword parmname">conditions</span></td>

              <td class="entry" headers="d950606e9896" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e9899" data-title="Description">An array of conditions for the exit rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9893" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d950606e9896" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9899" data-title="Description">
                <p class="p">Required. Label for the exit rule.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9893" data-title="Field Name"><span class="keyword parmname">logicalOperator</span></td>

              <td class="entry" headers="d950606e9896" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e9899" data-title="Description">Required. Logical operator in conditions for the exit rule. Valid
                values are:<a name="ul_j5c_2mw_xcc"><!-- --></a>
                <ul class="ul bulletList" id="ul_j5c_2mw_xcc">
                  <li class="li">
                    <samp class="codeph nolang">and</samp>—Evaluates to
                    <samp class="codeph nolang">true</samp> only if all
                    its conditions evaluate to true
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">or</samp>—Evaluates to <samp class="codeph nolang">true</samp> if any of its
                    conditions evaluate to true
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e9893" data-title="Field Name"><span class="keyword parmname">ruleOrder</span></td>

              <td class="entry" headers="d950606e9896" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e9899" data-title="Description">Indicates how the exit rule is ordered against other exit rules.
                The <span class="keyword parmname">ruleOrder</span> value must be unique within the
                flow.</td>

            </tr>

          </tbody>

        </table>

## FlowExperiment

A node that routes the flow execution based on a specified experiment distribution percentage. It extends [FlowNode](#FlowNode) and inherits all its fields. This metadata type is available in API version 61.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e10015">Field Name</th>

              <th class="featureTableHeader  " id="d950606e10018">Field Type</th>

              <th class="featureTableHeader  " id="d950606e10021">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e10015" data-title="Field Name"><span class="keyword parmname">duration</span></td>

              <td class="entry" headers="d950606e10018" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e10021" data-title="Description">The amount of time that the experiment runs. This field is
                available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10015" data-title="Field Name"><span class="keyword parmname">durationUnit</span></td>

              <td class="entry" headers="d950606e10018" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e10021" data-title="Description">The unit of measurement for experiment duration. Valid values
                are:<a name="ul_zmd_wr2_p2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_zmd_wr2_p2c">
                  <li class="li">Minutes</li>

                  <li class="li">Hours</li>

                  <li class="li">Days</li>

                  <li class="li">Weeks</li>

                  <li class="li">Months</li>

                </ul>
                This field is available in API version 64.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10015" data-title="Field Name"><span class="keyword parmname">paths</span></td>

              <td class="entry" headers="d950606e10018" data-title="Field Type">
                <a class="xref" href="#FlowExperimentPath">FlowExperimentPath</a>[]
              </td>

              <td class="entry" headers="d950606e10021" data-title="Description">An array of flow experiment paths.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10015" data-title="Field Name"><span class="keyword parmname">testGroupPercentage</span></td>

              <td class="entry" headers="d950606e10018" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e10021" data-title="Description">Specifies the distribution percentage of the test group. A valid
                number in the range 0-99. This field is available in API version
                64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10015" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d950606e10018" data-title="Field Type">FlowExperimentType</td>

              <td class="entry" headers="d950606e10021" data-title="Description">Required. The type of experiment. Valid value is:<a name="ul_llp_d4w_xcc"><!-- --></a>
                <ul class="ul bulletList" id="ul_llp_d4w_xcc">
                  <li class="li">Random</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## FlowExperimentPath

Defines an experiment path. It extends [FlowElement](#FlowElement) and inherits all its fields. This metadata type is available in API version 61.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| connector | [FlowConnector](#FlowConnector) | Specifies which node to execute after this experiment path. |
| label | string | Required. Label for the path. |
| percentage | int | Required. The distribution percentage for this path. |

## FlowFormula

Calculates a value using functions and elements in the flow. It extends [FlowElement](#FlowElement) and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e10233">Field Name</th>

              <th class="featureTableHeader  " id="d950606e10236">Field Type</th>

              <th class="featureTableHeader  " id="d950606e10239">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e10233" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d950606e10236" data-title="Field Type">FlowDataType (enumeration of type string)</td>

              <td class="entry" headers="d950606e10239" data-title="Description">
                <span class="ph" id="formula_datatype_desc"><a name="formula_datatype_desc"><!-- --></a>The data type for the
                  formula.</span>
                <span class="ph" id="formula_datatype_desc2"><a name="formula_datatype_desc2"><!-- --></a>Valid values are:</span><a name="formula_datatype_desc3"><!-- --></a>
                <ul class="ul bulletList" id="formula_datatype_desc3">
                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>
                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li"><samp class="codeph nolang">Time</samp></li>

                </ul>
                <p class="p"><span class="keyword parmname">dataType</span> defaults to <samp class="codeph nolang">Number</samp> if it isn’t defined in a
                  formula.</p>
                <p class="p">This field is available in API version 31.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10233" data-title="Field Name"><span class="keyword parmname">expression</span></td>

              <td class="entry" headers="d950606e10236" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e10239" data-title="Description">Required. Salesforce formula expression. The return value must
                match the data type. For API version 30.0 and earlier, the return
                value must be numeric.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10233" data-title="Field Name"><span class="keyword parmname">scale</span></td>

              <td class="entry" headers="d950606e10236" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e10239" data-title="Description">Scale of the return value, specifically, the number of digits to
                the right of the decimal point. Available only when the data type is
                Number or Currency. Corresponds to the Decimal Places field in Flow
                Builder.</td>

            </tr>

          </tbody>

        </table>

## FlowIcon

Allows a resource to include an icon. This metadata type is available in API version 64.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| iconName | String | The name of the selected Salesforce Lightning Design System icon. This field is available in API version 64.0 and later. |

## FlowInlineTransform

Specifies how to transform source data to target data in an Action element within a flow. This metadata type is available in API version 62.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e10408">Field Name</th>

              <th class="featureTableHeader  " id="d950606e10411">Field Type</th>

              <th class="featureTableHeader  " id="d950606e10414">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e10408" data-title="Field Name"><span class="keyword parmname">apexClass</span></td>

              <td class="entry" headers="d950606e10411" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e10414" data-title="Description">The Apex class of the target data after transformation if its
                data type is <samp class="codeph nolang">Apex</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10408" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d950606e10411" data-title="Field Type">FlowDataType (enumeration of type string)</td>

              <td class="entry" headers="d950606e10414" data-title="Description">Required. Specifies the data type of the transformed data. In
                Flow Builder, it corresponds to the target data. Valid types are:<a name="ul_f2d_212_mgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_f2d_212_mgc">
                  <li class="li"><samp class="codeph nolang">Apex</samp></li>

                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Multipicklist</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">Picklist</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">sObject</samp>—This value
                    corresponds to a record variable.
                  </li>

                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li"><samp class="codeph nolang">Time</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10408" data-title="Field Name"><span class="keyword parmname">isCollection</span></td>

              <td class="entry" headers="d950606e10411" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e10414" data-title="Description">Indicates whether the variable is a collection of values. The
                default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10408" data-title="Field Name"><span class="keyword parmname">transformValues</span></td>

              <td class="entry" headers="d950606e10411" data-title="Field Type">
                <a class="xref" href="#FlowTransformValue">FlowTransformValue</a>[]
              </td>

              <td class="entry" headers="d950606e10414" data-title="Description">An array of values for data transformation.</td>

            </tr>

          </tbody>

        </table>

## FlowInputFieldAssignment

Assigns the value for a record field based on a resource or static value. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Required. The name of the field to assign a value to when a record is created or updated. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | The value to assign to the field. |

## FlowInputValidationRule

Validation rules verify that the data entered by the user meets the specified requirements. If the validation rule evaluates to false, then the specified error message is displayed.

| Field Name | Field Type | Description |
| --- | --- | --- |
| errorMessage | string | Required. The error message to display when formulaExpression is false. |
| formulaExpression | string | Required. A formula that’s used to validate the user input. |

## FlowLoop

A construct for iterating through a collection. It extends [FlowNode](#FlowNode) and inherits all its fields. FlowLoop is available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e10704">Field Name</th>

              <th class="featureTableHeader  " id="d950606e10707">Field Type</th>

              <th class="featureTableHeader  " id="d950606e10710">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e10704" data-title="Field Name"><span class="keyword parmname">assignNextValueToReference</span></td>

              <td class="entry" headers="d950606e10707" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e10710" data-title="Description">The variable that’s assigned to the current value in the
                collection before navigating to the target of
                <span class="keyword parmname">nextValueConnector</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10704" data-title="Field Name"><span class="keyword parmname">collectionReference</span></td>

              <td class="entry" headers="d950606e10707" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e10710" data-title="Description">The collection being looped through.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10704" data-title="Field Name"><span class="keyword parmname">iterationOrder</span></td>

              <td class="entry" headers="d950606e10707" data-title="Field Type">iterationOrder (enumeration of type string)</td>

              <td class="entry" headers="d950606e10710" data-title="Description">Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Asc</samp>—Iterate through the
                    collection in the order the values are listed (first to
                    last).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Desc</samp>—Iterate through
                    the collection in the reverse order the values are listed
                    (last to first).
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10704" data-title="Field Name"><span class="keyword parmname">nextValueConnector</span></td>

              <td class="entry" headers="d950606e10707" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e10710" data-title="Description">A reference to the next element in the collection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10704" data-title="Field Name"><span class="keyword parmname">noMoreValuesConnector</span></td>

              <td class="entry" headers="d950606e10707" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e10710" data-title="Description">The element to navigate to when all entries in the collection
                have been iterated through.</td>

            </tr>

          </tbody>

        </table>

## FlowMetadataValue

Defines contextual information that can be passed between elements in a flow. Flow metadata values can be used in an application that produces or consumes flows. FlowMetadataValue is available in API version 31.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e10830">Field Name</th>

              <th class="featureTableHeader  " id="d950606e10833">Field Type</th>

              <th class="featureTableHeader  " id="d950606e10836">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e10830" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d950606e10833" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e10836" data-title="Description">Required. Name for the metadata value. This name doesn’t need to
                be unique across all elements. <p class="p">To specify that a flow approval
                  process send no email notifications to approvers, use
                  SendNoApproverEmails .</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e10830" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d950606e10833" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e10836" data-title="Description">Reference or value for the metadata value.</td>

            </tr>

          </tbody>

        </table>

## FlowNode

A node is a type of element that’s visible in the flow diagram. It extends [FlowElement](#FlowElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| elementSubtype | FlowElementSubtype (enumeration of type string) | Reserved for internal use. |
| group | string | Name of the group that the node belongs to. Available in API version 68.0 and later. |
| label | string | Name of the node. This non-unique label is different from the unique name of the node, which is inherited from [FlowElement](#FlowElement). |
| locationX | int | Required. Horizontal location of the node, in pixels from the left. In API version 64.0 and later, if a flow is saved in auto-layout, this field is set to 0. |
| locationY | int | Required. Vertical location of the node, in pixels from the top. In API version 64.0 and later, if a flow is saved in auto-layout, this field is set to 0. |

## FlowNodeGroup

A group of flow nodes for organizational purposes. It extends FlowNode and inherits all its fields. This metadata type is available in API version 68.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e11019">Field Name</th>

              <th class="featureTableHeader  " id="d950606e11022">Field Type</th>

              <th class="featureTableHeader  " id="d950606e11025">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e11019" data-title="Field Name"><span class="keyword parmname">faultConnector</span></td>

              <td class="entry" headers="d950606e11022" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e11025" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11019" data-title="Field Name"><span class="keyword parmname">groupType</span></td>

              <td class="entry" headers="d950606e11022" data-title="Field Type">GroupType (enumeration of type string)</td>

              <td class="entry" headers="d950606e11025" data-title="Description">Required. Type of group. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">generic</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11019" data-title="Field Name"><span class="keyword parmname">sourceBranchApiName</span></td>

              <td class="entry" headers="d950606e11022" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11025" data-title="Description">Connector branch that the group is on. Valid values depend on the
                <span class="keyword parmname">sourceReference</span> value:<ul class="ul bulletList">
                  <li class="li">Start (immediate path): <samp class="codeph nolang">immediate</samp>
                  </li>

                  <li class="li">Start (scheduled path): The API name of the path.</li>

                  <li class="li">Standard element: <samp class="codeph nolang">regular</samp>
                  </li>

                  <li class="li">Decision (outcome): The API name of the outcome.</li>

                  <li class="li">Decision (default path): <samp class="codeph nolang">default</samp>
                  </li>

                  <li class="li">Loop (for each item): <samp class="codeph nolang">forEach</samp>
                  </li>

                  <li class="li">Loop (after last item): <samp class="codeph nolang">noMoreValues</samp>
                  </li>

                  <li class="li">Fault path: <samp class="codeph nolang">fault</samp>
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11019" data-title="Field Name"><span class="keyword parmname">sourceReference</span></td>

              <td class="entry" headers="d950606e11022" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11025" data-title="Description">Name of the node immediately preceding the group. If the
                preceding node is the Start element, use <samp class="codeph nolang">__Start</samp>.</td>

            </tr>

          </tbody>

        </table>

## FlowOrchestratedStage

A stage node that contains steps in an orchestration. It extends [FlowNode](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm#FlowNode) and inherits all its fields. This metadata type is available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e11169">Field Name</th>

              <th class="featureTableHeader  " id="d950606e11172">Field Type</th>

              <th class="featureTableHeader  " id="d950606e11175">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e11169" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e11172" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e11175" data-title="Description">Specifies which node to execute after this stage.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11169" data-title="Field Name"><span class="keyword parmname">exitActionInputParameters</span></td>

              <td class="entry" headers="d950606e11172" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStepExitActionInputParameter">FlowStageStepExitActionInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e11175" data-title="Description">An array of input parameters from the stage to the evaluation
                flow. These parameters specify an exit condition for the
                stage.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11169" data-title="Field Name"><span class="keyword parmname">exitActionName</span></td>

              <td class="entry" headers="d950606e11172" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11175" data-title="Description">The name of the evaluation flow used as an exit condition for the
                stage.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11169" data-title="Field Name"><span class="keyword parmname">exitActionOutputParameters</span></td>

              <td class="entry" headers="d950606e11172" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStepExitActionOutputParameter">FlowStageStepExitActionOutputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e11175" data-title="Description">An array of output parameters from the evaluation flow to the
                stage. These parameters specify an exit condition for the
                stage.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11169" data-title="Field Name"><span class="keyword parmname">exitActionType</span></td>

              <td class="entry" headers="d950606e11172" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e11175" data-title="Description">The type of the evaluation flow for the custom exit condition.
                Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">EvaluationFlow</samp></li>

                  <li class="li">
                    <p class="p">This value is available in API version 61.0 and
                      later.</p>

                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11169" data-title="Field Name"><span class="keyword parmname">exitConditionLogic</span></td>

              <td class="entry" headers="d950606e11172" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11175" data-title="Description">Defines how the stage exit conditions are evaluated. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">And</samp></li>

                  <li class="li"><samp class="codeph nolang">Or</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom logic, such as (1 AND (2
                      OR 3))</samp></li>

                  <li class="li"><samp class="codeph nolang">Formula</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11169" data-title="Field Name"><span class="keyword parmname">exitConditions</span></td>

              <td class="entry" headers="d950606e11172" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e11175" data-title="Description">An array of requirements that must be met to exit the
                stage.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11169" data-title="Field Name"><span class="keyword parmname">faultConnector</span></td>

              <td class="entry" headers="d950606e11172" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e11175" data-title="Description">Not used.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11169" data-title="Field Name"><span class="keyword parmname">stageSteps</span></td>

              <td class="entry" headers="d950606e11172" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStep">FlowStageStep</a>[]
              </td>

              <td class="entry" headers="d950606e11175" data-title="Description">An array of stage step resources.</td>

            </tr>

          </tbody>

        </table>

## FlowOutputFieldAssignment

Assigns a record field’s value to a variable that can be used elsewhere in the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToReference | string | Required. Reference to the variable where you want to store the value of the record field. |
| field | string | Required. Name of the field whose value is to be assigned after a record lookup. |

## FlowRelatedRecordLookup (Beta)

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This feature is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/ "HTML (New Window)") or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/ "HTML (New Window)"). Use of this pilot or beta service is at the Customer's sole discretion.

Finds records in the database that are related to the records specified in FlowRecordLookup and stores their field values in the flow. Corresponds to a Get Records element in Flow Builder. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e11456">Field Name</th>

              <th class="featureTableHeader  " id="d950606e11459">Field Type</th>

              <th class="featureTableHeader  " id="d950606e11462">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">filterLogic</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11462" data-title="Description">The filter logic that’s applied to the filter condition
                requirements. To require all conditions, use <samp class="codeph nolang">AND</samp>. To require any conditions, use
                <samp class="codeph nolang">OR</samp>. For custom condition
                logic, enter the entire logic string. For example, <samp class="codeph nolang">1 AND 2 OR (3 AND 4)</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type">
                <a class="xref" href="#FlowRecordFilter">FlowRecordFilter</a>[]
              </td>

              <td class="entry" headers="d950606e11462" data-title="Description">An array that specifies the criteria used to select the record
                from the database.<p class="p">If the filters return more than one record,
                  they’re sorted according to the specified
                  <span class="keyword parmname">sortField</span> and
                  <span class="keyword parmname">sortOrder</span>. If
                  <span class="keyword parmname">outputReference</span> specifies a
                  non-collection record variable or if
                  <span class="keyword parmname">getFirstRecordOnly</span> is <samp class="codeph nolang">true</samp>, only the first record in
                  the sorted list is selected.
                </p>
                <p class="p">If
                  <span class="keyword parmname">sortField</span> or
                  <span class="keyword parmname">sortOrder</span> isn’t specified, records
                  aren’t returned in any particular order. If
                  <span class="keyword parmname">outputReference</span> specifies a
                  non-collection record variable or if
                  <span class="keyword parmname">getFirstRecordOnly</span> is <samp class="codeph nolang">true</samp>, only the first record in
                  the unsorted list is selected.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">getFirstRecordOnly</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e11462" data-title="Description">Indicates whether to store field values for only one record, even
                when multiple records meet the filter criteria. Supported only when
                <span class="keyword parmname">storeOutputAutomatically</span> is <samp class="codeph nolang">true</samp>. When
                <span class="keyword parmname">storeOutputAutomatically</span> is <samp class="codeph nolang">false</samp>, what determines whether one
                or multiple records are stored is whether
                <span class="keyword parmname">outputReference</span> specifies a record variable
                or a record collection variable.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">limit</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">
                  FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e11462" data-title="Description">Specifies the maximum number of records to store. Valid values
                are between 2 and 20,000. Supported only when
                <span class="keyword parmname">getFirstRecordOnly</span> is false.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">queriedFields</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type">strings[]</td>

              <td class="entry" headers="d950606e11462" data-title="Description">An array that specifies which fields from the selected record are
                saved to the specified record variable.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">relatedObject</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11462" data-title="Description">Name of the related object from which to select related
                records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">relatedRecords</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type">
                <a class="xref" href="#FlowRelatedRecordLookup">FlowRelatedRecordLookup</a>[]
              </td>

              <td class="entry" headers="d950606e11462" data-title="Description">An array that specifies the related records to look up in the
                database.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">relationshipField</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11462" data-title="Description">Specifies the API name of the relationship field used to link the
                object to its related object. This field is required for retrieving
                related records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">sortField</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11462" data-title="Description">The field that’s used for sorting the records that meet the
                filter criteria. If this field isn’t specified, the returned records
                aren’t sorted.<p class="p">You can only sort records by fields that have the
                  <span class="keyword parmname">Sort</span> API field property, as specified
                  in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/" target="_blank" title="HTML (New Window)">SOAP
                    API</a>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11456" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d950606e11459" data-title="Field Type">SortOrder (enumeration of type string)</td>

              <td class="entry" headers="d950606e11462" data-title="Description">Order in which to sort the records. If this field isn’t
                specified, then the results aren’t sorted.<p class="p">Valid values
                  are:</p>
                <a name="ul_v1p_nqv_w2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_v1p_nqv_w2c">
                  <li class="li">
                    <samp class="codeph nolang">Asc</samp>—Ascending
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Desc</samp>—Descending
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## FlowRecordCreate

Create a record in the database using values from the flow. It extends [FlowNode](#FlowNode) and inherits all its properties.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm#meta_create "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead."), [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization."), [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm#meta_update "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead."), and [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm#meta_delete "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead."). The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e11787">Field Name</th>

              <th class="featureTableHeader  " id="d950606e11790">Field Type</th>

              <th class="featureTableHeader  " id="d950606e11793">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">assignRecordIdToReference</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11793" data-title="Description">Reference to the variable where you want to store the ID after
                the record is created.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e11793" data-title="Description">Specifies which node to execute after creating the
                record.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">doesUpsert</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e11793" data-title="Description">Indicates whether the element creates or updates records. The
                default value is <samp class="codeph nolang">false</samp>,
                indicating that the element only creates records. This field is
                available in API version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">doesUpsertAllOrNone</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e11793" data-title="Description">Indicates whether the element creates or updates records only if
                all records are created or updated successfully. If set to <samp class="codeph nolang">true</samp> and a record fails, then the
                transaction rolls back and no records are created or updated.<p class="p">If
                  set to <samp class="codeph nolang">false</samp>, the
                  transaction creates or updates only the records that are
                  successful. The default value is <samp class="codeph nolang">true</samp>. This field is available in API version 62.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">faultConnector</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e11793" data-title="Description">Specifies which node to execute if the attempt to create a record
                results in an error.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">filterLogic</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11793" data-title="Description">The filter logic applied to the filter condition requirements. To
                require all conditions, use <samp class="codeph nolang">AND</samp>. To require any conditions, use <samp class="codeph nolang">OR</samp>. For custom condition logic,
                enter the entire logic string. For example, <samp class="codeph nolang">1 AND 2 OR (3 AND 4)</samp>. <p class="p">This field
                  is available in API version 61.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">
                <a class="xref" href="#FlowRecordFilter">FlowRecordFilter</a>[]
              </td>

              <td class="entry" headers="d950606e11793" data-title="Description">An array that specifies the criteria to select which records to
                create or update in the database.<p class="p">This field is available in API
                  version 61.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">inputAssignments</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">
                <a class="xref" href="#FlowInputFieldAssignment">FlowInputFieldAssignment</a>[]
              </td>

              <td class="entry" headers="d950606e11793" data-title="Description">An array that assigns values to the specified fields of the
                record being created.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">inputReference</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11793" data-title="Description">Specifies the record variable whose field values are used to
                populate the new record’s fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">object</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11793" data-title="Description">Required. The object type that the element creates.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">operationMultMatchingRecords</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11793" data-title="Description">The operation to perform if multiple matching records are found.
                Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">UpdateAllRecords</samp></li>

                  <li class="li"><samp class="codeph nolang">UpdateLatestRecord</samp></li>

                </ul>
                <p class="p">This field is available in API version 61.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">operationOneMatchingRecord</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11793" data-title="Description">The operation to perform if one matching record is found. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">UpdateAllRecords</samp></li>

                </ul>
                <p class="p">This field is available in API version 61.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">operationZeroMatchingRecords</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11793" data-title="Description">The operation to perform if no matching records are found. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                </ul>
                <p class="p">This field is available in API version 61.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">storeOutputAutomatically</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e11793" data-title="Description">Indicates whether the record ID is automatically available in the
                flow without creating any variables. When the value is <samp class="codeph nolang">true</samp>, you can reference the record
                ID by specifying the API name of the Create Records element in the
                flow. The default value is <samp class="codeph nolang">false</samp>. When the value is <samp class="codeph nolang">false</samp>, create a variable to store the record
                ID.<p class="p">This field is available in API version 48.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">upsertExternalIdField</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11793" data-title="Description">If <span class="keyword parmname">doesUpsert</span> is <samp class="codeph nolang">true</samp>, specifies the external ID field on the record.
                You can provide a value for this property or for the Upsert Standard
                ID Field property, but not both. This field is available in API
                version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e11787" data-title="Field Name"><span class="keyword parmname">upsertStandardIdField</span></td>

              <td class="entry" headers="d950606e11790" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e11793" data-title="Description">If <span class="keyword parmname">doesUpsert</span> is <samp class="codeph nolang">true</samp>, specifies the standard ID field like Account ID
                on the object. You can provide a value for this property or for the
                Upsert External ID Field property, but not both. This field is
                available in API version 62.0 and later.</td>

            </tr>

          </tbody>

        </table>

## FlowRecordDelete

Deletes one or more records in the database. It extends [FlowNode](#FlowNode) and inherits all its fields.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm#meta_create "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead."), [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization."), [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm#meta_update "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead."), and [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm#meta_delete "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead."). The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.

| Field Name | Field Type | Description |
| --- | --- | --- |
| connector | [FlowConnector](#FlowConnector) | Specifies which node to execute after deleting the record. |
| faultConnector | [FlowConnector](#FlowConnector) | Specifies which node to execute if the attempt to delete a record results in an error. |
| filters | [FlowRecordFilter](#FlowRecordFilter)\[\] | An array that specifies the criteria used to select which records to delete from the database. For example, delete accounts whose last activity was older than a specified date. |
| inputReference | string | Specifies the record variable whose record ID is used to identify which record to delete in the database. |
| object | string | Required. The name of the object whose records are deleted. |

## FlowRecordFilter

Sets the criteria for searching records in the database. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e12315">Field Name</th>

              <th class="featureTableHeader  " id="d950606e12318">Field Type</th>

              <th class="featureTableHeader  " id="d950606e12321">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e12315" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d950606e12318" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e12321" data-title="Description">Required. The field to be used for filtering records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12315" data-title="Field Name"><span class="keyword parmname">operator</span></td>

              <td class="entry" headers="d950606e12318" data-title="Field Type">FlowRecordFilterOperator (enumeration of type string)</td>

              <td class="entry" headers="d950606e12321" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">EqualTo</samp></li>

                  <li class="li"><samp class="codeph nolang">NotEqualTo</samp></li>

                  <li class="li"><samp class="codeph nolang">GreaterThan</samp></li>

                  <li class="li"><samp class="codeph nolang">LessThan</samp></li>

                  <li class="li"><samp class="codeph nolang">GreaterThanOrEqualTo</samp></li>

                  <li class="li"><samp class="codeph nolang">LessThanOrEqualTo</samp></li>

                  <li class="li"><samp class="codeph nolang">StartsWith</samp></li>

                  <li class="li"><samp class="codeph nolang">EndsWith</samp></li>

                  <li class="li"><samp class="codeph nolang">Contains</samp></li>

                  <li class="li"><samp class="codeph nolang">IsNull</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12315" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d950606e12318" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e12321" data-title="Description">Reference or value used with the field and operator to filter
                records.</td>

            </tr>

          </tbody>

        </table>

## FlowRecordLookup

Finds records in the database and stores their field values in the flow. Corresponds to a Get Records element in Flow Builder. It extends [FlowNode](#FlowNode) and inherits all its fields.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm#meta_create "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead."), [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization."), [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm#meta_update "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead."), and [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm#meta_delete "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead."). The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e12506">Field Name</th>

              <th class="featureTableHeader  " id="d950606e12509">Field Type</th>

              <th class="featureTableHeader  " id="d950606e12512">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">assignNullValuesIfNoRecordsFound</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e12512" data-title="Description">Specifies that all values are set to <samp class="codeph nolang">null</samp> when no record is found. Supported only when
                <span class="keyword parmname">storeOutputAutomatically</span> is <samp class="codeph nolang">false</samp>.<p class="p">This field is available in
                  API version 30.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e12512" data-title="Description">Specifies which node to execute after getting records from the
                database.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">faultConnector</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e12512" data-title="Description">Specifies which node to execute if the attempt to get records
                results in an error.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">filterLogic</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e12512" data-title="Description">The filter logic that’s applied to the filter condition
                requirements. To require all conditions, use <samp class="codeph nolang">AND</samp>. To require any conditions, use
                <samp class="codeph nolang">OR</samp>. For custom condition
                logic, enter the entire logic string. For example, <samp class="codeph nolang">1 AND 2 OR (3 AND 4)</samp>. This field is
                available in API version 50.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">
                <a class="xref" href="#FlowRecordFilter">FlowRecordFilter</a>[]
              </td>

              <td class="entry" headers="d950606e12512" data-title="Description">An array that specifies the criteria used to select the record
                from the database.<p class="p">If the filters return more than one record,
                  they’re sorted according to the specified
                  <span class="keyword parmname">sortField</span> and
                  <span class="keyword parmname">sortOrder</span>. If
                  <span class="keyword parmname">outputReference</span> specifies a
                  non-collection record variable or if
                  <span class="keyword parmname">getFirstRecordOnly</span> is <samp class="codeph nolang">true</samp>, only the first record in
                  the sorted list is selected.
                </p>
                <p class="p">If
                  <span class="keyword parmname">sortField</span> or
                  <span class="keyword parmname">sortOrder</span> isn’t specified, records
                  aren’t returned in any particular order. If
                  <span class="keyword parmname">outputReference</span> specifies a
                  non-collection record variable or if
                  <span class="keyword parmname">getFirstRecordOnly</span> is <samp class="codeph nolang">true</samp>, only the first record in
                  the unsorted list is selected.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">getFirstRecordOnly</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e12512" data-title="Description">Indicates whether to store field values for only one record, even
                when multiple records meet the filter criteria. Supported only when
                <span class="keyword parmname">storeOutputAutomatically</span> is <samp class="codeph nolang">true</samp>. When
                <span class="keyword parmname">storeOutputAutomatically</span> is <samp class="codeph nolang">false</samp>, what determines whether one
                or multiple records are stored is whether
                <span class="keyword parmname">outputReference</span> specifies a record variable
                or a record collection variable.<p class="p">This field is available in API
                  version 47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">limit</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">
                  FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e12512" data-title="Description">Specifies the maximum number of records to store. Valid values
                are between 2 and 20,000. Supported only when
                <span class="keyword parmname">getFirstRecordOnly</span> is false.<p class="p">This field
                  is available in API version 63.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">object</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e12512" data-title="Description">Name of the object from which to select the record.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">outputAssignments</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">
                <a class="xref" href="#FlowOutputFieldAssignment">FlowOutputFieldAssignment</a>[]
              </td>

              <td class="entry" headers="d950606e12512" data-title="Description">An array that assigns fields from the selected record to
                variables that can be used elsewhere in the flow. Supported only
                when <span class="keyword parmname">storeOutputAutomatically</span> is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">outputReference</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e12512" data-title="Description">Specifies the record variable or record collection variable that
                stores the queried fields’ values. Supported only when
                <span class="keyword parmname">storeOutputAutomatically</span> is <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">queriedFields</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">string[]</td>

              <td class="entry" headers="d950606e12512" data-title="Description">An array that specifies which fields from the selected record are
                saved to the specified record variable.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name">
                <span class="keyword parmname">relatedRecords</span> (beta)
              </td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">
                <a class="xref" href="#FlowRelatedRecordLookup">FlowRelatedRecordLookup</a>[]
              </td>

              <td class="entry" headers="d950606e12512" data-title="Description">An array that specifies the related records to look up in the
                database.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">sortField</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e12512" data-title="Description">The field that’s used for sorting the records that meet the
                filter criteria. If this field isn’t specified, the returned records
                aren’t sorted.<p class="p">You can only sort records by fields that have the
                  <span class="keyword parmname">Sort</span> API field property, as specified
                  in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/" target="_blank" title="HTML (New Window)">SOAP
                    API</a>.
                </p>
                <p class="p">This field is available in API version 25.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">SortOrder (enumeration of type string)</td>

              <td class="entry" headers="d950606e12512" data-title="Description">Order in which to sort the records. If this field isn’t
                specified, then the results aren’t sorted.<p class="p">Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Asc</samp>—Ascending
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Desc</samp>—Descending
                  </li>

                </ul>
                <p class="p">This field is available in API version 25.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e12506" data-title="Field Name"><span class="keyword parmname">storeOutputAutomatically</span></td>

              <td class="entry" headers="d950606e12509" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e12512" data-title="Description">Indicates whether the returned records’ field values are
                automatically available in the flow without creating any variables.
                When the value is <samp class="codeph nolang">true</samp>, the
                flow can reference a field by specifying the
                <span class="keyword parmname">name</span> of the Get Records element and the
                record field, such as <samp class="codeph nolang">Get_Contacts.AccountId</samp>. Supported only when
                <span class="keyword parmname">processType</span> is <samp class="codeph nolang">Flow</samp> or <samp class="codeph nolang">AutoLaunchedFlow</samp>.<p class="p">This field is available in API
                  version 47.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowRecordRollback

Rolls back the current transaction and cancels its pending record changes. Corresponds to the Roll Back Records element in Flow Builder. Available only in screen flows.

FlowRecordRollback extends [FlowNode](#FlowNode) and inherits all its fields. This metadata type is available in API version 52.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| connector | [FlowConnector](#FlowConnector) | Specifies which node to execute after rolling back the current transaction. |

## FlowRecordUpdate

Finds records in the database and updates them with values from the flow. It extends [FlowNode](#FlowNode) and inherits all its fields.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm#meta_create "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead."), [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization."), [update()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_update.htm#meta_update "Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead."), and [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm#meta_delete "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead."). The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.

| Field Name | Field Type | Description |
| --- | --- | --- |
| connector | [FlowConnector](#FlowConnector) | Specifies which node to execute after completing the record update. |
| faultConnector | [FlowConnector](#FlowConnector) | Specifies which node to execute if the attempt to update a record results in an error. |
| filters | [FlowRecordFilter](#FlowRecordFilter)\[\] | An array that specifies the criteria used to select the records to update in the database. |
| inputAssignments | [FlowInputFieldAssignment](#FlowInputFieldAssignment)\[\] | An array that assigns values to the specified fields of the record being updated. |
| inputReference | string | Specifies the record variable whose field values are used to update the record’s fields. |
| object | string | Required. Name of the object whose records are updated. |

## FlowRule

Defines the conditions and logic that enables a rule to evaluate to true. It extends [FlowElement](#FlowElement) and inherits all of its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e13155">Field Name</th>

              <th class="featureTableHeader  " id="d950606e13158">Field Type</th>

              <th class="featureTableHeader  " id="d950606e13161">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e13155" data-title="Field Name"><span class="keyword parmname">attributes</span></td>

              <td class="entry" headers="d950606e13158" data-title="Field Type">
                <a class="xref" href="#FlowAttribute">FlowAttribute</a>[]
              </td>

              <td class="entry" headers="d950606e13161" data-title="Description">An array of attributes for the flow rule. This field is available
                in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13155" data-title="Field Name"><span class="keyword parmname">conditionLogic</span></td>

              <td class="entry" headers="d950606e13158" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13161" data-title="Description">Specifies logic for the conditions. Value can be:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">and</samp>—Evaluates to
                    <samp class="codeph nolang">true</samp> if all of its
                    conditions are true.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">or</samp>—Evaluates to <samp class="codeph nolang">true</samp> if any conditions are
                    true.
                  </li>

                  <li class="li">Advanced logic like <samp class="codeph nolang">1 AND (2 OR
                      3)</samp>—Evaluates to <samp class="codeph nolang">true</samp> if the first condition is <samp class="codeph nolang">true</samp> and either the second
                    or third condition is <samp class="codeph nolang">true</samp>. <p class="p">When you use advanced logic, the
                      string can contain up to 1,000 characters.</p>
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13155" data-title="Field Name"><span class="keyword parmname">conditions</span></td>

              <td class="entry" headers="d950606e13158" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e13161" data-title="Description">An array of conditions for the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13155" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e13158" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e13161" data-title="Description">Specifies which node to execute if this rule evaluates to <samp class="codeph nolang">true</samp> in a decision first.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13155" data-title="Field Name"><span class="keyword parmname">doesRequireRecordChangedToMeetCriteria</span></td>

              <td class="entry" headers="d950606e13158" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e13161" data-title="Description">If set to <samp class="codeph nolang">true</samp>, conditions
                evaluate to <samp class="codeph nolang">true</samp> only if the
                record didn’t meet the required conditions before the triggering
                update but now meets the conditions after the update. This field is
                available in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13155" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d950606e13158" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13161" data-title="Description">Required. Label for the connector.</td>

            </tr>

          </tbody>

        </table>

## FlowSchedule

Specifies when and how frequently to run the flow. This metadata type is available in API version 47.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e13326">Field Name</th>

              <th class="featureTableHeader  " id="d950606e13329">Field Type</th>

              <th class="featureTableHeader  " id="d950606e13332">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e13326" data-title="Field Name"><span class="keyword parmname">dayOfMonthToRun</span></td>

              <td class="entry" headers="d950606e13329" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e13332" data-title="Description">The number of the day of the month on which the flow runs. For
                example, <samp class="codeph nolang">1</samp> is the first day of
                the month, <samp class="codeph nolang">2</samp> is the second day
                of the month, and so on. You can use <samp class="codeph nolang">-1</samp> for the last day of the month. This field is
                available in API version 66.0 and later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13326" data-title="Field Name"><span class="keyword parmname">daysOfWeekToRun</span></td>

              <td class="entry" headers="d950606e13329" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13332" data-title="Description">The number of the days of the week on which the flow is to run.
                For example, <samp class="codeph nolang">1</samp>, <samp class="codeph nolang">2</samp>, <samp class="codeph nolang">3</samp>, where <samp class="codeph nolang">1</samp> is
                Sunday, 2 is Monday, and so on. This field is available in API
                version 66.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13326" data-title="Field Name"><span class="keyword parmname">endDate</span></td>

              <td class="entry" headers="d950606e13329" data-title="Field Type">date</td>

              <td class="entry" headers="d950606e13332" data-title="Description">Reserved for future
                use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13326" data-title="Field Name"><span class="keyword parmname">endTime</span></td>

              <td class="entry" headers="d950606e13329" data-title="Field Type">time</td>

              <td class="entry" headers="d950606e13332" data-title="Description">Reserved for future
                use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13326" data-title="Field Name"><span class="keyword parmname">frequency</span></td>

              <td class="entry" headers="d950606e13329" data-title="Field Type">FlowStartFrequency (enumeration of type string)</td>

              <td class="entry" headers="d950606e13332" data-title="Description">Specifies how frequently to run the flow. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Once</samp></li>

                  <li class="li"><samp class="codeph nolang">Daily</samp></li>

                  <li class="li"><samp class="codeph nolang">Weekly</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">OnActivate</samp>—For
                    segment-triggered flows only. This value is available in API
                    version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Hourly</samp>—For
                    segment-triggered flows only. This value is available in API
                    version 66.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Monthly</samp>—For
                    segment-triggered flows only. This value is available in API
                    version 66.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Weekdays</samp>—For
                    segment-triggered flows only. This value is available in API
                    version 66.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Yearly</samp>—For
                    segment-triggered flows only. This value is available in API
                    version 66.0 and later.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13326" data-title="Field Name"><span class="keyword parmname">frequencyNumber</span></td>

              <td class="entry" headers="d950606e13329" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e13332" data-title="Description">For segment-triggered flows only. The number of times to run the
                flow for this schedule based on the <span class="keyword parmname">frequency</span>
                value. For example, if this field is <samp class="codeph nolang">2</samp>, and <span class="keyword parmname">frequency</span> is <samp class="codeph nolang">Hourly</samp>, the flow runs every hour
                for 2 hours . When this number is met, the flow no longer runs for
                this schedule. This field is available in API version 66.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13326" data-title="Field Name"><span class="keyword parmname">startDate</span></td>

              <td class="entry" headers="d950606e13329" data-title="Field Type">date</td>

              <td class="entry" headers="d950606e13332" data-title="Description">The date when the flow runs, or when the flow’s run schedule
                starts recurring.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13326" data-title="Field Name"><span class="keyword parmname">startTime</span></td>

              <td class="entry" headers="d950606e13329" data-title="Field Type">time</td>

              <td class="entry" headers="d950606e13332" data-title="Description">The time of day when the flow runs, based on the org’s default
                time zone.</td>

            </tr>

          </tbody>

        </table>

## FlowScheduledPath

Defines a scheduled path. It extends [FlowElement](#FlowElement) and inherits all its fields. This metadata type is available in API version 51.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e13547">Field Name</th>

              <th class="featureTableHeader  " id="d950606e13550">Field Type</th>

              <th class="featureTableHeader  " id="d950606e13553">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e13547" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e13550" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e13553" data-title="Description">Specifies which node to execute after this scheduled
                path.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13547" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d950606e13550" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13553" data-title="Description">Label for the scheduled path.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13547" data-title="Field Name"><span class="keyword parmname">maxBatchSize</span></td>

              <td class="entry" headers="d950606e13550" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e13553" data-title="Description">The maximum number of scheduled path interviews to execute in a
                single batch, from <samp class="codeph nolang">1</samp> to <samp class="codeph nolang">200</samp>. Default is <samp class="codeph nolang">200</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13547" data-title="Field Name"><span class="keyword parmname">offsetNumber</span></td>

              <td class="entry" headers="d950606e13550" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e13553" data-title="Description">Number of months, days, hours, or minutes to offset the time that
                the scheduled path executes. Negative values offset the time to
                execute before the provided time. Positive values offset the time to
                execute after the provided time.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13547" data-title="Field Name"><span class="keyword parmname">offsetUnit</span></td>

              <td class="entry" headers="d950606e13550" data-title="Field Type">FlowScheduledPathOffsetUnit (enumeration of type string)</td>

              <td class="entry" headers="d950606e13553" data-title="Description">Specify the time unit used to offset when the scheduled path
                executes. Possible values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Months</samp>—This value is
                    available in API version 56.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Days</samp></li>

                  <li class="li"><samp class="codeph nolang">Hours</samp></li>

                  <li class="li"><samp class="codeph nolang">Minutes</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13547" data-title="Field Name"><span class="keyword parmname">pathType</span></td>

              <td class="entry" headers="d950606e13550" data-title="Field Type">FlowScheduledPathType (enumeration of type string)</td>

              <td class="entry" headers="d950606e13553" data-title="Description">The type of scheduled path. <samp class="codeph nolang">null</samp> is used for time-triggered and record-triggered
                paths. The default value is <samp class="codeph nolang">null</samp>.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AsyncAfterCommit</samp>—The
                    scheduled path runs asynchronously after a save.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13547" data-title="Field Name"><span class="keyword parmname">recordField</span></td>

              <td class="entry" headers="d950606e13550" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13553" data-title="Description">Field used to determine when the scheduled path executes. The
                field’s object is defined in <a class="xref" href="#FlowStart">FlowStart</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13547" data-title="Field Name"><span class="keyword parmname">timeSource</span></td>

              <td class="entry" headers="d950606e13550" data-title="Field Type">FlowScheduledPathTimeSource (enumeration of type string)</td>

              <td class="entry" headers="d950606e13553" data-title="Description">Specify if a field or event is used to determine when the
                scheduled path executes. Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">RecordField</samp></li>

                  <li class="li"><samp class="codeph nolang">RecordTriggerEvent</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## FlowScreen

Screens capture information from users and display information to users. It extends [FlowNode](#FlowNode) and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e13752">Field Name</th>

              <th class="featureTableHeader  " id="d950606e13755">Field Type</th>

              <th class="featureTableHeader  " id="d950606e13758">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">actions</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">
                <a class="xref" href="#FlowScreenAction">FlowScreenAction</a>[]
              </td>

              <td class="entry" headers="d950606e13758" data-title="Description">An array of screen actions.<p class="p">This field is available in API
                  version 59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">allowBack</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e13758" data-title="Description">Indicates whether to show (<samp class="codeph nolang">true</samp>) or hide (<samp class="codeph nolang">false</samp>) the <strong class="ph uicontrol">Previous</strong> button on
                the screen at runtime. When true, the
                <strong class="ph uicontrol">Previous</strong> button appears only if the user
                visited a previous screen in the flow path and if
                <span class="keyword parmname">showFooter</span> for the screen is set to <samp class="codeph nolang">true</samp>. Set this field to false when
                revisiting the previous screen triggers an action that you don’t
                want repeated, such as a credit card transaction.<p class="p">This field is
                  available in API version 26.0 and later.</p>
                <p class="p">Default: <samp class="codeph nolang">true</samp></p>

                <p class="p"><span class="ph" id="flow_back_finish_restriction"><a name="flow_back_finish_restriction"><!-- --></a>You can set either
                    <span class="keyword parmname">allowBack</span> or
                    <span class="keyword parmname">allowFinish</span> to false, but not
                    both.</span></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">allowFinish</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e13758" data-title="Description">Indicates whether to show (<samp class="codeph nolang">true</samp>) or hide (<samp class="codeph nolang">false</samp>) the <strong class="ph uicontrol">Finish</strong> button on the
                screen at runtime. When <samp class="codeph nolang">true</samp>,
                the <strong class="ph uicontrol">Finish</strong> button appears only if the screen
                element is the end of a flow path, and if
                <span class="keyword parmname">showFooter</span> for the screen is set to <samp class="codeph nolang">true</samp>. The default value is <samp class="codeph nolang">true</samp>. <p class="p">Set to <samp class="codeph nolang">false</samp> if user is required to go
                  back to a previous screen to continue or complete the flow. For
                  example, don’t include a <strong class="ph uicontrol">Finish</strong> button on
                  a screen that tells the user to go back and make corrections on
                  a previous screen.</p>

                <p class="p">You can set <span class="keyword parmname">allowBack</span> or
                  <span class="keyword parmname">allowFinish</span> to <samp class="codeph nolang">false</samp>, but not both.
                </p>

                <p class="p">This field is available in API version 26.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname" id="flow_allowpause"><a name="flow_allowpause"><!-- --></a>allowPause</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e13758" data-title="Description">
                <span class="ph" id="flow_allowpause_desc"><a name="flow_allowpause_desc"><!-- --></a>Indicates whether to show (<samp class="codeph nolang">true</samp>) or hide (<samp class="codeph nolang">false</samp>) the
                  <strong class="ph uicontrol">Pause</strong> button on the screen at
                  runtime. The default value is <samp class="codeph nolang">true</samp>.</span>
                <p class="p">A flow screen displays the <strong class="ph uicontrol">Pause</strong> button if
                  all these conditions are <samp class="codeph nolang">true</samp>.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <strong class="ph uicontrol">Let users pause flows</strong> is enabled in
                    the organization’s process automation settings.
                  </li>

                  <li class="li">
                    <span class="keyword parmname">allowPause</span> for the screen is set to
                    <samp class="codeph nolang">true</samp>.
                  </li>

                  <li class="li">If the flow is embedded in a Visualforce page, the
                    &lt;flow:interview&gt; component has its
                    <span class="keyword parmname">showAllowPause</span> attribute set to
                    <samp class="codeph nolang">true</samp>.
                  </li>

                  <li class="li">The <span class="keyword parmname">showFooter</span> field for the screen is
                    set to <samp class="codeph nolang">true</samp>.</li>

                </ul>
                <p class="p">This field is available in API version 33.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname" id="flow_backButtonLabel"><a name="flow_backButtonLabel"><!-- --></a>backButtonLabel</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13758" data-title="Description">A label for the Back button.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e13758" data-title="Description">Specifies which node to execute after the screen node.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">
                <a class="xref" href="#FlowScreenField">FlowScreenField</a>[]
              </td>

              <td class="entry" headers="d950606e13758" data-title="Description">An array of fields to display on the screen.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">helpText</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13758" data-title="Description">Text that appears if the end user clicks a link for help
                text. <p class="p">Supports merge fields in API version
                  26.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname" id="flow_nextOrFinishButtonLabel"><a name="flow_nextOrFinishButtonLabel"><!-- --></a>nextOrFinishButtonLabel</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13758" data-title="Description">A label for the Next or Finish button.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname" id="flow_pauseButtonLabel"><a name="flow_pauseButtonLabel"><!-- --></a>pauseButtonLabel</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13758" data-title="Description">A label for the Pause button.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname" id="flow_pausetext"><a name="flow_pausetext"><!-- --></a>pausedText</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e13758" data-title="Description">
                <span class="ph" id="flow_pausetext_desc"><a name="flow_pausetext_desc"><!-- --></a>A confirmation message that appears
                  when an end user clicks
                  <strong class="ph uicontrol">Pause</strong>.</span>
                <p class="p">This field is available in
                  API version 33.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">rules</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type"></td>

              <td class="entry" headers="d950606e13758" data-title="Description">Reserved for future use. </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname" id="flow_showfooter"><a name="flow_showfooter"><!-- --></a>showFooter</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e13758" data-title="Description">
                <span class="ph" id="flow_showfooter_desc"><a name="flow_showfooter_desc"><!-- --></a>Indicates whether to show (<samp class="codeph nolang">true</samp>) or hide (<samp class="codeph nolang">false</samp>) the screen’s footer at
                  Lightning runtime. Classic runtime isn’t supported. The default
                  value is <samp class="codeph nolang">true</samp>.</span>
                <p class="p">The footer includes navigation actions for the screen. If
                  <span class="keyword parmname">showFooter</span> is hidden, use Lightning
                  components on the screen to show navigation actions.
                </p>

                <p class="p">This field is available in API version 42.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname" id="flow_showheader"><a name="flow_showheader"><!-- --></a>showHeader</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e13758" data-title="Description">
                <span class="ph" id="flow_showheader_desc"><a name="flow_showheader_desc"><!-- --></a>Indicates whether to show (<samp class="codeph nolang">true</samp>) or hide (<samp class="codeph nolang">false</samp>) the screen’s header at
                  Lightning runtime.</span> Classic runtime isn’t supported. The
                default value is <samp class="codeph nolang">true</samp>. <p class="p">The
                  header includes access to help text for the screen. If
                  <span class="keyword parmname">showHeader</span> is hidden, use Lightning
                  components on the screen to show help text.
                </p>

                <p class="p">This field is available in API version 42.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">stageReference</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e13758" data-title="Description">The API name of the stage resource that’s associated with the
                screen.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">styleSettings</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">
                <a class="xref" href="#FlowScreenStyleSetting">FlowScreenStyleSetting</a>[]
              </td>

              <td class="entry" headers="d950606e13758" data-title="Description">An array of flow screen style settings to customize the visual
                experience of a screen at run time. This field is available in API
                version 66.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e13752" data-title="Field Name"><span class="keyword parmname">triggers</span></td>

              <td class="entry" headers="d950606e13755" data-title="Field Type">
                <a class="xref" href="#FlowScreenTrigger">FlowScreenTrigger</a>[]
              </td>

              <td class="entry" headers="d950606e13758" data-title="Description">An array of triggers configured for a flow screen field or a flow
                screen field attribute.<p class="p">This field is available in API version
                  59.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowScreenAction

Defines an action that can be triggered by one or more flow screen components.

This metadata type is available in API version 59.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e14222">Field Name</th>

              <th class="featureTableHeader  " id="d950606e14225">Field Type</th>

              <th class="featureTableHeader  " id="d950606e14228">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e14222" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d950606e14225" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14228" data-title="Description">Required. The API name of the flow screen action. </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14222" data-title="Field Name"><span class="keyword parmname">actionType</span></td>

              <td class="entry" headers="d950606e14225" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e14228" data-title="Description">Required. The flow screen action type. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">flow</samp>—Invokes an
                    autolaunched flow.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14222" data-title="Field Name"><span class="keyword parmname">inputParameters</span></td>

              <td class="entry" headers="d950606e14225" data-title="Field Type">
                <a class="xref" href="#FlowScreenActionInputParameter">FlowScreenActionInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e14228" data-title="Description">An array of input parameters from the flow to the flow screen
                action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14222" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d950606e14225" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14228" data-title="Description">Requiired. The label of the flow screen action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14222" data-title="Field Name"><span class="keyword parmname">nameSegment</span></td>

              <td class="entry" headers="d950606e14225" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14228" data-title="Description">The API name of the flow screen action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14222" data-title="Field Name"><span class="keyword parmname">versionString</span></td>

              <td class="entry" headers="d950606e14225" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14228" data-title="Description">Specifies the version of the screen action to be invoked.<p class="p">This
                  field is available in API version 63.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowScreenActionInputParameter

Defines an iput parameter for a flow screen action. It extends [FlowScreenFieldInputParameter](#FlowScreenFieldInputParameter) and inherits all its fields.

This metadata type is available in API version 59.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Unique name of the input parameter of a flow screen action. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the valueof an input parameter for a flow screen action. |

## FlowScreenField

Represents a screen component. FlowScreenField extends [FlowElement](#FlowElement) and inherits all its fields. See [Salesforce Help: Standard Flow Screen Components](https://help.salesforce.com/s/articleView?id=platform.flow_ref_elements_screencmp.htm&language=en_US).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e14433">Field Name</th>

              <th class="featureTableHeader  " id="d950606e14436">Field Type</th>

              <th class="featureTableHeader  " id="d950606e14439">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">choiceReferences</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">string[]</td>

              <td class="entry" headers="d950606e14439" data-title="Description">An array of references to FlowChoices or FlowDynamicChoiceSets.
                The resulting choice options appear in the order specified in this
                array, where the element at index 0 provides the top-most choice
                option. Supported for these types of screen components.<ul class="ul bulletList">
                  <li class="li">RadioButtons</li>

                  <li class="li">DropdownBox</li>

                  <li class="li">MultiSelectCheckboxes</li>

                  <li class="li">MultiSelectPicklist</li>

                </ul>
                <p class="p">Multi-select checkboxes and multi-select picklist fields are
                  available in API version 26.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">FlowDataType (enumeration of type string)</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Data type of the screen component. Only supported for the
                InputField, RadioButtons, and DropdownBox types of screen
                components. Valid data types are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li"><samp class="codeph nolang">Time</samp></li>

                </ul>
                <p class="p">Boolean input fields, which appear as checkbox fields at
                  runtime, are available in API version 26.0 and later.</p>
                <p class="p">Only
                  the string data type is supported for multi-select checkboxes
                  and multi-select picklist fields. Multi-select fields are
                  available in API version 26.0 and later.</p>
                <p class="p">Date/time input
                  fields are available in API version 43.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">dataTypeMappings</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">
                <a class="xref" href="#FlowDataTypeMapping">FlowDataTypeMapping</a>[]
              </td>

              <td class="entry" headers="d950606e14439" data-title="Description">Reserved for future use. </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">defaultSelectedChoiceReference</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14439" data-title="Description">The name of the FlowChoice element to use as the default value
                for the screen component. Supported for these types of screen components.<ul class="ul bulletList">
                  <li class="li">RadioButtons</li>

                  <li class="li">DropdownBox</li>

                  <li class="li">MultiSelectCheckboxes</li>

                  <li class="li">MultiSelectPicklist</li>

                </ul>
                <p class="p">For DropdownBox field types only, if
                  <span class="keyword parmname">defaultSelectedChoiceReference</span> is empty
                  or null, the reference at index 0 of
                  <span class="keyword parmname">choiceReferences</span> is used as the default
                  value.
                </p>
                <p class="p">You can specify only one FlowChoice element as the
                  default value for multi-select checkboxes and multi-select
                  picklist fields. Multi-select fields are available in API
                  version 26.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">defaultValue</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e14439" data-title="Description">The value that is used by default when the screen component
                requires users to provide input. Only supported for InputField,
                LargeTextArea, and PasswordField.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">extensionName</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14439" data-title="Description">The name of the Lightning component to display. This field is
                available in API version 42.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">
                <a class="xref" href="#FlowScreenField">FlowScreenField</a>[]
              </td>

              <td class="entry" headers="d950606e14439" data-title="Description">An array of columns to display in a section, or an array of
                fields to display in a column. This field is available in API
                version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">fieldText</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Field label that is displayed on the screen. Supports merge
                fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">fieldType</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">FlowScreenFieldType (enumeration of type string)</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Required. The type of field to display on a flow screen. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">DisplayText</samp></li>

                  <li class="li"><samp class="codeph nolang">InputField</samp></li>

                  <li class="li"><samp class="codeph nolang">LargeTextArea</samp></li>

                  <li class="li"><samp class="codeph nolang">PasswordField</samp></li>

                  <li class="li"><samp class="codeph nolang">RadioButtons</samp></li>

                  <li class="li"><samp class="codeph nolang">DropdownBox</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">MultiSelectCheckboxes</samp>—This value is available in
                    API version 26.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MultiSelectPicklist</samp>—This value is available in API
                    version 26.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ComponentInstance</samp>—This
                    value is available in API version 42.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ComponentChoice</samp> and
                    <samp class="codeph nolang">ComponentInput</samp>—This
                    value is available in API version 48.0 and later for the
                    <samp class="codeph nolang">Survey</samp>
                    <span class="keyword parmname">processType</span> value only.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Region</samp>— Specifies that
                    a screen field in a section is a column. This value is
                    available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RegionContainer</samp>—Specifies that a screen field is a
                    section. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ObjectProvided</samp>—Specifies that a screen field is a
                    field from a Salesforce object. This value is available in
                    API version 51.0 and later.
                  </li>

                </ul>
                <p class="p">At runtime, each multi-select field stores its field value
                  as a concatenation of the user-selected choice values, separated
                  by semicolons. Any semicolons in the selected choice values are
                  removed when added to the multi-select field value.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">helpText</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Text that appears if the end user clicks the help icon (<a name="info_icon"><!-- --></a><img class="image" id="info_icon" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/vpm_info_up.png" alt="info">)
                for the screen component. <p class="p">Supports merge fields in API version
                  26.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">inputParameters</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">
                <a class="xref" href="#FlowScreenFieldInputParameter">FlowScreenFieldInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e14439" data-title="Description">An array of input parameters. Supported only when <samp class="codeph nolang">fieldType</samp> is <samp class="codeph nolang">ComponentInstance</samp>. <p class="p">This field is
                  available in API version 42.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">inputsOnNextNavToAssocScrn</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">FlowScreenFieldInputsRevisited (enumeration of type
                string)</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Controls whether the flow remembers the input value if the user
                moves to any screen and then returns to the screen component. Valid
                values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">UseStoredValues</samp>—Uses
                    values from when the user last visited this screen.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ResetValues</samp>—Refreshes
                    inputs to incorporate changes elsewhere in the flow.
                  </li>

                </ul>
                <p class="p">The default value is <samp class="codeph nolang">UseStoredValues</samp>.</p>
                <p class="p">This property applies to
                  screen components in API version 51.0 and later and to record
                  fields on flow screens in API version 57.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">isRequired</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Indicates whether the user must select a choice or provide input.
                Not supported for DisplayText or boolean inputField.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">isVisible</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e14439" data-title="Description"></td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">objectFieldReference</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Specifies the Salesforce object field for an ObjectProvided
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">outputParameters</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">
                <a class="xref" href="#FlowScreenFieldOutputParameter">FlowScreenFieldOutputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e14439" data-title="Description">An array of output parameters. Supported only when
                <span class="keyword parmname">fieldType</span> is <samp class="codeph nolang">ComponentInstance</samp> and when
                <span class="keyword parmname">storeOutputAutomatically</span> is <samp class="codeph nolang">false</samp>.<p class="p">This field is available in
                  API version 42.0 and later. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">regionContainerType</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">FlowRegionContainerType (enumeration of type string)</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Stores information about a section component header. Possible
                values include: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">SectionWithHeader</samp></li>

                  <li class="li"><samp class="codeph nolang">SectionWithoutHeader</samp></li>

                </ul>
                <p class="p">Available only when the component type is <samp class="codeph nolang">Section</samp>. This field is
                  available in API version 55.0 and later. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">scale</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Controls the number of digits to the right of the decimal point
                up to 17 places. If you leave this field blank or set it to zero,
                only whole numbers appear when your flow runs. <p class="p">Available only
                  when the data type is Number or Currency. Corresponds to the
                  Decimal Places field in Flow Builder.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">sourceTemplateApiName</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14439" data-title="Description"><span class="ph">The API name of the template specified
                  by the provider. This field is available in API version 62.0 and
                  later.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">sourceTemplateProviderType</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e14439" data-title="Description"><span class="ph">The API name of the source that
                  provides the template. This field is available in API version
                  62.0 and later.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">storeOutputAutomatically</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e14439" data-title="Description">Indicates whether the screen component’s output parameters are
                automatically available in the flow without creating any variables.
                When the value is <samp class="codeph nolang">true</samp>, you can
                reference an output parameter by specifying the
                <span class="keyword parmname">name</span> of the screen component and the output
                parameter, such as <samp class="codeph nolang">Mailing_Address.City</samp>.<p class="p">Supported only when
                  <span class="keyword parmname">fieldType</span> is <samp class="codeph nolang">ComponentInstance</samp>.
                </p>
                <p class="p">This
                  field is available in API version 47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">styleProperties</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type"><a class="xref" href="#FlowScreenFieldStyleProperties">FlowScreenFieldStyleProperties</a></td>

              <td class="entry" headers="d950606e14439" data-title="Description">Specifies the style properties of a screen component. <p class="p">This
                  field is available in API version 64.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">validationRule</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type"><a class="xref" href="#FlowInputValidationRule">FlowInputValidationRule</a></td>

              <td class="entry" headers="d950606e14439" data-title="Description">A rule that’s used to validate the user input when the screen
                component is of type InputField, LargeTextArea, or
                PasswordField.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e14433" data-title="Field Name"><span class="keyword parmname">visibilityRule</span></td>

              <td class="entry" headers="d950606e14436" data-title="Field Type"><a class="xref" href="#FlowVisibilityRule">FlowVisibilityRule</a></td>

              <td class="entry" headers="d950606e14439" data-title="Description">A condition-based rule that’s used to render or hide the screen
                component.<p class="p">This field is available in API version 47.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowScreenFieldInputParameter

Defines an input parameter from the flow to the extension. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. FlowScreenFieldInputParameter is available in API version 42.0.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Unique name for the input parameter. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value of the input parameter. |

## FlowScreenFieldOutputParameter

Defines an output parameter from the extension to the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. FlowScreenFieldOutputParameter is available in API version 42.0.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToReference | string | Required. Specifies the variable to which you want to assign the output parameter value. |
| name | string | Required. Unique name for the output parameter. |

## FlowScreenFieldStyleProperties

Defines how a screen component looks on a screen element at run time.

This metadata type is available in API version 64.0 and later.

| Field Name | Field type | Description |
| --- | --- | --- |
| styleSettings | [FlowScreenStyleSetting](#FlowScreenStyleSetting)\[\] | An array of flow screen style settings to customize the visual experience of a screen component at run time. This field is available in API version 66.0 and later. |
| width | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | The number of columns the width of the screen component fills up in a screen element's 12-column wide spatial grid. Valid values are numbers 1 through 12. |
| verticalAlignment | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | The vertical alignment of the screen component. Valid values are top, middle, bottom. |

## FlowScreenStyleSetting

A style setting for a flow screen or flow screen component. FlowScreenStyleSetting extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. FlowScreenStyleSetting is available in API version 66.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e15301">Field Name</th>

              <th class="featureTableHeader  " id="d950606e15304">Field Type</th>

              <th class="featureTableHeader  " id="d950606e15307">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e15301" data-title="Field Name"><span class="keyword parmname">propertyName</span></td>

              <td class="entry" headers="d950606e15304" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15307" data-title="Description">The name of the screen style property such as, <samp class="codeph nolang">--slds-c-input-color-border</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15301" data-title="Field Name"><span class="keyword parmname">propertyValue</span></td>

              <td class="entry" headers="d950606e15304" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e15307" data-title="Description">Defines the value for the screen style property such as, <samp class="codeph nolang">&lt;stringValue&gt;#4AC7CA&lt;/stringValue&gt;</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15301" data-title="Field Name"><span class="keyword parmname">scope</span></td>

              <td class="entry" headers="d950606e15304" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15307" data-title="Description">Specifies where the style setting is applied on a screen. Valid values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Container</samp></li>

                  <li class="li"><samp class="codeph nolang">Header</samp></li>

                  <li class="li"><samp class="codeph nolang">NextOrFinish</samp></li>

                  <li class="li"><samp class="codeph nolang">Previous</samp></li>

                  <li class="li"><samp class="codeph nolang">Pause</samp></li>

                </ul>
                Not supported for screen components.</td>

            </tr>

          </tbody>

        </table>

## FlowScreenTrigger

Defines an event handler for a flow screen component.

This metadata type is available in API version 59.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| eventName | string | Required. The API name of the event from eventSource that the trigger listens for. |
| eventSource | string | Required. The screen field, screen field attribute, action, or action attribute where eventName takes place. |
| handlers | [FlowScreenTriggerHandler](#FlowScreenTriggerHandler)\[\] | An array of flow screen handlers to conditionally run when the configured event is recevied. |

## FlowScreenTriggerHandler

Defines conditions for a flow screen trigger handler.

This metadata type is available in API version 59.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e15495">Field Name</th>

              <th class="featureTableHeader  " id="d950606e15498">Field Type</th>

              <th class="featureTableHeader  " id="d950606e15501">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e15495" data-title="Field Name"><span class="keyword parmname">conditions</span></td>

              <td class="entry" headers="d950606e15498" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e15501" data-title="Description">An array of conditions that must be <samp class="codeph nolang">true</samp> to trigger the handler.<p class="p">This field is available
                  in API version 63.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15495" data-title="Field Name"><span class="keyword parmname">conditionLogic</span></td>

              <td class="entry" headers="d950606e15498" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15501" data-title="Description">Specifies logic for the conditions. Valid values are:<a name="ul_aqj_tzn_zfc"><!-- --></a>
                <ul class="ul bulletList" id="ul_aqj_tzn_zfc">
                  <li class="li">
                    <samp class="codeph nolang">and</samp>—Evaluates to
                    <samp class="codeph nolang">true</samp> only if all
                    its conditions evaluate to true
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">or</samp>—Evaluates to <samp class="codeph nolang">true</samp> if any of its
                    conditions evaluate to true
                  </li>

                  <li class="li">Advanced logic like <samp class="codeph nolang">1 AND (2 OR
                      3)</samp>—Evaluates to <samp class="codeph nolang">true</samp> if the first condition is <samp class="codeph nolang">true</samp> and either the second
                    or third condition if <samp class="codeph nolang">true</samp>. <p class="p">When you use advanced logic, the
                      string must consist of 1,000 or fewer
                      characters.</p>
                  </li>

                </ul>
                <p class="p">This field is available in API version 63.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15495" data-title="Field Name">initBehavior</td>

              <td class="entry" headers="d950606e15498" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15501" data-title="Description">Specifies when to run screen actions after a screen loads. Valid
                values are:<a name="ul_bqj_tzn_zfc"><!-- --></a>
                <ul class="ul bulletList" id="ul_bqj_tzn_zfc">
                  <li class="li">
                    <samp class="codeph nolang">runOnLoad</samp>—Run screen
                    actions the first time a screen is visited, regardless of
                    the occurrence of any triggering events.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">runOnRevisit</samp>—Run screen
                    actions every time a screen is revisited by the user
                    clicking <strong class="ph uicontrol">Next</strong>, regardless of the
                    occurrence of any triggering events.
                  </li>

                </ul>
                <p class="p">This field is available in API version 64.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15495" data-title="Field Name">screenActionName</td>

              <td class="entry" headers="d950606e15498" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15501" data-title="Description">Required. The API name of the FlowScreenAction to run when
                conditions are met.</td>

            </tr>

          </tbody>

        </table>

## FlowStage

A section of your flow that can be represented in the UI, such as with breadcrumbs. It extends [FlowElement](#FlowElement) and inherits all its fields.

When an interview starts, any stages where isActive is true are added to the $Flow.ActiveStages global variable, which holds a collection of stages. Each stage’s stageOrder determines the order they’re added in. The stage with the lowest stageOrder is assigned to the $Flow.CurrentStage global variable.

| Field Name | Field Type | Description |
| --- | --- | --- |
| isActive | boolean | Indicates whether the stage is active by default. |
| label | string | A user-friendly label for this stage. |
| stageOrder | int | Indicates how the stage is ordered against other stages. The stageOrder value must be unique within the flow. |

## FlowStageStep

A step resource defines a step within a stage node. This metadata type is available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e15753">Field Name</th>

              <th class="featureTableHeader  " id="d950606e15756">Field Type</th>

              <th class="featureTableHeader  " id="d950606e15759">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Required. Name of the flow associated with the step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">actionType</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Required. The type of the step. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">stepApproval</samp>—An
                    Approval step available only for flow approval processes.
                    This value is available in API version 62.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">stepBackground</samp>—A
                    Background step available for both flow approval processes
                    and orchestrations.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">stepInteractive</samp>—An
                    Interactive step available only for orchestrations.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">stepMuleSoft</samp>—A MuleSoft
                    step available only for orchestrations.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">assignees</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type"><a class="xref" href="#subtype_FlowStageStepAssignee">FlowStageStepAssignee</a></td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of users, groups, or queues that are assigned to
                complete the interactive step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">canAssigneeEdit</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">debugSimulateStep</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Specifies whether to run the step in rollback mode. This field is
                available in API version 650 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">entryActionInputParameters</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStepEntryActionInputParameter">FlowStageStepEntryActionInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of input parameters from the step to the evaluation flow
                that are used as an entry condition for the step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">entryActionName</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15759" data-title="Description">The name of the evaluation flow used as an entry condition for
                the step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">entryActionOutputParameters</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStepEntryActionOutputParameter">FlowStageStepEntryActionOutputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of output parameters from the evaluation flow to the
                step used to determine if the step can be started.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">entryActionType</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e15759" data-title="Description">The type of the evaluation flow used as a custom entry condition
                for the step. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">EvaluationFlow</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">entryConditionLogic</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Defines how the entry requirements for a step are evaluated.
                Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">And</samp></li>

                  <li class="li"><samp class="codeph nolang">Or</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom logic, such as (1 AND (2
                      OR 3))</samp></li>

                  <li class="li"><samp class="codeph nolang">Formula</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">entryConditions</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of requirements that must be met to start the
                step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">exitActionInputParameters</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStepExitActionInputParameter">FlowStageStepExitActionInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of input parameters from the step to the evaluation
                flow. These parameters specify an exit condition for the
                step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">exitActionName</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15759" data-title="Description">The name of the step exit evaluation flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">exitActionOutputParameters</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStepExitActionOutputParameter">FlowStageStepExitActionOutputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of output parameters from the evaluation flow to the
                step. These parameters specify an exit condition for the
                step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">exitActionType</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e15759" data-title="Description">The type of the evaluation flow used as a custom exit condition
                for the step. The only possible value are:<a name="ul_gyq_kft_g2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_gyq_kft_g2c">
                  <li class="li"><samp class="codeph nolang">EvaluationFlow</samp></li>

                </ul>
                .
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">exitConditionLogic</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Defines how the exit requirements for an interactive step are
                evaluated. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">And</samp></li>

                  <li class="li"><samp class="codeph nolang">Or</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom logic, such as (1 AND (2
                      OR 3))</samp></li>

                  <li class="li"><samp class="codeph nolang">Formula</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">exitConditions</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of requirements to be met for exiting an interactive
                step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">inputParameters</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStepInputParameter">FlowStageStepInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of input parameters from the step to its associated
                flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Required. The label for the step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">outputConfigParams</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStepOutputConfigParam">FlowStageStepOutputConfigParam</a>[]
              </td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of mock output values to use to debug the step in
                rollback mode. This field is available in API version 650 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">outputParameters</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">
                <a class="xref" href="#subtype_FlowStageStepOutputParameter">FlowStageStepOutputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e15759" data-title="Description">An array of output parameters from a flow to its associated step.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">requiresAsyncProcessing</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Not used in API version 63.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">requiresMultiMemberApproval</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Indicates whether an approval step assigned to a group requires
                all group members to approve. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">0</samp>—A single group
                    member, queue member, or delegate approves or rejects the
                    approval work item, which approves or rejects the approval
                    step.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">100</samp>—All group members
                    or their delegates approve their child approval work items
                    to approve the step. If any group member or delegate rejects
                    their child approval work item, the approval step is
                    rejected.
                  </li>

                </ul>
                This field is available in API version 67.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">shouldLock</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e15753" data-title="Field Name"><span class="keyword parmname">stepSubtype</span></td>

              <td class="entry" headers="d950606e15756" data-title="Field Type">FlowElementSubtype (enumeration of type string)</td>

              <td class="entry" headers="d950606e15759" data-title="Description">Reserved for internal use.</td>

            </tr>

          </tbody>

        </table>

## FlowStageStepAssignee

An assignee associated with an Interactive step. Applicable only for interactive steps. This metadata type is available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e16234">Field Name</th>

              <th class="featureTableHeader  " id="d950606e16237">Field Type</th>

              <th class="featureTableHeader  " id="d950606e16240">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e16234" data-title="Field Name"><span class="keyword parmname">assignee</span></td>

              <td class="entry" headers="d950606e16237" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e16240" data-title="Description">Names of the user, group, or queue assigned to the interactive
                step.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16234" data-title="Field Name"><span class="keyword parmname">assigneeType</span></td>

              <td class="entry" headers="d950606e16237" data-title="Field Type">FlowStageStepAssigneeType (enumeration of type string)</td>

              <td class="entry" headers="d950606e16240" data-title="Description">Required. The type of the assignee associated with the
                interactive step. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Group</samp></li>

                  <li class="li"><samp class="codeph nolang">Queue</samp></li>

                  <li class="li"><samp class="codeph nolang">User</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">invalid—</samp> This value is
                    available in API version 61.0 and later.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## FlowStageStepEntryActionInputParameter

Defines an input parameter from the step to its associated evaluation flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 53.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. The unique name for the input parameter of the evaluation flow used by a step as an entry condition. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value of the input parameter of the evaluation flow used by a step as an entry condition. |

## FlowStageStepEntryActionOutputParameter

Defines an output parameter from an evaluation flow used to determine if the step meets entry criteria. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e16395">Field Name</th>

              <th class="featureTableHeader  " id="d950606e16398">Field Type</th>

              <th class="featureTableHeader  " id="d950606e16401">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e16395" data-title="Field Name"><span class="keyword parmname">assignToReference</span></td>

              <td class="entry" headers="d950606e16398" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16401" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16395" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d950606e16398" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16401" data-title="Description">Required. A unique name for the output parameter of the
                evaluation flow used by a step as an entry condition. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">isOrchestrationConditionMet</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## FlowStageStepExitActionInputParameter

Defines an input parameter from the stage or step to its associated evaluation flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 53.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. A unique name for the input parameter of the evaluation flow used by a stage or step as an exit condition. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value of the input parameter of the evaluation flow used by a stage or step as an exit condition. |

## FlowStageStepExitActionOutputParameter

Defines an output parameter from an evaluation flow used to determine if the stage or step meets exit criteria. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 53.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToReference | string | Reserved for future use. |
| name | string | Required. A unique name for the output parameter of the evaluation flow used by a stage or step as an exit condition. The only possible value is isOrchestrationConditionMet. |

## FlowStageStepInputParameter

Defines an input parameter from the step to the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 53.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Unique name for the input parameter for a flow associated with the step. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value of the input parameter of the flow associated with a step. |

## FlowStageStepOutputConfigParam

Defines a mock output value for a step. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 65.0 and later.

<table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry">Field Name</td><td class="entry">Field Type</td><td class="entry">Description</td></tr><tr><td class="entry"><span class="keyword parmname">name</span></td><td class="entry">string</td><td class="entry">Required. Unique name for the mock output value associated with the step.</td></tr><tr><td class="entry"><span class="keyword parmname">value</span></td><td class="entry"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td><td class="entry">Required. Defines the value of the mock output value. For enhanced security and data privacy, don't store personal identifiable information in this field.</td></tr></tbody></table>

## FlowStageStepOutputParameter

Defines an output parameter from the step to the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 53.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToReference | string | Reserved for future use. |
| name | string | Required. Unique name for the output parameter for a flow associated with the step. |

## FlowStart

Represents the flow’s Start element, which specifies how the flow starts. In an autolaunched flow, the Start element also defines when and how frequently to run the flow. To run the flow only for specific records, the Start element can define filter criteria.

FlowStart extends [FlowNode](#FlowNode) and inherits all its fields except name and label. This metadata type is available in API version 47.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e16825">Field Name</th>

              <th class="featureTableHeader  " id="d950606e16828">Field Type</th>

              <th class="featureTableHeader  " id="d950606e16831">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">activation</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The ID of the activation that triggers the flow. This field is
                available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">activationTemplate</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The name of the activation template that determines the contact
                point for each channel configured in the activation template for a
                segment-triggered flow. This field is available in 66.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">capabilityTypes</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">
                <a class="xref" href="#FlowCapability">FlowCapability</a>[]
              </td>

              <td class="entry" headers="d950606e16831" data-title="Description">An array of capabilities that can pass data with the flow. Only
                one capability is supported in API version 60.0 and later. This
                field is available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e16831" data-title="Description">Specifies which element to execute first.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">conditionLogic</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">Defines how the filtering conditions are evaluated. Valid values
                are:<a name="ul_wh2_m3y_jgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_wh2_m3y_jgc">
                  <li class="li"><samp class="codeph nolang">And</samp></li>

                  <li class="li"><samp class="codeph nolang">Or</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">conditions</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e16831" data-title="Description">An array of conditions that must be true for the event to
                trigger.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">dataGraph</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The data graph associated with the flow. Reference fields from
                this data graph throughout the flow. This field is available in API
                version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">dataLookups</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">
                <a class="xref" href="#FlowDataLookup">FlowDataLookup</a>[]
              </td>

              <td class="entry" headers="d950606e16831" data-title="Description">An array of data lookups that define how to retrieve related
                records at run time. This field is available in API version 68.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">dataTypeMappings</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">
                <a class="xref" href="#FlowDataTypeMapping">FlowDataTypeMapping</a>[]
              </td>

              <td class="entry" headers="d950606e16831" data-title="Description">An array of data type mappings for input and output values that
                have the generic sObject data type. This field is available in API
                version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">doesRequireRecordChangedToMeetCriteria</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e16831" data-title="Description">If set to <samp class="codeph nolang">true</samp>, conditions
                evaluate to <samp class="codeph nolang">true</samp> only if the
                record didn’t meet the required conditions before the triggering
                update but now meets the conditions after the update. This field is
                available in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">entryType</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">FlowEntryType (enumeration of type string)</td>

              <td class="entry" headers="d950606e16831" data-title="Description">Specifies when a unified individual can join a flow. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AfterCompletion</samp>—Unified
                    individuals can join the flow only after they complete all
                    previous flow runs of the same flow definition.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Always</samp>—Unified
                    individuals can always join the flow.
                  </li>

                  <li class="li">Never—Unified individuals can never reenter the flow. This
                    value is available in API version 63.0 and later.</li>

                </ul>
                <p class="p">This field is available in API version 60.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">eventName</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The name of the automation event that triggers the automation
                event-triggered flow. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">trgrOnSmsSubscription</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnEmailSubscription</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnOrderPlacement</samp></li>

                  <li class="li">The API name of a form </li>

                  <li class="li">The API name of an external service</li>

                </ul>
                <p class="p">This field is available in API version 61.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">eventType</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The type of the automation event that triggers the automation
                event-triggered flow. Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">exploreConversation</samp>—Available in API version 61.0
                    and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">externalEvent</samp></li>

                  <li class="li"><samp class="codeph nolang">processWebStoreUserRgstr</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnB2cCartAbandoned</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">trgrOnCustomEvent</samp>—Available in API version 64.0
                    and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">trgrOnEmailBounceEngagement</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnEmailLinkClickEngagement</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnEmailOpenEngagement</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnEmailSubscription</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnFormSubmission</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnOrderPlacement</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnPostOrdMktCmpnEngagement</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">trgrOnReferralEventSubmission</samp>—Available in API
                    version 65.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">trgrOnSmsDeliveryFailureEngagement</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnSmsLinkClickEngagement</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnSmsResponseEngagement</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnSmsSubscription</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">trgOnVoucherStsChgOtbdEngmt</samp>—Available in API
                    version 65.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">trgrOnWebCartAbandoned</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnWhatsAppDeliveredEngagement</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnWhatsAppDlvrFailureEngmt</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnWhatsAppLinkClickEngmt</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnWhatsAppReadEngagement</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnWhatsAppResponseEngmt</samp></li>

                  <li class="li"><samp class="codeph nolang">trgrOnWhatsAppSubscription</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">fanOutAction</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type"><a class="xref" href="#FlowActionCall">FlowActionCall</a></td>

              <td class="entry" headers="d950606e16831" data-title="Description">The invocable action in the Start element of a broadcast flow.
                This field is available in 66.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">filterFormula</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">A formula that’s used to filter what records execute the flow
                during a save. Available only in record-triggered flows. This field
                is available in API version 55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">filterLogic</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The filter logic that’s applied to the filter condition
                requirements. To require all conditions, use <samp class="codeph nolang"> AND</samp>. To require any conditions,
                use <samp class="codeph nolang">OR</samp>. For custom condition
                logic, enter the entire logic string, for example <samp class="codeph nolang">1 AND 2 OR (3 AND 4)</samp>. This field is
                available in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">
                <a class="xref" href="#FlowRecordFilter">FlowRecordFilter</a>[]
              </td>

              <td class="entry" headers="d950606e16831" data-title="Description">An array of filters to apply when retrieving records from the
                database. For example, filter accounts to include only the records
                that haven’t been updated in the last 4 weeks.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">flowRunAsUser</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">Specifies who to run the flow as. Possible values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">TriggeringUser</samp>—Run the
                    flow as the user that triggered the flow.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DefaultWorkflowUser</samp>—Run
                    the flow as the default workflow user.
                  </li>

                </ul>
                This field is available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">form</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">Required only for form-triggered flows. The content key value for
                the form used to trigger the flow. This field is available in API
                version 59.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">inputs</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">
                <a class="xref" href="#FlowStartInputParameter">FlowStartInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e16831" data-title="Description">An array of inputs to the Start element.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">maxBatchSize</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The maximum number of interviews to execute in a single batch for
                a schedule-triggered flow, from <samp class="codeph nolang">1</samp> to <samp class="codeph nolang">200</samp>.
                Default is <samp class="codeph nolang">200</samp>. This field is
                available in API version 67.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">object</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The object whose records you want to retrieve from the database.
                A flow interview starts for each record that meets the filter
                conditions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">prioritizedContactPointsList</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">A comma-separated list of channels used to choose the individual
                in the segment-triggered flow. The flow ranks these channels to
                select an individual. Valid values are: <samp class="codeph nolang">Email</samp>, <samp class="codeph nolang">Phone</samp>. <p class="p">
                  If the flow finds contact points for both, it uses the
                  higher-ranked channel. For example, if the list is <samp class="codeph nolang">Phone</samp>, <samp class="codeph nolang">Email</samp> and both exist, the flow
                  selects the individual associated with the phone. This field is
                  available in 66.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">publishSegment</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e16831" data-title="Description">Indicates whether to republish the segment and update segment
                membership before the flow runs or on the segment’s Data Cloud
                publish schedule. When the value is <samp class="codeph nolang">true</samp>, the segment is&nbsp;immediately republished before
                the flow runs, and ignores the segment's publish schedule. When the
                value is <samp class="codeph nolang">false</samp>, the segment is
                republished on the segment's Data Cloud publish schedule, but the
                segment isn't republished if the schedule is set to <samp class="codeph nolang">Do not refresh</samp>.<p class="p">The default value
                  is <samp class="codeph nolang">false</samp>.</p>
                <p class="p">This field
                  is available in API version 60.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">recordTriggerType</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">RecordTriggerType (enumeration of type string)</td>

              <td class="entry" headers="d950606e16831" data-title="Description">Specifies what type of record changes can start the flow.
                Possible values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Create</samp>—When a record is
                    created.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Update</samp>—When a record is
                    updated.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CreateAndUpdate</samp>—When a
                    record is created and updated.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Delete</samp>—When a record is
                    deleted. This value is available in API version 50.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">None</samp>—For flows that
                    aren’t record-triggered flows. This value is available in
                    API version 55.0 and later.
                  </li>

                </ul>
                <p class="p">Available only when <span class="keyword parmname">triggerType</span> is
                  <samp class="codeph nolang">RecordBeforeSave</samp> or
                  <samp class="codeph nolang">DataCloudDataChange</samp>.
                  This field is available in API version 48.0 and
                  later.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">schedule</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type"><a class="xref" href="#FlowSchedule">FlowSchedule</a></td>

              <td class="entry" headers="d950606e16831" data-title="Description">Required when <span class="keyword parmname">triggerType</span> is <samp class="codeph nolang">Scheduled</samp>. Specifies when and how
                frequently the flow runs.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">scheduledPaths</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">
                <a class="xref" href="#FlowScheduledPath">FlowScheduledPath</a>[]
              </td>

              <td class="entry" headers="d950606e16831" data-title="Description">Specifies the flow’s scheduled paths. This field is available in
                API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">segment</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The segment used to trigger the flow. This field is available in
                API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">sendMsgToOneContactPtPerIndv</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e16831" data-title="Description">Indicates whether a segment-triggered flow sends a message to
                only one contact per individual (<samp class="codeph nolang">true</samp>) or multiple contacts (<samp class="codeph nolang">false</samp>). The default value is
                (<samp class="codeph nolang">false</samp>). If
                <span class="keyword parmname">activationTemplate</span> is set, this field must
                be <samp class="codeph nolang">true</samp>. This field is
                available in 66.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">TimeZoneSidKey</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">triggeringDataGraph</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The API name of the data graph that includes the data model
                object that triggers the automation event-triggered flow. This field
                is available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">triggeringDataModelObjectPath</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">The Data Cloud path to the data model object that triggers the
                automation event-triggered flow. This field is available in API
                version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">triggerType</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">FlowTriggerType (enumeration of type string)</td>

              <td class="entry" headers="d950606e16831" data-title="Description">Specifies what causes the flow to run. If you exclude this field,
                the flow has no trigger and starts only when a user or app launches
                the flow. Possible

                values are:<a name="ul_mpz_m3l_lmb"><!-- --></a>
                <ul class="ul bulletList" id="ul_mpz_m3l_lmb">
                  <li class="li">
                    <samp class="codeph nolang">Activation</samp>—The flow
                    starts when an activation is published. This value is
                    available in API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AutomationEvent</samp>—The
                    flow starts when an automation event such as an SMS
                    subscription occurs. This value is available in API version
                    62.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Capability</samp>—When
                    <span class="keyword parmname">capabilityTypes</span> is set, the flow
                    starts when the capability is run. This value is available
                    in API version 60.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DataCloudDataChange</samp>—
                    The flow starts when data model object (DMO) or calculated
                    insight object (CIO) conditions are met. This value is
                    available in API version 59.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DataGraphDataChange</samp>—
                    The flow starts when conditions are met in the specified
                    data graph field. This value is available in API version
                    63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EventDrivenJourney</samp>—Reserved for internal use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ExternalSystemChange</samp>—The flow starts when a
                    relevant change is detected in an external system. This
                    value is available in API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IndivRelatedRecord</samp>—The
                    flow starts when an object or an object with fields related
                    to an individual is created or updated. This value is
                    available in API version 66.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PlatformEvent</samp>—The flow
                    starts when a platform event message is received. This value
                    is available in API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RecordAfterSave</samp>—The
                    flow starts after a record is saved. This value is available
                    in API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RecordBeforeDelete</samp>—Deleting a record triggers an
                    autolaunched flow before the record is deleted from the
                    database. This value is available in API version 50.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RecordBeforeSave</samp>—Creating and/or updating a record
                    triggers an autolaunched flow to make more updates to that
                    record before it’s saved to the database. This value is
                    available in API version 48.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Scheduled</samp>—The flow
                    starts at the scheduled time. This value is available in API
                    version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ScheduledJourney</samp>— The
                    flow starts only at the scheduled time and frequency. This
                    value is available in API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Segment</samp>— At the
                    scheduled time, the flow send emails to individuals included
                    in the chosen segment. This value is available in API
                    version 56.0 and later.
                  </li>

                </ul>
                <p class="p">Available only when <span class="keyword parmname">processType</span> is
                  <samp class="codeph nolang">AutoLaunchedFlow</samp> or
                  <samp class="codeph nolang">PromptFlow</samp>. This field
                  is available in API version 47.0 and later.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e16825" data-title="Field Name"><span class="keyword parmname">versionString</span></td>

              <td class="entry" headers="d950606e16828" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e16831" data-title="Description">
                <p class="p">Specifies the version of the automation event.</p>

                <p class="p">This field is available in API version 65.0 and later.</p>

              </td>

            </tr>

          </tbody>

        </table>

## FlowCapability

Defines the data structure of a capability. When the capability is invoked, it triggers the flow to run and data is passed between the flow and capability. It extends [FlowElement](#FlowElement) and inherits all of its fields. This metadata type is available in API version 60.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| capabilityName | string | Required. The specified capability that the flow integrates with. The valid format is Name://Name, for example, PromptBuilder://SalesEmail |
| inputs | [FlowCapabilityInput](#FlowCapabilityInput)\[\] | An array of capability inputs. The flow sets the input values and passes the data to the capability. |

## FlowCapabilityInput

Defines the data structure of a capability input. It extends [FlowElement](#FlowElement) and inherits all of its fields. This metadata type is available in API version 60.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e17806">Field Name</th>

              <th class="featureTableHeader  " id="d950606e17809">Field Type</th>

              <th class="featureTableHeader  " id="d950606e17812">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e17806" data-title="Field Name"><span class="keyword parmname">capabilityInputName</span></td>

              <td class="entry" headers="d950606e17809" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e17812" data-title="Description">Required. The input name is the same for the capability and the
                flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e17806" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d950606e17809" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e17812" data-title="Description">The data type of the capability input. Valid types are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Boolean</samp>—This value is
                    available in API version 61.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Currency</samp>—This value is
                    available in API version 61.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Date</samp>—This value is
                    available in API version 61.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Number</samp>—This value is
                    available in API version 61.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sObject</samp>—This value
                    corresponds to a record variable. This value is available in
                    API version 60.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">String</samp>—This value is
                    available in API version 61.0 and later.
                  </li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e17806" data-title="Field Name"><span class="keyword parmname">isCollection</span></td>

              <td class="entry" headers="d950606e17809" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e17812" data-title="Description">Required. Indicates whether the input is a collection of values.
                The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

          </tbody>

        </table>

## FlowStartInputParameter

Defines an input parameter to the flow Start element. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 62.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. The unique name for the input parameter to the Start element. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value of the input parameter to the Start element. |

## FlowStep

Steps function as placeholders when you’re building a flow. It extends [FlowNode](#FlowNode) and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| connectors | [FlowConnector](#FlowConnector)\[\] | Specifies which node to execute after the step node. |

## FlowSubflow

A subflow element references another flow, which it calls at run time. The flow that contains the subflow element is referred to as the parent flow. FlowSubflow extends [FlowNode](#FlowNode) and inherits all its fields. It’s available in API version 25.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e18057">Field Name</th>

              <th class="featureTableHeader  " id="d950606e18060">Field Type</th>

              <th class="featureTableHeader  " id="d950606e18063">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e18057" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e18060" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e18063" data-title="Description">Specifies which node to execute after the subflow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18057" data-title="Field Name"><span class="keyword parmname">flowName</span></td>

              <td class="entry" headers="d950606e18060" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e18063" data-title="Description">References the flow to call at runtime. The value must be an API
                name of a flow and it can’t contain an appended hyphen and version
                number.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18057" data-title="Field Name"><span class="keyword parmname">inputAssignments</span></td>

              <td class="entry" headers="d950606e18060" data-title="Field Type">
                <a class="xref" href="#FlowSubflowInputAssignment">FlowSubflowInputAssignment</a>[]
              </td>

              <td class="entry" headers="d950606e18063" data-title="Description">An array of input variable assignments that are set at the start
                of the flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18057" data-title="Field Name"><span class="keyword parmname">outputAssignments</span></td>

              <td class="entry" headers="d950606e18060" data-title="Field Type">
                <a class="xref" href="#FlowSubflowOutputAssignment">FlowSubflowOutputAssignment</a>[]
              </td>

              <td class="entry" headers="d950606e18063" data-title="Description">An array of output variable assignments that are set at the end
                of the flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18057" data-title="Field Name"><span class="keyword parmname">storeOutputAutomatically</span></td>

              <td class="entry" headers="d950606e18060" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e18063" data-title="Description">Indicates whether the subflow’s output parameters are
                automatically available in the flow without creating any variables.
                When the value is <samp class="codeph nolang">true</samp>, you can
                reference an output parameter by specifying the API name of the
                subflow in the flow. When the value is <samp class="codeph nolang">false</samp>, create variables manually to store output
                values from the subflow. The default value is <samp class="codeph nolang">false</samp>.<p class="p">This field is available in
                  API version 49.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowSubflowInputAssignment

Assigns an element or value from the parent flow to a variable in the referenced flow. Input assignments occur when the subflow calls the referenced flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. It’s available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Unique name for the variable in the referenced flow. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value to assign to the variable. |

## FlowSubflowOutputAssignment

Assigns the value of a variable from the referenced flow to a variable in the parent flow. Output assignments occur when the referenced flow is finished running. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. It’s available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToReference | string | Unique name for the variable in the parent flow. |
| name | string | Required. Unique name for the variable in the referenced flow. |

## FlowTransform

Defines a node that can dynamically transform the value of source data to target data in the flow. It extends [FlowNode](#FlowNode) and inherits all of its fields. This metadata type is available in API version 59.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e18329">Field Name</th>

              <th class="featureTableHeader  " id="d950606e18332">Field Type</th>

              <th class="featureTableHeader  " id="d950606e18335">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e18329" data-title="Field Name"><span class="keyword parmname">apexClass</span></td>

              <td class="entry" headers="d950606e18332" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e18335" data-title="Description">The Apex class of the target data after transformation if its
                data type is <samp class="codeph nolang">Apex</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18329" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e18332" data-title="Field Type">
                <a class="xref" href="#FlowConnector">FlowConnector</a>[]
              </td>

              <td class="entry" headers="d950606e18335" data-title="Description">Specifies which node to execute after this data
                transformation.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18329" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d950606e18332" data-title="Field Type">FlowDataType (enumeration of type string)</td>

              <td class="entry" headers="d950606e18335" data-title="Description">Required. Specifies the data type of the transformed data. In
                Flow Builder, it corresponds to the target data in the Transform
                element. Valid types are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Apex</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Boolean</samp>—This value is
                    available in API version 62.0.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Currency</samp>—This value is
                    available in API version 62.0.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Date</samp>—This value is
                    available in API version 62.0.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DateTime</samp>—This value is
                    available in API version 62.0.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Number</samp>—This value is
                    available in API version 62.0.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">String</samp>—This value is
                    available in API version 62.0.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sObject</samp>—This value
                    corresponds to a record variable.
                  </li>

                  <li class="li"><samp class="codeph nolang">Time</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18329" data-title="Field Name"><span class="keyword parmname">isCollection</span></td>

              <td class="entry" headers="d950606e18332" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e18335" data-title="Description">Indicates whether the variable is a collection of values. The
                default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18329" data-title="Field Name"><span class="keyword parmname">objectType</span></td>

              <td class="entry" headers="d950606e18332" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e18335" data-title="Description">Object type of this variable resource if its data type is <samp class="codeph nolang">sObject</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18329" data-title="Field Name"><span class="keyword parmname">scale</span></td>

              <td class="entry" headers="d950606e18332" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e18335" data-title="Description">Controls the number of digits to the right of the decimal point
                up to 17 places. If you leave this field blank or set it to zero,
                only whole numbers appear when your flow runs. <p class="p">Corresponds to the
                  Decimal Places field in Flow Builder.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18329" data-title="Field Name"><span class="keyword parmname">storeOutputAutomatically</span></td>

              <td class="entry" headers="d950606e18332" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e18335" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18329" data-title="Field Name"><span class="keyword parmname">transformValues</span></td>

              <td class="entry" headers="d950606e18332" data-title="Field Type">
                <a class="xref" href="#FlowTransformValue">FlowTransformValue</a>[]
              </td>

              <td class="entry" headers="d950606e18335" data-title="Description">An array of values for data transformation</td>

            </tr>

          </tbody>

        </table>

## FlowTransformValue

Defines the values for transforming specific data in the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 59.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| transformValueActions | [FlowTransformValueAction](#FlowTransformValueAction)\[\] | An array of actions for data transformation |
| transformValueName | string | Reserved for future use. |
| transformValueLabel | string | Reserved for future use. |
| transformValueDescription | string | Reserved for future use. |

## FlowTransformValueAction

Defines the data and actions to transform in the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. This metadata type is available in API version 59.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e18638">Field Name</th>

              <th class="featureTableHeader  " id="d950606e18641">Field Type</th>

              <th class="featureTableHeader  " id="d950606e18644">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e18638" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d950606e18641" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e18644" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18638" data-title="Field Name"><span class="keyword parmname">actionType</span></td>

              <td class="entry" headers="d950606e18641" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e18644" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18638" data-title="Field Name"><span class="keyword parmname">actionVersionString</span></td>

              <td class="entry" headers="d950606e18641" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e18644" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18638" data-title="Field Name"><span class="keyword parmname">assignToReference</span></td>

              <td class="entry" headers="d950606e18641" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e18644" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18638" data-title="Field Name"><span class="keyword parmname">inputParameters</span></td>

              <td class="entry" headers="d950606e18641" data-title="Field Type">
                <a class="xref" href="#FlowTransformValueActionInputParameter">FlowTransformValueActionInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e18644" data-title="Description">An array of input parameters for data transformation. This field
                is available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18638" data-title="Field Name"><span class="keyword parmname">outputFieldApiName</span></td>

              <td class="entry" headers="d950606e18641" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e18644" data-title="Description">The API name of the field for transformed data in a data
                transformation mapping. In Flow Builder, it corresponds to the
                target data field in the Transform element.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18638" data-title="Field Name"><span class="keyword parmname">transformType</span></td>

              <td class="entry" headers="d950606e18641" data-title="Field Type">FlowTransformValueActionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e18644" data-title="Description">Required. The type of transformation from source data to target
                data. Valid types are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Count</samp>—Calculates the
                    number of items in a source collection.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">GetItemByIndex</samp>—Reserved
                    for future use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">InnerJoin</samp>—Joins
                    selected data from two source collections that are stored in
                    a target collection in a flow. This value is available in
                    API version 63.0 and later. See
                    <span class="keyword parmname">complexValueType</span> on <a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a>.
                    <samp class="codeph nolang">InnerJoin</samp> isn't a
                    valid value for <a class="xref" href="#FlowInlineTransform">FlowInlineTransform</a>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">InvocableAction</samp>—Reserved for future use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Map</samp>—Specifies a mapping
                    between the datasets in flows. In Flow Builder, it
                    corresponds to the mapping between source data fields and
                    target data fields.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Sum</samp>—Adds the numeric
                    values of a field on each item in a collection.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18638" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d950606e18641" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e18644" data-title="Description">Defines the value of the transformed data. In Flow Builder, the
                value of this field corresponds to the result of the target data
                field in the Transform element.</td>

            </tr>

          </tbody>

        </table>

## FlowTransformValueActionInputParameter

Defines the input parameters of the source data for data transformation. This metadata type is available in API version 60.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e18834">Field Name</th>

              <th class="featureTableHeader  " id="d950606e18837">Field Type</th>

              <th class="featureTableHeader  " id="d950606e18840">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e18834" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d950606e18837" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e18840" data-title="Description">A key that specifies the configuration of input parameters for
                this data transformation when <span class="keyword parmname">transformType</span> is
                set to <samp class="codeph nolang">Sum</samp> or <samp class="codeph nolang">Count</samp>. Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">aggregationField</samp>—The
                    field on each item in a source collection that’s used to
                    calculate the transformed value.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">aggregationValues</samp>—The
                    source collection that’s used to calculate the transformed
                    value.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18834" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d950606e18837" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e18840" data-title="Description">Defines the value of the specified key in
                <span class="keyword parmname">name</span>.
              </td>

            </tr>

          </tbody>

        </table>

## FlowTextTemplate

Defines a text template that can be used throughout the flow. It extends [FlowElement](#FlowElement) and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e18929">Field Name</th>

              <th class="featureTableHeader  " id="d950606e18932">Field Type</th>

              <th class="featureTableHeader  " id="d950606e18935">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e18929" data-title="Field Name"><span class="keyword parmname">isViewedAsPlainText</span></td>

              <td class="entry" headers="d950606e18932" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e18935" data-title="Description">If set to <samp class="codeph nolang">true</samp>, the flow
                resource remembers the View as Plain Text setting used for the text
                template after the flow resource is saved. If set to <samp class="codeph nolang">false</samp>, the flow resource uses the
                View as Rich Text setting.<p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e18929" data-title="Field Name"><span class="keyword parmname">text</span></td>

              <td class="entry" headers="d950606e18932" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e18935" data-title="Description">Actual text of the template. Supports merge fields.</td>

            </tr>

          </tbody>

        </table>

## FlowValueMappingType

Defines the specific data transformation type that converts the value of a source action output parameter in valueMappingKey before assigning the result to the target output parameter in valueMappingTarget.

| Field Name | Field Type | Description |
| --- | --- | --- |
| FirstEntry | string | This configuration extracts the first item's object in valueMappingKey and assigns it to the target output parameter in valueMappingTarget. |

## FlowVariable

With variables, creates updatable values to use in the flow. FlowVariable extends [FlowElement](#FlowElement) and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e19074">Field Name</th>

              <th class="featureTableHeader  " id="d950606e19077">Field Type</th>

              <th class="featureTableHeader  " id="d950606e19080">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e19074" data-title="Field Name"><span class="keyword parmname">apexClass</span></td>

              <td class="entry" headers="d950606e19077" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19080" data-title="Description">The Apex class of this variable if its data type is <samp class="codeph nolang">Apex</samp>. This field is available in
                API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19074" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d950606e19077" data-title="Field Type">FlowDataType (enumeration of type string)</td>

              <td class="entry" headers="d950606e19080" data-title="Description">Required. Valid types are:<a name="FlowDataType_ext_values"><!-- --></a>
                <ul class="ul bulletList" id="FlowDataType_ext_values">
                  <li class="li">
                    <samp class="codeph nolang">Apex</samp>—This value is
                    available in API version 46.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">DateTime</samp>—This value is
                    available in API version 30.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Multipicklist</samp>—This
                    value is available in API version 34.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Picklist</samp>—This value is
                    available in API version 34.0 and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">sObject</samp>—This value
                    corresponds to a record variable.
                  </li>

                  <li class="li"><samp class="codeph nolang">Time</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19074" data-title="Field Name"><span class="keyword parmname" id="field_isCollection_name"><a name="field_isCollection_name"><!-- --></a>isCollection</span></td>

              <td class="entry" headers="d950606e19077" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e19080" data-title="Description">
                <span class="ph" id="field_isCollection_desc"><a name="field_isCollection_desc"><!-- --></a>Indicates whether the variable
                  is a collection of values.</span> This field is available in API
                version 30.0 and later. In API version 32.0 and later, a collection
                variable can be of any data type.<p class="p">The default value is <samp class="codeph nolang">False</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19074" data-title="Field Name"><span class="keyword parmname" id="field_isInput_name"><a name="field_isInput_name"><!-- --></a>isInput</span></td>

              <td class="entry" headers="d950606e19077" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e19080" data-title="Description">
                <span class="ph" id="field_isInput_desc"><a name="field_isInput_desc"><!-- --></a>Indicates whether the variable can be
                  set at the start of the flow using URL parameters, Visualforce
                  controllers, or subflow inputs.</span> This field is available in
                API version 25.0 and later.<p class="p">Default value:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">False</samp> for a variable
                    created in API version 25.0 and later or in the Flow Builder
                    in Summer ’12 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">True</samp> for a variable
                    created in API version 24.0 or in Flow Builder in Spring ’12
                    and earlier.
                  </li>

                </ul>
                <p class="p">Disabling input or output access for an existing variable
                  can break the functionality of applications and pages that call
                  the flow and access the variable. For example, you can access
                  variables from URL parameters, processes, and other
                  flows.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19074" data-title="Field Name"><span class="keyword parmname" id="field_isOutput_name"><a name="field_isOutput_name"><!-- --></a>isOutput</span></td>

              <td class="entry" headers="d950606e19077" data-title="Field Type">boolean</td>

              <td class="entry" headers="d950606e19080" data-title="Description">
                <span class="ph" id="field_isOutput_desc"><a name="field_isOutput_desc"><!-- --></a>Indicates whether the variable’s
                  value can be accessed from Visualforce controllers and other
                  flows.</span> This field is available in API version 25.0 and
                later.<p class="p">Default value:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">False</samp> for a variable
                    created in API version 25.0 and later or in the Flow Builder
                    in Summer ’12 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">True</samp> for a variable
                    created in API version 24.0 or in Flow Builder in Spring ’12
                    and earlier.
                  </li>

                </ul>
                <p class="p">Disabling input or output access for an existing variable
                  can break the functionality of applications and pages that call
                  the flow and access the variable. For example, you can access
                  variables from URL parameters, processes, and other
                  flows.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19074" data-title="Field Name"><span class="keyword parmname">objectType</span></td>

              <td class="entry" headers="d950606e19077" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19080" data-title="Description">Object type of this variable if its data type is <samp class="codeph nolang">sObject</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19074" data-title="Field Name"><span class="keyword parmname">scale</span></td>

              <td class="entry" headers="d950606e19077" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e19080" data-title="Description">Controls the number of digits to the right of the decimal point
                up to 17 places. If you leave this field blank or set it to zero,
                only whole numbers appear when your flow runs. <p class="p">Corresponds to the
                  Decimal Places field in Flow Builder.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19074" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d950606e19077" data-title="Field Type"><a class="xref" href="#FlowElementReferenceOrValue">FlowElementReferenceOrValue</a></td>

              <td class="entry" headers="d950606e19080" data-title="Description">Default value of this variable.<p class="p">Default values aren’t supported
                  if the variable’s data type is <samp class="codeph nolang">Picklist</samp> or <samp class="codeph nolang">Multipicklist</samp>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowVisibilityRule

Visibility rules render a flow screen component when visibility rule conditions are met. Hides a flow screen component when visibility rule conditions aren’t met. This metadata type is available in API version 47.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e19331">Field Name</th>

              <th class="featureTableHeader  " id="d950606e19334">Field Type</th>

              <th class="featureTableHeader  " id="d950606e19337">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e19331" data-title="Field Name"><span class="keyword parmname">conditionLogic</span></td>

              <td class="entry" headers="d950606e19334" data-title="Field Type"> string</td>

              <td class="entry" headers="d950606e19337" data-title="Description">Specifies logic for the conditions. Value can be:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">and</samp>—Evaluates to
                    <samp class="codeph nolang">true</samp> only if all
                    its conditions evaluate to true.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">or</samp>—Evaluates to <samp class="codeph nolang">true</samp> if any of its
                    conditions evaluate to true.
                  </li>

                  <li class="li">Advanced logic like <samp class="codeph nolang">1 AND (2 OR
                      3)</samp>—Evaluates to <samp class="codeph nolang">true</samp> if the first condition is <samp class="codeph nolang">true</samp> and either the second
                    or third condition is <samp class="codeph nolang">true</samp>. <p class="p">When you use advanced logic, the
                      string must consist of 1,000 or fewer characters.
                    </p>
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19331" data-title="Field Name"><span class="keyword parmname">conditions</span></td>

              <td class="entry" headers="d950606e19334" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e19337" data-title="Description">An array of conditions that must be true for the flow to wait for
                this event.</td>

            </tr>

          </tbody>

        </table>

## FlowWait

Waits for one or more defined events to occur. FlowWait extends [FlowNode](#FlowNode) and inherits all its fields. FlowWait is available in API version 32.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e19440">Field Name</th>

              <th class="featureTableHeader  " id="d950606e19443">Field Type</th>

              <th class="featureTableHeader  " id="d950606e19446">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e19440" data-title="Field Name"><span class="keyword parmname">defaultConnector</span></td>

              <td class="entry" headers="d950606e19443" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e19446" data-title="Description">Specifies which node to execute if the conditions are false for
                every event in the Wait element.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19440" data-title="Field Name"><span class="keyword parmname">defaultConnectorLabel</span></td>

              <td class="entry" headers="d950606e19443" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19446" data-title="Description">Label for the default connector.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19440" data-title="Field Name"><span class="keyword parmname">faultConnector</span></td>

              <td class="entry" headers="d950606e19443" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e19446" data-title="Description">Specifies which node to execute if the attempt to wait results in
                an error. If any of the wait events fail, the flow takes the fault
                connector.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19440" data-title="Field Name"><span class="keyword parmname">timeZoneId</span></td>

              <td class="entry" headers="d950606e19443" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19446" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19440" data-title="Field Name"><span class="keyword parmname">waitEvents</span></td>

              <td class="entry" headers="d950606e19443" data-title="Field Type">
                <a class="xref" href="#FlowWaitEvent">FlowWaitEvent</a>[]
              </td>

              <td class="entry" headers="d950606e19446" data-title="Description">An array of events that the Wait element is waiting for.<p class="p">If the
                  conditions for every event evaluate to <samp class="codeph nolang">false</samp>, the
                  <span class="keyword parmname">defaultConnector</span> is used.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowWaitEvent

An event that a FlowWait element is waiting for. FlowWaitEvent extends [FlowElement](#FlowElement) and inherits all its fields. FlowWaitEvent is available in API version 32.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d950606e19565">Field Name</th>

              <th class="featureTableHeader  " id="d950606e19568">Field Type</th>

              <th class="featureTableHeader  " id="d950606e19571">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">conditionLogic</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19571" data-title="Description">Specifies logic for the conditions. Value can be:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">and</samp>—Evaluates to
                    <samp class="codeph nolang">true</samp> only if all
                    its conditions evaluate to <samp class="codeph nolang">true</samp>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">or</samp>—Evaluates to <samp class="codeph nolang">true</samp> if any of its
                    conditions evaluate to <samp class="codeph nolang">true</samp>
                  </li>

                  <li class="li">Advanced logic like <samp class="codeph nolang">1 AND (2 OR
                      3)</samp>—Evaluates to <samp class="codeph nolang">true</samp> if the first condition is <samp class="codeph nolang">true</samp> and either the second
                    or third condition is <samp class="codeph nolang">true</samp>
                    <p class="p">When you use advanced logic, the string must consist of
                      1,000 or fewer characters.</p>
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">associatedElement</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19571" data-title="Description">The API name of the event that resumes the flow. This field is
                available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">conditions</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">
                <a class="xref" href="#FlowCondition">FlowCondition</a>[]
              </td>

              <td class="entry" headers="d950606e19571" data-title="Description">An array of conditions that must be <samp class="codeph nolang">true</samp> for the flow to wait for this
                event.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">automationEventName</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19571" data-title="Description">Name of the automation event that the Wait element is waiting
                for.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">automationEventType</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e19571" data-title="Description">The type of the automation event that triggers the Wait element
                is waiting for. Valid values are:<a name="ul_sd4_1gm_pdc"><!-- --></a>
                <ul class="ul bulletList" id="ul_sd4_1gm_pdc">
                  <li class="li">
                    <samp class="codeph nolang">exploreConversation</samp>—This value is available in API
                    version 61.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">trgrOnCustomEvent</samp>—This
                    value is available in API version 64.0 and later.
                  </li>

                  <li class="li"><span class="keyword parmname">trgrOnSmsSubscription</span></li>

                  <li class="li"><span class="keyword parmname">trgrOnEmailSubscription</span></li>

                  <li class="li"><span class="keyword parmname">trgrOnOrderPlacement</span></li>

                  <li class="li"><span class="keyword parmname">trgrOnFormSubmission</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type"><a class="xref" href="#FlowConnector">FlowConnector</a></td>

              <td class="entry" headers="d950606e19571" data-title="Description">Specifies which node to execute if this event is the first event
                that occurs.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">eventType</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19571" data-title="Description">Required. The event’s type. The type determines which input
                parameters are available to define this event. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <span class="keyword parmname">AlarmEvent</span>—This event is an alarm based
                    off an absolute date/time value.
                  </li>

                  <li class="li">
                    <span class="keyword parmname">DateRefAlarmEvent</span>—This event is an
                    alarm based off a date/time field on a record.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">extendUntil</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">Time</td>

              <td class="entry" headers="d950606e19571" data-title="Description">Reserved for future use. </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">
                <a class="xref" href="#FlowRecordFilter">FlowRecordFilter</a>[]
              </td>

              <td class="entry" headers="d950606e19571" data-title="Description">An array of filters to apply when retrieving records from the
                database. For example, filter accounts to include only the records
                that haven’t been updated in the last 4 weeks. This field is
                available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">filterlogic</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19571" data-title="Description">The filter logic that’s applied to the filter condition
                requirements. To require all conditions, use AND. To require any
                conditions, use OR. For custom condition logic, enter the entire
                logic string, for example 1 AND 2 OR (3 AND 4). This field is
                available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">inputParameters</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">
                <a class="xref" href="#FlowWaitInputParameter">FlowWaitEventInputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e19571" data-title="Description">An array of the event’s input parameters. The parameter values
                are set by using values from the flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">interactionType</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">FlowWaitInteractionType (enumeration of type string)</td>

              <td class="entry" headers="d950606e19571" data-title="Description">Specifies what type of event can resume the flow. Possible values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">RcsResponse</samp>—An RCS
                    response event. This value is available in API version 67.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SmsResponse</samp>—An SMS
                    response event
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WhatsappResponse</samp>—A
                    WhatsApp response event
                  </li>

                </ul>
                This field is available in API version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19571" data-title="Description">Required. Label for the wait event.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">object</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">string</td>

              <td class="entry" headers="d950606e19571" data-title="Description">The object that contains the event you want to use to resume the
                flow. This field is available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">offset</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">int</td>

              <td class="entry" headers="d950606e19571" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">offsetUnit</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">FlowScheduledPathOffsetUnit (enumeration of type string)</td>

              <td class="entry" headers="d950606e19571" data-title="Description">Reserved for future use. </td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname" id="flowwaitevent_output_name"><a name="flowwaitevent_output_name"><!-- --></a>outputParameters</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">
                <a class="xref" href="#FlowWaitOutputParameter">FlowWaitEventOutputParameter</a>[]
              </td>

              <td class="entry" headers="d950606e19571" data-title="Description"><span class="ph" id="flowwaitevent_output_desc"><a name="flowwaitevent_output_desc"><!-- --></a>An array of the event’s output
                  parameters. The parameter values are assigned from the event to
                  variables in the flow.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d950606e19565" data-title="Field Name"><span class="keyword parmname">recordTriggerType</span></td>

              <td class="entry" headers="d950606e19568" data-title="Field Type">RecordTriggerType</td>

              <td class="entry" headers="d950606e19571" data-title="Description">Specifies what type of record changes can resume the flow.
                Possible values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Create</samp>—When a related
                    record is created
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Update</samp>—When a related
                    record is updated
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CreateAndUpdate</samp>—When a
                    related record is created and updated
                  </li>

                </ul>
                This field is available in API version 60.0 and later.</td>

            </tr>

          </tbody>

        </table>

## FlowWaitEventInputParameter

An input parameter for FlowWaitEvent. The parameter’s value is set by using values from the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. FlowWaitEventInputParameter is available in API version 32.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Unique name for the input parameter. |
| value | [FlowElementReferenceOrValue](#FlowElementReferenceOrValue) | Defines the value of the input parameter. |

## FlowWaitEventOutputParameter

An output parameter for FlowWaitEvent. The parameter’s value is assigned to a variable in the flow so that it can be referenced in another part of the flow. It extends [FlowBaseElement](#FlowBaseElement) and inherits all its fields. FlowWaitEventOutputParameter is available in API version 32.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignToReference | string | Required. Specifies the variable to which you want to assign the output parameter value. |
| name | string | Required. Unique name for the output parameter. |

## Upgrade Flow Files to API Version 44.0 or Later

In API version 43.0 and earlier, the Flow object’s fullName field included the flow’s version number. Starting in API version 44, the field no longer includes the version number. Before you deploy using API version 44.0 via Metadata API or Salesforce CLI, make sure that:

- The flows directory doesn’t include any unused flow versions.
- For each active flow, the status field is Active. Any flow without a status value is deployed or retrieved with a status value of Draft.
- The flowDefinitions directory is empty.

For Metadata API only.

- The package.xml file is set to API version 44.0.
- For the latest version of each flow, the file name doesn’t include a version number. For example, change myflow-3.flow to myflow.flow.

For Salesforce CLI only.

- The sfdx-project.json file is set to "sourceApiVersion": "44.0".
- For the latest version of each flow, the file name doesn’t include a version number. For example, change myflow-1.flow-meta.xml to myflow.flow-meta.xml.

As part of this upgrade, flow definitions are no longer necessary when you deploy or retrieve via Metadata API. If you deploy with flow definitions, the active version numbers in the flow definitions override the **status** fields in the flows. For example, the active version number in the flow definition is version 3, and the latest version of the flow is version 4 with the **status** field as Active. After you deploy your flow, the active version is version 3.

After you finished this upgrade, you can integrate with a version control system without worrying about flow file names changing. To reduce deployment issues when you push the source code into a scratch org, make sure that you don’t reuse an existing scratch org.

For more information, see [Deploy Processes and Flows as Active](https://help.salesforce.com/s/articleView?id=platform.flow_distribute_deploy_active.htm&type=5&language=en_US) in _Salesforce Help_.

## Declarative Metadata Sample Definition

Here’s a sample XML definition of a flow.

<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionCalls>
        <name>Get\_Info</name>
        <label>Get Info</label>
        <locationX>380</locationX>
        <locationY>242</locationY>
        <actionName>GetFirstFromCollection</actionName>
        <actionType>apex</actionType>
        <connector>
            <targetReference>Update\_If\_Existing</targetReference>
        </connector>
        <dataTypeMappings>
            <typeName>T\_\_inputCollection</typeName>
            <typeValue>Account</typeValue>
        </dataTypeMappings>
        <dataTypeMappings>
            <typeName>U\_\_outputMember</typeName>
            <typeValue>Account</typeValue>
        </dataTypeMappings>
        <flowTransactionModel>CurrentTransaction</flowTransactionModel>
        <inputParameters>
            <name>inputCollection</name>
            <value>
                <elementReference>accts.accounts</elementReference>
            </value>
        </inputParameters>
        <nameSegment>GetFirstFromCollection</nameSegment>
        <storeOutputAutomatically>true</storeOutputAutomatically>
        <versionSegment>1</versionSegment>
    </actionCalls>
    <actionCalls>
        <name>Post\_to\_Contact\_s\_Feed</name>
        <label>Post to Contact&apos;s Feed</label>
        <locationX>50</locationX>
        <locationY>890</locationY>
        <actionName>chatterPost</actionName>
        <actionType>chatterPost</actionType>
        <connector>
            <targetReference>Confirm</targetReference>
        </connector>
        <flowTransactionModel>CurrentTransaction</flowTransactionModel>
        <inputParameters>
            <name>text</name>
            <value>
                <elementReference>chatterMessage</elementReference>
            </value>
        </inputParameters>
        <inputParameters>
            <name>subjectNameOrId</name>
            <value>
                <elementReference>contact.Id</elementReference>
            </value>
        </inputParameters>
        <nameSegment>chatterPost</nameSegment>
        <storeOutputAutomatically>true</storeOutputAutomatically>
        <versionSegment>1</versionSegment>
    </actionCalls>
    <apiVersion>49.0</apiVersion>
    <assignments>
        <name>Set\_Contact\_ID</name>
        <label>Set Contact ID</label>
        <locationX>50</locationX>
        <locationY>674</locationY>
        <assignmentItems>
            <assignToReference>contact.Id</assignToReference>
            <operator>Assign</operator>
            <value>
                <elementReference>existingId</elementReference>
            </value>
        </assignmentItems>
        <connector>
            <targetReference>Update\_Contact</targetReference>
        </connector>
    </assignments>
    <decisions>
        <name>Update\_If\_Existing</name>
        <label>Update If Existing?</label>
        <locationX>380</locationX>
        <locationY>350</locationY>
        <defaultConnector>
            <isGoTo>true</isGoTo>
            <targetReference>Create\_Contact</targetReference>
        </defaultConnector>
        <defaultConnectorLabel>No</defaultConnectorLabel>
        <rules>
            <name>Update\_Yes</name>
            <conditionLogic>and</conditionLogic>
            <conditions>
                <leftValueReference>updateExisting</leftValueReference>
                <operator>EqualTo</operator>
                <rightValue>
                    <booleanValue>true</booleanValue>
                </rightValue>
            </conditions>
            <connector>
                <targetReference>Find\_a\_Match</targetReference>
            </connector>
            <label>Yes</label>
        </rules>
    </decisions>
    <decisions>
        <name>Update\_or\_Create</name>
        <label>Update or Create?</label>
        <locationX>182</locationX>
        <locationY>566</locationY>
        <defaultConnector>
            <targetReference>Create\_Contact</targetReference>
        </defaultConnector>
        <defaultConnectorLabel>Create New</defaultConnectorLabel>
        <rules>
            <name>Update\_Existing</name>
            <conditionLogic>and</conditionLogic>
            <conditions>
                <leftValueReference>existingId</leftValueReference>
                <operator>IsNull</operator>
                <rightValue>
                    <booleanValue>false</booleanValue>
                </rightValue>
            </conditions>
            <connector>
                <targetReference>Set\_Contact\_ID</targetReference>
            </connector>
            <label>Update Existing</label>
        </rules>
    </decisions>
    <dynamicChoiceSets>
        <name>accounts</name>
        <dataType>String</dataType>
        <displayField>Name</displayField>
        <object>Account</object>
        <outputAssignments>
            <assignToReference>contact.AccountId</assignToReference>
            <field>Id</field>
        </outputAssignments>
        <valueField>Id</valueField>
    </dynamicChoiceSets>
    <environments>Default</environments>
    <formulas>
        <name>created\_or\_updated</name>
        <dataType>String</dataType>
        <expression>IF({!Create\_Contact}, &quot;created&quot;, &quot;updated&quot;)</expression>
    </formulas>
    <interviewLabel>New Contact {!$Flow.CurrentDateTime}</interviewLabel>
    <isAdditionalPermissionRequiredToRun>true</isAdditionalPermissionRequiredToRun>
    <isTemplate>true</isTemplate>
    <label>New Contact</label>
    <processMetadataValues>
        <name>BuilderType</name>
        <value>
            <stringValue>LightningFlowBuilder</stringValue>
        </value>
    </processMetadataValues>
    <processMetadataValues>
        <name>CanvasMode</name>
        <value>
            <stringValue>AUTO\_LAYOUT\_CANVAS</stringValue>
        </value>
    </processMetadataValues>
    <processMetadataValues>
        <name>OriginBuilderType</name>
        <value>
            <stringValue>LightningFlowBuilder</stringValue>
        </value>
    </processMetadataValues>
    <processType>Flow</processType>
    <recordCreates>
        <name>Create\_Contact</name>
        <label>Create Contact</label>
        <locationX>314</locationX>
        <locationY>674</locationY>
        <connector>
            <isGoTo>true</isGoTo>
            <targetReference>Post\_to\_Contact\_s\_Feed</targetReference>
        </connector>
        <inputReference>contact</inputReference>
    </recordCreates>
    <recordLookups>
        <name>Find\_a\_Match</name>
        <label>Find a Match</label>
        <locationX>182</locationX>
        <locationY>458</locationY>
        <assignNullValuesIfNoRecordsFound>true</assignNullValuesIfNoRecordsFound>
        <connector>
            <targetReference>Update\_or\_Create</targetReference>
        </connector>
        <filterLogic>and</filterLogic>
        <filters>
            <field>FirstName</field>
            <operator>EqualTo</operator>
            <value>
                <elementReference>contact.FirstName</elementReference>
            </value>
        </filters>
        <filters>
            <field>LastName</field>
            <operator>EqualTo</operator>
            <value>
                <elementReference>contact.LastName</elementReference>
            </value>
        </filters>
        <object>Contact</object>
        <outputAssignments>
            <assignToReference>existingId</assignToReference>
            <field>Id</field>
        </outputAssignments>
    </recordLookups>
    <recordUpdates>
        <name>Update\_Contact</name>
        <label>Update Contact</label>
        <locationX>50</locationX>
        <locationY>782</locationY>
        <connector>
            <targetReference>Post\_to\_Contact\_s\_Feed</targetReference>
        </connector>
        <inputReference>contact</inputReference>
    </recordUpdates>
    <screens>
        <name>Confirm</name>
        <label>Confirm</label>
        <locationX>50</locationX>
        <locationY>998</locationY>
        <allowBack>false</allowBack>
        <allowFinish>true</allowFinish>
        <allowPause>true</allowPause>
        <fields>
            <name>confirmation\_message</name>
            <fieldText>Thanks! &lt;a href=&quot;/{!contact.Id}&quot;&gt;The contact&lt;/a&gt; was {!created\_or\_updated}.</fieldText>
            <fieldType>DisplayText</fieldType>
        </fields>
        <showFooter>true</showFooter>
        <showHeader>true</showHeader>
    </screens>
    <screens>
        <name>Contact\_Info</name>
        <label>Contact Info</label>
        <locationX>380</locationX>
        <locationY>134</locationY>
        <allowBack>true</allowBack>
        <allowFinish>true</allowFinish>
        <allowPause>true</allowPause>
        <connector>
            <targetReference>Get\_Info</targetReference>
        </connector>
        <fields>
            <name>contactName</name>
            <extensionName>flowruntime:name</extensionName>
            <fieldType>ComponentInstance</fieldType>
            <inputsOnNextNavToAssocScrn>UseStoredValues</inputsOnNextNavToAssocScrn>
            <isRequired>true</isRequired>
            <outputParameters>
                <assignToReference>contact.FirstName</assignToReference>
                <name>firstName</name>
            </outputParameters>
            <outputParameters>
                <assignToReference>contact.LastName</assignToReference>
                <name>lastName</name>
            </outputParameters>
        </fields>
        <fields>
            <name>Account</name>
            <choiceReferences>accounts</choiceReferences>
            <dataType>String</dataType>
            <fieldText>Account</fieldText>
            <fieldType>DropdownBox</fieldType>
            <isRequired>true</isRequired>
        </fields>
        <fields>
            <name>update\_toggle</name>
            <extensionName>flowruntime:toggle</extensionName>
            <fieldType>ComponentInstance</fieldType>
            <inputParameters>
                <name>label</name>
                <value>
                    <stringValue>If this contact already exists, update the existing record.</stringValue>
                </value>
            </inputParameters>
            <inputParameters>
                <name>messageToggleActive</name>
                <value>
                    <stringValue>Update existing</stringValue>
                </value>
            </inputParameters>
            <inputParameters>
                <name>messageToggleInactive</name>
                <value>
                    <stringValue>Create other contact</stringValue>
                </value>
            </inputParameters>
            <inputsOnNextNavToAssocScrn>UseStoredValues</inputsOnNextNavToAssocScrn>
            <isRequired>true</isRequired>
            <outputParameters>
                <assignToReference>updateExisting</assignToReference>
                <name>value</name>
            </outputParameters>
        </fields>
        <showFooter>true</showFooter>
        <showHeader>true</showHeader>
    </screens>
    <start>
        <locationX>254</locationX>
        <locationY>0</locationY>
        <connector>
            <targetReference>Contact\_Info</targetReference>
        </connector>
    </start>
    <status>Draft</status>
    <textTemplates>
        <name>chatterMessage</name>
        <isViewedAsPlainText>false</isViewedAsPlainText>
        <text>The contact was {!created\_or\_updated}.</text>
    </textTemplates>
    <variables>
        <name>accts</name>
        <apexClass>ComplexObjectExample</apexClass>
        <dataType>Apex</dataType>
        <isCollection>false</isCollection>
        <isInput>false</isInput>
        <isOutput>false</isOutput>
    </variables>
    <variables>
        <name>contact</name>
        <dataType>SObject</dataType>
        <isCollection>false</isCollection>
        <isInput>false</isInput>
        <isOutput>false</isOutput>
        <objectType>Contact</objectType>
    </variables>
    <variables>
        <name>existingId</name>
        <dataType>String</dataType>
        <isCollection>false</isCollection>
        <isInput>false</isInput>
        <isOutput>false</isOutput>
    </variables>
    <variables>
        <name>updateExisting</name>
        <dataType>Boolean</dataType>
        <isCollection>false</isCollection>
        <isInput>false</isInput>
        <isOutput>false</isOutput>
    </variables>
</Flow>

Sample XML definition with a subflow element.

<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>65.0</apiVersion>
    <areMetricsLoggedToDataCloud>false</areMetricsLoggedToDataCloud>
    <assignments>
        <name>Assign\_Value</name>
        <label>Assign Value</label>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <assignmentItems>
            <assignToReference>Counter\_Value</assignToReference>
            <operator>Assign</operator>
        </assignmentItems>
    </assignments>
    <customProperties>
        <name>ScreenProgressIndicator</name>
        <value>
            <stringValue>{&quot;location&quot;:&quot;top&quot;,&quot;type&quot;:&quot;simple&quot;}</stringValue>
        </value>
    </customProperties>
    <environments>Default</environments>
    <interviewLabel>Sample Definition Screen 1 {!$Flow.CurrentDateTime}</interviewLabel>
    <label>Sample Definition Screen 1</label>
    <processMetadataValues>
        <name>BuilderType</name>
        <value>
            <stringValue>LightningFlowBuilder</stringValue>
        </value>
    </processMetadataValues>
    <processMetadataValues>
        <name>CanvasMode</name>
        <value>
            <stringValue>AUTO\_LAYOUT\_CANVAS</stringValue>
        </value>
    </processMetadataValues>
    <processMetadataValues>
        <name>OriginBuilderType</name>
        <value>
            <stringValue>LightningFlowBuilder</stringValue>
        </value>
    </processMetadataValues>
    <processType>Flow</processType>
    <start>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <connector>
            <targetReference>Call\_My\_Subflow</targetReference>
        </connector>
    </start>
    <status>Draft</status>
    <subflows>
        <name>Call\_My\_Subflow</name>
        <label>Call My Subflow</label>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <connector>
            <targetReference>Assign\_Value</targetReference>
        </connector>
        <flowName>Sample\_Definition\_Autolaunched</flowName>
        <inputAssignments>
            <name>Counter</name>
        </inputAssignments>
        <inputAssignments>
            <name>Counter\_Value2</name>
        </inputAssignments>
    </subflows>
    <variables>
        <name>Counter\_Value</name>
        <dataType>Number</dataType>
        <isCollection>false</isCollection>
        <isInput>true</isInput>
        <isOutput>true</isOutput>
        <scale>0</scale>
        <value>
            <numberValue>1.0</numberValue>
        </value>
    </variables>
</Flow>

Sample XML definition of an autolaunched flow with a loop.

<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>65.0</apiVersion>
    <areMetricsLoggedToDataCloud>false</areMetricsLoggedToDataCloud>
    <assignments>
        <name>Assign\_Counter</name>
        <label>Assign Counter</label>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <assignmentItems>
            <assignToReference>Counter</assignToReference>
            <operator>Add</operator>
            <value>
                <numberValue>1.0</numberValue>
            </value>
        </assignmentItems>
        <assignmentItems>
            <assignToReference>Loop\_Accounts.NumberOfEmployees</assignToReference>
            <operator>Add</operator>
            <value>
                <elementReference>Counter</elementReference>
            </value>
        </assignmentItems>
        <connector>
            <targetReference>Loop\_Accounts</targetReference>
        </connector>
    </assignments>
    <environments>Default</environments>
    <interviewLabel>Sample Definition Autolaunched {!$Flow.CurrentDateTime}</interviewLabel>
    <label>Sample Definition Autolaunched</label>
    <loops>
        <name>Loop\_Accounts</name>
        <label>Loop Accounts</label>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <collectionReference>Get\_Accounts</collectionReference>
        <iterationOrder>Asc</iterationOrder>
        <nextValueConnector>
            <targetReference>Assign\_Counter</targetReference>
        </nextValueConnector>
    </loops>
    <processMetadataValues>
        <name>BuilderType</name>
        <value>
            <stringValue>LightningFlowBuilder</stringValue>
        </value>
    </processMetadataValues>
    <processMetadataValues>
        <name>CanvasMode</name>
        <value>
            <stringValue>AUTO\_LAYOUT\_CANVAS</stringValue>
        </value>
    </processMetadataValues>
    <processMetadataValues>
        <name>OriginBuilderType</name>
        <value>
            <stringValue>LightningFlowBuilder</stringValue>
        </value>
    </processMetadataValues>
    <processType>AutoLaunchedFlow</processType>
    <recordLookups>
        <name>Get\_Accounts</name>
        <label>Get Accounts</label>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <assignNullValuesIfNoRecordsFound>false</assignNullValuesIfNoRecordsFound>
        <connector>
            <targetReference>Loop\_Accounts</targetReference>
        </connector>
        <getFirstRecordOnly>false</getFirstRecordOnly>
        <limit>
            <numberValue>10.0</numberValue>
        </limit>
        <object>Account</object>
        <storeOutputAutomatically>true</storeOutputAutomatically>
    </recordLookups>
    <runInMode>SystemModeWithoutSharing</runInMode>
    <start>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <connector>
            <targetReference>Get\_Accounts</targetReference>
        </connector>
    </start>
    <status>Draft</status>
    <variables>
        <name>AccountCollection</name>
        <dataType>SObject</dataType>
        <isCollection>true</isCollection>
        <isInput>false</isInput>
        <isOutput>false</isOutput>
        <objectType>Account</objectType>
    </variables>
    <variables>
        <name>Counter</name>
        <dataType>Number</dataType>
        <isCollection>false</isCollection>
        <isInput>false</isInput>
        <isOutput>false</isOutput>
        <scale>0</scale>
    </variables>
</Flow>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [_Salesforce Help_: Deploy Processes and Flows as Active](https://help.salesforce.com/s/articleView?id=platform.flow_distribute_deploy_active.htm&type=5&language=en_US)

<!-- document id=b4c43315c0c10d7da5da84759b445bde78568d6ffbd8520b1c1a409422743cc9 url=/legacydeveloper/current/en-us/api_meta/meta_flowcategory.md -->

# FlowCategory

Represents a list of flows that are grouped by category. Flows aren’t added directly to a Lightning Bolt Solution. Instead, add the category the flows are in to the Lightning Bolt Solution. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

FlowCategory components have the suffix .flowCategory and are stored in the flowCategories folder.

## Version

FlowCategory components are available in API version 43.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | The description of this flow category. |
| flowCategoryItems | [FlowCategoryItems](#FlowCategoryItems)\[\] | The list of flows in this flow category. |
| masterLabel | string | Required. The label for this flow category, which appears in Setup. |

## FlowCategoryItems

Represents the list of flows in a flow category.

| Field Name | Field Type | Description |
| --- | --- | --- |
| flow | string | Required. The name of the flow. |

## Declarative Metadata Sample Definition

The following is an example of a FlowCategory component.

<?xml version="1.0" encoding="UTF-8"?>
<FlowCategory xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <flowCategoryItems\>
        <flow\>PausableFlow</flow\>
    </flowCategoryItems\>
    <flowCategoryItems\>
        <flow\>BankingFlow</flow\>
    </flowCategoryItems\>
    <masterLabel\>updateBenefits</masterLabel\>
        <description\>All the update benefits.</description\>
</FlowCategory\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>updateBenefits</members\>
        <name\>FlowCategory</name\>
    </types\>
    <version\>43.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=412523dae30919db26ed0066a20ac4cdc30d9e8a3b4cab861dc9a61c69ce9401 url=/legacydeveloper/current/en-us/api_meta/meta_flowdefinition.md -->

# FlowDefinition

Represents the flow definition’s description and active flow version number.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

In API version 44.0, we recommend upgrading your flows to flow metadata file names without version numbers and discontinue using the FlowDefinition object to activate or deactivate a flow. Then use the Flow object to activate or deactivate a flow. For more information, see [Upgrade Flow Files to API Version 44.0](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm#md_flow_upgrade).

If you deploy with flow definitions, the active version numbers in the flow definitions override the status fields in the flows. For example, the active version number in the flow definition is version 3, and the latest version of the flow is version 4 with the status field as Active. After you deploy your flow, the active version is version 3.

## Declarative Metadata File Suffix and Directory Location

FlowDefinitions are stored in the flowDefinitions directory of the corresponding package directory. The file name matches the flow definition's unique full name, and the extension is .flowDefinition.

## Version

[FlowDefinition](#meta_flowdefinition "Represents the flow definition’s description and active flow version number.") is available in API version 34.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| activeVersionNumber | int | The version number of the active flow. |
| apiVersion | int | Reserved for internal use. |
| description | string | Description of the flow definition. |
| masterLabel | string | Label for the flow definition. In managed packages, this field inherits the flow’s active version name. To change this label from a subscriber’s org, edit the packaged flow name. |

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=74801e5069bbc2303b9fa93fa29521c17574782fc03ad4b000cf485223dafbd5 url=/legacydeveloper/current/en-us/api_meta/meta_flowsettings.md -->

# FlowSettings

Represents the Salesforce settings for processes and flows, such as whether Lightning runtime for flows is enabled.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

FlowSettings values are stored in the Flow.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

FlowSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d518734e94">Field Name</th>

              <th class="featureTableHeader  " id="d518734e97">Field Type</th>

              <th class="featureTableHeader  " id="d518734e100">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">canDebugFlowAsAnotherUser</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether a flow can be debugged as another user (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Corresponds to the <span class="keyword parmname">Let admins debug flows as other
                  users</span> field on the Process Automation Settings page in Setup. Available
                in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">doesEnforceApexCpuTimeLimit</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether Salesforce accurately measures the CPU time that flows and
                processes consume (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">Corresponds to the Accurately Measure the
                  CPU Time Consumption of Flows and Processes release update. Available in API
                  version 51.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">doesFormulaEnforceDataAccess</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether formula resources and formula fields in a flow enforce
                record-level security (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">Corresponds to the Enforce Data Access in
                  Flow Formulas critical update. Available in API version 48.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">doesFormulaGenerateHtmlOutput</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether flow formula functions that generate HTML, such as <samp class="codeph nolang">BR()</samp>, <samp class="codeph nolang">IMAGE()</samp>,
                and <samp class="codeph nolang">HYPERLINK()</samp>, include encoded markers
                (<samp class="codeph nolang">__BR_ENCODED__</samp>) (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in
                API version 48.0 and later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowBREncodedFixEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether <samp class="codeph nolang">BR()</samp> functions in flow
                and process formulas result in a line break (<samp class="codeph nolang">true</samp>) or resolve to <samp class="codeph nolang">_BR_ENCODED_</samp> as
                a literal value (<samp class="codeph nolang">false</samp>). <p class="p">Corresponds to the
                  Use the BR() Function in Flows and Processes critical update.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowCustomPropertyEditor</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether an org has custom property editors enabled for actions and
                screen fields in Flow Builder (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>).<p class="p">This field is available in API
                  version 48.0 to 50.0. The field is deprecated in API version 50.0 and later. All
                  orgs that have Flow Builder support custom property editors for actions and screen
                  fields.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowDeployAsActiveEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether processes and flows can be deployed as active via change sets
                or Metadata API. When the value is <samp class="codeph nolang">false</samp>, all
                processes and flows are deployed as inactive. When the value is <samp class="codeph nolang">true</samp>, deploying an active process or flow in a
                production org causes your Apex tests to run. If Apex tests don’t launch your org’s
                required percentage of active processes and autolaunched flows, the deployment is
                rolled back.<p class="p">The default value is <samp class="codeph nolang">false</samp> for
                  production orgs and is <samp class="codeph nolang">true</samp> for
                  non-production orgs such as scratch, sandbox, and developer
                  orgs.</p>
                <p class="p">Corresponds to the <span class="keyword parmname">Deploy processes and flows as
                    active</span> field on the Process Automation Settings page in Setup. The
                  field appears in the user interface on production orgs only.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowFieldFilterEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether flows can successfully execute Create Records and Update
                Records elements that update fields to which the running doesn’t have edit access.
                By default (<samp class="codeph nolang">false</samp>), the Create Records or
                Update Records element fails and executes the fault path if it has one. When the
                value is <samp class="codeph nolang">true</samp>, the element sets only the fields
                that the running user can edit. No notification is sent when some fields aren’t
                updated.<p class="p">Corresponds to the <span class="keyword parmname">Filter inaccessible fields from flow
                    requests</span> field on the Process Automation Settings page in
                  Setup.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowFormulasFixEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether process and flow formulas return null values when the
                calculations involve a null record variable or null lookup relationship field. When
                the value is <samp class="codeph nolang">true</samp>, those formulas return null
                values at run time. When the value is <samp class="codeph nolang">false</samp>,
                those formulas return unhandled exceptions at run time.<p class="p">Corresponds to the Check
                  for Null Record Variables or Null Values of Lookup Relationship Fields in Process
                  and Flow Formulas critical update.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowInterviewSharingEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether users can resume the paused flow interviews that they have
                edit access to. By default (<samp class="codeph nolang">true</samp>), users can
                resume interviews that are shared with them, either directly or via the role
                hierarchy. When the value is <samp class="codeph nolang">false</samp>, each paused
                interview can be resumed only by the interview owner or a flow admin who has view
                access to the interview.<p class="p">Corresponds to the <span class="keyword parmname">Let users resume shared flow
                    interviews</span> field on the Process Automation Settings page in
                  Setup.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowListMetadataLargeCapEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowNullPreviousValueFix</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether each process evaluates criteria by always using the original
                record field values from when the process begins. When the value is <samp class="codeph nolang">true</samp>, each process with an Update Records action and
                multiple criteria nodes always evaluates criteria using the original field values of
                the record. When the value is <samp class="codeph nolang">false</samp>, processes
                evaluate the updated values of record fields that were null when the process
                began.<p class="p">Corresponds to the Evaluate Criteria Based on Original Record Values in
                  the Process Builder critical update.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowPauseEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether screens can display the Pause button so that users can pause
                flow interviews. By default, the value is <samp class="codeph nolang">false</samp>.<p class="p">Corresponds to the <span class="keyword parmname">Let users pause flows</span>
                  field on the Process Automation Settings page in Setup.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowReactiveScreens</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether supported screen components in flows running on API version
                57.0 and 58.0 can react to changes in other components on the same screen. This
                setting isn’t applicable to flows running on API version 59.0 and later. By default,
                the value is <samp class="codeph nolang">false</samp>. To make a component
                reactive, reference the output of another component on the same screen in the
                configuration pane.<p class="p">Corresponds to the <span class="keyword parmname">Enable Reactive Components for
                    Specific Flow Versions</span> field on the Process Automation Settings page
                  in Setup.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowUseApexExceptionEmail</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether process and flow error emails are sent to:<ul class="ul bulletList">
                  <li class="li">The user who last modified the process or flow (<samp class="codeph nolang">false</samp>)</li>

                  <li class="li">The addresses set on the Apex Exception Email page in Setup (<samp class="codeph nolang">true</samp>)</li>

                </ul>
                <p class="p">By default, the value is <samp class="codeph nolang">false</samp>.
                  Corresponds to the <span class="keyword parmname">Send Process or Flow Error Email to</span> field
                  on the Process Automation Settings page in Setup.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowViaRestUsesUserCtxt</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether a flow that runs via REST API uses the running user’s profile
                and permission sets to determine the object permissions and field-level access of
                the flow.<p class="p">Corresponds to the Run Flows in User Context via REST API critical
                  update. Available in API version 54.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableFlowsLightningApp </span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether users with the necessary permissions can use the Automation
                Lightning app to create, manage, and monitor flows, orchestrations, and flow
                approval processes; track flow interviews; browse available actions; and configure
                flow logging. Corresponds to the <strong class="ph uicontrol">Enable the Automation Lightning
                  App</strong> setting on the Process Automation Settings page in Setup.
                Available in API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableInvocableFlowFixEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Removed in API version 50.0 and later.<p class="p">Indicates whether all autolaunched
                  flow interviews are executed when they’re invoked in bulk from a process or the
                  Invocable Actions resource in REST API (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). When the value is <samp class="codeph nolang">false</samp>, flow interviews that share identical input
                  parameters aren’t executed.</p>
                <p class="p">Corresponds to the Execute All Flow Interviews
                  When Invoked in Bulk critical update.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">enableLightningRuntimeEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether flows that are launched from a URL or from Setup use the
                Lightning runtime experience (<samp class="codeph nolang">true</samp>) or the
                Classic runtime experience (<samp class="codeph nolang">false</samp>). By default,
                the value is <samp class="codeph nolang">true</samp>.<p class="p">Corresponds to the
                  <span class="keyword parmname">Enable Lightning runtime for flows</span> field on the Process
                  Automation Settings page in Setup.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">isAccessToInvokedApexRequired</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether flows can invoke Apex classes only when the running users’
                profiles or permission sets include access to those Apex classes. When the value is
                <samp class="codeph nolang">false</samp>, Apex class security doesn’t apply to
                flows.<p class="p">Corresponds to the Require User Access to Apex Classes Invoked by Flow
                  critical update.</p>
                <p class="p">This field is available in API versions 47.0 to 58.0. The
                  field is deprecated in API version 59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">isApexPluginAccessModifierRespected</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether flows respect the public access modifiers for legacy Apex
                actions. When the value is <samp class="codeph nolang">true</samp>:<ul class="ul bulletList">
                  <li class="li">Flows fail when they execute public legacy Apex actions from a different
                    namespace.</li>

                  <li class="li">Public legacy Apex actions from a different namespace aren't available in Flow
                    Builder.</li>

                  <li class="li">Global legacy Apex actions with public <samp class="codeph nolang">describe</samp> or <samp class="codeph nolang">invoke</samp> methods are
                    unavailable to flows in a different namespace.</li>

                </ul>
                When the value is <samp class="codeph nolang">false</samp>, you can add
                public legacy Apex actions to flows even though they’re not supported. Also, global
                legacy Apex actions with public <samp class="codeph nolang">describe</samp> or
                <samp class="codeph nolang">invoke</samp> methods are available to flows in a
                different namespace.<p class="p">Corresponds to the Make Flows Respect Access Modifiers for
                  Legacy Apex Actions critical update. Available in API version 48.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">isEnhancedFlowListViewVisible</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether the enhanced Flows list view in Lightning Experience replaces
                the Classic Flows list view (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">true</samp>. If the field is set to <samp class="codeph nolang">false</samp>, the Classic Flows list view replaces the
                enhanced list view.</td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">isFlowApexContextRetired</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether the rules for enforcing explicit access to Apex classes are
                disabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). For most Salesforce orgs the default value is
                <samp class="codeph nolang">true</samp>. <p class="p">Corresponds to the Disable Rules for
                  Enforcing Explicit Access to Apex Classes release update.</p>
                <p class="p">This field is
                  available in API versions 49.0 to 58.0. The field is deprecated in API version
                  59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">isFlowBlockAccessToSessionIDEnabled</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether a valid session ID is returned in API.SessionID (<samp class="codeph nolang">false</samp>) or not (<samp class="codeph nolang">true</samp>). The default value is false. When the value is <samp class="codeph nolang">true</samp>, flows that access the session ID variable
                receive a placeholder string instead of a valid session ID.</td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">isManageFlowRequiredForAutomationCharts</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether the Manage Flow permission is required to view all charts in
                Automation Home (Beta) (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. All users with the View Setup and
                Configuration permission can view all charts in Automation Home. If the field is set
                to <samp class="codeph nolang">true</samp>, then users with the View Setup and
                Configuration permission can view only the Total Started Automations by Process Type
                chart. The Manage Flow permission is required to view all charts.</td>

            </tr>

            <tr>
              <td class="entry" headers="d518734e94" data-title="Field Name"><span class="keyword parmname">isTimeResumedInSameRunContext</span></td>

              <td class="entry" headers="d518734e97" data-title="Field Type">boolean</td>

              <td class="entry" headers="d518734e100" data-title="Description">Indicates whether paused autolaunched flows always resume in the same context
                and retain the user access that they had before being paused (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">Corresponds to the Make Paused Flow Interviews Resume in the
                  Same Context with the Same User Access release update.</p>
                <p class="p">This field is
                  available in API versions 57.0 and 58.0. Removed in API version 59.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s an example of the Flow.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<FlowSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <doesFormulaEnforceDataAccess\>true</doesFormulaEnforceDataAccess\>
    <enableFlowBREncodedFixEnabled\>true</enableFlowBREncodedFixEnabled\>
    <enableFlowDeployAsActiveEnabled\>false</enableFlowDeployAsActiveEnabled\>
    <enableFlowFieldFilterEnabled\>false</enableFlowFieldFilterEnabled\>
    <enableFlowFormulasFixEnabled\>true</enableFlowFormulasFixEnabled\>
    <enableFlowInterviewSharingEnabled\>true</enableFlowInterviewSharingEnabled\>
    <enableFlowNullPreviousValueFix\>true</enableFlowNullPreviousValueFix\>
    <enableFlowPauseEnabled\>true</enableFlowPauseEnabled\>
    <enableFlowUseApexExceptionEmail\>false</enableFlowUseApexExceptionEmail\>
    <enableLightningRuntimeEnabled\>true</enableLightningRuntimeEnabled\>
    <isApexPluginAccessModifierRespected\>true</isApexPluginAccessModifierRespected\>
    <isEnhancedFlowListViewVisible\>true</isEnhancedFlowListViewVisible\>
    <isManageFlowRequiredForAutomationCharts\>false</isManageFlowRequiredForAutomationCharts\>
</FlowSettings\>

## Example Package Manifest

Here’s an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>Flow</members\>
		<name\>Settings</name\>
	</types\>
	<version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=1ea980a692ce60ab88223130836362544ff79ee02814495e059c079d89737f2f url=/legacydeveloper/current/en-us/api_meta/meta_flowtest.md -->

# FlowTest

Represents the metadata associated with a flow test. Before you activate a record-triggered, autolaunched, or Data Cloud-triggered flow, you can test it to verify its expected results and identify flow run-time failures.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

FlowTest components have the suffix .flowtest, and Salesforce stores them in the flowtests folder.

## Version

FlowTest components are available in API version 55.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The description of the flow test, such as what it does or how it works.



 |
| flowApiName | 

Field Type

string

Description

Required.

The API name of the flow associated with the flow test.



 |
| flowTestDataSources | 

Field Type

[FlowTestDataSource](#subtype_FlowTestDataSource)\[\]

Description

An array of data sources for the flow test of a record-triggered flow or an autolaunched flow. This field is available in API version 66.0 and later.



 |
| flowTestFlowVersions | 

Field Type

[FlowTestFlowVersion](#subtype_FlowTestFlowVersion)\[\]

Description

An array of flow versions that are associated with the flow test. This field is available in API version 66.0 and later.



 |
| isolatedObjectExternalKeys | 

Field Type

[FlowTestIsolObjExtlKey](#subtype_FlowTestIsolObjExtlKey)\[\]

Description

An array of isolated objects and the key fields that uniquely identify each record for the flow test of a record-triggered flow or an autolaunched flow. This field is available in API version 66.0 and later.



 |
| label | 

Field Type

string

Description

Required.

The label of the flow test.



 |
| testPoints | 

Field Type

[FlowTestPoint](#subtype_FlowTestPoint)\[\]

Description

An array of test points for the test.



 |
| testType | 

Field Type

FlowTestType (enumeration of type string)

Description

Required.

Specifies whether the test contains assertions. This field is available in API version 66.0 and later.

Possible values are:

- WithAssertion—The automated comparison of the actual flow outcome with the user-defined expected outcome that assertions define.





 |

## FlowTestFlowVersion

Defines the flow version for the flow test. This subtype is available in API version 66.0 and later.

| Field Name | Description |
| --- | --- |
| flowVersionNumber | 
Field Type

string

Description

The version number of the flow version that’s associated with the flow test.



 |

## FlowTestDataSource

Defines the data source for a flow test of a record-triggered flow or an autolaunched flow. This subtype is available in API version 66.0 and later.

| Field Name | Description |
| --- | --- |
| apexClass | 
Field Type

string

Description

Required.

The Apex class associated with the data source when dataSourceType is ApexClass.



 |
| dataSourceType | 

Field Type

FlowTestDataSourceType (enumeration of type string)

Description

Required.

The data source type for the flow test.

Possible value is ApexClass.





 |

## FlowTestIsolObjExtlKey

Defines an external isolated object and the fields that identify unique records to test for a record-triggered flow or an autolaunched flow. This subtype is available in API version 66.0 and later.

| Field Name | Description |
| --- | --- |
| keyFields | 
Field Type

[FlowTestExtKeyField](#subtype_FlowTestExtKeyField)\[\]

Description

The key fields that identify unique records to test. Don’t use fields of the lookup data type.



 |
| objectType | 

Field Type

string

Description

Required.

The object type of the isolated data to test.



 |

## FlowTestExtKeyField

Defines the external key fields that identify the unique records in isolated test data for a record-triggered flow or an autolaunched flow. This subtype is available in API version 66.0 and later.

| Field Name | Description |
| --- | --- |
| fieldName | 
Field Type

string

Description

Required.

The field API name to identify the unique records to test.



 |

## FlowTestPoint

Defines a flow test point that Salesforce evaluates when a flow test runs. Salesforce evaluates each test point in the order that it’s listed.

| Field Name | Description |
| --- | --- |
| assertions | 
Field Type

[FlowTestAssertion\[\]](#subtype_FlowTestAssertion)

Description

An array of assertions for the test.



 |
| elementApiName | 

Field Type

string

Description

Required.

The element API names for the start of the flow and the end of the flow.

Possible values are:

- Start
- Finish





 |
| isUseMockOuput | Reserved for future use. |
| parameters | 

Field Type

[FlowTestParameter\[\]](#subtype_FlowTestParameter)

Description

An array of parameters for the test.



 |

## FlowTestAssertion

Defines an assertion for a test point that Salesforce evaluates when a flow test runs. If one assertion evaluates to false, the test run fails.

| Field Name | Description |
| --- | --- |
| conditions | 
Field Type

[FlowTestCondition\[\]](#subtype_FlowTestCondition)

Description

An array of conditions for an assertion.



 |
| errorMessage | 

Field Type

string

Description

If the associated condition evaluates to false, this custom message appears in Flow Builder.



 |

## FlowTestCondition

Defines a condition for an assertion that Salesforce evaluates when a flow test runs. If one condition evaluates to false, the assertion fails.

| Field Name | Description |
| --- | --- |
| leftValueReference | 
Field Type

string

Description

Required.

The reference to the flow resource that the specified operator applies to.



 |
| operator | 

Field Type

FlowComparisonOperator (enumeration of type string)

Description

Required.

The flow test uses this value to evaluate the resource reference in the leftValueReference field. The date comparison operators, such as IsAfter, IsBefore, and IsOn, apply to Date fields only, not DateTime fields.

Possible values are:

- Contains
- EndsWith
- EqualTo
- GreaterThan
- GreaterThanLastNumberOfDays—Returns true if the date value is more than N days before today. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
- GreaterThanOrEqualTo
- HasError—This value is available in API version 64.0 and later.
- HasNoValue—Returns true if the date value has no value. This value is available in API version 67.0 and later.
- HasValue—Returns true if the date value has a value. This value is available in API version 67.0 and later.
- In—This value is available in API version 56.0 and later.
- IsAfter—Returns true if the date value is after the specified date. This value is available in API version 67.0 and later.
- IsAnniversaryOfToday—Returns true if the month and day of the date value match today's month and day. This value is available in API version 67.0 and later.
- IsBefore—Returns true if the date value is before the specified date. This value is available in API version 67.0 and later.
- IsBlank—This value is available in API version 61.0 and later.
- IsChanged
- IsEmpty—This value is available in API version 61.0 and later.
- IsLastMonth—Returns true if the date value falls within the previous calendar month. This value is available in API version 67.0 and later.
- IsNextMonth—Returns true if the date value falls within the next calendar month. This value is available in API version 67.0 and later.
- IsNotAnniversaryOfToday—Returns true if the month and day of the date value don't match today's month and day. This value is available in API version 67.0 and later.
- IsNull
- IsOn—Returns true if the date value is the same as the specified date. This value is available in API version 67.0 and later.
- IsThisMonth—Returns true if the date value falls within the current calendar month. This value is available in API version 67.0 and later.
- IsToday—Returns true if the date value is today's date. This value is available in API version 67.0 and later.
- IsTomorrow—Returns true if the date value is tomorrow's date. This value is available in API version 67.0 and later.
- IsYesterday—Returns true if the date value is yesterday's date. This value is available in API version 67.0 and later.
- LastNumberOfDays—Returns true if the date value falls within the last N days, including today. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
- LastNumberOfMonths—Returns true if the date value falls within the last N calendar months, excluding the current month. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
- LastNumberOfYears—Returns true if the date value falls within the last N calendar years, excluding the current year. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
- LastYear—Returns true if the date value falls within the previous calendar year. This value is available in API version 67.0 and later.
- LessThan
- LessThanOrEqualTo
- NextNumberOfDays—Returns true if the date value falls within the next N days, including today. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
- NextNumberOfMonths—Returns true if the date value falls within the next N calendar months, excluding the current month. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
- NextYear—Returns true if the date value falls within the next calendar year. This value is available in API version 67.0 and later.
- NotEqualTo
- NotIn—This value is available in API version 56.0 and later.
- StartsWith
- ThisYear—Returns true if the date value falls within the current calendar year. This value is available in API version 67.0 and later.
- WasSelected
- WasSet
- WasVisited





 |
| rightValue | 

Field Type

[FlowTestReferenceOrValue](#subtype_FlowTestReferenceOrValue)

Description

The value that the operator applies to the resource reference in the leftValueReference field.



 |

## FlowTestReferenceOrValue

Defines a specific value that the operator applies to the resource reference in flow test assertions and conditions.

| Field Name | Description |
| --- | --- |
| booleanValue | 
Field Type

boolean

Description

Specifies a boolean value.



 |
| dateTimeValue | 

Field Type

dateTime

Description

Specifies a dateTime value.



 |
| dateValue | 

Field Type

date

Description

Specifies a dateValue value.



 |
| elementReference | Reserved for future use. |
| jsonValue | 

Field Type

string

Description

Specifies a JSON value for the isolated test data record. This field is available in API version 66.0 and later.



 |
| numberValue | 

Field Type

double

Description

Specifies a number value.



 |
| sobjectValue | 

Field Type

string

Description

Specifies an sObject value.



 |
| stringValue | 

Field Type

string

Description

Specifies a string value.



 |
| timeValue | 

Field Type

time

Description

Specifies a time value.



 |

## FlowTestParameter

Defines parameters for the triggering record, flow path, and input variable in the Start test point.

| Field Name | Description |
| --- | --- |
| leftValueReference | 
Field Type

string

Description

Required.

The name of the parameter. When type is InputTriggeringRecordInitial or InputTriggeringRecordUpdated, the value for leftValueReference must be $Record. When type is ScheduledPath, the value for leftValueReference must be ScheduledPathApiName.



 |
| type | 

Field Type

FlowTestParameterType (enumeration of type string)

Description

Required.

The type of parameter.

Possible values are:

- InputTriggeringRecordInitial
- InputTriggeringRecordUpdated
- InputVariable—This value is available in API version 66.0 and later.
- ScheduledPath—Available in API version 56.0 and later.





 |
| value | 

Field Type

[FlowTestReferenceOrValue](#subtype_FlowTestReferenceOrValue)

Description

Required.

The value that the operator applies to the resource reference in the leftValueReference field.



 |

## Declarative Metadata Sample Definition

The following is an example of a FlowTest component.

<?xml version="1.0" encoding="UTF-8"?>
<FlowTest xmlns="http://soap.sforce.com/2006/04/metadata">
    <flowApiName\>Example\_Test</flowApiName\>
    <label\>Test Two</label\>
    <testPoints\>
        <elementApiName\>Start</elementApiName\>
        <parameters\>
            <leftValueReference\>$Record</leftValueReference\>
            <type\>InputTriggeringRecordInitial</type\>
            <value\>
                <sobjectValue\>{&quot;AnnualRevenue&quot;:100000,&quot;BillingCity&quot;:&quot;New York&quot;}}</sobjectValue\>
            </value\>
        </parameters\>
        <parameters\>
            <leftValueReference\>ScheduledPathApiName</leftValueReference\>
            <type\>ScheduledPath</type\>
            <value\>Every\_Monday</value\>
        </parameters\>
        <parameters\>
            <leftValueReference\>$Record</leftValueReference\>
            <type\>InputTriggeringRecordUpdated</type\>
            <value\>
                <sobjectValue\>{&quot;AnnualRevenue&quot;:100000,&quot;BillingCity&quot;:&quot;New York&quot;}</sobjectValue\>
            </value\>
        </parameters\>
    </testPoints\>
    <testPoints\>
        <assertions\>
            <conditions\>
                <leftValueReference\>$Record.Industry</leftValueReference\>
                <operator\>EqualTo</operator\>
                <rightValue\>
                    <stringValue\>Other</stringValue\>
                </rightValue\>
            </conditions\>
            <errorMessage\>Industry was not set.</errorMessage\>
        </assertions\>
        <elementApiName\>Finish</elementApiName\>
    </testPoints\>
</FlowTest\>

For isolated test data sample:

<?xml version="1.0" encoding="UTF-8"?>
<FlowTest xmlns="http://soap.sforce.com/2006/04/metadata">
    <flowApiName\>Example\_Test</flowApiName\>
    <label\>Test Two</label\>
    <flowTestDataSources\>
        <apexClass\>FlowTestDataFactory</apexClass\>
        <dataSourceType\>ApexClass</dataSourceType\>
    </flowTestDataSources\>
    <flowTestFlowVersions\>
        <flowVersionNumber\>1</flowVersionNumber\>
    </flowTestFlowVersions\>   
    <isolatedObjectExternalKeys\>
        <keyFields\>
            <fieldName\>Phone</fieldName\>
        </keyFields\>
        <objectType\>Account</objectType\>
    </isolatedObjectExternalKeys\>
    <testPoints\>
        <elementApiName\>Start</elementApiName\>                  
        <parameters\>
            <leftValueReference\>Accounts</leftValueReference\>
            <type\>InputVariable</type\>
            <value\>
                <jsonValue\>{&quot;fields&quot;:{&quot;Phone&quot;:&quot;4155551212&quot;},&quot;attributes&quot;:{&quot;type&quot;:&quot;Account&quot;}}</jsonValue\>
            </value\>
        </parameters\>
    </testPoints\>
    <testPoints\>
        <assertions\>
            <conditions\>
                <leftValueReference\>Accounts.Phone</leftValueReference\>
                <operator\>EqualTo</operator\>
                <rightValue\>
                    <stringValue\>4155551212</stringValue\>
                </rightValue\>
            </conditions\>         
            <errorMessage\>Account not found.</errorMessage\>
        </assertions\>
        <elementApiName\>Finish</elementApiName\>
    </testPoints\>
    <testType\>WithAssertion</testType\>
</FlowTest\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>Test\_Two</members\>
<name\>FlowTest</name\>
</types\>
<version\>66.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=345ff170340c4b5063aa52819a7f9e4c7a48c76fd6058d90598ea5217d5690aa url=/legacydeveloper/current/en-us/api_meta/meta_flowvaluemap.md -->

# FlowValueMap

Represents the metadata associated with creating a reusable entity for defining and managing mappings between source and target values used within a flow.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

FlowValueMap components have the suffix .flowvaluemap and are stored in the flowvaluemaps folder.

## Version

FlowValueMap components are available in API version 66.0 and later.

## Special Access Rules

Only authenticated users can access this metadata type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d524736e104">Field Name</th>

              <th class="featureTableHeader  " id="d524736e107">Field Type</th>

              <th class="featureTableHeader  " id="d524736e110">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d524736e104" data-title="Field Name"><span class="keyword parmname">defaultValue</span></td>

              <td class="entry" headers="d524736e107" data-title="Field Type">text</td>

              <td class="entry" headers="d524736e110" data-title="Description">Specifies the default target value used when no source value is found in the
                value map. <p class="p">A value is required if the <span class="keyword parmname">defaultValueStrategy</span>
                  field is set to <span class="keyword parmname">FixedValue</span>. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d524736e104" data-title="Field Name"><span class="keyword parmname">defaultValueStrategy</span></td>

              <td class="entry" headers="d524736e107" data-title="Field Type">
                <p dir="ltr" class="p">FlowValueMapDefaultStrategy (enumeration of type string)</p>

              </td>

              <td class="entry" headers="d524736e110" data-title="Description">Required. Specifies the strategy used to apply the default target value if the
                source value is not found in the value map. Valid values are:<a name="ul_zj3_54n_kjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_zj3_54n_kjc">
                  <li class="li">
                    <span class="keyword parmname">PassThrough</span>: Pass the original source value through if no
                    mapping is found.
                  </li>

                  <li class="li">
                    <span class="keyword parmname">FixedValue</span>: Use the defined DefaultValue if no mapping is
                    found.
                  </li>

                  <li class="li">
                    <span class="keyword parmname">FailFlow</span>: Fail the flow if no mapping is found.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d524736e104" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d524736e107" data-title="Field Type">text</td>

              <td class="entry" headers="d524736e110" data-title="Description">User-provided description for the value map.</td>

            </tr>

            <tr>
              <td class="entry" headers="d524736e104" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d524736e107" data-title="Field Type">text</td>

              <td class="entry" headers="d524736e110" data-title="Description">Required. Label for the value map.</td>

            </tr>

            <tr>
              <td class="entry" headers="d524736e104" data-title="Field Name"><span class="keyword parmname">sourceType</span></td>

              <td class="entry" headers="d524736e107" data-title="Field Type">FlowValueMapDataType (enumeration of type string)</td>

              <td class="entry" headers="d524736e110" data-title="Description">Required. Specifies the supported data types for value map source data. Valid
                types are:<a name="ul_qjm_z4n_kjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_qjm_z4n_kjc">
                  <li class="li"><span class="keyword parmname">Boolean</span></li>

                  <li class="li"><span class="keyword parmname">Date</span></li>

                  <li class="li"><span class="keyword parmname">DateTime</span></li>

                  <li class="li"><span class="keyword parmname">Number</span></li>

                  <li class="li"><span class="keyword parmname">String</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d524736e104" data-title="Field Name"><span class="keyword parmname">targetType</span></td>

              <td class="entry" headers="d524736e107" data-title="Field Type">FlowValueMapDataType (enumeration of type string)</td>

              <td class="entry" headers="d524736e110" data-title="Description">Required. Specifies the supported data types for value map target data. Valid
                types are:<a name="ul_xjk_dpn_kjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_xjk_dpn_kjc">
                  <li class="li"><span class="keyword parmname">Boolean</span></li>

                  <li class="li"><span class="keyword parmname">Date</span></li>

                  <li class="li"><span class="keyword parmname">DateTime</span></li>

                  <li class="li"><span class="keyword parmname">Number</span></li>

                  <li class="li"><span class="keyword parmname">String</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d524736e104" data-title="Field Name"><span class="keyword parmname">valueMapEntries</span></td>

              <td class="entry" headers="d524736e107" data-title="Field Type">
                <a class="xref" href="#FlowValueMapEntry">FlowValueMapEntry</a>[]
              </td>

              <td class="entry" headers="d524736e110" data-title="Description">List of source-target mappings in the value map. </td>

            </tr>

          </tbody>

        </table>

## FlowValueMapEntry

Stores an individual record linking a specific source value to a target value. This entity maintains a relationship to its parent FlowValueMap definition and makes sure that each sourceValue is unique within that parent definition.

| Field Name | Field Type | Description |
| --- | --- | --- |
| sourceValue | text | Required. Specifies the source value in this FlowValueMap definition. |
| targetValue | text | Required. Specifies the target value in this FlowValueMap definition. |

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=2df3581af00fb6e00de5ef1ce5c79c74f7f5141d6a01bc8586426fc8dd0b30ab url=/legacydeveloper/current/en-us/api_meta/meta_folder.md -->

# Folder

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

Five folder types currently exist in Salesforce:

- Document folder
- Email folder (available for Salesforce Classic email templates only)
- Email Template folder
- Report folder
- Dashboard folder

Folder type names end with the “Folder” suffix. For example, the type name of a document folder is “DocumentFolder”.

## File Suffix and Directory Location

Folders are stored in the corresponding component directory of the package. These directories are named documents, email, emailTemplates, reports, and dashboards. Folders don’t have a text file representation—they’re containers for files. For each folder, an accompanying metadata file named FolderName.folderType\-meta.xml is created at the same directory level. The FolderName.folderType\-meta.xml metadata file contains the metadata information for that folder, such as the accessType. For example, for a documents folder named sampleFolder, there’s a sampleFolder.documentFolder-meta.xml within the documents folder of the package.

## Deploying or Retrieving Nested Folders

To deploy or retrieve only a nested folder component, and not its contents, you must use a specific syntax in your package.xml. To reference the nested folder itself, append a trailing slash (/) to its full name in the <members\> tag.

For example, to retrieve a nested DocumentFolder named MyNestedFolder located inside MyTopFolder, your package.xml must list the member with a trailing slash (/).

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyTopFolder/MyNestedFolder/</members\>
        <name\>DocumentFolder</name\>
    </types\>
    <version\>58.0</version\>
</Package\>
                

If you omit the trailing slash (for example, <members\>MyTopFolder/MyNestedFolder</members\>), the operation fails. The API incorrectly searches for a Document component named MyNestedFolder instead of the folder.

This syntax applies to all folder types. For ReportFolder, you must use the Report type in the manifest. For Lightning Email Template folders, use the EmailTemplateFolder type.

## Version

Folders are available in API version 11.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d525698e200">Field Name</th>

              <th class="featureTableHeader  " id="d525698e203">Field Type</th>

              <th class="featureTableHeader  " id="d525698e206">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d525698e200" data-title="Field Name"><span class="keyword parmname" id="folder_accesstype"><a name="folder_accesstype"><!-- --></a>accessType</span></td>

              <td class="entry" headers="d525698e203" data-title="Field Type">FolderAccessTypes (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d525698e206" data-title="Description">Required. The type of access for this folder. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Shared</samp>. This folder is
                    accessible only by the specified set of users.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Public</samp>. This folder is
                    accessible by all users, including portal users.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PublicInternal</samp>. <span class="ph" id="PublicInternalDesc"><a name="PublicInternalDesc"><!-- --></a>This folder is accessible by all
                      users, excluding portal users. This setting is available
                      for report and dashboard folders in organizations with a
                      partner portal or Customer Portal enabled.</span>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Hidden</samp>. This folder is
                    hidden from all users.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d525698e200" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d525698e203" data-title="Field Type">string</td>

              <td class="entry" headers="d525698e206" data-title="Description">The name used as a unique identifier for API access. The
                <span class="keyword parmname">fullName</span> can contain only underscores and
                alphanumeric characters. It must be unique, begin with a letter, not
                include spaces, not end with an underscore, and not contain two
                consecutive underscores. This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>
                component.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d525698e200" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d525698e203" data-title="Field Type">string</td>

              <td class="entry" headers="d525698e206" data-title="Description">Required. The name of the document folder.</td>

            </tr>

            <tr>
              <td class="entry" headers="d525698e200" data-title="Field Name"><span class="keyword parmname">publicFolderAccess</span></td>

              <td class="entry" headers="d525698e203" data-title="Field Type">PublicFolderAccess (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d525698e206" data-title="Description">If <samp class="codeph nolang">Public</samp> is the value for
                <a class="xref" href="#folder_accesstype">accessType</a>, this field indicates the type of access all users
                have to the contents of the folder. Valid values include:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ReadOnly</samp>. All users can
                    read the contents of the folder, but no user can change the
                    contents.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ReadWrite</samp>. All users
                    can read or change the contents of the folder.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d525698e200" data-title="Field Name"><span class="keyword parmname" id="field_sharedTo"><a name="field_sharedTo"><!-- --></a>sharedTo</span></td>

              <td class="entry" headers="d525698e203" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm" title="SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.">SharedTo</a></td>

              <td class="entry" headers="d525698e206" data-title="Description">
                <span class="ph" id="field_sharedTo_desc"><a name="field_sharedTo_desc"><!-- --></a>Sharing access for the folder.</span>
                See <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.security_sharing_considerations.htm&amp;type=5&amp;language=en_US" target="_blank">Sharing Considerations</a> in
                Salesforce Help.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the package manifest definition of a document folder that contains a document:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>basic</fullName\>
    <types\>
        <members\>sampleFolder</members\>
        <members\>sampleFolder/TestDocument.txt</members\>
        <name\>Document</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

The following is an example of the sampleFolder-meta.xml metadata file for the sampleFolder document folder:

<?xml version="1.0" encoding="UTF-8"?>
<DocumentFolder xmlns="http://soap.sforce.com/2006/04/metadata">
    <accessType\>Public</accessType\>
    <name\>sampleFolder</name\>
    <publicFolderAccess\>ReadWrite</publicFolderAccess\>
</DocumentFolder\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

1. [FolderShare](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_foldershare.htm)  
    Represents the settings for enhanced analytics folder sharing. Users can control access to reports or dashboards by giving others Viewer, Editor, or Manager access to the folder that contains the report or dashboard.

#### See Also

- [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dashboard.htm "Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.")
- [Document](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_document.htm "Represents a Document. All documents must be in a document folder, such as sampleFolder/TestDocument.")
- [EmailTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailtemplate.htm "Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only.")
- [Report](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm "Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.")

<!-- document id=6e3bdcebb3bc38e88e1dde2535b71a1249a8d0a8bd93d6d18cb0c4910db48092 url=/legacydeveloper/current/en-us/api_meta/meta_foldershare.md -->

# FolderShare

Represents the settings for enhanced analytics folder sharing. Users can control access to reports or dashboards by giving others Viewer, Editor, or Manager access to the folder that contains the report or dashboard.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

During package installation, FolderShare for DashboardFolder and ReportFolder is ignored.

## File Suffix and Directory Location

FolderShare objects are stored in the reports and dashboards directories. For each report or dashboard folder it contains, there’s a metadata file named FolderName\-meta.xml. The FolderName\-meta.xml metadata file contains the metadata information for that folder, such as the accessLevel. For example, if the reports directory contains a reports folder named myReportsFolder, it also has a myReportsFolder-meta.xml file at the same level as myReportsFolder.

## Version

FolderShare components are available in API version 28 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d526665e112">Field Name</th>

              <th class="featureTableHeader  " id="d526665e115">Field Type</th>

              <th class="featureTableHeader  " id="d526665e118">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d526665e112" data-title="Field Name"><span class="keyword parmname">accessLevel</span></td>

              <td class="entry" headers="d526665e115" data-title="Field Type">FolderShareAccessLevel (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d526665e118" data-title="Description">Required. Specifies the combination of actions that can be taken on the folder.
                Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">View</samp>. User can run a report or refresh a
                    dashboard, but can’t edit them. All users have at least Viewer access to
                    report and dashboard folders that have been shared with them. (Some users can
                    have administrative permissions that give them greater access.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EditAllContents</samp>. Users can view and
                    modify the reports or dashboards in the folder, and move them to and from any
                    other folders that they have equivalent access to.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Manage</samp>. Users can do everything Viewers
                    and Editors can do, plus control other users’ access to a folder.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d526665e112" data-title="Field Name"><span class="keyword parmname">sharedTo</span></td>

              <td class="entry" headers="d526665e115" data-title="Field Type">string</td>

              <td class="entry" headers="d526665e118" data-title="Description">Required. Specifies the user, group, or role that has the specified access
                level to the folder. </td>

            </tr>

            <tr>
              <td class="entry" headers="d526665e112" data-title="Field Name"><span class="keyword parmname">sharedToType</span></td>

              <td class="entry" headers="d526665e115" data-title="Field Type">FolderSharedToType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d526665e118" data-title="Description">Required. Specifies the type of entity that the folder is shared with. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Group</samp>. Users in a specified public group
                    have the specified access level to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Manager</samp>.
                    Available in API version
                    29.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ManagerAndSubordinatesInternal</samp>.
                    Available in API version
                    29.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Role</samp>. Users with a specified role have
                    the specified access level to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RoleAndSubordinates</samp>. Users with a
                    specified role, and users with a role subordinate to that role, have the
                    specified access level to the folder. Only available when digital experiences is
                    enabled for your org and Experience Cloud site users are created with external
                    account roles other than a shared person account role.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RoleAndSubordinatesInternal</samp>. Users with a
                    specified role and users with a role subordinate to that role, except public
                    portal users, have the specified access level to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Organization</samp>. All internal users have the
                    specified access level to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Territory</samp>. Users in a specified territory
                    have the specified access level to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TerritoryAndSubordinates</samp>. Users in a
                    specified territory, and users in territories subordinate to the specified
                    territory, have the specified access level to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AllPrmUsers</samp>. All PRM Portal users have
                    the specified level of access to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">User</samp>. The specified individual user has
                    the specified level of access to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PartnerUser</samp>. The specified individual
                    user of a partner portal has the specified level of access to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AllCspUsers</samp>. All Customer Success Portal
                    users have the specified level of access to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomerPortalUser</samp>. The specified
                    individual user of a customer portal has the specified level of access to the
                    folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PortalRole</samp>. Users with a specified role
                    in a portal have the specified access level to the folder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PortalRoleAndSubordinates</samp>. Portal users
                    with a specified role, and portal users with a role subordinate to that role,
                    have the specified access level to the folder.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a FolderShare component for a dashboard folder:

<?xml version="1.0" encoding="UTF-8"?>
<DashboardFolder xmlns="http://soap.sforce.com/2006/04/metadata">
  <folderShares\>
        <accessLevel\>View</accessLevel\>
        <sharedTo\>R1</sharedTo\>
        <sharedToType\>Role</sharedToType\>
    </folderShares\>
</DashboardFolder\>

Here’s an example of a FolderShare component for a report folder:

<?xml version="1.0" encoding="UTF-8"?>
<ReportFolder xmlns="http://soap.sforce.com/2006/04/metadata">
  <folderShares\>
       <accessLevel\>View</accessLevel\>
        <sharedTo\>R1</sharedTo\>
        <sharedToType\>Role</sharedToType\>
    </folderShares\>
</ReportFolder\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=d85fec075a90a8a23ab99bd8f172f56caf0eebba4ad819f090e3f052806aef71 url=/legacydeveloper/current/en-us/api_meta/meta_forecastingfilter.md -->

# ForecastingFilter

Represents the custom filter for including or excluding data from opportunity forecasts.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

ForecastingFilter components have the suffix .forecastingFilter and are stored in the forecastingFilters folder.

## Version

ForecastingFilter components are available in API version 55.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| filterLogic | 
Field Type

string

Description

The logic that controls the evaluation of conditions. Only AND is supported. For example, 1 AND 2 AND 3.



 |
| forecastingType | 

Field Type

string

Description

Required. The ID of the forecast type. Can be linked only to forecast types created in Summer ’21 and later.



 |
| forecastingTypeSource | 

Field Type

string

Description

Required. The ID of the forecast type source. Can be linked only to forecast type sources created in Summer ’21 or later and with a forecast source definition with source object of 'Opportunity.'



 |
| masterLabel | 

Field Type

string

Description

Required. The label for this object, which displays in Setup. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en\_US.



 |

## Declarative Metadata Sample Definition

The following is an example of a ForecastingFilter component.

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingFilter xmlns="http://soap.sforce.com/2006/04/metadata">
    <filterLogic\>1 AND 2</filterLogic\>
    <forecastingType\>d</forecastingType\>
    <forecastingTypeSource\>d7</forecastingTypeSource\>
    <masterLabel\>FF\_OpportunityLineItem</masterLabel\>
</ForecastingFilter\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ForecastingFilter</name\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=bc099a4fdba721bb2a8c2e1442a5d00330e4fbbf2110d9554eee3f12ed7074ca url=/legacydeveloper/current/en-us/api_meta/meta_forecastingfiltercondition.md -->

# ForecastingFilterCondition

Represents the custom filter condition logic for including or excluding data from opportunity forecasts.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

ForecastingFilterCondition components have the suffix .ForecastingFilterCondition and are stored in the ForecastingFilterConditions folder.

## Version

ForecastingFilterCondition components are available in API version 55.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| fieldName | 
Field Type

string

Description

Required. The name of the opportunity field to be filtered.



 |
| forecastingFilter | 

Field Type

string

Description

Required. The ID of the forecast filter.



 |
| forecastingSourceDefinition | 

Field Type

string

Description

The ID of the forecasting source definition.



 |
| masterLabel | 

Field Type

string

Description

Required. The label for this object, which displays in Setup. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en\_US.



 |
| operation | 

Field Type

FilterOperation (enumeration of type string)

Description

Required. The operator in the filter condition. Possible values are:

- equals
- greaterOrEqual—greater than or equal to
- greaterThan
- lessOrEqual—less than or equal to
- lessThan
- notEqual—not equal to





 |
| sortOrder | 

Field Type

int

Description

Required. The index value for the condition. This value represents the condition in the FilterLogic field on the ForecastingFilter object. For example, 1.



 |
| value | 

Field Type

string

Description

The value of the filter condition. If multiple values are specified, they must be separated by a comma delimiter.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If you have multiple currencies enabled, and add a custom filter on a currency field as part of your forecast type definition, the corporate currency at the time the filter was created is used. If you have a single currency enabled, the absolute value is used in your filter condition.















 |

## Declarative Metadata Sample Definition

The following is an example of a ForecastingFilterCondition component.

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingFilterCondition xmlns="http://soap.sforce.com/2006/04/metadata">
    <colName\>mostlikely</colName\>
    <fieldName\>Amount</fieldName\>
    <forecastingFilter\>d</forecastingFilter\>
    <forecastingSourceDefinition\>d7</forecastingSourceDefinition\>
    <masterLabel\>FFC\_Opportunity</masterLabel\>
    <operation\>greaterThan</masterLabel\>
    <sortOrder\>1</masterLabel\>
    <value\>100000</value\>
</ForecastingFilterCondition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ForecastingFilterCondition</name\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

## Usage

A forecast type can contain up to three filter conditions.

<!-- document id=877964f2b7e517373da1f673ad27a24b95870eff57917b0b13979b313d8e3577 url=/legacydeveloper/current/en-us/api_meta/meta_forecastingobjectlistsettings.md -->

# ForecastingObjectListSettings

Represents an org’s forecasting object list settings. Use these settings to control which object types and field types appear in the list of object details on the forecasts page. For example, pipeline forecasts use the Opportunity object, and the object list settings specify which fields from that object are available in the opportunity list section of the forecasts page. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

ForecastingObjectListSettings values are stored in the ForecastingObjectList.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ForecastingObjectListSettings is available in API versions 52.0 and later.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The information in this topic applies only to forecast types created in Summer ’21 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| forecastingTypeObjectListSettings | [ForecastingTypeObjectListSettings](#ForecastingTypeObjectListSettings) | For each forecast type, specifies the information that is displayed in the list of object details that roll up into the forecasts. For example, the list of opportunities rolls up into opportunity-based forecasts. |

## ForecastingTypeObjectListSettings

Represents an org’s forecasting type object list settings.

| Field Name | Field Type | Description |
| --- | --- | --- |
| forecastingObjectListLabelMappings | [ForecastingObjectListLabelMapping](#forecastingObjectListLabelMapping) | Mapping of labels with each field displayed as a column in the object detail list on the forecasts page. |
| forecastingObjectListSelectedSettings | [forecastingObjectListSelectedSettings](#forecastingObjectListSelectedSettings) | Specifies the object fields that are used as columns in the object detail list on the forecasts page. |
| forecastingObjectListUnselectedSettings | [forecastingObjectListUnselectedSettings](#forecastingObjectListUnselectedSettings) | Lists the object fields that are available but not currently used as columns in the object detail list on the forecasts page. Changes to forecastingObjectListSelectedSettings field are reflected in this field. |
| forecastingTypeDeveloperName | string | Developer name of the forecast type that these object list settings apply to. |

## ForecastingObjectListLabelMapping

Represents an org’s forecasting type object list label mapping.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Object field’s API name. |
| label | string | Object field’s name in the object detail list on the forecasts page. |

## forecastingObjectListSelectedSettings

Represents an org’s forecasting type object list selected settings.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Object field’s API name. |

## forecastingObjectListUnselectedSettings

Represents an org’s forecasting type object list unselected settings.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Object field’s API name. |

## Declarative Metadata Sample Definition

The following is an example of the ForecastingObjectListSettings.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingObjectListSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <forecastingTypeObjectListSettings\>
        <forecastingObjectListLabelMappings\>
            <field\>CREATEDBY\_USER.ALIAS</field\>
            <label\>Created By Alias</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.AMOUNT</field\>
            <label\>Amount</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.CLOSE\_DATE</field\>
            <label\>Close Date</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.TYPE</field\>
            <label\>Type</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.CREATED\_DATE</field\>
            <label\>Created Date</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.LAST\_UPDATE</field\>
            <label\>Last Modified Date</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.LEAD\_SOURCE</field\>
            <label\>Lead Source</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.EXP\_AMOUNT</field\>
            <label\>Expected Revenue</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.CLOSED</field\>
            <label\>Closed</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.WON</field\>
            <label\>Won</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>00Nxx000001G2W0</field\>
            <label\>CustomOppCurr</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CORE.USERS.ALIAS</field\>
            <label\>Opportunity Owner Alias</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.PROBABILITY</field\>
            <label\>Probability (%)</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.LAST\_ACTIVITY</field\>
            <label\>Last Activity</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.FISCAL\_QUARTER</field\>
            <label\>Fiscal Quarter</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>00Nxx000001G8GS</field\>
            <label\>TaraTestOppCurr</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>DESCRIPTION</field\>
            <label\>Description</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.FISCAL\_PERIOD</field\>
            <label\>Fiscal Period</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>FULL\_NAME</field\>
            <label\>Owner Full Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.NEXT\_STEP</field\>
            <label\>Next Step</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>UPDATEDBY\_USER.ALIAS</field\>
            <label\>Last Modified By Alias</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.STAGE\_NAME</field\>
            <label\>Stage</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CONTRACT.NAME</field\>
            <label\>Contract Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.QUANTITY</field\>
            <label\>Quantity</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>SPLITAMOUNT</field\>
            <label\>Forecasted Amount</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.NAME</field\>
            <label\>Opportunity Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CORE.USERS.LAST\_NAME</field\>
            <label\>Owner Last Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.FISCAL\_YEAR</field\>
            <label\>Fiscal Year</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>TERR2\_NAME</field\>
            <label\>Territory Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CORE.USERS.FIRST\_NAME</field\>
            <label\>Owner First Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>ACCOUNT.SITE</field\>
            <label\>Account Site</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>ACCOUNT.NAME</field\>
            <label\>Account Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.PRIVATE</field\>
            <label\>Private</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>TERR2\_DESC</field\>
            <label\>Territory Description</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CONTRACT.CONTRACT\_NUMBER</field\>
            <label\>Contract Number</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>FORECAST\_CATEGORY</field\>
            <label\>Forecast Category</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListSelectedSettings\>
            <field\>OPPORTUNITY.NAME</field\>
        </forecastingObjectListSelectedSettings\>
        <forecastingObjectListUnselectedSettings\>
            <field\>ACCOUNT.NAME</field\>
            <field\>CONTRACT.CONTRACT\_NUMBER</field\>
            <field\>CONTRACT.NAME</field\>
            <field\>OPPORTUNITY.STAGE\_NAME</field\>
            <field\>FORECAST\_CATEGORY</field\>
            <field\>OPPORTUNITY.CLOSE\_DATE</field\>
            <field\>OPPORTUNITY.AMOUNT</field\>
            <field\>CORE.USERS.ALIAS</field\>
            <field\>CORE.USERS.FIRST\_NAME</field\>
            <field\>CORE.USERS.LAST\_NAME</field\>
            <field\>FULL\_NAME</field\>
            <field\>OPPORTUNITY.PROBABILITY</field\>
            <field\>DESCRIPTION</field\>
            <field\>OPPORTUNITY.EXP\_AMOUNT</field\>
            <field\>OPPORTUNITY.LEAD\_SOURCE</field\>
            <field\>OPPORTUNITY.NEXT\_STEP</field\>
            <field\>OPPORTUNITY.PRIVATE</field\>
            <field\>OPPORTUNITY.QUANTITY</field\>
            <field\>OPPORTUNITY.TYPE</field\>
            <field\>UPDATEDBY\_USER.ALIAS</field\>
            <field\>CREATEDBY\_USER.ALIAS</field\>
            <field\>OPPORTUNITY.CLOSED</field\>
            <field\>OPPORTUNITY.WON</field\>
            <field\>ACCOUNT.SITE</field\>
            <field\>OPPORTUNITY.FISCAL\_YEAR</field\>
            <field\>OPPORTUNITY.FISCAL\_QUARTER</field\>
            <field\>OPPORTUNITY.FISCAL\_PERIOD</field\>
            <field\>OPPORTUNITY.LAST\_ACTIVITY</field\>
            <field\>OPPORTUNITY.CREATED\_DATE</field\>
            <field\>OPPORTUNITY.LAST\_UPDATE</field\>
            <field\>SPLITAMOUNT</field\>
            <field\>00Nxx000001G2W0</field\>
            <field\>00Nxx000001G8GS</field\>
            <field\>TERR2\_NAME</field\>
            <field\>TERR2\_DESC</field\>
        </forecastingObjectListUnselectedSettings\>
        <forecastingTypeDeveloperName\>OpportunityLineItemRevenue</forecastingTypeDeveloperName\>
    </forecastingTypeObjectListSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the ForecastingObjectListSettingsSettings settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>ForecastingObjectListSettings</members\>
		<name\>Settings</name\>
	</types\>
	<version\>52.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=23e18dfee7712b06063c8ae6553104c21e7c4508c31f37b6312ebc19c06ae679 url=/legacydeveloper/current/en-us/api_meta/meta_forecastingsettings.md -->

# ForecastingSettings

Represents the Forecasts settings options. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

[ForecastingSettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_forecastingsettings.htm#meta_forecastingsettings) components are available in API version 28 and later. The structure of the [ForecastingSettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_forecastingsettings.htm#meta_forecastingsettings) type changed significantly in API version 30.0 and in API version 53.0.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

[ForecastingSettings](#meta_forecastingsettings "Represents the Forecasts settings options. This type extends the Metadata metadata type and inherits its fullName field.") values are stored in a single file named Forecasting.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

[ForecastingSettings](#meta_forecastingsettings "Represents the Forecasts settings options. This type extends the Metadata metadata type and inherits its fullName field.") components are available in API version 28 and later. The structure of the [ForecastingSettings](#meta_forecastingsettings "Represents the Forecasts settings options. This type extends the Metadata metadata type and inherits its fullName field.") type changed significantly in API version 30.0 and in API version 53.0.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d529656e157">Field Name</th>

              <th class="featureTableHeader  " id="d529656e160">Field Type</th>

              <th class="featureTableHeader  " id="d529656e163">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">displayCurrency</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type"><span class="ph" id="DisplayCurrency"><a name="DisplayCurrency"><!-- --></a>DisplayCurrency (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</span></td>

              <td class="entry" headers="d529656e163" data-title="Description">Removed. The currency for displaying forecasts; either the
                organization's corporate currency or each forecast owner's personal
                currency setting. The selected currency is the default used in
                forecasts and selected in setup. The selection must be one of the
                currencies enabled for use in the organization, and only one
                selection is allowed. The default is <samp class="codeph nolang">CORPORATE</samp>. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CORPORATE</samp></li>

                  <li class="li"><samp class="codeph nolang">PERSONAL</samp></li>

                </ul>
                <p class="p">Available in API version 28.0 to 46.0. In API version 47.0
                  and later, use
                  <span class="keyword parmname">defaultToPersonalCurrency</span>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">defaultToPersonalCurrency</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e163" data-title="Description">If multicurrency is enabled, this field indicates whether the
                user’s personal currency is used in forecasts. If <samp class="codeph nolang">true</samp> (default), the user’s personal
                currency is used. If <samp class="codeph nolang">false</samp>, the
                corporate currency is used. <p class="p">Available in API version 47.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">enableForecasts</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e163" data-title="Description">Indicates if Salesforce Forecasting is enabled or not. Set to
                <samp class="codeph java">true</samp> to enable and <samp class="codeph java">false</samp> to disable the functionality.
                <p class="p">Disabling Forecasts can result in data loss. Refer to
                  Salesforce Help before disabling any functionality.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">forecastingCategoryMappings</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type">ForecastingCategoryMapping[]</td>

              <td class="entry" headers="d529656e163" data-title="Description">A list of mappings associating forecast types with forecast
                rollups. As of Spring ’20 and later, only standard users with the
                View All Forecasts or Allow Forecasting permission or delegated
                forecast manager status can access this subtype.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">forecastingDisplayedFamilySettings</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type">
                <a class="xref" href="#forecastingDisplayedFamilySettings">ForecastingDisplayedFamilySettings</a>[]
              </td>

              <td class="entry" headers="d529656e163" data-title="Description">The product families chosen to allow forecasting on in Lightning
                Experience. This field is available in API version 40.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">forecastingSubmissionSettings</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type">ForecastingSubmissionSettings</td>

              <td class="entry" headers="d529656e163" data-title="Description">The submission options for forecasts. Available in API version
                62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">forecastingTypeSettings</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type">
                <a class="xref" href="#ForecastingTypeSettings">ForecastingTypeSettings</a>[]
              </td>

              <td class="entry" headers="d529656e163" data-title="Description">A list of forecast types. For field values, see <a class="xref" href="#ForecastingTypeSettings">ForecastingTypeSettings</a>. The maximum number of forecast types is
                four.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">globalAdjustmentsSettings</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type">AdjustmentsSettings[]</td>

              <td class="entry" headers="d529656e163" data-title="Description">The adjustment options for forecasts. Available in API version
                53.0 and later. In API version 52.0 and earlier, use the
                <span class="keyword parmname">adjustmentsSettings</span> field on
                ForecastingTypeSettings.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">globalForecastRangeSettings</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type">ForecastRangeSettings[]</td>

              <td class="entry" headers="d529656e163" data-title="Description">The default periods and range selections in forecasts. Available
                in API version 53.0 and later. In API version 52.0 and earlier, use
                the <span class="keyword parmname">forecastRangeSettings</span> field on
                ForecastingTypeSettings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e157" data-title="Field Name"><span class="keyword parmname">globalQuotasSettings</span></td>

              <td class="entry" headers="d529656e160" data-title="Field Type">QuotasSettings[]</td>

              <td class="entry" headers="d529656e163" data-title="Description">Enables or disables quotas in Salesforce Forecasting. Available
                in API version 53.0 and later. In API version 52.0 and earlier, use
                the <span class="keyword parmname">quotasSettings</span> field on
                ForecastingTypeSettings.</td>

            </tr>

          </tbody>

        </table>

## ForecastingCategoryMapping

The category mappings for forecasts. This subtype appears eight times within the ForecastingSettings type. Each occurrence includes fields that specify a type of forecast category rollup, which forecast categories each rollup includes, and the weight of each forecast category in the rollup. Organizations using either cumulative forecast rollups or individual forecast category columns must include all eight occurrences of this subtype. As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this subtype.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d529656e390">Field</th>

              <th class="featureTableHeader  " id="d529656e393">Field Type</th>

              <th class="featureTableHeader  " id="d529656e396">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d529656e390" data-title="Field"><span class="keyword parmname">forecastingItemCategoryApiName</span></td>

              <td class="entry" headers="d529656e393" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e396" data-title="Description">Required. This field specifies the API name of the rollup type.
                The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">openpipeline</samp></li>

                  <li class="li"><samp class="codeph nolang">bestcaseforecast</samp></li>

                  <li class="li"><samp class="codeph nolang">commitforecast</samp></li>

                  <li class="li"><samp class="codeph nolang">pipelineonly</samp></li>

                  <li class="li"><samp class="codeph nolang">bestcaseonly</samp></li>

                  <li class="li"><samp class="codeph nolang">commitonly</samp></li>

                  <li class="li"><samp class="codeph nolang">closedonly</samp></li>

                  <li class="li"><samp class="codeph nolang">omittedonly</samp></li>

                  <li class="li"><samp class="codeph nolang">customcategory</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e390" data-title="Field"><span class="keyword parmname">weightedSourceCategories</span></td>

              <td class="entry" headers="d529656e393" data-title="Field Type">WeightedSourceCategory[]</td>

              <td class="entry" headers="d529656e396" data-title="Description">This field can occur more than one time when specifying more than
                one forecast category to include in the rollup type. Each occurrence
                contains two subfields that specify a forecast category to include
                in the forecast rollup type and its weight. Some rollup types
                include more than one forecast category. This list shows the
                forecast categories that are included in each rollup type.<ul class="ul bulletList">
                  <li class="li">Rollup: <samp class="codeph nolang">openpipeline</samp>,
                    Forecast categories: pipeline, best case, commit</li>

                  <li class="li">Rollup: <samp class="codeph nolang">bestcaseforecast</samp>, Forecast categories: best
                    case, commit, closed</li>

                  <li class="li">Rollup: <samp class="codeph nolang">commitforecast</samp>,
                    Forecast categories: commit, closed</li>

                  <li class="li">Rollup: <samp class="codeph nolang">pipelineonly</samp>,
                    Forecast categories: <samp class="codeph nolang">pipeline</samp>
                  </li>

                  <li class="li">Rollup: <samp class="codeph nolang">bestcaseonly</samp>, Forecast categories: <samp class="codeph nolang">best case</samp>
                  </li>

                  <li class="li">Rollup: <samp class="codeph nolang">commitonly</samp>,
                    Forecast categories: <samp class="codeph nolang">commit</samp>
                  </li>

                  <li class="li">Rollup: <samp class="codeph nolang">closedonly</samp>,
                    Forecast categories: <samp class="codeph nolang">closed</samp>
                  </li>

                  <li class="li">Rollup: <samp class="codeph nolang">omittedonly</samp>,
                    Forecast categories: <samp class="codeph nolang">omitted</samp>
                  </li>

                  <li class="li">Rollup: customcategory, Forecast categories: custom
                    category</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ForecastingDisplayedFamilySettings

The product families that an admin chooses to allow forecasting on in Lightning Experience. This field is available in API version 40.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| productFamily | string | The product family available to forecast on. Each product family is unique. |

## ForecastingSubmissionSettings

The setting allows forecast users to submit their forecast numbers at a point in time.

| Field | Field Type | Description |
| --- | --- | --- |
| allowForecastingSubmissions | boolean | Required. Indicates whether forecast submissions are allowed in forecasts. |

## ForecastingTypeSettings

The settings for each forecast type. An organization can have up to four forecast types active. If you omit a previously enabled forecast type that has a minimum API version less than or equal to the metadata package version, its quota and adjustment data is deleted from the org.

Omitting a forecast type field from the XML can deactivate that forecast type: if the forecast type was available in the release specified by the XML package version, that forecast type is deactivated and its quota and adjustment data are deleted.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d529656e668">Field Name</th>

              <th class="featureTableHeader  " id="d529656e671">Field Type</th>

              <th class="featureTableHeader  " id="d529656e674">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. Indicates whether the forecast type specified in the
                <span class="keyword parmname">name</span> field is active. <p class="p">Setting the
                  <span class="keyword parmname">active</span> field to false purges all
                  forecasting data, adjustments, and quotas for the forecast type.
                  When <span class="keyword parmname">active</span> is set to true, some values on
                  the Forecasts tab don’t appear immediately. An in-process con
                  appears to indicate that the values are being
                  calculated.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">adjustmentsSettings</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type"><a class="xref" href="#adjustmentsSettings">AdjustmentsSettings</a></td>

              <td class="entry" headers="d529656e674" data-title="Description">Removed. This field enables or disables the adjustments option in
                forecasts. In API version 53.0 and later, use
                globalAdjustmentsSettings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">displayedCategoryApiNames</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e674" data-title="Description">This read-only field appears four times to specify the four
                forecast rollup categories displayed in the Forecasts tab, for
                either cumulative forecast rollups, or individual forecast category
                rollups. Always use the same 4 values for both
                <span class="keyword parmname">displayedCategoryApiNames</span> and
                <span class="keyword parmname">forecastedCategoryApiNames</span>.<p class="p">Valid values
                  for organizations using cumulative forecast rollups:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">openpipeline</samp></li>

                  <li class="li"><samp class="codeph nolang">bestcaseforecast</samp></li>

                  <li class="li"><samp class="codeph nolang">commitforecast</samp></li>

                  <li class="li"><samp class="codeph nolang">closedonly</samp></li>

                </ul>
                <p class="p">Valid values for organizations using individual forecast
                  category rollups:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">pipelineonly</samp></li>

                  <li class="li"><samp class="codeph nolang">bestcaseonly</samp></li>

                  <li class="li"><samp class="codeph nolang">commitonly</samp></li>

                  <li class="li"><samp class="codeph nolang">closedonly</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">forecastedCategoryApiNames</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e674" data-title="Description">This field appears four times to specify the four forecast rollup
                categories used in the organization, for either cumulative forecast
                rollups, or individual forecast category rollups.<p class="p">Valid values for
                  organizations using cumulative forecast rollups:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">openpipeline</samp></li>

                  <li class="li"><samp class="codeph nolang">bestcaseforecast</samp></li>

                  <li class="li"><samp class="codeph nolang">commitforecast</samp></li>

                  <li class="li"><samp class="codeph nolang">closedonly</samp></li>

                  <li class="li"><samp class="codeph nolang">customcategory</samp></li>

                </ul>
                <p class="p">Valid values for organizations using individual forecast
                  category rollups:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">pipelineonly</samp></li>

                  <li class="li"><samp class="codeph nolang">bestcaseonly</samp></li>

                  <li class="li"><samp class="codeph nolang">commitonly</samp></li>

                  <li class="li"><samp class="codeph nolang">closedonly</samp></li>

                  <li class="li"><samp class="codeph nolang">customcategory</samp></li>

                </ul>
                <p class="p">Changing from one set of four values to the other changes
                  the organization setting for Enable Cumulative Forecast Rollups
                  in Setup. If this field is omitted, the setting isn’t
                  changed.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">forecastingDateType</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">ForecastingDateType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. The date type that forecast amounts are based on.
                <p class="p">Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">OpportunityCloseDate</samp>
                    (default)
                  </li>

                  <li class="li"><samp class="codeph nolang">ProductDate</samp></li>

                  <li class="li"><samp class="codeph nolang">ScheduleDate</samp></li>

                  <li class="li">OLIMeasureCloseDateOnly</li>

                  <li class="li"><samp class="codeph nolang">ProductDateOnly</samp></li>

                  <li class="li"><samp class="codeph nolang">ScheduleDateOnly</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityCustomDate</samp>
                    (Available in API version 57.0 and later)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OLIMeasureOppCustomDateOnly</samp> (Available in API
                    version 57.0 and later)
                  </li>

                </ul>
                <p class="p">Available in API version 42.0 and later. In API version 42.0
                  only, date types are read only and available only via
                  API.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">forecastRangeSettings</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type"><a class="xref" href="#ForecastRangeSettings">ForecastRangeSettings</a></td>

              <td class="entry" headers="d529656e674" data-title="Description">Removed. The default periods and range selections in forecasts.
                In API version 53.0 and later, use
                globalForecastRangeSettings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">hasProductFamily</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. Indicates whether the forecasting type has product
                family forecasts enabled. Available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">isAmount</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. <span class="ph" id="isAmountDesc"><a name="isAmountDesc"><!-- --></a>This read-only field indicates
                  whether the forecast type is based on revenue amounts. The value
                  of <span class="keyword parmname">isAmount</span> is always the opposite of the
                  value of <span class="keyword parmname">isQuantity</span>.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">isAvailable</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. <span class="ph" id="isAvailableDesc"><a name="isAvailableDesc"><!-- --></a>This read-only field indicates
                  whether the forecast type can currently be used in the
                  organization. For example, the revenue splits forecast type
                  can’t be used in an organization that doesn’t have Opportunity
                  Splits enabled.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">isQuantity</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. <span class="ph" id="isQuantityDesc"><a name="isQuantityDesc"><!-- --></a>This read-only field indicates
                  whether the forecast type is based on product quantities. The
                  value of <span class="keyword parmname">isQuantity</span> is always the opposite
                  of the value of <span class="keyword parmname">isAmount</span>.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">managerAdjustableCategoryApiNames</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e674" data-title="Description">This read-only field appears twice to specify the two forecast
                rollup categories that forecast managers can adjust in the
                organization for either cumulative forecast rollups or individual
                forecast category rollups. This field can only be used when the
                <span class="keyword parmname">enableAdjustments</span> field contains a value of
                true. If both the
                <span class="keyword parmname">managerAdjustableCategoryApiNames</span> and
                <span class="keyword parmname">ownerAdjustableCategoryApiNames</span> fields are
                being used, they must contain the same two values. Their values must
                also be consistent with the values of the
                <span class="keyword parmname">enableAdjustments</span> and
                <span class="keyword parmname">enableOwnerAdjustments</span> fields. <p class="p">Valid
                  values for organizations using cumulative forecast rollups:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">bestcaseforecast</samp></li>

                  <li class="li"><samp class="codeph nolang">commitforecast</samp></li>

                </ul>
                <p class="p">Valid values for organizations using individual forecast
                  category rollups:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">bestcaseonly</samp></li>

                  <li class="li"><samp class="codeph nolang">commitonly</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. <span class="ph" id="masterLabelDesc"><a name="masterLabelDesc"><!-- --></a>This read-only field indicates
                  the UI label for the forecast type.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. The name of the forecast type. Each forecast type
                requires a specific string.<p class="p">Using ForecastingSettings, you can
                  activate only these forecast types.</p>
                <a name="forecastingTypeSettings_name_values"><!-- --></a>
                <ul class="ul bulletList" id="forecastingTypeSettings_name_values">
                  <li class="li">
                    <samp class="codeph nolang">LineItemQuantityProductDate</samp>: Product Families
                    - Quantity by product date. Available in API versions 47.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LineItemQuantityScheduleDate</samp>: Product Families
                    - Quantity by schedule date. Available in API versions 47.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LineItemRevenueProductDate</samp>: Product Families -
                    Revenue by product date. Available in API versions 47.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LineItemRevenueScheduleDate</samp>: Product Families
                    - Revenue by schedule date. Available in API versions 47.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityLineItemQuantity</samp>: Product Families
                    - Quantity.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityLineItemRevenue</samp>: Product Families -
                    Revenue.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityOverlayRevenue</samp>: Opportunity Overlay
                    Splits - Revenue.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityQuantity</samp>:
                    Opportunities - Quantity.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityQuantityProductDate</samp>: Opportunities
                    - Quantity by product date. Available in API versions 43.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityQuantityScheduleDate</samp>: Opportunities
                    - Quantity by schedule date. Available in API versions 43.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityRevenue</samp>: Opportunities - Revenue.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityRevenueProductDate</samp>: Opportunities -
                    Revenue by product date. Available in API versions 43.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunityRevenueScheduleDate</samp>: Opportunities
                    - Revenue by schedule date. Available in API versions 43.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpportunitySplitRevenue</samp>: Opportunity Revenue
                    Splits - Revenue.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang"><var class="keyword varname">Territory_Model_NameN</var></samp>:
                    Territories, where <var class="keyword varname">Territory_Model_Name</var>
                    is the name of your active territory model in the API.
                    <var class="keyword varname">Territory_Model_Name</var> can be followed
                    by <var class="keyword varname">N</var>, an auto-generated number that
                    distinguishes between territory forecast types. Available in
                    API versions 44.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang"><var class="keyword varname">Territory_Model_NameN</var>_ProductFamily</samp>:
                    Deprecated. Territories - Product Families, where
                    <var class="keyword varname">Territory_Model_Name</var> is the name of
                    your active territory model in the API and can be followed
                    by <var class="keyword varname">N</var>, an auto-generated number that
                    distinguishes between territory forecast types. Available in
                    API versions 45.0 and 46.0. For territory models created in
                    API version 47.0 and later, <samp class="codeph nolang"><var class="keyword varname">Territory_Model_NameN</var></samp>
                    is used.
                  </li>

                  <li class="li">The name of a custom opportunity split type that has been
                    enabled as a forecast type. Custom split types are based on
                    currency fields, which can contain revenue amounts
                    only.</li>

                </ul>
                <p class="p">To create and manage other forecast types in API version
                  52.0 and later, use <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingsourcedefinition.htm" title="Represents the object, measure, date type, and hierarchy that a forecast uses to project sales.">ForecastingSourceDefinition</a>, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingtype.htm" title="Represents a forecast type.">ForecastingType</a>, and <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingtypesource.htm" title="Represents the mapping of a forecasting source definition to a forecast type.">ForecastingTypeSource</a>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">opportunityListFieldsLabelMappings</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type"><a class="xref" href="#OpportunityListFieldsLabelMappings">OpportunityListFieldsLabelMapping</a></td>

              <td class="entry" headers="d529656e674" data-title="Description">A read-only list of the API names and
                UI labels for all fields on the Opportunity object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">opportunityListFields​SelectedSettings</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type"><a class="xref" href="#OpportunityListFieldsSelectedSettings">OpportunityListFields​SelectedSettings</a></td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. The fields selected to appear in the opportunity pane of
                the forecast page for the forecast type. One of the selected fields must be
                <strong class="ph uicontrol">Opportunity Name</strong>. You can select up to 15
                fields.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">opportunityListFields​UnselectedSettings</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type"><a class="xref" href="#OpportunityListFieldsUnselectedSettings">OpportunityListFields​UnselectedSettings</a></td>

              <td class="entry" headers="d529656e674" data-title="Description">Required. The fields <em class="ph i">not</em> selected to appear in the
                opportunity pane of the forecast page for the forecast type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">opportunitySplitName</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e674" data-title="Description">Indicates whether the forecasting type has a split type, and if
                so, the name of the split type. Available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">ownerAdjustableCategoryApiNames</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e674" data-title="Description">This read-only field appears twice to specify the two forecast
                rollup categories that forecast owners can adjust in the
                organization, for either cumulative forecast rollups, or individual
                forecast category rollups. This field can only be used when the
                <span class="keyword parmname">enableOwnerAdjustments</span> field contains a
                value of true. If both the
                <span class="keyword parmname">managerAdjustableCategoryApiNames</span> and
                <span class="keyword parmname">ownerAdjustableCategoryApiNames</span> fields are
                being used, they must contain the same two values. Their values must
                also be consistent with the values of the
                <span class="keyword parmname">enableAdjustments</span> and
                <span class="keyword parmname">enableOwnerAdjustments</span> fields.<p class="p">Valid
                  values for organizations using cumulative forecast rollups:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">bestcaseforecast</samp></li>

                  <li class="li"><samp class="codeph nolang">commitforecast</samp></li>

                </ul>
                <p class="p">Valid values for organizations using individual forecast
                  category rollups:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">bestcaseonly</samp></li>

                  <li class="li"><samp class="codeph nolang">commitonly</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">quotasSettings</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type"><a class="xref" href="#QuotasSettings">QuotasSettings</a></td>

              <td class="entry" headers="d529656e674" data-title="Description">Removed. This field enables or disables the quota option in
                forecasts. In API version 53.0 and later, use
                globalQuotasSettings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e668" data-title="Field Name"><span class="keyword parmname">territory2ModelName</span></td>

              <td class="entry" headers="d529656e671" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e674" data-title="Description">Indicates whether the forecasting type has a Territory2 model,
                and if so, the name of the Territory2 model. Available in API
                version 41.0 and later.</td>

            </tr>

          </tbody>

        </table>

## AdjustmentsSettings

The adjustment options for forecasts.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d529656e1378">Field</th>

              <th class="featureTableHeader  " id="d529656e1381">Field Type</th>

              <th class="featureTableHeader  " id="d529656e1384">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d529656e1378" data-title="Field"><span class="keyword parmname">allowExpandedColumns</span></td>

              <td class="entry" headers="d529656e1381" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e1384" data-title="Description">Required. Set to <samp class="codeph java">true</samp> to show
                separate columns on the forecasts page for each adjustable forecast
                category and <samp class="codeph java">false</samp> to show
                adjustments when a user hovers over a forecast category. All
                forecast types must contain the same
                <span class="keyword parmname">allowExpandedColumns</span> value.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e1378" data-title="Field"><span class="keyword parmname">enableAdjustments</span></td>

              <td class="entry" headers="d529656e1381" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e1384" data-title="Description">Required. Set to <samp class="codeph java">true</samp> to
                enable manager adjustments and <samp class="codeph java">false</samp> to disable them. All forecast types must contain
                the same <span class="keyword parmname">enableAdjustments</span> value. <p class="p">Disabling
                  adjustments results in adjustment data being purged.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e1378" data-title="Field"><span class="keyword parmname">enableOwnerAdjustments</span></td>

              <td class="entry" headers="d529656e1381" data-title="Field Type">boolean</td>

              <td class="entry" headers="d529656e1384" data-title="Description">Required. Set to <samp class="codeph java">true</samp> to
                enable owner adjustments for forecasts and <samp class="codeph java">false</samp> to disable them. All forecast types must contain
                the same <span class="keyword parmname">enableOwnerAdjustments</span> value.
                <p class="p">Disabling adjustments results in forecast adjustment data
                  being purged.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ForecastingGroup

The group based on a custom picklist that is used to group or roll up forecast totals on the forecasts page. For example, group forecasts using a custom picklist for industry or sales type.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d529656e1488">Field</th>

              <th class="featureTableHeader  " id="d529656e1491">Field Type</th>

              <th class="featureTableHeader  " id="d529656e1494">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d529656e1488" data-title="Field"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d529656e1491" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e1494" data-title="Description">Required. The API name that identifies the forecast
                group.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e1488" data-title="Field"><span class="keyword parmname">forecastingGroupItems</span></td>

              <td class="entry" headers="d529656e1491" data-title="Field Type"><a class="xref" href="#ForecastingGroupItem">ForecastingGroupItem</a></td>

              <td class="entry" headers="d529656e1494" data-title="Description">Required. The picklist values for the forecast type. Possible
                values include the picklist values defined in
                <span class="keyword parmname">groupField</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e1488" data-title="Field"><span class="keyword parmname">groupField</span></td>

              <td class="entry" headers="d529656e1491" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e1494" data-title="Description">Required. The field name of the custom picklist used as a group.
                Possible values include custom, single-selection picklists available
                in <span class="keyword parmname">sourceObject</span>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e1488" data-title="Field"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d529656e1491" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e1494" data-title="Description">Required. This read-only field indicates the UI label for the
                forecast group.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e1488" data-title="Field"><span class="keyword parmname">sourceObject</span></td>

              <td class="entry" headers="d529656e1491" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e1494" data-title="Description">Required. The source object for the picklist for the forecast
                group. Possible values include:<ul class="ul bulletList">
                  <li class="li">Opportunity</li>

                  <li class="li">OpportunityLineItem</li>

                  <li class="li">Product2</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ForecastingGroupItem

The picklist value that is specified as the forecasting group for a forecast type, and the order it displays in on the forecasts page.

| Field | Field Type | Description |
| --- | --- | --- |
| displayPosition | int | Required. Indicates the display order of the values on the forecasts page. |
| sourceAPIValue | string | Required. The API name is that’s derived from the group value. |

## ForecastRangeSettings

The default periods and range selections in forecasts. Users can forecast up to 15 months, 15 fiscal periods, or 8 quarters in the future or past. If your forecast range includes the current month, period, or quarter, the forecasts page shows the current month, period, or quarter by default. If not, the first month, period, or quarter of the range is selected. All forecast types must contain the same forecastRangeSettings field values.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d529656e1681">Field</th>

              <th class="featureTableHeader  " id="d529656e1684">Field Type</th>

              <th class="featureTableHeader  " id="d529656e1687">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d529656e1681" data-title="Field"><span class="keyword parmname">beginning</span></td>

              <td class="entry" headers="d529656e1684" data-title="Field Type">int</td>

              <td class="entry" headers="d529656e1687" data-title="Description">Required. Indicates the beginning month or quarter to display by
                default.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e1681" data-title="Field"><span class="keyword parmname">displaying</span></td>

              <td class="entry" headers="d529656e1684" data-title="Field Type">int</td>

              <td class="entry" headers="d529656e1687" data-title="Description">Required. Indicates the number of months or quarters to display
                by default. The maximum number of months is 12 and quarters is
                8.</td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e1681" data-title="Field"><span class="keyword parmname">periodType</span></td>

              <td class="entry" headers="d529656e1684" data-title="Field Type">
                <span class="ph" id="PeriodTypes"><a name="PeriodTypes"><!-- --></a>PeriodTypes</span>
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)
              </td>

              <td class="entry" headers="d529656e1687" data-title="Description">Required. Indicates what type of period to use. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Month</samp></li>

                  <li class="li"><samp class="codeph nolang">Quarter</samp></li>

                  <li class="li"><samp class="codeph nolang">Week</samp></li>

                  <li class="li"><samp class="codeph nolang">Year</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## OpportunityListFieldsLabelMapping

A read-only list of the API names and UI labels for all fields on the Opportunity object.

| Field | Field Type | Description |
| --- | --- | --- |
| field | string | Required. The API name of the Opportunity field. |
| label | string | Required. The UI label of the Opportunity field. |

## OpportunityListFields​SelectedSettings

The fields selected to appear in the opportunity pane of the forecast page for the forecast type. One of the selected fields must be **Opportunity Name**. You can select up to 15 fields.

| Field | Field Type | Description |
| --- | --- | --- |
| field | string | Specifies names of fields to display in the opportunity pane. |

## OpportunityListFields​UnselectedSettings

The fields _not_ selected to appear in the opportunity pane of the forecast page for the forecast type.

| Field | Field Type | Description |
| --- | --- | --- |
| field | string | Specifies names of fields not displayed in the opportunity pane. |

## QuotasSettings

[QuotasSettings](#QuotasSettings) indicates if quotas are available in forecasts.

| Field | Field Type | Description |
| --- | --- | --- |
| showQuotas | boolean | Required. Set to true to enable quotas. All forecast types must contain the same showQuotas field value. |

## WeightedSourceCategory

This field can occur more than one time when specifying more than one forecast category to include in the rollup type. Each occurrence contains two subfields that specify a forecast category to include in the forecast rollup type and its weight. Some rollup types include more than one forecast category. This table shows the forecast categories that are included in each rollup type.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d529656e2024">Field</th>

              <th class="featureTableHeader  " id="d529656e2027">Field Type</th>

              <th class="featureTableHeader  " id="d529656e2030">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d529656e2024" data-title="Field"><span class="keyword parmname">sourceCategoryApiName</span></td>

              <td class="entry" headers="d529656e2027" data-title="Field Type">string</td>

              <td class="entry" headers="d529656e2030" data-title="Description">Required. Specifies the API name of a forecast category to
                include in the rollup type. The valid values are.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">pipeline</samp></li>

                  <li class="li"><samp class="codeph nolang">best case</samp></li>

                  <li class="li"><samp class="codeph nolang">commit</samp></li>

                  <li class="li"><samp class="codeph nolang">closed</samp></li>

                  <li class="li"><samp class="codeph nolang">omitted</samp></li>

                  <li class="li"><samp class="codeph nolang">customcategory</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d529656e2024" data-title="Field"><span class="keyword parmname">weight</span></td>

              <td class="entry" headers="d529656e2027" data-title="Field Type">double</td>

              <td class="entry" headers="d529656e2030" data-title="Description">Required. Specifies the weight given to the forecast category
                when calculating the forecast for the rollup type. The only
                supported value is <samp class="codeph nolang">1.0</samp>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a [ForecastingSettings](#meta_forecastingsettings "Represents the Forecasts settings options. This type extends the Metadata metadata type and inherits its fullName field.") component that enables the Opportunity-Revenue forecast type, adjustments, owner adjustments, and quotas, and changes forecast range settings:

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <defaultToPersonalCurrency\>false</defaultToPersonalCurrency\>
    <enableForecasts\>true</enableForecasts\>    
    <globalAdjustmentsSettings\>
        <enableAdjustments\>true</enableAdjustments\>
        <enableOwnerAdjustments\>true</enableOwnerAdjustments\>
    </globalAdjustmentsSettings\>
    <globalForecastRangeSettings\>
        <beginning\>1</beginning\>
        <displaying\>6</displaying\>
        <periodType\>Month</periodType\>
    </globalForecastRangeSettings\>
    <globalQuotasSettings\>
        <showQuotas\>true</showQuotas\>
    </globalQuotasSettings\>
    <forecastingCategoryMappings\>
        <forecastingItemCategoryApiName\>commitonly</forecastingItemCategoryApiName\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>commit</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
    </forecastingCategoryMappings\>
    <forecastingCategoryMappings\>
        <forecastingItemCategoryApiName\>closedonly</forecastingItemCategoryApiName\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>closed</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
    </forecastingCategoryMappings\>
    <forecastingCategoryMappings\>
        <forecastingItemCategoryApiName\>openpipeline</forecastingItemCategoryApiName\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>most likely</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>commit</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>pipeline</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>best case</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
    </forecastingCategoryMappings\>
    <forecastingCategoryMappings\>
        <forecastingItemCategoryApiName\>omittedonly</forecastingItemCategoryApiName\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>omitted</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
    </forecastingCategoryMappings\>
    <forecastingCategoryMappings\>
        <forecastingItemCategoryApiName\>bestcaseforecast</forecastingItemCategoryApiName\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>most likely</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>commit</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>closed</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>best case</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
    </forecastingCategoryMappings\>
    <forecastingCategoryMappings\>
        <forecastingItemCategoryApiName\>pipelineonly</forecastingItemCategoryApiName\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>pipeline</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
    </forecastingCategoryMappings\>
    <forecastingCategoryMappings\>
        <forecastingItemCategoryApiName\>commitforecast</forecastingItemCategoryApiName\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>closed</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>commit</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
    </forecastingCategoryMappings\>
    <forecastingCategoryMappings\>
        <forecastingItemCategoryApiName\>bestcaseonly</forecastingItemCategoryApiName\>
        <weightedSourceCategories\>
            <sourceCategoryApiName\>best case</sourceCategoryApiName\>
            <weight\>1.0</weight\>
        </weightedSourceCategories\>
    </forecastingCategoryMappings\>
    <forecastingTypeSettings\>
	<name\>OpportunityRevenue</name\>
        <active\>true</active\>    
        <hasProductFamily\>false</hasProductFamily\>
        <isAmount\>true</isAmount\>
        <isAvailable\>true</isAvailable\>
        <isQuantity\>false</isQuantity\>
        <managerAdjustableCategoryApiNames\>commitonly</managerAdjustableCategoryApiNames\>
        <managerAdjustableCategoryApiNames\>bestcaseonly</managerAdjustableCategoryApiNames\>
        <masterLabel\>Opportunities</masterLabel\>
	<displayedCategoryApiNames\>closedonly</displayedCategoryApiNames\>
        <displayedCategoryApiNames\>commitonly</displayedCategoryApiNames\>
        <displayedCategoryApiNames\>bestcaseonly</displayedCategoryApiNames\>
        <displayedCategoryApiNames\>pipelineonly</displayedCategoryApiNames\>
        <forecastedCategoryApiNames\>commitonly</forecastedCategoryApiNames\>
        <forecastedCategoryApiNames\>closedonly</forecastedCategoryApiNames\>
        <forecastedCategoryApiNames\>pipelineonly</forecastedCategoryApiNames\>
        <forecastedCategoryApiNames\>bestcaseonly</forecastedCategoryApiNames\>
        <forecastingDateType\>OpportunityCloseDate</forecastingDateType\>
        <opportunityListFieldsSelectedSettings\>
            <field\>OPPORTUNITY.NAME</field\>
        </opportunityListFieldsSelectedSettings\>
    </forecastingTypeSettings\>
</ForecastingSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a99f49e347b58cfebe5cae17b5d0f6ff132edb4deb1a57791682f521ecda496b url=/legacydeveloper/current/en-us/api_meta/meta_forecastingsourcedefinition.md -->

# ForecastingSourceDefinition

Represents the object, measure, date type, and hierarchy that a forecast uses to project sales.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ForecastingSourceDefinition components have the suffix .forecastingSourceDefinition and are stored in the forecastingSourceDefinitions folder.

## Version

ForecastingSourceDefinition components are available in API version 52.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d535406e105">Field Name</th>

              <th class="featureTableHeader  " id="d535406e108">Field Type</th>

              <th class="featureTableHeader  " id="d535406e111">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d535406e105" data-title="Field Name"><span class="keyword parmname">categoryField</span></td>

              <td class="entry" headers="d535406e108" data-title="Field Type">string</td>

              <td class="entry" headers="d535406e111" data-title="Description">Name of the forecast category that is associated with the forecast type.
                Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Opportunity.ForecastCategoryName</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d535406e105" data-title="Field Name"><span class="keyword parmname">dateField</span></td>

              <td class="entry" headers="d535406e108" data-title="Field Type">string</td>

              <td class="entry" headers="d535406e111" data-title="Description">Field that is used for the forecast type’s date type. For example, the
                <span class="keyword parmname">CloseDate</span> field on Opportunity is used for opportunity close
                date-based forecast types. Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Opportunity.CloseDate </samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItem.ServiceDate</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItemSchedule.ScheduleDate</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d535406e105" data-title="Field Name"><span class="keyword parmname">familyField</span></td>

              <td class="entry" headers="d535406e108" data-title="Field Type">string</td>

              <td class="entry" headers="d535406e111" data-title="Description">Use this field to group forecasts by product family. Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Product2.Family</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d535406e105" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d535406e108" data-title="Field Type">string</td>

              <td class="entry" headers="d535406e111" data-title="Description">Required. Controlling label for this forecasting source definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d535406e105" data-title="Field Name"><span class="keyword parmname">measureField</span></td>

              <td class="entry" headers="d535406e108" data-title="Field Type">string</td>

              <td class="entry" headers="d535406e111" data-title="Description">Field that is used for the forecast type’s measure. For example, the
                <span class="keyword parmname">Amount</span> field on Opportunity is associated with revenue-based
                forecast types. Possible values are*:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Opportunity.Amount</samp></li>

                  <li class="li"><samp class="codeph nolang">Opportunity.<var class="keyword varname">Custom</var></samp></li>

                  <li class="li"><samp class="codeph nolang">Opportunity.TotalOpportunityQuantity</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItem.<var class="keyword varname">Custom</var></samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItem.Quantity</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItem.TotalPrice</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItemSchedule.<var class="keyword varname">Custom</var></samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItemSchedule.Quantity</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItemSchedule.Revenue</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunitySplit.<var class="keyword varname">Custom</var></samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunitySplit.SplitAmount</samp></li>

                </ul>
                *Where <var class="keyword varname">Custom</var> represents the name of the custom field that a
                forecast type’s measure is based on. Example: Use <samp class="codeph nolang">Megawatts__c</samp> to forecast energy consumption.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d535406e105" data-title="Field Name"><span class="keyword parmname">sourceObject</span></td>

              <td class="entry" headers="d535406e108" data-title="Field Type">string</td>

              <td class="entry" headers="d535406e111" data-title="Description">Required. Object associated with this forecasting source definition. Possible
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Opportunity</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItem</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItemSchedule</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunitySplit</samp></li>

                  <li class="li"><samp class="codeph nolang">Product2</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d535406e105" data-title="Field Name"><span class="keyword parmname">territory2Field</span></td>

              <td class="entry" headers="d535406e108" data-title="Field Type">string</td>

              <td class="entry" headers="d535406e111" data-title="Description">For a territory-based forecast type, indicates the field that is used for
                territory information. Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Opportunity.Territory2Id</samp></li>

                </ul>
                <p class="p">For user role-based forecast types, this value is <samp class="codeph nolang">null</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d535406e105" data-title="Field Name"><span class="keyword parmname">userField</span></td>

              <td class="entry" headers="d535406e108" data-title="Field Type">string</td>

              <td class="entry" headers="d535406e111" data-title="Description">Specifies who owns the forecast. Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Opportunity.OwnerId</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunitySplit.SplitOwnerId</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ForecastingSourceDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingSourceDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>TestFsd</masterLabel\>
    <sourceObject\>Opportunity</sourceObject\>
    <measureField\>Opportunity.Amount</measureField\>
    <dateField\>Opportunity.CloseDate</dateField\>
    <userField\>Opportunity.OwnerId</userField\>
    <categoryField\>Opportunity.ForecastCategoryName</categoryField\>
</ForecastingSourceDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ForecastingSourceDefinition</name\>
    </types\>
    <version\>52.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

## Usage

- Forecast types that were available before API version 52.0 can be activated, deactivated, and deleted but not created. To enable an existing forecast type, update the active flag.
- Forecast types that are available only in API version 52.0 and later can be created, activated, deactivated, and deleted. If the forecast type doesn’t exist, it is created in the inactive state. If the forecast type exists, the active flag is updated. Deploy the zip file twice to create and activate the forecast type.
- Deploy Metadata API types in the following sequence: ForecastingSettings, ForecastingType, ForecastingSourceDefinition, and then ForecastingTypeSource. If all are specified in the package file, the sequence is followed automatically.

<!-- document id=e7ba7ca90d9fa3b56fc3d42328b5d4f10a3c8daaf593d590b394d503dc57d527 url=/legacydeveloper/current/en-us/api_meta/meta_forecastingtype.md -->

# ForecastingType

Represents a forecast type.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ForecastingType components have the suffix .forecastingType and are stored in the forecastingTypes folder.

## Version

ForecastingType components are available in API version 52.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d536488e105">Field Name</th>

              <th class="featureTableHeader  " id="d536488e108">Field Type</th>

              <th class="featureTableHeader  " id="d536488e111">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">boolean</td>

              <td class="entry" headers="d536488e111" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, the forecast type is
                active. If <samp class="codeph nolang">false</samp>, the forecast type isn’t
                active. The default value is <samp class="codeph nolang">false</samp>.</td>


            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">amount</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">boolean</td>

              <td class="entry" headers="d536488e111" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, the forecast type is
                based on a revenue measure. If <samp class="codeph nolang">false</samp>, the
                forecast type is based on a quantity measure. The default value is <samp class="codeph nolang">true</samp>.</td>


            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">dateType</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">string</td>

              <td class="entry" headers="d536488e111" data-title="Description">Required. The date type that forecast amounts are based on. <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">OpportunityCloseDate</samp>: Base forecasts on
                    opportunity close dates.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ProductDate</samp>: Base forecasts on
                    opportunity product line item dates, if available.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ScheduleDate</samp>: Base forecasts on
                    opportunity product schedule dates, if available.
                  </li>

                </ul>
                <p class="p">The following values are available in API version 52.0 and later, in
                  Performance Edition and in Unlimited Edition with Sales Cloud.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">OLIMeasureCloseDateOnly</samp>: Base forecasts
                    on opportunity close dates.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ProductDateOnly</samp>: Base forecasts on
                    opportunity product line item dates, if available.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ScheduleDateOnly</samp>: Base forecasts on
                    opportunity product schedule dates, if available.
                  </li>

                </ul>
              </td>


            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">string</td>

              <td class="entry" headers="d536488e111" data-title="Description">Required. The name of the forecasting type. The
                <span class="keyword parmname">DeveloperName</span> is called <span class="keyword parmname">name</span> in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingsettings.htm" title="Represents the Forecasts settings options. This type extends the Metadata metadata type and inherits its fullName field.">ForecastingSettings</a> and Forecasting
                Type in custom reports.
              </td>


            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">forecastingGroupDeveloperName</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">string</td>

              <td class="entry" headers="d536488e111" data-title="Description">Indicates the forecast group assigned to the forecast type. Required if
                <span class="keyword parmname">hasCustomGroup</span> is <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">hasCustomGroup</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">boolean</td>

              <td class="entry" headers="d536488e111" data-title="Description">Indicates whether the forecasting type has a forecast group, based on a custom
                picklist assigned. Use ForecastingGroup and ForecastingGroupItems subtypes in
                ForecastingSettings to identify the group and the values.</td>

            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">hasProductFamily</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">boolean</td>

              <td class="entry" headers="d536488e111" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, the forecast type
                includes product families. If <samp class="codeph nolang">false</samp>, the
                forecast type doesn’t include product families. The default value is <samp class="codeph nolang">false</samp>.</td>


            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">string</td>

              <td class="entry" headers="d536488e111" data-title="Description">Required. Controlling label for this ForecastingType value. This display value
                is the internal label that doesn’t get translated.</td>


            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">opportunitySplitType</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">string</td>

              <td class="entry" headers="d536488e111" data-title="Description">Indicates whether the forecasting type has a split type and, if so, the name of
                the split type.</td>


            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">opptyLineItemSplitType</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">string</td>

              <td class="entry" headers="d536488e111" data-title="Description">Indicates whether the forecasting type has an opportunity line item (product)
                split type and, if so, the name of the line item split type. Available in API
                version 58.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">quantity</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">boolean</td>

              <td class="entry" headers="d536488e111" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, the forecast type is
                based on a quantity measure. If <samp class="codeph nolang">false</samp>, the
                forecast type is based on a revenue measure. The default value is <samp class="codeph nolang">false</samp>.</td>


            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">roleType</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">string</td>

              <td class="entry" headers="d536488e111" data-title="Description">Required. Indicates whether the role type has a ForecastingType, and if so,
                which ForecastingType. Possible values are <samp class="codeph nolang">R</samp>
                (user role-based forecast type) and <samp class="codeph nolang">Y</samp>
                (Territory2-based forecast type).</td>


            </tr>

            <tr>
              <td class="entry" headers="d536488e105" data-title="Field Name"><span class="keyword parmname">territory2Model</span></td>

              <td class="entry" headers="d536488e108" data-title="Field Type">string</td>

              <td class="entry" headers="d536488e111" data-title="Description">Indicates whether the ForecastingType has a Territory2 model and, if so, the
                name of the Territory2 model.</td>


            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ForecastingType component using the role hierarchy.

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>false</active\>
    <amount\>true</amount\>
    <dateType\>0</dateType\>
    <developerName\>qqw</developerName\>
    <hasProductFamily\>false</hasProductFamily\>
    <masterLabel\>qqw</masterLabel\>
    <quantity\>false</quantity\>
    <roleType\>R</roleType\>
</ForecastingType\>

The following is an example of a ForecastingType component using the territory hierarchy.

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>false</active\>
    <amount\>false</amount\>
    <dateType\>0</dateType\>
    <developerName\>New\_Model6</developerName\>
    <hasProductFamily\>false</hasProductFamily\>
    <masterLabel\>Opportunity Quantity by Territory</masterLabel\>
    <quantity\>true</quantity\>
    <roleType\>Y</roleType\>
    <territory2Model\>New\_Model6</territory2Model\>
</ForecastingType\>

The following is an example of a ForecastingType component using an opportunity split type.

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>false</active\>
    <amount\>true</amount\>
    <dateType\>0</dateType\>
    <developerName\>split12</developerName\>
    <hasProductFamily\>false</hasProductFamily\>
    <masterLabel\>split12</masterLabel\>
    <opportunitySplitType\>Custom\_Revenue</opportunitySplitType\>
    <quantity\>false</quantity\>
    <roleType\>R</roleType\>
</ForecastingType\>

The following is an example of a ForecastingType component using an opportunity line item split type.

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <amount\>true</amount\>
    <dateType\>0</dateType\>
    <developerName\>productrevenuesplit</developerName\>
    <hasProductFamily\>true</hasProductFamily\>
    <masterLabel\>productrevenuesplit</masterLabel\>
    <opportunitySplitType\>Revenue</opportunitySplitType\>
    <opptyLineItemSplitType\>Revenue</opptyLineItemSplitType\>
    <quantity\>false</quantity\>
    <roleType\>R</roleType\>
</ForecastingType\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ForecastingType</name\>
    </types\>
    <version\>52.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

## Usage

- Legacy forecast types that were available before API version 52.0 can be deactivated but not activated, created, or deleted.
- Forecast types that are available only in API version 52.0 and later can be created, activated, deactivated, and deleted. If the forecast type doesn’t exist, it’s created in the inactive state. If the forecast type exists, the active flag is updated. Deploy the zip file twice to create and activate the forecast type.
- Deploy Metadata API types in this sequence: ForecastingSettings, ForecastingType, ForecastingSourceDefinition, and then ForecastingTypeSource. If all are specified in the package file, the sequence is followed automatically.

<!-- document id=1fcc215dd293b8d5d8515d3a9ed0858a834a5bbd100fe9bcd91446f5557db911 url=/legacydeveloper/current/en-us/api_meta/meta_forecastingtypesource.md -->

# ForecastingTypeSource

Represents the mapping of a forecasting source definition to a forecast type.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ForecastingTypeSource components have the suffix .forecastingTypeSource and are stored in the ForecastingTypeSources folder.

## Version

ForecastingTypeSource components are available in API version 52.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d537776e105">Field Name</th>

              <th class="featureTableHeader  " id="d537776e108">Field Type</th>

              <th class="featureTableHeader  " id="d537776e111">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d537776e105" data-title="Field Name"><span class="keyword parmname">forecastingSourceDefinition</span></td>

              <td class="entry" headers="d537776e108" data-title="Field Type">string</td>

              <td class="entry" headers="d537776e111" data-title="Description">Required. ID of the forecasting source definition.</td>


            </tr>

            <tr>
              <td class="entry" headers="d537776e105" data-title="Field Name"><span class="keyword parmname">forecastingType</span></td>

              <td class="entry" headers="d537776e108" data-title="Field Type">string</td>

              <td class="entry" headers="d537776e111" data-title="Description">Required. ID of the forecast type. Can be linked only to forecast types created
                in Summer ’21 and later.</td>


            </tr>

            <tr>
              <td class="entry" headers="d537776e105" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d537776e108" data-title="Field Type">string</td>

              <td class="entry" headers="d537776e111" data-title="Description">Required. Controlling label for this forecasting type source.</td>


            </tr>

            <tr>
              <td class="entry" headers="d537776e105" data-title="Field Name"><span class="keyword parmname">parentSourceDefinition</span></td>

              <td class="entry" headers="d537776e108" data-title="Field Type">string</td>

              <td class="entry" headers="d537776e111" data-title="Description">For forecast types not based on the Opportunity object and not based on a
                custom measure, this value represents the parent ForecastingSourceDefinition of the
                linked ForecastingSourceDefinition.<ul class="ul bulletList">
                  <li class="li">Opportunity Product is the parent of Opportunity.</li>

                  <li class="li">Opportunity Split is the parent of Opportunity.</li>

                  <li class="li">Line Item Schedule is the parent of Opportunity Product.</li>

                </ul>
              </td>


            </tr>

            <tr>
              <td class="entry" headers="d537776e105" data-title="Field Name"><span class="keyword parmname">relationField</span></td>

              <td class="entry" headers="d537776e108" data-title="Field Type">string</td>

              <td class="entry" headers="d537776e111" data-title="Description">Represents the field that links the source objects of the parent
                ForecastingSourceDefinition to the child ForecastingSourceDefinition. Possible
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">OpportunityLineItem.OpportunityId</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItem.Product2Id</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunityLineItemSchedule.OpportunityLineItemId</samp></li>

                  <li class="li"><samp class="codeph nolang">OpportunitySplit.OpportunityId</samp></li>

                </ul>
              </td>


            </tr>

            <tr>
              <td class="entry" headers="d537776e105" data-title="Field Name"><span class="keyword parmname">sourceGroup</span></td>

              <td class="entry" headers="d537776e108" data-title="Field Type">int</td>

              <td class="entry" headers="d537776e111" data-title="Description">Required. Represents a grouping of forecasting source definitions.</td>


            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following are two examples of a ForecastingTypeSource component. The first bases forecasts on the Opportunity Product object. The second bases forecasts on the Line Item Schedule object.

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingTypeSource xmlns="http://soap.sforce.com/2006/04/metadata">
    <forecastingSourceDefinition\>FSD\_OpportunityLineItem</forecastingSourceDefinition\>
    <forecastingType\>d</forecastingType\>
    <masterLabel\>ForecastingTypeSource\_d7</masterLabel\>
    <parentSourceDefinition\>FSD\_OpportunityLineItemSchedule1</parentSourceDefinition\>
    <relationField\>OpportunityLineItemSchedule.OpportunityLineItemId</relationField\>
    <sourceGroup\>1</sourceGroup\>
</ForecastingTypeSource\>

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingTypeSource xmlns="http://soap.sforce.com/2006/04/metadata">
<forecastingSourceDefinition\>FSDOpportunityLineItemSchedule</forecastingSourceDefinition\>
    <forecastingType\>c3</forecastingType\>
    <masterLabel\>ForecastingTypeSource\_c37syR</masterLabel\>
    <sourceGroup\>1</sourceGroup\>
</ForecastingTypeSource\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ForecastingTypeSource</name\>
    </types\>
    <version\>52.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

## Usage

- Forecast types that were available before API version 52.0 can be activated, deactivated, and deleted but not created. To enable an existing forecast type, update the active flag.
- Forecast types that are available only in API version 52.0 and later can be created, activated, deactivated, and deleted. If the forecast type doesn’t exist, it is created in the inactive state. If the forecast type exists, the active flag is updated. Deploy the zip file twice to create and activate the forecast type.
- Deploy Metadata API types in the following sequence: ForecastingSettings, ForecastingType, ForecastingSourceDefinition, and then ForecastingTypeSource. If all are specified in the package file, the sequence is followed automatically.

<!-- document id=dceb14345a23e5222ebecbe6d499d5a6d76f0a4c35d886ed0d6fa45f8c92e485 url=/legacydeveloper/current/en-us/api_meta/meta_fueltype.md -->

# FuelType

Represents a custom fuel type in an org.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

FuelType components have the suffix .fuelType and are stored in the fuelTypes folder.

## Version

FuelType components are available in API version 57.0 and later.

## Special Access Rules

The Net Zero Cloud permission set license is required to access this object along with the user access for carbon accounting and org access for custom fuels and unit of measures (UOMs).

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d538487e101">Field Name</th>

              <th class="featureTableHeader  " id="d538487e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d538487e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d538487e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: Description about the fuel type.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d538487e101" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d538487e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether the fuel type is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d538487e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d538487e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type.</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d538487e101" data-title="Field Name"><span class="keyword parmname">isStationaryAssetFuel</span></td>

              <td class="entry" headers="d538487e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Indicates whether the fuel type is used in stationary
                  assets (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d538487e101" data-title="Field Name"><span class="keyword parmname">isVehicleAssetFuel</span></td>

              <td class="entry" headers="d538487e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether the fuel type is used in a vehicle
                  asset (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d538487e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d538487e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">A user-friendly name for FuelType, which is defined when
                  the FuelType is created.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a FuelType component.

<?xml version="1.0" encoding="UTF-8"?>
<FuelType xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>This is Petrol Fuel Type</description\>
    <isProtected\>true</isProtected\>
    <isActive\>true</isActive\>
    <isStationaryAssetFuel\>true</isStationaryAssetFuel\>
    <isVehicleAssetFuel\>true</isVehicleAssetFuel\>
    <masterLabel\>Petrol</masterLabel\>
</FuelType\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>Petrol</members\>
      <members\>Diesel</members\>
      <members\>Kerosine</members\>
      <name\>FuelType</name\>
   </types\>
   <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=f1ebe2eae6298b903de5fe295dd7a5cef6e60bcccc02beabd6e800b2330be568 url=/legacydeveloper/current/en-us/api_meta/meta_fueltypesustnuom.md -->

# FuelTypeSustnUom

Represents a mapping between the custom fuel types and their corresponding unit of measure (UOM) values defined by a customer in an org.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

FuelTypeSustnUom components have the suffix .fuelTypeSustnUom and are stored in the fuelTypeSustnUoms folder.

## Version

FuelTypeSustnUom components are available in API version 57.0 and later.

## Special Access Rules

The Net Zero Cloud permission set license is required to access this object along with the user access for carbon accounting and org access for custom fuels and UOMs.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d539152e101">Field Name</th>

              <th class="featureTableHeader  " id="d539152e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">

            <tr>
              <td class="entry" headers="d539152e101" data-title="Field Name"><span class="keyword parmname">fuelType</span></td>

              <td class="entry" headers="d539152e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The name of the fuel type that’s mapped to the unit
                  of measure.</p>

                <div class="p">Possible values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">AutogasLPG</samp></li>

                    <li class="li"><samp class="codeph nolang">Biodiesel</samp></li>

                    <li class="li"><samp class="codeph nolang">Biomass</samp></li>

                    <li class="li"><samp class="codeph nolang">CityGas</samp></li>

                    <li class="li"><samp class="codeph nolang">CompressedNaturalGasCNG</samp></li>

                    <li class="li"><samp class="codeph nolang">Cooling</samp></li>

                    <li class="li"><samp class="codeph nolang">Diesel</samp></li>

                    <li class="li"><samp class="codeph nolang">Electricity</samp></li>

                    <li class="li"><samp class="codeph nolang">Ethanol</samp></li>

                    <li class="li"><samp class="codeph nolang">FuelOil</samp></li>

                    <li class="li"><samp class="codeph nolang">Gasoline</samp></li>

                    <li class="li"><samp class="codeph nolang">Heat</samp></li>

                    <li class="li"><samp class="codeph nolang">HeavyOil</samp></li>

                    <li class="li"><samp class="codeph nolang">ITElectricity</samp></li>

                    <li class="li"><samp class="codeph nolang">JetFuel</samp></li>

                    <li class="li"><samp class="codeph nolang">Kerosene</samp></li>

                    <li class="li"><samp class="codeph nolang">LightOil</samp></li>

                    <li class="li"><samp class="codeph nolang">LiquidNaturalGasLNG</samp></li>

                    <li class="li"><samp class="codeph nolang">MobileDiesel</samp></li>

                    <li class="li"><samp class="codeph nolang">NaturalGas</samp></li>

                    <li class="li"><samp class="codeph nolang">Propane</samp></li>

                    <li class="li"><samp class="codeph nolang">Refrigerant</samp></li>

                    <li class="li"><samp class="codeph nolang">Steam</samp></li>

                  </ul>
                </div>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d539152e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d539152e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type.</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d539152e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d539152e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: A user-friendly name for FuelTypeSustnUom, which is defined when the FuelTypeSustnUom
                  is created.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d539152e101" data-title="Field Name"><span class="keyword parmname">unitOfMeasure</span></td>

              <td class="entry" headers="d539152e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The unit of measure that’s mapped to the fuel
                  type.</p>

                <div class="p">Possible values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">1000m3</samp></li>

                    <li class="li"><samp class="codeph nolang">GJ</samp></li>

                    <li class="li"><samp class="codeph nolang">GWh</samp></li>

                    <li class="li"><samp class="codeph nolang">Kiloliters</samp></li>

                    <li class="li"><samp class="codeph nolang">Liters</samp></li>

                    <li class="li"><samp class="codeph nolang">MJ</samp></li>

                    <li class="li"><samp class="codeph nolang">MMBtu</samp></li>

                    <li class="li"><samp class="codeph nolang">MWh</samp></li>

                    <li class="li"><samp class="codeph nolang">Therms</samp></li>

                    <li class="li"><samp class="codeph nolang">Tonnes</samp></li>

                    <li class="li"><samp class="codeph nolang">UkGallons</samp></li>

                    <li class="li"><samp class="codeph nolang">UsGallons</samp></li>

                    <li class="li"><samp class="codeph nolang">ccf</samp></li>

                    <li class="li"><samp class="codeph nolang">kG</samp></li>

                    <li class="li"><samp class="codeph nolang">kWh</samp></li>

                    <li class="li"><samp class="codeph nolang">kcal</samp></li>

                    <li class="li"><samp class="codeph nolang">lbs</samp></li>

                    <li class="li"><samp class="codeph nolang">longTons</samp></li>

                    <li class="li"><samp class="codeph nolang">m3</samp></li>

                    <li class="li"><samp class="codeph nolang">shortTons</samp></li>

                  </ul>
                </div>

              </td>


            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a FuelTypeSustnUom component.

<?xml version="1.0" encoding="UTF-8"?>
<FuelTypeSustnUom xmlns="http://soap.sforce.com/2006/04/metadata">
    <fuelType\>FuelOil</fuelType\>
    <isProtected\>false</isProtected\>
    <masterLabel\>FuelOil\_Liters</masterLabel\>
    <unitOfMeasure\>Liters</unitOfMeasure\>
</FuelTypeSustnUom\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>Pkg</fullName\>
    <types\>
        <members\>FuelOil\_Liters</members\>
        <members\>Gas\_1000m3</members\>
        <members\>Heat\_kWh</members\>
        <name\>FuelTypeSustnUom</name\>
    </types\>
    <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=e4b31d29465e069b94c173c56b93af53040729cd3948534e38e3b5242245257c url=/legacydeveloper/current/en-us/api_meta/meta_functionreference.md -->

# FunctionReference

Represents information about a deployed Salesforce Function that can be invoked from the org. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

FunctionReference does not support direct access and should be managed using Salesforce CLI commands associated with Functions. A FunctionReference component file has the suffix .functions and is stored in the functions directory.

## Version

FunctionReference components are available in API version 52.0 and later.

## Special Access Rules

FunctionReference components can’t be used directly. Always use Salesforce CLI commands associated with Functions to properly deploy Functions and associate Functions with orgs. Attempting to manipulate FunctionReference components directly without using Functions CLI commands is not supported.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Represents the description of the Salesforce Function. |
| label | string | Represents the label for the Salesforce Function. |
| permissionSet | string | Represents a set of permissions that's used to control org resources that the Function has access to. |

<!-- document id=29ffe3666a661ffe02e87a10057420e178fb7724264f1c9638c29975cec148f4 url=/legacydeveloper/current/en-us/api_meta/meta_fundraisingconfig.md -->

# FundraisingConfig

Represents a collection of settings to configure the fundraising product.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

FundraisingConfig components have the suffix .fundraisingConfig and are stored in the fundraisingConfigs folder.

## Version

FundraisingConfig components are available in API version 58.0 and later.

## Special Access Rules

Your org must have Fundraising Access license as a part of the Nonprofit Cloud to access this object.

## Fields

| Field Name | Description |
| --- | --- |
| donorMatchingMethod | 
Field Type

DonorMatchingMethod (enumeration of type string)

Description

Reserved for future use.



 |
| failedTransactionCount | 

Field Type

int

Description

The count of consecutive failed past transactions before the gift commitment status is changed to Failing. If set to 0, the status is never auto-changed to Failing.



 |
| householdSoftCreditRole | 

Field Type

string

Description

Reserved for future use.



 |
| installmentExtDayCount | 

Field Type

int

Description

The duration in the number of days before or after an unpaid transaction in a gift commitment is marked as another installment in the gift commitment schedule. The unpaid transaction within the grace period is considered a gift transaction.



 |
| isHshldSoftCrAutoCrea | 

Field Type

boolean

Description

Reserved for future use.



 |
| lapsedUnpaidTrxnCount | 

Field Type

int

Description

The count of consecutive unpaid past transactions before the gift commitment status is changed to Lapsed. If set to 0, the status is never auto-changed to Lapsed.



 |
| masterLabel | 

Field Type

string

Description

A user-friendly name for FundraisingConfig, which is defined when the FundraisingConfig is created.



 |
| shouldClosePaidRcrCmt | 

Field Type

boolean

Description

Indicates whether to automatically close a recurring gift commitment when it has no ongoing or future schedule and no unpaid transaction (true) or not (false).

The default value is false. Available in API version 59.0 and later.



 |
| shouldCreateRcrSchdTrxn | 

Field Type

boolean

Description

Indicates whether the next transaction in a recurring schedule is automatically created (true) or not (false).

The default value is true. Available in API version 59.0 and later.



 |
| utmCampaignSrcObj | 

Field Type

string

Description

Name of the sObject of the campaign for which the donation was received. Available in API version 64.0 and later.



 |
| utmCampaignSrcObjField | 

Field Type

string

Description

Name of the field on the sObject in utmCampaignSrcObj of the campaign for which the donation was received. Available in API version 64.0 and later.



 |
| utmMediumSrcObj | 

Field Type

string

Description

Name of the sObject that stores data about the message channel from which the donation originated. Available in API version 64.0 and later.



 |
| utmMediumSrcObjField | 

Field Type

string

Description

Name of the field on the sObject in utmMediumSrcObj that stores data about the message channel from which the donation originated. Available in API version 64.0 and later.



 |
| utmSourceSrcObj | 

Field Type

string

Description

Name of the sObject that stores data about the source of a donation. Available in API version 64.0 and later.



 |
| utmSourceSrcObjField | 

Field Type

string

Description

Name of the field on the sObject in utmSourceSrcObj that stores data about the source of a donation. Available in API version 64.0 and later.



 |

## Declarative Metadata Sample Definition

The following is an example of a FundraisingConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<FundraisingConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <lapsedUnpaidTrxnCount\>5</lapsedUnpaidTrxnCount\>
    <householdSoftCreditRole\>Admin</householdSoftCreditRole\>
    <isHshldSoftCrAutoCrea\>true</isHshldSoftCrAutoCrea\>
    <installmentExtDayCount\>7</installmentExtDayCount\>
    <donorMatchingMethod\>No\_Matching</donorMatchingMethod\>
    <donorExternalIdField\>TestExtId\_\_c</donorExternalIdField\>
    <failedTransactionCount\>12</failedTransactionCount\>
    <outreachSourceCodeGenFmla\>OutreachSourceCodeGenFmla</outreachSourceCodeGenFmla\>
    <shouldCreateRcrSchdTrxn\>true</shouldCreateRcrSchdTrxn\>
    <shouldClosePaidRcrCmt\>false</shouldClosePaidRcrCmt\>
    <masterLabel\>MasterLabel</masterLabel\>
    <utmMediumSrcObj\>UTM Medium Src Obj</utmMediumSrcObj\>
    <utmMediumSrcObjField\>UTM Medium Src Obj Field</utmMediumSrcObjField\>
    <utmSourceSrcObj\>UTM Source Src Obj</utmSourceSrcObj\>
    <utmSourceSrcObjField\>UTM Source Src Obj Field</utmSourceSrcObjField\>
    <utmCampaignSrcObj\>UTM Campaign Src Obj</utmCampaignSrcObj\>
    <utmCampaignSrcObjField\>UTM Campaign Src Obj Field</utmCampaignSrcObjField\>
</FundraisingConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>FundraisingConfig</name\>
    </types\>
    <version\>64.0</version\>
</Package\>

<!-- document id=b4cae6c2e4773fe72b41a56ef6e587f8de00cc8fc222fb64485fbac0b4cac1ae url=/legacydeveloper/current/en-us/api_meta/meta_gatewayproviderpaymentmethodtype.md -->

# GatewayProviderPaymentMethodType

Represents an entity that allows integrators and payment providers to choose an active payment to receive an order's payment data rather than allowing the Salesforce Order Management platform to select a default payment method. This object is available in API version 51 and later.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Version

gatewayProviderPaymentMethodType components are available in API version 51 and later.

## Special Access Rules

## Fields

| Field Name | Description |
| --- | --- |
| comments | 
Field Type

textarea

Description

Additional details about the gateway provider payment method type record. Max length is 1000 characters.



 |
| gtwyProviderPaymentMethodType | 

Field Type

string

Description

Links the Salesforce payment method to the payment method used in the Salesforce Order Management storefront. Your payment gateway integration uses this field when finding a payment method to link to a payment.

The value of GtwyProviderPaymentMethodType must match the payment method value sent to the order's Payment Instrument in Salesforce Order Management.

Here are examples of payment method values that Salesforce could receive from Salesforce Order Management.

- CREDIT\_CARD
- BASIC\_CREDIT
- CreditCard
- GooglePay
- ApplePay





 |
| masterLabel | 

Field Type

string

Description

Required. The gateway provider payment method type name that appears in the user interface.



 |
| paymentGatewayProvider | 

Field Type

reference

Description

Specifies the payment gateway provider that Salesforce Order Management should use when processing payments. One payment gateway provider can be related to multiple payment method types.



 |
| paymentMethodType | 

Field Type

picklist

Description

Specifies the type of payment method used on an order in Salesforce Order Management.

Possible values are:

- AlternativePaymentMethod
- CardPaymentMethod
- DigitalWallet





 |
| recordType | 

Field Type

reference

Description

ID of the record type entity related to the gateway provider payment method type.

This is a relationship field.



 |

## Declarative Metadata Sample Definition

The following is an example of a GatewayProviderPaymentMethodType component.

<?xml version="1.0" encoding="UTF-8"?>
<GatewayProviderPaymentMethodType xmlns="http://soap.sforce.com/2006/04/metadata">
    <gtwyProviderPaymentMethodType\>Klarna</gtwyProviderPaymentMethodType\>
    <masterLabel\>Test</masterLabel\>
    <paymentGatewayProvider\>adyen\_\_Adyen</paymentGatewayProvider\>
    <paymentMethodType\>AlternativePaymentMethod</paymentMethodType\>
    <recordType\>AlternativePaymentMethod.Klarna</recordType\>
</GatewayProviderPaymentMethodType\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>GatewayProviderPaymentMethodType</name\>
    </types\>
    <version\>51.0</version\>
</Package\>

<!-- document id=6e94556b9c30bf847afb0dd25e1ceb000b5ac80f159d033d8479b3c1e4b04f4f url=/legacydeveloper/current/en-us/api_meta/meta_genaifunction.md -->

# GenAiFunction

Represents an agent action that can be added to an AI agent.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

GenAiFunction components have the suffix .genAiFunction and are stored in the genAiFunctions folder.

GenAiFunction components can contain folders for the [input](#input_folder) and [output](#output_folder) schemas. Here’s an example component, showing the schema folders.

![GenAiFunction folder structure](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/mdapi_genaifunction_folder.png)

See the [Input Folder](#input_folder) and [Output Folder](#output_folder) sections for more information.

## Version

GenAiFunction components are available in API version 60.0 and later.

## Special Access Rules

GenAiFunction is available only if Agents is enabled in your org.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

A description explaining the general purpose and domain of the action.



 |
| invocationTarget | 

Field Type

string

Description

Required. Target invocation used by invocation operations.





 |
| invocationTargetType | 

Field Type

PlannerFunctionInvocableTargetType (enumeration of type string)

Description

Required. Invocable action type used by invocation operations.

Values are:

- api
- apex
- auraEnabled
- createCatalogItemRequest
- executeIntegrationProcedure
- externalService
- flow
- generatePromptResponse
- mcpTool
- namedQuery
- quickAction
- retriever
- runExpressionSet
- slack
- standardInvocableAction
- stub





 |
| isConfirmationRequired | 

Field Type

boolean

Description

Indicates whether confirmation is required for this action.



 |
| isIncludeInProgressIndicator | 

Field Type

boolean

Description

Indicates whether to display the progress indicator for this action.



 |
| mappingAttributes | 

Field Type

[GenAiPlannerAttr](#section_GenAiPlannerAttr)\[\]

Description

List of attributes for the planner.



 |
| masterLabel | 

Field Type

string

Description

Required. The master label for the generative AI action.





 |
| pluginField | 

Field Type

string

Description

Represents the action’s parent topic.





 |
| progressIndicatorMessage | 

Field Type

string

Description

The progress message.





 |

## GenAiPlannerAttr

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Description of the planner attribute.



 |
| label | 

Field Type

string

Description

Required. Label for the planner attribute.





 |
| name | 

Field Type

string

Description

Required. Name of the planner attribute.



 |
| parameterName | 

Field Type

string

Description

Required. The parameter name.



 |
| parameterType | 

Field Type

PlannerAttrMappingType (enumeration of type string)

Description

Required. The parameter type. Values are:

- input
- output





 |

## Input Folder

The input folder contains a schema.json file with the action inputs. Here’s a sample input schema file.

{
  "required" : \["OwnerId", "Status"\],
  "properties" : {
    "OwnerId" : {
      "title" : "Owner Id",
      "description" : "ID of the Salesforce record that owns the request.",
      "lightning:type" : "lightning\_\_textType",
      "lightning:isPII" : false,
      "copilotAction:isUserInput" : true
    },
    "Status" : {
      "title" : "Request Status",
      "description" : "The status of the contact request.",
      "lightning:type" : "lightning\_\_textType",
      "lightning:isPII" : false,
      "copilotAction:isUserInput" : true
    }
  },
  "lightning:type" : "lightning\_\_objectType"
}
				

This table describes the properties that you can specify in this JSON file.

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d542231e742">Field Name</th>

              <th class="featureTableHeader  " id="d542231e745">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d542231e742" data-title="Field Name"><span class="keyword parmname">required</span></td>

              <td class="entry" headers="d542231e745" data-title="Description">
                <a name="dl_fl4_4yq_q2c"><!-- --></a>
                <dl class="dl detailList" id="dl_fl4_4yq_q2c">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">array of strings</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">A list of all the required properties in the input
                    list.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e742" data-title="Field Name"><span class="keyword parmname">properties</span></td>

              <td class="entry" headers="d542231e745" data-title="Description">
                <a name="dl_gl4_4yq_q2c"><!-- --></a>
                <dl class="dl detailList" id="dl_gl4_4yq_q2c">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">object</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The parent object for all the properties associated with
                    the input.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e742" data-title="Field Name">
                <span class="keyword parmname">{PROPERTY_NAME}</span>
                <p class="p">(child of properties
                  field)</p>
              </td>

              <td class="entry" headers="d542231e745" data-title="Description">
                <a name="dl_hl4_4yq_q2c"><!-- --></a>
                <dl class="dl detailList" id="dl_hl4_4yq_q2c">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">object</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. Each property in the
                    <span class="keyword parmname">properties</span> object must contain
                    the API value corresponding to the input parameter.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e742" data-title="Field Name">
                <span class="keyword parmname">title</span>
                <p class="p">(child of properties.PROPERTY_NAME
                  field)</p>
              </td>

              <td class="entry" headers="d542231e745" data-title="Description">
                <a name="dl_il4_4yq_q2c"><!-- --></a>
                <dl class="dl detailList" id="dl_il4_4yq_q2c">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. The label for the property.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e742" data-title="Field Name">
                <span class="keyword parmname">description</span>
                <p class="p">(child of
                  properties.PROPERTY_NAME field)</p>
              </td>

              <td class="entry" headers="d542231e745" data-title="Description">
                <a name="dl_jl4_4yq_q2c"><!-- --></a>
                <dl class="dl detailList" id="dl_jl4_4yq_q2c">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The description for the property.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e742" data-title="Field Name">
                <span class="keyword parmname">lightning:type</span>
                <p class="p">(child of
                  properties.PROPERTY_NAME field)</p>
              </td>

              <td class="entry" headers="d542231e745" data-title="Description">
                <a name="dl_kl4_4yq_q2c"><!-- --></a>
                <dl class="dl detailList" id="dl_kl4_4yq_q2c">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. Describes the type of property. </dd>

                  <dd class="dd" id="lighting-type-description">
                    <a name="lighting-type-description"><!-- --></a>Some of the possible
                    values include:
                    <a name="ul_ll4_4yq_q2c"><!-- --></a>
                    <ul class="ul bulletList" id="ul_ll4_4yq_q2c">
                      <li class="li">
                        <samp class="codeph nolang">lightning__booleanType</samp>—Boolean
                        type.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__dateType</samp>—Date type.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__dateTimeType</samp>—Date and time
                        type. When using this value, you must provide a
                        <samp class="codeph nolang">dateTime</samp>
                        string. This field is specified in the format
                        <samp class="codeph nolang">yyyy-MM-dd'T'HH:mm:ss.SSSZ</samp>. You can also
                        provide a <samp class="codeph nolang">timeZone</samp> string. Use the timezone
                        attribute to specify a time zone in the IANA time
                        zone database format.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__integerType</samp>—Integer type.
                        When using this value, you can also provide
                        <samp class="codeph nolang">maximum</samp> and
                        <samp class="codeph nolang">minimum</samp>
                        numbers for this property.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__listType</samp>—List type.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__multilineTextType</samp>—Multi-line
                        text type. When using this value, you can also
                        provide <samp class="codeph nolang">maxLength</samp> and <samp class="codeph nolang">minLength</samp> numbers for
                        this property.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__numberType</samp>—Number type. When
                        using this value, you can also provide <samp class="codeph nolang">maximum</samp> and <samp class="codeph nolang">minimum</samp> numbers for
                        this property.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__objectType</samp>—Object type. When
                        using this value, you must also provide a <samp class="codeph nolang">properties</samp> object
                        that contains the list of subproperties within
                        it.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__recordIdType</samp>—Record ID
                        type.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__richTextType</samp>—Rich text type.
                        When using this value, you can also provide
                        <samp class="codeph nolang">maxLength</samp> and
                        <samp class="codeph nolang">minLength</samp>
                        numbers for this property.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__textType</samp>—Text type. When
                        using this value, you can also provide <samp class="codeph nolang">maxLength</samp> and <samp class="codeph nolang">minLength</samp> numbers for
                        this property. The maximum text type length is 250
                        characters.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__urlType</samp>—URL type. When using
                        this value, you can also provide an array of
                        strings in a <samp class="codeph nolang">lightning:allowedUrlSchemes</samp> field to
                        specify the list of allowed URL schemes.
                      </li>

                    </ul>

                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e742" data-title="Field Name">
                <span class="keyword parmname">lightning:isPII</span>
                <p class="p">(child of
                  properties.PROPERTY_NAME field)</p>
              </td>

              <td class="entry" headers="d542231e745" data-title="Description">
                <a name="dl_ml4_4yq_q2c"><!-- --></a>
                <dl class="dl detailList" id="dl_ml4_4yq_q2c">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates whether the property contains personally
                    identifiable information.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e742" data-title="Field Name">
                <span class="keyword parmname">copilotAction:isUserInput</span>
                <p class="p">(child of
                  properties.PROPERTY_NAME field)</p>
              </td>

              <td class="entry" headers="d542231e745" data-title="Description">
                <a name="dl_nl4_4yq_q2c"><!-- --></a>
                <dl class="dl detailList" id="dl_nl4_4yq_q2c">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates whether the property is presented as user
                    input.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e742" data-title="Field Name"><span class="keyword parmname">lightning:type</span></td>

              <td class="entry" headers="d542231e745" data-title="Description">
                <a name="dl_ol4_4yq_q2c"><!-- --></a>
                <dl class="dl detailList" id="dl_ol4_4yq_q2c">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. Describes the type of input. This value should
                    always be <samp class="codeph nolang">lightning__objectType</samp>.</dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## Output Folder

The output folder contains a schema.json file with the action output. Here’s a sample output schema file.

{
				"properties" : {
				"Id" : {
				"title" : "Contact Request Id",
				"description" : "ID of the Salesforce contact request record.",
				"lightning:type" : "lightning\_\_recordIdType",
				"lightning:isPII" : false,
				"copilotAction:isDisplayable" : true,
				"copilotAction:isUsedByPlanner" : true
				}
				},
				"lightning:type" : "lightning\_\_objectType"
				}

This table describes the properties that you can specify in this JSON file.

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d542231e1199">Field Name</th>

              <th class="featureTableHeader  " id="d542231e1202">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d542231e1199" data-title="Field Name"><span class="keyword parmname">properties</span></td>

              <td class="entry" headers="d542231e1202" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">object</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The parent object for all the properties associated with
                    the output.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e1199" data-title="Field Name">
                <span class="keyword parmname">{PROPERTY_NAME}</span>
                <p class="p">(child of properties
                  field)</p>
              </td>

              <td class="entry" headers="d542231e1202" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">object</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. Each property in the
                    <span class="keyword parmname">properties</span> object must contain
                    the API value corresponding to the output
                    parameter.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e1199" data-title="Field Name">
                <span class="keyword parmname">title</span>
                <p class="p">(child of properties.PROPERTY_NAME
                  field)</p>
              </td>

              <td class="entry" headers="d542231e1202" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. The label for the property.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e1199" data-title="Field Name">
                <span class="keyword parmname">description</span>
                <p class="p">(child of
                  properties.PROPERTY_NAME field)</p>
              </td>

              <td class="entry" headers="d542231e1202" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The description for the property.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e1199" data-title="Field Name">
                <span class="keyword parmname">lightning:type</span>
                <p class="p">(child of properties.PROPERTY_NAME
                  field)</p>
              </td>

              <td class="entry" headers="d542231e1202" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. Describes the type of output.</dd>

                  <dd class="dd">Some of the possible values include:
                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">lightning__booleanType</samp>—Boolean
                        type.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__dateType</samp>—Date type.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__dateTimeType</samp>—Date and time
                        type. When using this value, you must provide a
                        <samp class="codeph nolang">dateTime</samp>
                        string. This field is specified in the format
                        <samp class="codeph nolang">yyyy-MM-dd'T'HH:mm:ss.SSSZ</samp>. You can also
                        provide a <samp class="codeph nolang">timeZone</samp> string. Use the timezone
                        attribute to specify a time zone in the IANA time
                        zone database format.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__integerType</samp>—Integer type.
                        When using this value, you can also provide
                        <samp class="codeph nolang">maximum</samp> and
                        <samp class="codeph nolang">minimum</samp>
                        numbers for this property.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__listType</samp>—List type.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__multilineTextType</samp>—Multi-line
                        text type. When using this value, you can also
                        provide <samp class="codeph nolang">maxLength</samp> and <samp class="codeph nolang">minLength</samp> numbers for
                        this property.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__numberType</samp>—Number type. When
                        using this value, you can also provide <samp class="codeph nolang">maximum</samp> and <samp class="codeph nolang">minimum</samp> numbers for
                        this property.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__objectType</samp>—Object type. When
                        using this value, you must also provide a <samp class="codeph nolang">properties</samp> object
                        that contains the list of subproperties within
                        it.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__recordIdType</samp>—Record ID
                        type.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__richTextType</samp>—Rich text type.
                        When using this value, you can also provide
                        <samp class="codeph nolang">maxLength</samp> and
                        <samp class="codeph nolang">minLength</samp>
                        numbers for this property.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__textType</samp>—Text type. When
                        using this value, you can also provide <samp class="codeph nolang">maxLength</samp> and <samp class="codeph nolang">minLength</samp> numbers for
                        this property. The maximum text type length is 250
                        characters.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">lightning__urlType</samp>—URL type. When using
                        this value, you can also provide an array of
                        strings in a <samp class="codeph nolang">lightning:allowedUrlSchemes</samp> field to
                        specify the list of allowed URL schemes.
                      </li>

                    </ul>

                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e1199" data-title="Field Name">
                <span class="keyword parmname">lightning:isPII</span>
                <p class="p">(child of properties.PROPERTY_NAME
                  field)</p>
              </td>

              <td class="entry" headers="d542231e1202" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates whether the property contains personally identifiable information.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e1199" data-title="Field Name">
                <span class="keyword parmname">copilotAction:isDisplayable</span>
                <p class="p">(child of properties.PROPERTY_NAME
                  field)</p>
              </td>

              <td class="entry" headers="d542231e1202" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates whether the property is displayable as
                    output.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e1199" data-title="Field Name">
                <span class="keyword parmname">copilotAction:isUsedByPlanner</span>
                <p class="p">(child of
                  properties.PROPERTY_NAME field)</p>
              </td>

              <td class="entry" headers="d542231e1202" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates whether the property is used by the agent planner. At least one output
                    property must have this value as true or else the
                    planner returns random responses.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d542231e1199" data-title="Field Name"><span class="keyword parmname">lightning:type</span></td>

              <td class="entry" headers="d542231e1202" data-title="Description">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Field Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. Describes the type of output. This value
                    should always be <samp class="codeph nolang">lightning__objectType</samp>.</dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## Usage

In Winter '26 orgs and later, use [GenAiPlannerBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplannerbundle.htm "Represents a planner for an agent or agent template. It’s a container for all the topics and actions used to interact with a large language model (LLM).") to retrieve actions that are created within a particular agent. To retrieve actions in the asset library, use GenAiFunction.

When deploying topic or action metadata to a Summer '25 (version 64.0) org, retrieve the metadata using Metadata API version 64.0, even if your source org is Winter '26 or later (version 65.0). For Winter \`26 and later, use Metadata API version 65.0 and later.

## Declarative Metadata Sample Definition

The following is an example of a GenAiFunction component.

<?xml version="1.0" encoding="UTF-8"?>
<GenAiFunction xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>get tracking information</description\>
    <invocationTarget\>TrackShipment</invocationTarget\>
    <invocationTargetType\>apex</invocationTargetType\>
    <isConfirmationRequired\>false</isConfirmationRequired\>
    <masterLabel\>get\_tracking\_info</masterLabel\>
</GenAiFunction\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>GenAiFunction</name\>
   </types\>
   <version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=41124db60b5a6b53382f9b8af9bf9867f7dfcfb6c9dc4b0fa55c8fa62e9c8ac9 url=/legacydeveloper/current/en-us/api_meta/meta_genaiplanner.md -->

# GenAiPlanner

Represents a planner for an agent. It’s a container for all the topics and actions used to interact with a large language model (LLM).

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

GenAiPlanner components have the suffix .genAiPlanner and are stored in the genAiPlanners folder.

## Version

GenAiPlanner components are available in API version 60.0 to 63.0. GenAiPlannerBundle replaces GenAiPlanner in API version 64.0 and later.

## Special Access Rules

GenAiPlanner is available only if Agents is enabled in your org.

## Fields

| Field Name | Description |
| --- | --- |
| attributeMappings | 
Field Type

[GenAiPlannerAttrMapping](#section_GenAiPlannerAttrMapping)\[\]

Description

A list of action attribute mappings.





 |
| capabilities | 

Field Type

string

Description

A set of tags associated with the agent.





 |
| description | 

Field Type

string

Description

A description explaining the general purpose and domain of the agent.



 |
| genAiFunctions | 

Field Type

[GenAiPlannerFunctionDef](#GenAiPlannerFunctionDef)\[\]

Description

A list of agent action definitions, such as a knowledge action, that are not contained in a topic.



 |
| genAiPlannerRuleExpressions | 

Field Type

GenAiPlannerRuleExpr\[\]

Description

Deprecated. Use ruleExpressions instead.



 |
| genAiPlugins | 

Field Type

[GenAiPlannerFunctionDef](#GenAiPlannerFunctionDef)\[\]

Description

A list of agent topic definitions.



 |
| masterLabel | 

Field Type

string

Description

Required. The master label for the planner.





 |
| plannerType | 

Field Type

PlannerType (enumeration of type string)

Description

Required. A particular approach to problem solving that is given as prompt instructions to a large language model (LLM).

The only supported value is:

- AiCopilot\_\_ReAct—Uses a reactive reasoning strategy to solve problems with the LLM. This strategy consists of prompting the LLM to generate the next step in response to an event and the current context. It differs from a sequential reasoning engine in that it doesn’t plan more than one step ahead of time.





 |
| ruleExpressionAssignments | 

Field Type

[GenAiPlannerRuleExprAsgn](#section_GenAiPlannerRuleExprAsgn)\[\]

Description

A list of rule expression assignments.



 |
| ruleExpressions | 

Field Type

[GenAiPlannerRuleExprDef](#section_GenAiPlannerRuleExprDef)\[\]

Description

A list of rule expressions.



 |

## GenAiPlannerAttrMapping

Represents an attribute mapping, which enables you to map the output of one action attribute to the input of another attribute. This mapping enables you to propagate sensitive data safely without relying on untrusted user input.

| Field Name | Description |
| --- | --- |
| attributeName | 
Field Type

string

Description

Required. The attribute name in the format: Namespace.TopicName.ActionName.AttributeName.





 |
| attributeType | 

Field Type

AttributeType (enumeration of type string)

Description

Required. The attribute type. Values are:

- CustomPluginFunctionAttribute—Map to a custom action input or output
- StandardPluginFunctionInput—Map to a standard action input
- StandardPluginFunctionOutput—Map output to a variable





 |
| constantValue | 

Field Type

string

Description

Reserved for future use.





 |
| mappingTargetName | 

Field Type

string

Description

The target name for the attribute mapping.





 |
| mappingType | 

Field Type

AttributeMappingType (enumeration of type string)

Description

Required. The target type. Values are:

- ActionAttribute
- Constant
- Variable
- ContextVariable





 |

## GenAiPlannerFunctionDef

Represents an agent topic or action definition.

| Field Name | Description |
| --- | --- |
| genAiCustomizedPlugin | 
Field Type

[GenAiLocalPlugin](#section_GenAiLocalPlugin)\[\]

Description

A list of custom agent topics.





 |
| genAiFunctionName | 

Field Type

string

Description

The name of the agent action.





 |
| genAiPluginName | 

Field Type

string

Description

The name of the agent topic.





 |

## GenAiLocalPlugin

Represents a custom agent topic.

| Field Name | Description |
| --- | --- |
| aiPluginUtterances | 
Field Type

[AiPluginUtteranceDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aipluginutterancedef.htm "Represents an utterance that can be used to pick a topic during runtime.")\[\]

Description

A list of utterances that can be used to pick a topic during runtime.



 |
| description | 

Field Type

string

Description

The description of the topic.



 |
| genAiFunctions | 

Field Type

[GenAiPluginFunctionDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm#GenAiPluginFunctionDef)\[\]

Description

A list of functions in the topic.



 |
| genAiPluginInstructions | 

Field Type

[GenAiPluginInstructionDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugininstructiondef.htm "Represents a topic instruction.")\[\]

Description

A list of instructions in the topic.



 |
| language | 

Field Type

string

Description

Required.

The language of the topic.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label for the topic.



 |
| name | 

Field Type

string

Description

Required.

Represents the API name of the topic. This name must be unique across all custom and customized topics. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| pluginType | 

Field Type

PluginType (enumeration of type string)

Description

Required.

Values are:

- Topic





 |
| scope | 

Field Type

string

Description

A specific job description for a topic.



 |

## GenAiPlannerRuleExprAsgn

Represents a rule-expression assignment to either a topic or an action.

| Field Name | Description |
| --- | --- |
| ruleExpressionName | 
Field Type

string

Description

Required. The name of the rule expression.





 |
| targetName | 

Field Type

string

Description

Required. The target of the assignment, which is a Namespace.TopicName.ActionName or a TopicName.





 |
| targetType | 

Field Type

string

Description

Required. The type of the target. Values are:

- Function—A knowledge action
- Plugin—A topic
- PluginFunction—An action in a topic





 |

## GenAiPlannerRuleExprDef

Represents a rule expression, which conditionally locks or unlocks topics and actions based on defined security criteria.

| Field Name | Description |
| --- | --- |
| conditions | 
Field Type

[GenAiPlannerRuleExprCondition](#section_GenAiPlannerRuleExprCondition)\[\]

Description

A list of conditions for a rule expression.





 |
| expression | 

Field Type

string

Description

An expression with the combined conditions.





 |
| expressionLabel | 

Field Type

string

Description

Required. The expression label.



 |
| expressionName | 

Field Type

string

Description

Required. The expression name.



 |
| expressionType | 

Field Type

string

Description

The expression type. Values are:

- handlebars—Reserved for future use
- sel—Salesforce Expression Language, as used in formula fields





 |

## GenAiPlannerRuleExprCondition

Represents a condition for a rule expression.

| Field Name | Description |
| --- | --- |
| leftOperand | 
Field Type

string

Description

Required. The left operand in the expression.





 |
| leftOperandType | 

Field Type

GenAiAgentVariableType (enumeration of type string)

Description

Required. The type for the left operand. Values are:

- Variable
- ContextVariable
- Attribute





 |
| operator | 

Field Type

GenAiRuleExpressionOperator (enumeration of type string)

Description

Required. The operator in the expression. Values are:

- equal
- greaterThan
- greaterThanOrEqual
- lessThan
- lessThanOrEqual
- notEqual
- isEmpty
- isNotEmpty





 |
| rightOperandValue | 

Field Type

string

Description

The value for the right operand.



 |

## Declarative Metadata Sample Definition

The following is an example of a GenAiPlanner component.

<?xml version="1.0" encoding="UTF-8"?>
<GenAiPlanner xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Copilot reasoning engine description</description\>
    <masterLabel\>EmployeeCopilotPlanner</masterLabel\>
    <plannerType\>AiCopilot\_\_SequentialPlannerIntentClassifier</plannerType\>
</GenAiPlanner\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>GenAiPlanner</name\>
   </types\>
   <version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=46d60d95acf68997c17fac74581e4276b39baf11abbd7137bdd3925801f751d4 url=/legacydeveloper/current/en-us/api_meta/meta_genaiplannerbundle.md -->

# GenAiPlannerBundle

Represents a planner for an agent or agent template. It’s a container for all the topics and actions used to interact with a large language model (LLM).

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

GenAiPlannerBundle components have the suffix .genAiPlannerBundle and are stored in a subfolder for the agent in the genAiPlannerBundles folder.

## Version

GenAiPlannerBundle components are available in API version 64.0 and later. GenAiPlannerBundle replaces GenAiPlanner, which is available in API version 63.0 and earlier.

## Special Access Rules

GenAiPlannerBundle is available only if Agents is enabled in your org.

## Fields

| Field Name | Description |
| --- | --- |
| attributeMappings | 
Field Type

[GenAiPlannerAttrMapping](#section_GenAiPlannerAttrMapping)\[\]

Description

A list of action attribute mappings.





 |
| botTemplate | 

Field Type

string

Description

If this planner is used by an agent template instead of an agent, this field is the template associated with the planner.



 |
| capabilities | 

Field Type

string

Description

A set of tags associated with the agent.





 |
| description | 

Field Type

string

Description

A description explaining the general purpose and domain of the agent.



 |
| genAiFunctions | 

Field Type

[GenAiPlannerFunctionDef](#GenAiPlannerFunctionDef)\[\]

Description

A list of agent action definitions, such as a knowledge action, that are not contained in a topic.



 |
| genAiPlugins | 

Field Type

[GenAiPlannerFunctionDef](#GenAiPlannerFunctionDef)\[\]

Description

A list of agent topic definitions.



 |
| masterLabel | 

Field Type

string

Description

Required. The master label for the planner.





 |
| plannerType | 

Field Type

PlannerType (enumeration of type string)

Description

Required. A particular approach to problem solving that is given as prompt instructions to a large language model (LLM).

The supported values are:

- AiCopilot\_\_AgileAppDev—Uses an iterative development strategy to assist with building applications using the LLM. This strategy prompts the LLM to generate modular, testable components based on evolving user input and context. Unlike linear workflows, it supports continuous refinement and feedback loops throughout the development process.
- AiCopilot\_\_ReAct—Uses a reactive reasoning strategy to solve problems with the LLM. This strategy consists of prompting the LLM to generate the next step in response to an event and the current context. It differs from a sequential reasoning engine in that it doesn’t plan more than one step ahead of time.
- Atlas\_\_ConcurrentMultiAgentOrchestration—Uses a unified orchestration strategy to solve problems with the LLM across text and voice agent interactions. This strategy prompts the LLM to plan and execute multiple steps concurrently, coordinating across sub-agents and tools. Unlike single-step reactive strategies, it supports parallel tool calling and multi-agent coordination within a single interaction.





 |
| ruleExpressionAssignments | 

Field Type

[GenAiPlannerRuleExprAsgn](#section_GenAiPlannerRuleExprAsgn)\[\]

Description

A list of rule expression assignments.



 |
| ruleExpressions | 

Field Type

[GenAiPlannerRuleExprDef](#section_GenAiPlannerRuleExprDef)\[\]

Description

A list of rule expressions.



 |

## GenAiPlannerAttrMapping

Represents an attribute mapping, which enables you to map the output of one action attribute to the input of another attribute. This mapping enables you to propagate sensitive data safely without relying on untrusted user input.

| Field Name | Description |
| --- | --- |
| attributeName | 
Field Type

string

Description

Required. The attribute name in the format: Namespace.TopicName.ActionName.AttributeName.





 |
| attributeType | 

Field Type

AttributeType (enumeration of type string)

Description

Required. The attribute type. Values are:

- CustomPluginFunctionAttribute—Map to a custom action input or output
- StandardPluginFunctionInput—Map to a standard action input
- StandardPluginFunctionOutput—Map output to a variable





 |
| constantValue | 

Field Type

string

Description

Reserved for future use.





 |
| mappingTargetName | 

Field Type

string

Description

The target name for the attribute mapping.





 |
| mappingType | 

Field Type

AttributeMappingType (enumeration of type string)

Description

Required. The target type. Values are:

- ActionAttribute
- Constant
- Variable
- ContextVariable





 |

## GenAiPlannerFunctionDef

Represents an agent topic or action definition.

| Field Name | Description |
| --- | --- |
| genAiCustomizedPlugin | 
Field Type

[GenAiLocalPlugin](#section_GenAiLocalPlugin)\[\]

Description

A list of custom agent topics.





 |
| genAiFunctionName | 

Field Type

string

Description

The name of the agent action.





 |
| genAiPluginName | 

Field Type

string

Description

The name of the agent topic.





 |

## GenAiLocalPlugin

Represents a custom agent topic.

| Field Name | Description |
| --- | --- |
| aiPluginUtterances | 
Field Type

[AiPluginUtteranceDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aipluginutterancedef.htm "Represents an utterance that can be used to pick a topic during runtime.")\[\]

Description

A list of utterances that can be used to pick a topic during runtime.



 |
| canEscalate | 

Field Type

boolean

Description

Determines whether this topic is applicable for escalation to a rep.



 |
| description | 

Field Type

string

Description

Required.

The description of the topic.



 |
| genAiFunctions | 

Field Type

[GenAiPluginFunctionDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm#GenAiPluginFunctionDef)\[\]

Description

A list of functions in the topic.



 |
| genAiPluginInstructions | 

Field Type

[GenAiPluginInstructionDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugininstructiondef.htm "Represents a topic instruction.")\[\]

Description

A list of instructions in the topic.



 |
| language | 

Field Type

string

Description

Required.

The language of the topic.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label for the topic.



 |
| name | 

Field Type

string

Description

Required.

Represents the API name of the topic. This name must be unique across all custom and customized topics. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| pluginType | 

Field Type

PluginType (enumeration of type string)

Description

Required.

Values are:

- Topic
- APICustomTopic





 |
| scope | 

Field Type

string

Description

A specific job description for a topic.



 |

## GenAiPlannerRuleExprAsgn

Represents a rule-expression assignment to either a topic or an action.

| Field Name | Description |
| --- | --- |
| ruleExpressionName | 
Field Type

string

Description

Required. The name of the rule expression.





 |
| targetName | 

Field Type

string

Description

Required. The target of the assignment, which is a Namespace.TopicName.ActionName or a TopicName.





 |
| targetType | 

Field Type

string

Description

Required. The type of the target. Values are:

- Function—A knowledge action
- Plugin—A topic
- PluginFunction—An action in a topic





 |

## GenAiPlannerRuleExprDef

Represents a rule expression, which conditionally locks or unlocks topics and actions based on defined security criteria.

| Field Name | Description |
| --- | --- |
| conditions | 
Field Type

[GenAiPlannerRuleExprCondition](#section_GenAiPlannerRuleExprCondition)\[\]

Description

A list of conditions for a rule expression.





 |
| expression | 

Field Type

string

Description

An expression with the combined conditions.





 |
| expressionLabel | 

Field Type

string

Description

Required. The expression label.



 |
| expressionName | 

Field Type

string

Description

Required. The expression name.



 |
| expressionType | 

Field Type

string

Description

The expression type. Values are:

- handlebars—Reserved for future use
- sel—Salesforce Expression Language, as used in formula fields





 |

## GenAiPlannerRuleExprCondition

Represents a condition for a rule expression.

| Field Name | Description |
| --- | --- |
| leftOperand | 
Field Type

string

Description

Required. The left operand in the expression.





 |
| leftOperandType | 

Field Type

GenAiAgentVariableType (enumeration of type string)

Description

Required. The type for the left operand. Values are:

- Variable
- ContextVariable
- Attribute





 |
| operator | 

Field Type

GenAiRuleExpressionOperator (enumeration of type string)

Description

Required. The operator in the expression. Values are:

- equal
- greaterThan
- greaterThanOrEqual
- lessThan
- lessThanOrEqual
- notEqual
- isEmpty
- isNotEmpty





 |
| rightOperandValue | 

Field Type

string

Description

The value for the right operand.



 |

## Usage

In Winter ‘26 orgs and later, use GenAiPlannerBundle to retrieve topics and actions created in an agent. To retrieve global topics and actions, or those created in the Asset Library, use [GenAiPlugin](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm "Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents.") and [GenAiFunction](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaifunction.htm "Represents an agent action that can be added to an AI agent.").

In Summer ‘25 orgs and earlier, deploy topic and action metadata using [GenAiPlugin](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm "Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents.") and [GenAiFunction](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaifunction.htm "Represents an agent action that can be added to an AI agent.").

When deploying topic or action metadata to a Summer '25 (version 64.0) org, retrieve the metadata using Metadata API version 64.0, even if your source org is Winter '26 or later (version 65.0). For Winter \`26 and later, use Metadata API version 65.0 and later.

## Declarative Metadata Sample Definition

Here’s an example of a GenAiPlannerBundle component.

<?xml version="1.0" encoding="UTF-8"?>
<GenAiPlannerBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <attributeMappings\>
        attributeName>SvcCopilotTmpl\_\_CaseManagement.SvcCopilotTmpl\_\_CreateCaseEnhancedData.verifiedCustomerID</attributeName\>
        <attributeType\>StandardPluginFunctionInput</attributeType\>
        <mappingTargetName\>VerifiedCustomerId</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_CaseManagement.SvcCopilotTmpl\_\_GetCasesForVerifiedContact.verifiedContactID</attributeName\>
        <attributeType\>StandardPluginFunctionInput</attributeType\>
        <mappingTargetName\>VerifiedCustomerId</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_CaseManagement.SvcCopilotTmpl\_\_GetCaseByVerifiedCaseNumber.verifiedContactID</attributeName\>
        <attributeType\>StandardPluginFunctionInput</attributeType\>
        <mappingTargetName\>VerifiedCustomerId</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_SendEmailVerificationCode.authenticationKey</attributeName\>
        <attributeType\>StandardPluginFunctionOutput</attributeType\>
        <mappingTargetName\>authenticationKey</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_SendEmailVerificationCode.customerId</attributeName\>
        <attributeType\>StandardPluginFunctionOutput</attributeType\>
        <mappingTargetName\>customerId</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_SendEmailVerificationCode.customerType</attributeName\>
        <attributeType\>StandardPluginFunctionOutput</attributeType\>
        <mappingTargetName\>customerType</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.authenticationKey</attributeName\>
        <attributeType\>StandardPluginFunctionInput</attributeType\>
        <mappingTargetName\>authenticationKey</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.customerId</attributeName\>
        <attributeType\>StandardPluginFunctionInput</attributeType\>
        <mappingTargetName\>customerId</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.customerType</attributeName\>
        <attributeType\>StandardPluginFunctionInput</attributeType\>
        <mappingTargetName\>customerType</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.isVerified</attributeName\>
        <attributeType\>StandardPluginFunctionOutput</attributeType\>
        <mappingTargetName\>isVerified</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.customerId</attributeName\>
        <attributeType\>StandardPluginFunctionOutput</attributeType\>
        <mappingTargetName\>VerifiedCustomerId</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_AccountManagement.SvcCopilotTmpl\_\_ResetSecurePassword.verifiedContactID</attributeName\>
        <attributeType\>StandardPluginFunctionInput</attributeType\>
        <mappingTargetName\>VerifiedCustomerId</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <attributeMappings\>
        <attributeName\>SvcCopilotTmpl\_\_AccountManagement.SvcCopilotTmpl\_\_UpdateVerifiedContact.verifiedContactID</attributeName\>
        <attributeType\>StandardPluginFunctionInput</attributeType\>
        <mappingTargetName\>VerifiedCustomerId</mappingTargetName\>
        <mappingType\>Variable</mappingType\>
    </attributeMappings\>
    <description\>Deliver personalized customer interactions with an autonomous AI agent. Agentforce Service Agent intelligently supports your customers with common inquiries and escalates complex issues.</description\>
    <genAiFunctions\>
        <genAiFunctionName\>EmployeeCopilot\_\_AnswerQuestionsWithKnowledge</genAiFunctionName\>
    </genAiFunctions\>
    <genAiPlugins\>
        <genAiPluginName\>SvcCopilotTmpl\_\_AccountManagement</genAiPluginName\>
    </genAiPlugins\>
    <genAiPlugins\>
        <genAiPluginName\>SvcCopilotTmpl\_\_CaseManagement</genAiPluginName\>
    </genAiPlugins\>
    <genAiPlugins\>
        <genAiPluginName\>SvcCopilotTmpl\_\_Escalation</genAiPluginName\>
    </genAiPlugins\>
    <genAiPlugins\>
        <genAiPluginName\>SvcCopilotTmpl\_\_GeneralFAQ</genAiPluginName\>
    </genAiPlugins\>
    <genAiPlugins\>
        <genAiPluginName\>SvcCopilotTmpl\_\_ServiceCustomerVerification</genAiPluginName\>
    </genAiPlugins\>
    <masterLabel\>ASA Template Base</masterLabel\>
    <plannerType\>AiCopilot\_\_ReAct</plannerType\>
    <ruleExpressionAssignments\>
        <ruleExpressionName\>Verified\_User</ruleExpressionName\>
        <targetName\>SvcCopilotTmpl\_\_AccountManagement</targetName\>
        <targetType\>Plugin</targetType\>
    </ruleExpressionAssignments\>
    <ruleExpressionAssignments\>
        <ruleExpressionName\>Verified\_User</ruleExpressionName\>
        <targetName\>SvcCopilotTmpl\_\_CaseManagement</targetName\>
        <targetType\>Plugin</targetType\>
    </ruleExpressionAssignments\>
    <ruleExpressions\>
        <conditions\>
            <leftOperand\>isVerified</leftOperand\>
            <leftOperandType\>Variable</leftOperandType\>
            <operator\>equal</operator\>
            <rightOperandValue\>true</rightOperandValue\>
        </conditions\>
        <expression\>Verified\_User</expression\>
        <expressionLabel\>Verified User</expressionLabel\>
        <expressionName\>Verified\_User</expressionName\>
        <expressionType\>sel</expressionType\>
    </ruleExpressions\>
</GenAiPlannerBundle\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>GenAiPlannerBundle</name\>
   </types\>
   <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=47491746ef599c6c8fef07e12f147d57be660a11aa692e0411571318fd9d9366 url=/legacydeveloper/current/en-us/api_meta/meta_genaiplugin.md -->

# GenAiPlugin

Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

GenAiPlugin components have the suffix .genAiPlugin and are stored in the genAiPlugins folder.

## Version

GenAiPlugin components are available in API version 62.0 and later.

## Special Access Rules

GenAiPlugin is available only if Agents is enabled in your org.

## Fields

| Field Name | Description |
| --- | --- |
| aiPluginUtterances | 
Field Type

[AiPluginUtteranceDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aipluginutterancedef.htm "Represents an utterance that can be used to pick a topic during runtime.")\[\]

Description

A list of utterances that can be used to pick a topic during runtime.



 |
| canEscalate | 

Field Type

boolean

Description

Indicates whether this topic is eligible for escalation to a rep.



 |
| description | 

Field Type

string

Description

The description of the topic.



 |
| developerName | 

Field Type

string

Description

Required.

Represents the API name of the topic. This name must be unique across all custom and customized topics. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| genAiFunctions | 

Field Type

[GenAiPluginFunctionDef](#GenAiPluginFunctionDef)\[\]

Description

A list of functions in the topic.



 |
| genAiPluginInstructions | 

Field Type

[GenAiPluginInstructionDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugininstructiondef.htm "Represents a topic instruction.")\[\]

Description

A list of instructions in the topic.



 |
| language | 

Field Type

string

Description

Required.

The language of the topic.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label for the topic.



 |
| plannerField | 

Field Type

string

Description

Represents the topic’s parent planner.



 |
| pluginType | 

Field Type

PluginType (enumeration of type string)

Description

Required.

Values are:

- Topic
- APICustomTopic





 |
| scope | 

Field Type

string

Description

A specific job description for a topic.



 |

## GenAiPluginFunctionDef

A function in the topic.

| Field Name | Description |
| --- | --- |
| functionName | 
Field Type

string

Description

Required.

The API name of the function.



 |

## Usage

In Winter '26 orgs and later, use [GenAiPlannerBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplannerbundle.htm "Represents a planner for an agent or agent template. It’s a container for all the topics and actions used to interact with a large language model (LLM).") to retrieve topics that are created within a particular agent. To retrieve topics in the asset library, use GenAiPlugin.

When deploying topic or action metadata to a Summer '25 (version 64.0) org, retrieve the metadata using Metadata API version 64.0, even if your source org is Winter '26 or later (version 65.0). For Winter \`26 and later, use Metadata API version 65.0 and later.

## Declarative Metadata Sample Definition

The following is an example of a GenAiPlugin component.

<GenAiPlugin xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <description\>Engages and interacts with the user about any request that could be CRM data related.
      This could be tasks such as identify and summarize records, answer queries, aggregate data,
      find and query objects, update records, or drafting and refining emails.</description\>
    <developerName\>General\_CRM\_Customized</developerName\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_IdentifyObjectByName</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_IdentifyRecordByName</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_QueryRecords</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_QueryRecordsWithAggregate</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_GetActivitiesTimeline</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_GetActivityDetails</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_GetRecordDetails</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_DraftOrReviseEmail</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_UpdateRecordFields</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_WebSearch</functionName\>
    </genAiFunctions\>
    <genAiFunctions\>
        <functionName\>EmployeeCopilot\_\_AnswerQuestionsWithKnowledge</functionName\>
    </genAiFunctions\>
    <genAiPluginInstructions\>
        <description\>There are multiple available data retrieval functions at your disposal.
          You can use each one of them multiple times if needed. You should use functions
          as many times as necessary until you have all the data required to fulfill the request of the user.
          You can perform extra calls if you think you can get additional relevant information.</description\>
        <developerName\>therearemu0</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>therearemu</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>Do not declare your intent i.e. &quot;I will now retrieve the data&quot; - Just fetch the data.</description\>
        <developerName\>donotdecla1</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>donotdecla</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>Identify the object type (i.e., leads, opportunities, accounts) the user asks about.
           If unclear, confirm with the user and make a suggestion based on the query context and history.</description\>
        <developerName\>identifyth2</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>identifyth</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>When only the name of a record is mentioned in the user request, you MUST call the IdentifyRecordByName action
          to get the necessary IDs.</description\>
        <developerName\>whenonlyth3</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>whenonlyth</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>Always call QueryRecords &amp; QueryRecordsWithAggregate passing plain natural language english as input.
          You must Include the record ID in the input if available.</description\>
        <developerName\>alwayscall4</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>alwayscall</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>For accounts and contacts, combine the WebSearch action with the CRM data retrieval actions.
           MUST maintain citations in the answer.</description\>
        <developerName\>foraccount5</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>foraccount</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>When a user asks for a summary or overview of a record, use GetRecordDetails to get an overview
          of the data of the record, then use other data retrieval actions as needed.</description\>
        <developerName\>whenausera6</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>whenausera</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>When asked for a summary on multiple records, you must iterate over all record IDs and for each one,
          call GetRecordDetails.</description\>
        <developerName\>whenaskedf7</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>whenaskedf</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>If the user asks about activities you must call GetActivitiesTimeline.</description\>
        <developerName\>iftheusera8</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>iftheusera</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>When providing the Activity Types for GetActivitiesTimeline, choose all the types that are relevant
           to the user request. Examples - User Request 1 - &quot;What questions does John Doe have that need addressing?&quot;,
           Activity Types - &quot;Call&quot;, &quot;Email&quot;.
           User Request 2 - &quot;What are the next activities for John Doe?&quot;, Activity Types - &quot;Task&quot;, &quot;Event&quot;.</description\>
        <developerName\>whenprovid9</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>whenprovid</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>When asked about recent activities, you should provide the answer, starting from the last 30 days
          and ending on the current date, unless a specific date range is specified by the user.</description\>
        <developerName\>whenaskeda10</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>whenaskeda</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>When you are asked about a single Call, Meeting, Email or any other single specific activity, call GetActivityDetails.</description\>
        <developerName\>whenyouare11</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>whenyouare</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>Always use DraftOrReviseEmail when asked to generate a new email or revise a previously generated email.</description\>
        <developerName\>alwaysused12</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>alwaysused</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>ExtractRecordFieldsAndValuesFromUserInput must be called prior to UpdateRecordFields.</description\>
        <developerName\>extractrec13</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>extractrec</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>Avoid using structured lists, bullet points, or numbered lists. Instead, present the information in complete sentences
          and paragraphs as if you were writing an article or a report.</description\>
        <developerName\>avoidusing14</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>avoidusing</masterLabel\>
    </genAiPluginInstructions\>
    <genAiPluginInstructions\>
        <description\>User questions which can be answered by knowledge articles or documents. These questions usually want information,
          instructions or guidance, including but not limited to customer questions about company information, policies and frequently asked questions.</description\>
        <developerName\>userquesti15</developerName\>
        <language xsi:nil="true"/>
        <masterLabel\>userquesti</masterLabel\>
    </genAiPluginInstructions\>
    <language\>en\_US</language\>
    <masterLabel\>General CRM Customized</masterLabel\>
    <pluginType\>Topic</pluginType\>
    <scope\>Your job is to interact and answer questions for the user about anything Salesforce or CRM data related,
      combining all data retrieval functions. i.e: QueryRecords(), GetRecordDetails(), GetActivitiesTimeline(), GetActivityDetails(), WebSearch()</scope\>
</GenAiPlugin\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>GenAiPlugin</name\>
   </types\>
   <version\>62.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=cd9b228b5433f48b228f03bbb9c0ce4222a3b8182e74f038154250ddb9525236 url=/legacydeveloper/current/en-us/api_meta/meta_genaiplugininstructiondef.md -->

# GenAiPluginInstructionDef

Represents a topic instruction.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

GenAiPluginInstructionDef components are part of a GenAiPlugin component and aren't used separately.

## Version

GenAiPluginInstructionDef components are available in API version 62.0 and later.

## Special Access Rules

GenAiPluginInstructionDef is available only if Agents is enabled in your org.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Required.

Description of the topic instruction.



 |
| developerName | 

Field Type

string

Description

Required.

Represents the API name of the topic instruction. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| language | 

Field Type

string

Description

Required.

The language of the topic instruction.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label for the topic instruction.



 |
| sortOrder | 

Field Type

integer

Description

A numerical value used to determine the order the instructions will be executed in.



 |

## Declarative Metadata Sample Definition

See [GenAiPlugin](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm "Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents.").

<!-- document id=7d3041f43da1ec2504191f20c1ec48b1a19620f31418ccfee1e0c1c5c2b16daa url=/legacydeveloper/current/en-us/api_meta/meta_genaiprompttemplate.md -->

# GenAiPromptTemplate

Represents the definition of a prompt template, including its related objects and fields.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

GenAiPromptTemplate components have the suffix .genAiPromptTemplate and are stored in the genAiPromptTemplates folder.

## Version

GenAiPromptTemplate components are available in API version 60.0 and later.

## Special Access Rules

GenAiPromptTemplate is available only if Prompt Builder is enabled in your org and you have the Prompt Template Manager permission.

## Fields

| Field Name | Description |
| --- | --- |
| activeVersion | 
Field Type

int

Description

This tag will be deprecated in 63.0 and will not work in 64.0 and later. Use activeVersionIdentifier instead.



 |
| activeVersionIdentifier | 

Field Type

string

Description

Specifies the version identifier of the active prompt template version. This tag will use versionIdentifier as the value for the active version.



 |
| description | 

Field Type

string

Description

A description of the prompt template.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for GenAiPromptTemplate, which is defined when the GenAiPromptTemplate is created.



 |
| overridable | 

Field Type

boolean

Description

Indicates whether the prompt template can be overridden when part of a managed package.



 |
| relatedEntity | 

Field Type

string

Description

The Salesforce record type that the prompt template is associated with.



 |
| relatedField | 

Field Type

string

Description

The Salesforce field that the prompt template is associated with.



 |
| templateVersions | 

Field Type

[GenAiPromptTemplateVersion](#genaiprompttemplateversion)\[\]

Description

Required. An array of prompt template versions.



 |
| type | 

Field Type

string

Description

Required. Represents the template type that the prompt template is based on. Valid values are:

- einstein\_gpt\_\_fieldCompletion
- einstein\_gpt\_\_salesEmail
- einstein\_gpt\_\_recordSummary
- einstein\_gpt\_\_flex
- einstein\_gpt\_\_caseEmailDraft





 |
| visibility | 

Field Type

GenAiPromptTemplateVisibilityType ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)

Description

Indicates the scope of visibility for the prompt template. Valid values are:

- API
- Global





 |

## GenAiPromptTemplateVersion

Represents a version of a prompt template.

| Field Name | Description |
| --- | --- |
| content | 
Field Type

string

Description

Required. Text of the prompt template version.



 |
| description | 

Field Type

string

Description

Description of the prompt template version.



 |
| fileDroppingStrategy | 

Field Type

string

Description

Defines the strategy for managing attached files when context limits are exceeded.



 |
| generationTemplateConfigs | 

Field Type

[GenAiPromptTemplateGenerationConfig](#GenAiPromptTemplateGenerationConfig)\[\]

Description

Reference to the policies for the prompt template version.



 |
| inputs | 

Field Type

[GenAiPromptTemplateInput](#genaiprompttemplateinput)\[\]

Description

An array of prompt template inputs associated with the prompt template version.



 |
| isCitationEnabled | 

Field Type

boolean

Description

Indicates whether citations are included in generated responses.



 |
| outputSchema | 

Field Type

string

Description

Defines the expected JSON schema structure for the generated output.



 |
| primaryModel | 

Field Type

string

Description

The model associated with the prompt template version.



 |
| responseFormat | 

Field Type

GenAiPromptTemplateResponseFormat ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm) of type string)

Description

Defines the response format. Values are:

- HTML
- JSON
- MarkDown





 |
| status | 

Field Type

GenAiPromptTemplateStatus ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm) of type string)

Description

Required. Indicates the status of the prompt template in Prompt Builder. Valid values are:

- Published—Published version of a prompt template. The active version of the prompt template must be published.
    
    Published prompt templates can't be edited with UI or Metadata API.
- Draft—Draft version of a prompt template.





 |
| templateDataProviders | 

Field Type

[GenAiPromptTemplateDataProvider](#genaiprompttemplatedataprovider)\[\]

Description

An array of prompt template data providers associated with the prompt template version.



 |
| versionNumber | 

Field Type

int

Description

Required. Version number of the prompt template version. Versions are counted sequentially from 1.

This tag will be deprecated in 63.0 and will not work in 64.0 and later. Use versionIdentifier instead.





 |
| versionIdentifier | 

Field Type

string

Description

Version identifier of the prompt template version identifier. This is generated automatically once a template is deployed and retrieved from an org.

If a unique value is not specified then it will be generated for you. It must be unique for each version for a given template.





 |

## GenAiPromptTemplateGenerationConfig

References the policies for this prompt template version. A policy describes high-level behavior for the prompt template, such as the allowed languages, conversation style, or desired response length. Currently, a policy is defined in a configuration file.

| Field Name | Description |
| --- | --- |
| generationConfigDeveloperName | 
Field Type

string

Description

Developer name of the policy for this prompt template version.



 |

## GenAiPromptTemplateInput

Represents an input for a prompt template, such as a Salesforce record, field, or Apex primitive data type.

| Field Name | Description |
| --- | --- |
| apiName | 
Field Type

string

Description

Required. Name of the prompt template input parameter.



 |
| definition | 

Field Type

string

Description

Required. The URI definition of the input parameter. For example,  SOBJECT://Account and SOBJECT://Account/Description.



 |
| description | 

Field Type

string

Description

Description of the prompt template input parameter.



 |
| masterLabel | 

Field Type

string

Description

A user-friendly name for GenAiPromptTemplateInput, which is defined when the GenAiPromptTemplateInput is created.



 |
| referenceName | 

Field Type

string

Description

Required. Name of the prompt template input to use in expressions. For example, Input:Recipient and Input:Sender</referenceName>.



 |
| required | 

Field Type

boolean

Description

Required. Specifies whether this input parameter is required (true) or optional (false).



 |

## GenAiPromptTemplateDataProvider

Represents a source of data for a prompt template version, such as an invocable action, flow, or Apex method.

| Field Name | Description |
| --- | --- |
| definition | 
Field Type

string

Description

Required. The URI definition of the data provider, such as flow://ns\_\_CallToActionFlow.



 |
| description | 

Field Type

string

Description

Description of the data provider.



 |
| label | 

Field Type

string

Description

Required. A user-friendly name for GenAiPromptTemplateDataProvider, which is defined when the GenAiPromptTemplateDataProvider is created.



 |
| parameters | 

Field Type

[GenAiPromptTemplateDataProviderParam](#genaiprompttemplatedataproviderparam)\[\]

Description

An array of parameters associated with the data provider.



 |
| referenceName | 

Field Type

string

Description

Required. Name of the data provider to use in expressions.



 |

## GenAiPromptTemplateDataProviderParam

Represents a parameter that a data provider uses to retrieve information.

| Field Name | Description |
| --- | --- |
| definition | 
Field Type

string

Description

Required. URI definition of the parameter. For example,  SOBJECT://User</definition>.



 |
| isRequired | 

Field Type

boolean

Description

Required. Specifies whether the parameter is required (true) or optional (false).



 |
| parameterName | 

Field Type

string

Description

Required. Name of the parameter.



 |
| valueExpression | 

Field Type

string

Description

Value or expression of the parameter to use in prompt template text. For example, {!$Input:Recipient}.



 |

## Declarative Metadata Sample Definition

The following is an example of a GenAiPromptTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<GenAiPromptTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <activeVersionIdentifier>a94ACO8feseESrBtllQUNLvKEqlCHiPSDLX5rXUnvPs=\_1</activeVersionIdentifier\>
    <description\>Recommend relevant financial products to client based on their needs and goals</description\>
    <masterLabel\>Recommend Relevant Products</masterLabel\>
    <relatedEntity\>Contact</relatedEntity\>
    <templateVersions\>
        <content\>You are a financial advisor at {!$Input:Sender.CompanyName} and your name is {!$Input:Sender.Name}. You are writing an email to a prospective client recommending relevant financial products based on their data and goals. Reference the data below to generate your email, recommending only relevant products for the customer that match our recommendation criteria for each product.
Client name: {!$Input:Recipient.Name}
Client age: {!$Input:Recipient.Age\_\_c}
Client occupation: {!$Input:Recipient.Occupation\_\_c}
Client income: {!$Input:Recipient.Income\_\_c}
Client financial goals: {!$Input:Recipient.Financial\_Goals\_\_c}

{!$Flow:Fetch\_Products.Prompt}

Generate a subject line that can increase the open rate using words and content that is related to the email body content. It must be no more than 10 words.
Start the opening message of the email with an ice-breaker talking about relevant challenges or opportunities with personal finance and how you can help.
Indirectly allude to a point of common interest, shared background, or relevant experience with {!$Input:Recipient.Name}. You aim to subtly reference or highlight this connection to establish rapport, demonstrate relevance, and foster a sense of familiarity.
Indirectly encourage the lead {!$Input:Recipient.Name} to respond to your email by showing that you are willing to discuss opportunities for working together and answer any questions they may have.
Be concise in your email.</content\>
        <inputs\>
            <apiName\>Sender</apiName\>
            <definition\>SOBJECT://User</definition\>
            <referenceName\>Input:Sender</referenceName\>
            <required\>true</required\>
        </inputs\>
        <inputs\>
            <apiName\>Recipient</apiName\>
            <definition\>SOBJECT://Contact</definition\>
            <referenceName\>Input:Recipient</referenceName\>
            <required\>true</required\>
        </inputs\>
        <primaryModel\>sfdc\_ai\_\_DefaultOpenAIGPT4</primaryModel\>
        <status\>Published</status\>
        <templateDataProviders\>
            <definition\>flow://Fetch\_Products</definition\>
            <parameters\>
                <definition\>SOBJECT://User</definition\>
                <isRequired\>true</isRequired\>
                <parameterName\>Sender</parameterName\>
                <valueExpression\>{!$Input:Sender}</valueExpression\>
            </parameters\>
            <parameters\>
                <definition\>SOBJECT://Contact</definition\>
                <isRequired\>true</isRequired\>
                <parameterName\>Recipient</parameterName\>
                <valueExpression\>{!$Input:Recipient}</valueExpression\>
            </parameters\>
            <referenceName\>Flow:Fetch\_Products</referenceName\>
        </templateDataProviders\>
        <versionIdentifier>a94ACO8feseESrBtllQUNLvKEqlCHiPSDLX5rXUnvPs=\_1
</versionIdentifier\>
    </templateVersions\>
    <type\>einstein\_gpt\_\_salesEmail</type\>
    <visibility\>Global</visibility\>
</GenAiPromptTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>GenAiPromptTemplate</name>
    </types>
    <version>60.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=dd23493bfa7cb6cb5b486240224c73257a54d0997db7f05920e570bb729f9730 url=/legacydeveloper/current/en-us/api_meta/meta_genaiprompttemplateactv.md -->

# GenAiPromptTemplateActv

Represents the activation status of a Salesforce-provided prompt template.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

GenAiPromptTemplateActv components have the suffix .genAiPromptTemplateActivation and are stored in the genAiPromptTemplateActivations folder.

## Version

GenAiPromptTemplateActv components are available in API version 60.0 and later.

## Special Access Rules

GenAiPromptTemplate is available only if Prompt Builder is enabled in your org and you have the Prompt Template Manager permission.

## Fields

| Field Name | Description |
| --- | --- |
| accessLevel | 
Field Type

GenAiPromptTemplateActvAccessLevel ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm) of type string)

Description

Indicates which users can access the Salesforce-provided prompt template. Valid values are:

- Allowed—Users with access to Prompt Builder can see the prompt template.
- Blocked—Only admin users with access to Prompt Builder can see the prompt template.





 |
| developerName | 

Field Type

string

Description

Name of the activation record. This name can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| masterLabel | 

Field Type

string

Description

A user-friendly name for GenAiPromptTemplateActv, which is defined when the GenAiPromptTemplateActv is created.



 |
| templateDeveloperName | 

Field Type

string

Description

Name of the Salesforce-provided prompt template that the activation record is associated with.



 |

## Declarative Metadata Sample Definition

The following is an example of a GenAiPromptTemplateActv component.

<?xml version="1.0" encoding="UTF-8"?>
<GenAiPromptTemplateActv xmlns="http://soap.sforce.com/2006/04/metadata">
    <MasterLabel\> Activation Record for Prompt Template </MasterLabel\>
    <PromptTemplateDeveloperName\>einstein\_gpt\_\_introductionLeadEmail
    </PromptTemplateDeveloperName\>
    <DeveloperName\>HideIntroductionLeadEmail</DeveloperName\>
    <Description\>Status of template </Description\>
    <AccessLevel\>BLOCKED</AccessLevel\>
</GenAiPromptTemplateActv\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <name>GenAiPromptTemplateActv</name>
        <members>HideIntroductionLeadEmail.genAiPromptTemplateActivation</members>
    </types>
    <version>60.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=97bce09f8bf4db0af8ca08269b41a73cb4436f36fc4d5522e96d0181745df891 url=/legacydeveloper/current/en-us/api_meta/meta_giftentrygridtemplate.md -->

# GiftEntryGridTemplate

Represents templates that customize the gift entry grid in Fundraising.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

GiftEntryGridTemplate components have the suffix .giftEntryGridTempate and are stored in the giftEntryGridTemplate folder.

## Version

GiftEntryGridTemplate components are available in API version 66.0 and later.

## Special Access Rules

This object is available only if the Fundraising Access license is enabled, the Fundraising User system permission is assigned to users, and the Gift Entry Grid is enabled.

## Fields

| Field Name | Description |
| --- | --- |
| Description | 
Type

textarea

Properties

Create, Nillable, Update

Description

The description of the gift entry grid template.



 |
| IsSingleGiftDefault | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether the template is the default template for single gift entry (true) or not (false, the default).



 |
| TemplateConfiguration | 

Type

string

Properties

Create, Filter, Group, Sort, Update

Description

The template configuration that includes the data for fields, columns, and components.



 |

## Declarative Metadata Sample Definition

The following is an example of a GiftEntryGridTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<GiftEntryGridTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Demo of Default Template</description\>
    <developerName\>Demo\_of\_Default\_Template</developerName\>
    <isSingleGiftDefault\>false</isSingleGiftDefault\>
    <masterLabel\>Demo of Default Template</masterLabel\>
    <templateConfiguration\>templateName: Demo of Default Template
apiVersion: 66.0
columns:
 -
  columnId: Donor
  columnType: Component
  columnField:
    sourceField: DonorId
    isFieldRequired: true
    isFieldHidden: false
  columnComponent:
    componentNameDisplay: runtime\_industries\_frops/giftEntryGridColumnDisplay
    componentNameEdit: runtime\_industries\_frops/giftEntryGridLookup
  columnModal:
    modalTitleLabel: $Label.GiftEntryGrid.AddDonorDetailsModalTitle
    modalComponent:
      componentName: runtime\_industries\_frops/giftEntryGridFieldsModal
    modalIcon:
      expandIcon: utility:expand\_alt
      expandIconAltText: $Label.GiftEntryGrid.DonorExpandIconAltText
      lockIcon: utility:lock
      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
      noIconAltText: &quot;&quot;
    isModalReadOnly: false
    modalAltTitleLabel: $Label.GiftEntryGrid.EditDonorDetailsModalTitle
    modalAltTitleLabelVisibilityRule:
     -
      field: DonorId
      values:
       - null
      operator: NOT\_EQUALS
      multipleRulesEvaluationOperator: AND
    modalFields:
     -
      sourceField: GiftType
      fieldLabel: $Label.GiftEntryGrid.DonorType
      isFieldRequired: true
      isFieldHidden: false
      defaultValue: Individual
      fieldReadOnlyRule:
       -
        field: DonorId
        values:
         - null
        operator: NOT\_EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: OrganizationName
      isFieldRequired: true
      isFieldHidden: false
      visibilityRules:
       -
        field: GiftType
        values:
         - Organizational
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: Salutation
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: GiftType
        values:
         - Individual
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: FirstName
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: GiftType
        values:
         - Individual
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: LastName
      isFieldRequired: true
      isFieldHidden: false
      visibilityRules:
       -
        field: GiftType
        values:
         - Individual
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: Email
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: GiftType
        values:
         - Individual
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: HomePhone
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: GiftType
        values:
         - Individual
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: MobilePhone
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: GiftType
        values:
         - Individual
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: MobilePhone
      fieldLabel: $Label.GiftEntryGrid.OrganizationPhone
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: GiftType
        values:
         - Organizational
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: Street
      isFieldRequired: false
      isFieldHidden: false
     -
      sourceField: City
      isFieldRequired: false
      isFieldHidden: false
     -
      sourceField: State
      isFieldRequired: false
      isFieldHidden: false
     -
      sourceField: PostalCode
      isFieldRequired: false
      isFieldHidden: false
     -
      sourceField: Country
      isFieldRequired: false
      isFieldHidden: false
  isColumnHidden: false
  isColumnReadOnly: false
  columnWidth: 240
  columnLabel: $Label.GiftEntryGrid.DonorLookup
 -
  columnId: GiftReceivedDate
  columnType: Field
  columnField:
    sourceField: GiftReceivedDate
    isFieldRequired: true
    isFieldHidden: false
  isColumnHidden: false
  isColumnReadOnly: false
  columnWidth: 180
  columnLabel: GiftReceivedDate
 -
  columnId: Commitments
  columnType: Component
  columnField:
    sourceField: GiftCommitmentId
    isFieldRequired: false
    isFieldHidden: false
  columnComponent:
    componentNameDisplay: runtime\_industries\_frops/giftEntryGridColumnDisplay
    componentNameEdit: runtime\_industries\_frops/giftEntryGridCommitmentColEdit
  columnModal:
    modalTitleLabel: $Label.GiftEntryGrid.NewCommitmentModalTitle
    modalComponent:
      componentName: runtime\_industries\_frops/giftEntryGridFieldsModal
    modalIcon:
      expandIcon: utility:expand\_alt
      expandIconAltText: $Label.GiftEntryGrid.CommitmentExpandIconAltText
      lockIcon: utility:lock
      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
      noIconAltText: &quot;&quot;
    isModalReadOnly: false
    modalAltTitleLabel: $Label.GiftEntryGrid.ViewCommitmentModalTitle
    modalAltTitleLabelVisibilityRule:
     -
      field: GiftCommitmentId
      values:
       - null
      operator: NOT\_EQUALS
      multipleRulesEvaluationOperator: AND
    modalFields:
     -
      sourceField: EffectiveStartDate
      fieldLabel: $Label.GiftEntryGrid.CommitmentEffectiveStartDateLabel
      isFieldRequired: true
      isFieldHidden: false
      fieldReadOnlyRule:
       -
        field: GiftCommitmentId
        values:
         - null
        operator: NOT\_EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: ExpectedEndDate
      fieldLabel: $Label.GiftEntryGrid.CommitmentExpectedEndDateLabel
      isFieldRequired: false
      isFieldHidden: false
      fieldReadOnlyRule:
       -
        field: GiftCommitmentId
        values:
         - null
        operator: NOT\_EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: TransactionPeriod
      isFieldRequired: true
      isFieldHidden: false
      fieldReadOnlyRule:
       -
        field: GiftCommitmentId
        values:
         - null
        operator: NOT\_EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: TransactionInterval
      isFieldRequired: true
      isFieldHidden: false
      fieldReadOnlyRule:
       -
        field: GiftCommitmentId
        values:
         - null
        operator: NOT\_EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: TransactionDay
      isFieldRequired: true
      isFieldHidden: false
      visibilityRules:
       -
        field: TransactionPeriod
        values:
         - Monthly
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
      fieldReadOnlyRule:
       -
        field: GiftCommitmentId
        values:
         - null
        operator: NOT\_EQUALS
        multipleRulesEvaluationOperator: AND
  isColumnHidden: false
  isColumnReadOnly: false
  columnWidth: 240
  columnLabel: $Label.GiftEntryGrid.CommitmentColumnLabel
 -
  columnId: GiftAmount
  columnType: Field
  columnField:
    sourceField: GiftAmount
    isFieldRequired: false
    isFieldHidden: false
  isColumnHidden: false
  isColumnReadOnly: false
  columnWidth: 160
  columnLabel: GiftAmount
 -
  columnId: PaymentMethod
  columnType: Field
  columnField:
    sourceField: PaymentMethod
    isFieldRequired: true
    isFieldHidden: false
  columnModal:
    modalTitleLabel: $Label.GiftEntryGrid.PaymentInformationModalTitle
    modalComponent:
      componentName: runtime\_industries\_frops/giftEntryGridFieldsModal
    modalIcon:
      expandIcon: utility:expand\_alt
      expandIconAltText: $Label.GiftEntryGrid.PaymentMethodIconAltText
      lockIcon: utility:lock
      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
      noIconAltText: &quot;&quot;
    isModalReadOnly: false
    modalFields:
     -
      sourceField: PaymentMethod
      isFieldRequired: true
      isFieldHidden: false
     -
      sourceField: Last4
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: PaymentMethod
        values:
         - Credit Card
         - ACH
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: ExpiryMonth
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: PaymentMethod
        values:
         - Credit Card
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: ExpiryYear
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: PaymentMethod
        values:
         - Credit Card
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: CheckDate
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: PaymentMethod
        values:
         - Check
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
     -
      sourceField: PaymentIdentifier
      isFieldRequired: false
      isFieldHidden: false
      visibilityRules:
       -
        field: PaymentMethod
        values:
         - Check
        operator: EQUALS
        multipleRulesEvaluationOperator: AND
  isColumnHidden: false
  isColumnReadOnly: false
  columnWidth: 180
  columnLabel: PaymentMethod
 -
  columnId: OutreachSourceCode
  columnType: Field
  columnField:
    sourceField: OutreachSourceCodeId
    isFieldRequired: false
    isFieldHidden: false
  isColumnHidden: false
  isColumnReadOnly: false
  columnWidth: 200
  columnLabel: $Label.GiftEntryGrid.OutreachSourceCodeLookup
 -
  columnId: Campaign
  columnType: Field
  columnField:
    sourceField: CampaignId
    isFieldRequired: false
    isFieldHidden: false
  isColumnHidden: false
  isColumnReadOnly: false
  columnWidth: 200
  columnLabel: $Label.GiftEntryGrid.CampaignLookup
 -
  columnId: Designations
  columnType: Component
  columnField:
    sourceField: GiftDesignation1Id
    isFieldRequired: false
    isFieldHidden: false
  columnComponent:
    componentNameDisplay: runtime\_industries\_frops/giftEntryGridColumnDisplay
    componentNameEdit: runtime\_industries\_frops/giftEntryGridLookup
  columnModal:
    modalTitleLabel: $Label.GiftEntryGrid.DesignationsModalTitle
    modalComponent:
      componentName: runtime\_industries\_frops/giftEntryGridDesignation
    modalIcon:
      expandIcon: utility:expand\_alt
      expandIconAltText: $Label.GiftEntryGrid.DesignationExpandIconAltText
      lockIcon: utility:lock
      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
      noIconAltText: &quot;&quot;
    isModalReadOnly: false
  isColumnHidden: false
  isColumnReadOnly: false
  columnWidth: 240
  columnLabel: $Label.GiftEntryGrid.DesignationsLookup
 -
  columnId: SoftCredits
  columnType: Component
  columnField:
    sourceField: RecipientId
    isFieldRequired: false
    isFieldHidden: false
  columnComponent:
    componentNameDisplay: runtime\_industries\_frops/giftEntryGridColumnDisplay
    componentNameEdit: runtime\_industries\_frops/giftEntryGridLookup
  columnModal:
    modalTitleLabel: $Label.GiftEntryGrid.SoftCreditsModalTitle
    modalComponent:
      componentName: runtime\_industries\_frops/giftEntryGridSoftCredit
    modalIcon:
      expandIcon: utility:expand\_alt
      expandIconAltText: $Label.GiftEntryGrid.SoftCreditsExpandIconAltText
      lockIcon: utility:lock
      lockIconAltText: $Label.GiftEntryGrid.LockIconAltText
      noIconAltText: &quot;&quot;
    isModalReadOnly: false
  isColumnHidden: false
  isColumnReadOnly: false
  columnWidth: 240
  columnLabel: $Label.GiftEntryGrid.SoftCreditsLookup</templateConfiguration\>
</GiftEntryGridTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>GiftEntryGridTemplate</name\>
    </types\>
    <version\>66.0</version\>
</Package\>

<!-- document id=5673af3e735bf4861c7435fff813a8c0ffefb18ceac7256254bdd34f522e9a7a url=/legacydeveloper/current/en-us/api_meta/meta_globalpicklist.md -->

# GlobalPicklist

Represents a global picklist, or the set of shared picklist values that custom picklist fields can use. In contrast, the custom picklist fields that are based on a global picklist are of type CustomValue. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

GlobalPicklist components have the suffix .globalPicklist and are stored in the globalPicklist folder.

## Version

GlobalPicklist components are available in API version 37.0 only. In API version 38.0 and later, GlobalPicklist is replaced by the [GlobalValueSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalvalueset.htm "Represents the metadata for a global picklist value set, which is the set of shared values that custom picklist fields can use. A global value set isn’t a field itself. In contrast, the custom picklist fields that are based on a global picklist are of type ValueSet. This type extends the Metadata metadata type and inherits its fullName field.") type.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | It’s useful to state the global picklist’s purpose, and which objects it’s intended for. Limit: 255 characters. |
| globalPicklistValues | [GlobalPicklistValue](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalpicklistvalue.htm "Represents the definition of a value used in a global picklist. Custom picklist fields can inherit the picklist value set from a global picklist.")\[\] | Requires at least one value. The list of values, or “picklist value set,” that’s defined for a global picklist. The picklist value set is inherited by any custom picklist field that’s based on that global picklist. Each value is of type GlobalPicklistValue. A global picklist can have up to 1,000 total values, including inactive values. |
| masterLabel | string | Required. A global picklist’s name, which is defined when the global picklist is created. Appears as Label in the user interface. |
| sorted | string | Indicates whether a global picklist’s value set is sorted in alphabetical order. By default this value is false. |

## Declarative Metadata Sample Definition

This Territories.globalPicklist is an example of a GlobalPicklist component.

<?xml version="1.0" encoding="UTF-8"?>
<GlobalPicklist xmlns="http://soap.sforce.com/2006/04/metadata">
    <description>Updated:This is a basic global picklist</description>
    <globalPicklistValues>
        <fullName>Northwest</fullName>
        <default>false</default>
    </globalPicklistValues>
    <globalPicklistValues>
        <fullName>Northeast</fullName>
        <default>false</default>
    </globalPicklistValues>
    <globalPicklistValues>
        <fullName>South</fullName>
        <default>true</default>
    </globalPicklistValues>
    <globalPicklistValues>
        <fullName>Southwest</fullName>
        <default>false</default>
        <isActive>false</isActive>
    </globalPicklistValues>
    <masterLabel>Territories</masterLabel>
    <sorted>true</sorted>
</GlobalPicklist>

This example package.xml references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Territories</members>
        <name>GlobalPicklist</name>
    </types>
    <version>37.0</version>
</Package>

<!-- document id=c23db201c0df70dbec5924a52661e96a71186fbcf8c3fe94c6b8edcb8f625219 url=/legacydeveloper/current/en-us/api_meta/meta_globalpicklistvalue.md -->

# GlobalPicklistValue

Represents the definition of a value used in a global picklist. Custom picklist fields can inherit the picklist value set from a global picklist.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

GlobalPicklistValue components don’t have file suffixes or directories because they’re lists of values and not custom fields. For file-based operations they can be accessed through GlobalPicklist (which is in API v37.0 only).

## Version

GlobalPicklistValue components are available in API version 37.0 only. In API version 38.0 and later, GlobalPicklistValue is replaced by [CustomValue](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customvalue.htm "Represents the definition of a value used in a global value set or local custom picklist. Custom picklist fields can be local and unique, or can inherit their values from a global picklist (called a global value set in API version 38.0). This type extends the Metadata metadata type and inherits its fullName field.").

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| color | string | The color assigned to the picklist value when it’s used in charts on reports and dashboards. The color is in hexadecimal format; for example, #FF6600. If a color is not specified, it’s assigned dynamically upon chart generation. |
| default | boolean | Required. Indicates whether this value is the default selection for the global picklist and the custom picklists that share its picklist value set. This field is set to true by default. |
| description | string | The global picklist value’s description. It’s useful to include a description for a global picklist value so the reason for creating it can be tracked. Limit: 255 characters. |
| isActive | boolean | Indicates whether this value is currently active or inactive. The default value is true. Users can select only active values from a picklist. An API retrieve operation for global picklist values returns all active and inactive values in the picklist. (Meanwhile, retrieving the values of a non-global, unrestricted picklist returns only the active values.) |

## PicklistValue

This metadata type defines a value in the picklist and specifies whether this value is the default value. This type extends the GlobalPicklistValue metadata type and inherits all its fields. In API version 36.0 and earlier, PicklistValue extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") type and inherits its fullName field.

Note the following when working with picklist values:

- When you retrieve a standard object, all picklist values are retrieved, not just the customized picklist values.
- When you deploy changes to standard picklist fields, picklist values are added as needed.
- To deactivate a global picklist value, you can invoke an update() call on GlobalPicklist with the value omitted, or with the value’s isActive field set to false. Or, you can invoke an update() call directly on GlobalPicklistValue with the isActive field set to false.
- If picklist values are missing from a component definition, they get deactivated when deployed. Deactivation occurs for picklist values of both standard and custom fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d558612e254">Field Name</th>

              <th class="featureTableHeader  " id="d558612e257">Field Type</th>

              <th class="featureTableHeader  " id="d558612e260">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="AllowEmail"><a name="AllowEmail"><!-- --></a>allowEmail</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="AllowEmailDesc"><a name="AllowEmailDesc"><!-- --></a>Indicates whether this value lets users email a quote
                  PDF (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the
                  <span class="keyword parmname">Status</span> field in quotes.</span>
                This field is available in API version 18.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="field_closed"><a name="field_closed"><!-- --></a>closed</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="field_closed_desc"><a name="field_closed_desc"><!-- --></a>Indicates whether this value is associated with a
                  closed status (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Status</span> field in cases and tasks.</span> This field is
                available in API version 16.0 and up to version 36.0. In version 37.0, this field is
                in GlobalPicklistValue.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname">controllingFieldValues</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">string[]</td>

              <td class="entry" headers="d558612e260" data-title="Description">A list of values in the controlling field that are linked to this picklist
                value. The controlling field can be a checkbox or a picklist. This field is
                available in API version 14.0 and later. The values in the list depend on the field type:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Checkbox</samp>: <samp class="codeph nolang">checked</samp> or <samp class="codeph nolang">unchecked</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Picklist</samp>: The
                    <span class="keyword parmname">fullname</span> of the picklist value in the controlling
                    field.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="field_converted"><a name="field_converted"><!-- --></a>converted</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="field_converted_desc"><a name="field_converted_desc"><!-- --></a>Indicates whether this value is associated with a
                  converted status (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is relevant for only the standard
                  <span class="keyword parmname">Lead Status</span> field in leads.</span>
                <span class="ph">Your organization can set its own guidelines for
                  determining when a lead is qualified, but typically, you want to convert a lead as
                  soon as it becomes a real opportunity that you want to forecast.</span> For more
                information, see “Convert Qualified Leads” in the Salesforce online
                help. This field is available in API version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="field_cssExposed"><a name="field_cssExposed"><!-- --></a>cssExposed</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="field_cssExposed_desc"><a name="field_cssExposed_desc"><!-- --></a>Indicates whether this value is available in
                  your Self-Service Portal (<samp class="codeph java">true</samp>), or not
                  (<samp class="codeph java">false</samp>). This field is only relevant for the
                  standard <span class="keyword parmname">Case Reason</span> field in cases.</span>
                <p class="p">Self-Service
                  provides an online support channel for your customers - allowing them to resolve
                  their inquiries without contacting a customer service representative. For more
                  information about Self-Service, see “Setting Up Your Self-Service
                  Portal” in the Salesforce online help. </p>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Starting with Spring
                            ’12, the Self-Service portal isn’t available for new Salesforce
                            orgs. Existing orgs continue to have access to the Self-Service
                            portal.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
                <p class="p">This field is available in API version 16.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="field_forecastCategory"><a name="field_forecastCategory"><!-- --></a>forecastCategory</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">ForecastCategories (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="field_forecastCategory_desc"><a name="field_forecastCategory_desc"><!-- --></a>Indicates whether this value is associated
                  with a forecast category (<samp class="codeph java">true</samp>), or not
                  (<samp class="codeph java">false</samp>). This field is only relevant for the
                  standard <span class="keyword parmname">Stage</span> field in opportunities.</span>
                <ul class="ul bulletList">
                  <li class="li">Omitted</li>

                  <li class="li">Pipeline</li>

                  <li class="li">BestCase</li>

                  <li class="li">Forecast</li>

                  <li class="li">Closed</li>

                </ul>
                <p class="p">This field is available in API version 16.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="field_highPriority"><a name="field_highPriority"><!-- --></a>highPriority</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="field_highPriority_desc"><a name="field_highPriority_desc"><!-- --></a>Indicates whether this value is a high
                  priority item (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Priority</span> field in tasks.</span> For more information about
                tasks, see “Start Using Tasks” in the Salesforce online help. This
                field is available in API version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="field_probability"><a name="field_probability"><!-- --></a>probability</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">int</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="field_probability_desc"><a name="field_probability_desc"><!-- --></a>Indicates whether this value is a probability
                  percentage (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Stage</span> field in opportunities.</span> This field is available
                in API version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="field_reverseRole"><a name="field_reverseRole"><!-- --></a>reverseRole</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">string</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="field_reverseRole_desc"><a name="field_reverseRole_desc"><!-- --></a>A picklist value corresponding to a reverse
                  role name for a partner. If the role is “subcontractor”, then the
                  reverse role might be “general contractor”. Assigning a partner role
                  to an account in Salesforce creates a reverse partner relationship so that both
                  accounts list the other as a partner. This field is only relevant for partner
                  roles.</span>
                <p class="p">For more information, see “Partner Fields” in the
                  Salesforce online help.</p>
                This field is available in API version 18.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="field_reviewed"><a name="field_reviewed"><!-- --></a>reviewed</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="field_reviewed_desc"><a name="field_reviewed_desc"><!-- --></a>Indicates whether this value is associated with a
                  reviewed status (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Status</span> field in solutions.</span> For more information about
                opportunities, see “Creating Solutions” in the Salesforce online help.
                This field is available in API version 16.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d558612e254" data-title="Field Name"><span class="keyword parmname" id="field_won"><a name="field_won"><!-- --></a>won</span></td>

              <td class="entry" headers="d558612e257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d558612e260" data-title="Description">
                <span class="ph" id="field_won_desc"><a name="field_won_desc"><!-- --></a>Indicates whether this value is associated with a
                  closed or won status (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). This field is only relevant for the standard
                  <span class="keyword parmname">Stage</span> field in opportunities.</span> This field is available
                in API version 16.0 and later.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

For an example of GlobalPicklistValue components with a package.xml that references them, see [GlobalPicklist](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalpicklist.htm#meta_globalpicklist "Represents a global picklist, or the set of shared picklist values that custom picklist fields can use. In contrast, the custom picklist fields that are based on a global picklist are of type CustomValue. This type extends the Metadata metadata type and inherits its fullName field.").

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=314270acb03d228bbbe7e1bcfaa1a1819e2966daa164dfbe3836aba5c589246b url=/legacydeveloper/current/en-us/api_meta/meta_globalvalueset.md -->

# GlobalValueSet

Represents the metadata for a global picklist value set, which is the set of shared values that custom picklist fields can use. A global value set isn’t a field itself. In contrast, the custom picklist fields that are based on a global picklist are of type ValueSet. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

GlobalValueSet components have the suffix .globalValueSet and are stored in the globalValueSets folder.

## Version

GlobalValueSet components are available in API version 38.0 and later. In API version 37.0, this component is the GlobalPicklist type.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| customValue | [CustomValue](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customvalue.htm#meta_customvalue "Represents the definition of a value used in a global value set or local custom picklist. Custom picklist fields can be local and unique, or can inherit their values from a global picklist (called a global value set in API version 38.0). This type extends the Metadata metadata type and inherits its fullName field.")\[\] | Requires at least one value. The list of values, or “global value set,” that’s defined for a global picklist. The global value set is inherited by any custom picklist field that uses that value set. Each value is of type customValue. A global value set can have up to 1,000 total values, including inactive values. |
| description | string | It’s useful to state the global value set’s purpose and which objects it’s intended for. Limit: 255 characters. |
| masterLabel | string | Required. A global value set’s name, which is defined when the global value set is created. Appears as Label in the user interface. |
| sorted | boolean | Required. Indicates whether a global value set is sorted in alphabetical order. By default this value is false. |

## Declarative Metadata Sample Definition

This UpsellGlobal.globalValueSet is an example of a GlobalValueSet component.

<?xml version="1.0" encoding="UTF-8"?>
<GlobalValueSet xmlns="http://soap.sforce.com/2006/04/metadata">
   <description>Updated:This is a basic global value set.</description>
   <masterLabel>UpsellGlobal</masterLabel>
   <customValue>
      <fullName>Maybe</fullName>
      <default>false</default>
      <label>Maybe</label>
   </customValue>
   <customValue>
      <fullName>No</fullName>
      <default>false</default>
      <label>No</label>
   </customValue>
   <customValue>
      <fullName>Yes</fullName>
      <default>false</default>
      <label>Yes</label>
   </customValue>
   <sorted>false</sorted>
</GlobalValueSet>

This example package.xml references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>UpsellGlobal</members>
        <name>GlobalValueSet</name>
    </types>
    <version>40.0</version>
</Package>

Any global value set created in API version 57.0 or later automatically has the \_\_gvs suffix appended to the developer name. When you make any CRUD-based call with the GlobalValueSet type, you must append the suffix to the fullName field when you reference the type.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=79a5cf7fd7ceae680160f3e937d572afb870cdf371106dc7d7d43b981e9ad604 url=/legacydeveloper/current/en-us/api_meta/meta_globalvaluesettranslation.md -->

# GlobalValueSetTranslation

Contains details for a global value set translation. Global value sets are lists of values that can be shared by multiple custom picklist fields, optionally across objects. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

GlobalValueSetTranslation components have the suffix .globalValueSetTranslation and are stored in the globalValueSetTranslations folder.

Translations are stored in a file with a format of ValueSetName-lang.globalValueSetTranslation, where ValueSetName is the global value set’s name, and lang is the translation language.

## Version

GlobalValueSetTranslation components are available in API version 38.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| valueTranslation | [ValueTranslation](#ValueTranslation_section)\[\] | The translated name of a value in a translated global value set. Each valueTranslation is paired with a masterLabel, which is the original (untranslated) name of the value. |

## ValueTranslation

The original value name and the translated value name in a translated global value set.

| Field | Field Type | Description |
| --- | --- | --- |
| masterLabel | string | Required. The original (untranslated) name of a value in a global value set. Each valueTranslation has a masterLabel paired with its translation. |
| translation | string | The translated name of a value in a translated global value set. |

## Declarative Metadata Sample Definition

This example shows a GlobalValueSetTranslation component. When a value isn’t translated, its translation becomes a comment that’s paired with its masterLabel.

<?xml version="1.0" encoding="UTF-8"?>
<GlobalValueSetTranslation xmlns="http://soap.sforce.com/2006/04/metadata">
    <valueTranslation>
        <masterLabel>Three</masterLabel>
        <translation>Trois</translation>
    </valueTranslation>
    <valueTranslation>
        <masterLabel>Four</masterLabel>
        <translation>Quatre</translation>
    </valueTranslation>
    <valueTranslation>
        <masterLabel>Five</masterLabel>
        <translation><!-- Five --></translation>
    </valueTranslation>
</GlobalValueSetTranslation>

This example is a package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
        <types>
        <members>Numbers-fr</members>
        <name>GlobalValueSetTranslation</name>
    </types>
    <version>38.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Translations](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm "Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.")

<!-- document id=294bbe20a9bea41baa6302f55a7dc82a962f6a052f374e0890b364a2b7021934 url=/legacydeveloper/current/en-us/api_meta/meta_googleappssettings.md -->

# GoogleAppsSettings

Represents the settings for Google Apps in Salesforce.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

A GoogleAppsSettings component file has the suffix .settings and is stored in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

GoogleAppsSettings components are available in API version 46.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableGmailButtons | boolean | Indicates whether the Gmail Buttons setting is enabled (true) or not (false). |
| enableGmailButtonsAndLinks | boolean | Indicates whether Gmail Buttons and Links are enabled (true) or not (false). |
| enableGmailLinks | boolean | Indicates whether the Gmail Links setting is enabled (true) or not (false). |
| enableGoogleDocs | boolean | Indicates whether the Add Google Docs to Salesforce setting is enabled (true) or not (false). |
| enableGoogleDocsTab | boolean | Indicates whether the Add Google Docs button on the Libraries tab is enabled (true) or not (false). |
| enableGoogleTalk | boolean | Indicates whether the Google Talk Sidebar Component is enabled (true) or not (false). |
| googleAppsDomain | string | Specifies the domain registered for your organization’s Google Apps account. |

## Declarative Metadata Sample Definition

The following is an example of a GoogleAppsSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<GoogleAppsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableGmailButtons\>false</enableGmailButtons\>
    <enableGmailButtonsAndLinks\>false</enableGmailButtonsAndLinks\>
    <enableGmailLinks\>false</enableGmailLinks\>
    <enableGoogleDocs\>false</enableGoogleDocs\>
    <enableGoogleDocsTab\>false</enableGoogleDocsTab\>
    <enableGoogleTalk\>false</enableGoogleTalk\>
    <googleAppsDomain\>example.com</googleAppsDomain\>
    <googleAppsDomainLinked\>false</googleAppsDomainLinked\>
    <googleAppsDomainValidated\>false</googleAppsDomainValidated\>
</GoogleAppsSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Google Apps settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>GoogleApps</members\>
		<name\>Settings</name\>
	</types\>
	<version\>46.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=0d5becdff93c45c02918e7412153203528e8155f386f0f3f228eea4650c4bd73 url=/legacydeveloper/current/en-us/api_meta/meta_group.md -->

# Group

Represents a set of public groups, which can have users, roles, and other groups.

## Declarative Metadata File Suffix and Directory Location

The file suffix for group components is .group and components are stored in the groups directory of the corresponding package directory.

## Version

Group components are available in API version 24.0 and later.

## Special Access Rules

As of Spring ’20 and later, only authenticated internal and external users can access this type.

## Fields

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Members of the public group aren’t migrated when you deploy the group type.

This metadata type represents the valid values that define a group:

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | The description for the group. Available in API version 62.0 and later. |
| doesIncludeBosses | boolean | Required. Indicates whether records shared with users in this group are also shared with users higher in the role hierarchy (true) or not (false). This field corresponds to the Grant Access Using Hierarchies checkbox on the group’s detail page. Available in API version 18.0 and later. |
| fullName | string | The unique identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") component. Corresponds to **Group Name** in the user interface. |
| name | string | Required. The name of the group. Corresponds to **Label** in the user interface. |

## Declarative Metadata Sample Definition

The following is the definition of a group.

<?xml version="1.0" encoding="UTF-8"?>
<Group xmlns="http://soap.sforce.com/2006/04/metadata">
    <doesIncludeBosses\>true</doesIncludeBosses\>
    <fullName\>admin</fullName\>
    <name\>test</name\>
</Group\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=dd76eff50cff4e45673221f9d3ae64b02bf2f0be83e8807108c54e9c7382b24b url=/legacydeveloper/current/en-us/api_meta/meta_headers.md -->

# Headers

Use headers in Metadata API calls to set options for each call.

- **[AllOrNoneHeader](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_allornoneheader.htm)**  
    Indicates whether to roll back all metadata changes when some of the records in a call result in failures.
- **[CallOptions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_calloptions.htm)**  
    Specifies the API client identifier.
- **[DebuggingHeader](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_debuggingheader.htm)**  
    Specifies that the deployment result contains the debug log output, and specifies the level of detail included in the log. The debug log contains the output of Apex tests that are executed as part of a deployment.
- **[SessionHeader](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sessionheader.htm)**  
    Specifies the session ID that the login call returns. This session ID is used to authenticate all subsequent Metadata API calls.

<!-- document id=eeaca74fdf44399be4e86ededd4fe0c5bd7bef9f4cfefca0ca30def7f926cc66 url=/legacydeveloper/current/en-us/api_meta/meta_helpsettings.md -->

# HelpSettings

Represents the org setting that changes the destination of help.salesforce.com to an alternative URL. Use this setting to deploy and retrieve the alternative Help URL.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for details.

## File Suffix and Directory Location

HelpSettings values are stored in the Help.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

HelpSettings components are available in API version 68.0 and later.

## Special Access Rules

To retrieve or deploy HelpSettings, users need the Customize Application permission. You can’t create or delete this component. HelpSettings isn’t supported in unlocked packages.

## Fields

| Field Name | Description |
| --- | --- |
| alternativeUrl | 
Field Type

string

Description

The alternative URL that opens when users access Salesforce Help. The URL can contain up to 255 characters and must be a valid URL. If validation fails, deployment returns an INVALID\_OPERATION error. If the element is omitted from a deployment, the existing URL doesn’t change. To clear the alternative URL, leave the field blank.



 |

## Declarative Metadata Sample Definition

The following is an example of a HelpSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<HelpSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <alternativeUrl\>https://help.example.com/docs</alternativeUrl\>
</HelpSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Help</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=08f646708a55bb8206d6d5a9aa304a0f1ed1eb6f00f4367460c45b761c5bb8d5 url=/legacydeveloper/current/en-us/api_meta/meta_highvelocitysalessettings.md -->

# HighVelocitySalesSettings

Represents an org’s Sales Engagement settings. With Sales Engagement, you can make your inside sales team as effective as possible.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

HighVelocitySalesSettings values are stored in a single file named HighVelocitySales.settings in the settings directory of the corresponding package directory.

## Version

HighVelocitySalesSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d562856e110">Field Name</th>

              <th class="featureTableHeader  " id="d562856e113">Field Type</th>

              <th class="featureTableHeader  " id="d562856e116">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableACAutoSendEmail</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether a cadence step of type Automated Send can be created <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Allowing Salesforce to automatically send an email to a
                prospect can make your sales team more efficient, because reps don’t have to send
                the email themselves. <p class="p">Default value is <samp class="codeph nolang">true</samp>.
                </p>
                <p class="p">Available in API version 48.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableACChangeTargetAssignee</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether target assignees, target owners, and users with access to
                related cadences can update target assignees <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. <p class="p">Available
                  in API version 50.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableACSkipWeekends</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether Skip Weekends is enabled <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>.<p class="p">Available
                  in API version 48.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableBusinessHours</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether Business Hours is enabled in Sales Engagement <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>.<p class="p">Available in API version 58.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableCadenceVariantTestingPref</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether AB testing for cadence steps is enabled <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. <p class="p">Available in API version 53.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableChgTgtAssigneeUsrPermPref</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether the change target assignee action is controlled by user
                permission <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>.<p class="p">Available in API version 51.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableDispositionCategory</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether Call Outcomes For Branching is enabled in Sales Engagement
                <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Use Call Outcomes For Branching to group calls into different
                outcome categories such as "Left Voicemail" or "Not Interested." You can see the
                outcomes in a report, or use them to determine how cadences are branched.
                <span class="keyword parmname">enableHighVelocitySales</span> must be <samp class="codeph nolang">true</samp> to use Sales Engagement.<p class="p">Default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableEngagementWaveAnalyticsPref</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether you can see engagement statistics in CRM Analytics <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Use CRM Analytics to analyze information about calls,
                engagement, and how each sales rep moves through their cadence steps.</td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableHighVelocitySales</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether Sales Engagement is enabled <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. If enabled,
                it turns on the features required for the product and makes the app available to
                users.<p class="p">Default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableHighVelocitySalesSetup</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether Sales Engagement is enabled <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>.<p class="p">Default
                  value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableInvoiceAttributionPref</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether Invoice Attribution is enabled <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. <p class="p">Available
                  in API version 56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableLogACallForCTIPref</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether Log a Call appears to CTI users by default <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. <p class="p">Available in API version 54.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableLogTasksForLinkedInPref</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether users can log standard tasks upon completion of a LinkedIn
                step <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>.<p class="p">Available in API version 54.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableMultipleCadencesPref</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether targets can be assigned to multiple cadences <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. <p class="p">Available in API version 57.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableOpportunityAttributionPermPref</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether Opportunity Attribution is enabled <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. <p class="p">Available in API version 51.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableQuickCadenceAutoSendEmail</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether Automated Email send is enabled for Sales Engagement quick
                cadences <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. <p class="p">Available in API version 57.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d562856e110" data-title="Field Name"><span class="keyword parmname">enableTaskLoggingPref</span></td>

              <td class="entry" headers="d562856e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d562856e116" data-title="Description">Indicates whether users can log tasks after manual completion of a cadence step
                <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>.<p class="p">Available in API version 56.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the HighVelocitySales.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<HighVelocitySalesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <enableACAutoSendEmail\>false</enableACAutoSendEmail\>
  <enableACChangeTargetAssignee\>false</enableACChangeTargetAssignee\>
  <enableACSkipWeekends\>false</enableACSkipWeekends\>
  <enableBusinessHours\>false</enableBusinessHours\>
  <enableCadenceVariantTestingPref\>false</enableCadenceVariantTestingPref\>
  <enableChgTgtAssigneeUsrPermPref\>false</enableChgTgtAssigneeUsrPermPref\>
  <enableDispositionCategory\>true</enableDispositionCategory\>
  <enableEngagementWaveAnalyticsPref\>true</enableEngagementWaveAnalyticsPref\>
  <enableHighVelocitySales\>true</enableHighVelocitySales\>
  <enableHighVelocitySalesSetup\>true</enableHighVelocitySalesSetup\>
  <enableInvoiceAttributionPref\>false</enableInvoiceAttributionPref\>
  <enableLogACallForCTIPref\>false</enableLogACallForCTIPref\>
  <enableLogTasksForLinkedInPref\>false</enableLogTasksForLinkedInPref\>
  <enableMultipleCadencesPref\>false</enableMultipleCadencesPref\>
  <enableOpportunityAttributionPermPref\>false</enableOpportunityAttributionPermPref\>
  <enableQuickCadenceAutoSendEmail\>false</enableQuickCadenceAutoSendEmail\>
  <enableTaskLoggingPref\>true</enableTaskLoggingPref\>
</HighVelocitySalesSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the HighVelocitySalesSettings settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>HighVelocitySalesSettings</members\>
		<name\>Settings</name\>
	</types\>
	<version\>47.0</version\>
</Package\>

<!-- document id=c7cb084efaa8165b147a76206fc644d2e018084047bb829a206b45a4969ab4d8 url=/legacydeveloper/current/en-us/api_meta/meta_historyretentionpolicy.md -->

# HistoryRetentionPolicy

Represents the policy for archiving field history data. When you set a policy, you specify the number of months that you want to keep field history in Salesforce before archiving it. By default, when Field Audit Trail is enabled, all field history is retained.

This component is only available to users with the RetainFieldHistory permission.

## Declarative Metadata File Suffix and Directory Location

Field history retention policies are defined as part of a standard or custom object. You can set field history retention policies for objects individually. See [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.") for more information.

## Version

Available in API version 31.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| archiveAfterMonths | int | Required. The number of months that you want to keep field history data in Salesforce before archiving. You can set a minimum of 1 month and a maximum of 18 months. If you don't set a number, the default is 18 months. (That is, Salesforce maintains data for 18 months before archiving.) |
| archiveRetentionYears | int | The number of years until you manually delete data from the archive. Use this field as a reminder for manually deleting data. By default, field history data isn’t automatically deleted when Field Audit Trail is enabled. |
| description | string | A text description for the history retention. |
| gracePeriodDays | int | The number of days of extra time after the archiveAfterMonths period before the data is archived. The gracePeriodDays interval applies only to the first time that the data is archived; because all the data is copied the first time, the operation can take longer than subsequent times when only the data that changed since the last archival operation is copied. The gracePeriodDays provides extra time for the administrator to prepare the organization before the initial archive operation. You can set a minimum of zero days and a maximum of 10 days. If no number is set, the default is 1 day. |

## Declarative Metadata Sample Definition

This sample shows the definition of a history retention policy for a custom object.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
   <historyRetentionPolicy\>
       <archiveAfterMonths\>6</archiveAfterMonths\>
       <archiveRetentionYears\>5</archiveRetentionYears\>
       <description\>My field history retention</description\>
   </historyRetentionPolicy\>

...
</CustomObject\>

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fieldset.htm "FieldSet")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_index.htm "Index")

<!-- document id=8c0760904d7c45b82b6710189635878e6f68c17703908bd548c720e8cdca226d url=/legacydeveloper/current/en-us/api_meta/meta_homepagecomponent.md -->

# HomePageComponent

Represents the metadata associated with a home page component. You can customize the Home tab in Salesforce Classic to include components such as sidebar links, a company logo, a dashboard snapshot, or custom components that you create. Use to create, update, or delete home page component definitions.

For more information, see “[Salesforce Classic Home Tab Page Layouts](https://help.salesforce.com/s/articleView?id=platform.customize_homepage.htm&type=5&language=en_US "HTML (New Window)")” in the Salesforce Help.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Declarative Metadata File Suffix and Directory Location

The file suffix for home page components is .homePageComponent and components are stored in the homepagecomponents directory of the corresponding package directory.

## Version

Home page components are available in API version 12.0 and later.

## HomePageComponent

This metadata type represents the valid values that define a home page component:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d564856e108">Field Name</th>

              <th class="featureTableHeader  " id="d564856e111">Field Type</th>

              <th class="featureTableHeader  " id="d564856e114">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d564856e108" data-title="Field Name"><span class="keyword parmname">body</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">string</td>

              <td class="entry" headers="d564856e114" data-title="Description">The text body inside the HTML page component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d564856e108" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">string</td>

              <td class="entry" headers="d564856e114" data-title="Description">The name can only contain characters, letters, and the underscore (_)
                character. The name must start with a letter, and can’t end with an underscore or
                contain two consecutive underscore characters.<p class="p">Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component, this field isn’t defined in
                  the WSDL for this component. It must be specified when creating, updating, or
                  deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see
                  an example of this field specified for a call.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d564856e108" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">int</td>

              <td class="entry" headers="d564856e114" data-title="Description">Required for Visualforce Area components. Indicates the height (in pixels) of
                the component.<p class="p">This field is available in API version 31.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d564856e108" data-title="Field Name"><span class="keyword parmname">links</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">string[]</td>

              <td class="entry" headers="d564856e114" data-title="Description">If the <span class="keyword parmname">pageComponentType</span> is <samp class="codeph nolang">links</samp>, then zero or more names of custom page links can be specified.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ObjectWebLink</samp></li>

                  <li class="li"><samp class="codeph nolang">CustomPageWebLink</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d564856e108" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">string</td>

              <td class="entry" headers="d564856e114" data-title="Description">This field is only available for Visualforce Area components and indicates the
                API name of the Visualforce page that is associated with the component. <p class="p">This
                  field is available in API version 31.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d564856e108" data-title="Field Name"><span class="keyword parmname">pageComponentType</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">PageComponentType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d564856e114" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">links</samp></li>

                  <li class="li"><samp class="codeph nolang">htmlArea</samp></li>

                  <li class="li"><samp class="codeph nolang">imageOrNote</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">visualforcePage</samp> (This value is available
                    in API version 31.0 and later.)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d564856e108" data-title="Field Name"><span class="keyword parmname">showLabel</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d564856e114" data-title="Description">This field is only available for Visualforce Area components and specifies
                whether the component displays with a label (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">This field
                  is available in API version 31.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d564856e108" data-title="Field Name"><span class="keyword parmname">showScrollbars</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d564856e114" data-title="Description">This field is only available for Visualforce Area components and specifies
                whether the component displays with scrollbars (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">This field
                  is available in API version 31.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d564856e108" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">PageComponentWidth (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d564856e114" data-title="Description">This field is only available for HTML and Visualforce Area components, and
                indicates whether it’s a narrow or wide home page component. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">narrowComponents</samp></li>

                  <li class="li"><samp class="codeph nolang">wideComponents</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of a home page component. See [Declarative Metadata Sample Definition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm#HomePageLayout_meta_example) and [Declarative Metadata Sample Definition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm#weblink_example) for related samples.

<?xml version="1.0" encoding="UTF-8"?>
<HomePageComponent xmlns="http://soap.sforce.com/2006/04/metadata">
  <height\>200</height\>
  <page\>MyVisualforcePage</page\>
  <pageComponentType\>visualforcePage</pageComponentType\>
  <showLabel\>true</showLabel\>
  <showScrollbars\>true</showScrollbars\>
  <width\>wideComponents</width\>
</HomePageComponent\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [HomePageLayout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm "Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile.")
- [WebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm "Represents a custom button or link defined in a custom object.")

<!-- document id=352408c28f8ee2e5686acc99cfb43f606a5d9eab6c5e0f189aafa44a1e301cfe url=/legacydeveloper/current/en-us/api_meta/meta_homepagelayouts.md -->

# HomePageLayout

Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile.

## File Suffix and Directory Location

Home page layouts are stored in the homePageLayouts directory of the corresponding package directory. The extension is .homePageLayout.

## Version

Home page components are available in API version 12.0 and later. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Fields

This metadata type represents the valid values that define a home page layout:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d565908e95">Field Name</th>

              <th class="featureTableHeader  " id="d565908e98">Field Type</th>

              <th class="featureTableHeader  " id="d565908e101">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d565908e95" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d565908e98" data-title="Field Type">string</td>

              <td class="entry" headers="d565908e101" data-title="Description">The name can only contain characters, letters, and the underscore
                (_) character. The name must start with a letter, and can’t end with
                an underscore or contain two consecutive underscore
                characters.<p class="p">Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component, this field isn’t defined in
                  the WSDL for this component. It must be specified when creating,
                  updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see an example of this field
                  specified for a call.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d565908e95" data-title="Field Name"><span class="keyword parmname">narrowComponents</span></td>

              <td class="entry" headers="d565908e98" data-title="Field Type">string[]</td>

              <td class="entry" headers="d565908e101" data-title="Description">The list of elements in the narrow column on the left side of the
                home page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d565908e95" data-title="Field Name"><span class="keyword parmname">wideComponents</span></td>

              <td class="entry" headers="d565908e98" data-title="Field Type">string[]</td>

              <td class="entry" headers="d565908e101" data-title="Description">The list of elements in the wide column on the right side of the
                home page.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of a home page layout. See [Declarative Metadata Sample Definition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm#HomePageCompenent_example) and [Declarative Metadata Sample Definition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm#weblink_example) for related samples.

<?xml version="1.0" encoding="UTF-8"?>
<HomePageLayout xmlns="http://soap.sforce.com/2006/04/metadata">
    <narrowComponents\>google</narrowComponents\>
</HomePageLayout\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [HomePageComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm "Represents the metadata associated with a home page component. You can customize the Home tab in Salesforce Classic to include components such as sidebar links, a company logo, a dashboard snapshot, or custom components that you create. Use to create, update, or delete home page component definitions.")
- [WebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm "Represents a custom button or link defined in a custom object.")

<!-- document id=6b5bcb29be1af6347a100e5755c3cf728d41240f8af679f6929b0a13032acbe1 url=/legacydeveloper/current/en-us/api_meta/meta_ideassettings.md -->

# IdeasSettings

Represents the metadata used to manage settings for Ideas.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

IdeasSettingsIdeas.settings in the settings folder 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

IdeasSettings

## Ideas

Represents settings for Ideas and Idea Themes.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableIdeaThemes | boolean | Indicates whether Idea Themes is enabled (true) or not (false). |
| enableIdeas | boolean | Indicates whether Ideas is enabled (true) or not (false). |
| enableIdeasReputation | boolean | Indicates whether Reputation is enabled (true) or not (false). You can’t enable IdeasReputation without enabling the Ideas Reputation permission in your organization. This field is available in API version 28.0 and later. |
| enableChatterProfile | boolean | Indicates that the Chatter user profile is used for Ideas user profiles. If enableChatterProfile is true, the ideasProfilePage value must not be specified. If enableChatterProfile is false, then specify a ideasProfilePage value, otherwise the Ideas zone profile is used. This field is available in API version 29.0 and later. |
| ideasProfilePage | string | The name of the Visualforce page to use for a custom Ideas user profile, if enableChatterProfile is false. If enableChatterProfile is false, then specify a ideasProfilePage value, otherwise the Ideas zone profile is used. This field is available in API version 29.0 and later. |
| halfLife | double | Indicates how quickly old ideas drop in ranking on the Popular Ideas subtab. The half-life setting determines how the number of days after which old ideas drop in ranking on the Popular Ideas subtab, to make room for ideas with more recent votes. A shorter half-life moves older ideas down the page faster than a longer half-life. |

## Declarative Metadata Sample Definition

The following is an example ideas.settings metadata file:

<?xml version="1.0" encoding="UTF-8"?>
<IdeasSettings xmlns="http://soap.sforce.com/2006/04/metadata">
   <enableIdeaThemes\>true</enableIdeaThemes\>
   <enableIdeas\>true</enableIdeas\>
   <enableIdeasReputation\>true</enableIdeasReputation\>
   <enableChatterProfile\>false</enableChatterProfile\>
   <ideasProfilePage\>name of Visualforce page</ideasProfilePage\>
   <halfLife\>2.6</halfLife\>
</IdeasSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a3d078437e87b3a7b663d47a619ea3c125af658971285004fa68dcc71717276f url=/legacydeveloper/current/en-us/api_meta/meta_identityprovidersettings.md -->

# IdentityProviderSettings

Represents the settings used to enable or disable Salesforce as a SAML identity provider for single sign-on (SSO).

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

IdentityProviderSettings values are stored in the IdentityProvider.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

IdentityProviderSettings components are available in API version 57.0 and later.

## Special Access Rules

To access IdentityProviderSettings, a user must have the Customize Application user permission.

## Fields

| Field Name | Description |
| --- | --- |
| certificateName | 
Field Type

string

Description

Required.

The certificate that Salesforce uses to communicate with SAML SSO service providers, such as third-party service providers or another Salesforce org acting as a service provider. You can enter the name of a self-signed certificate or a certificate signed by a certificate authority.



 |
| enableIdentityProvider | 

Field Type

boolean

Description

Required.

Indicates whether Salesforce can be used as a SAML identity provider (true) or not (false).



 |

## Declarative Metadata Sample Definition

The following is an example of an IdentityProviderSettings component. In this example, Salesforce is enabled as a SAML identity provider.

<?xml version="1.0" encoding="UTF-8"?>
<IdentityProviderSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <certificateName\>Certificate Name</certificateName\>
    <enableIdentityProvider\>true</enableIdentityProvider\>
</IdentityProviderSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>IdentityProvider</members\>
        <name\>Settings</name\>
    </types\>
    <version\>57.0</version\>
</Package\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=48b6605325d7fc19ef6e85fed7a8b28fdea2cd14fc5f19786a14bcb55cf950c0 url=/legacydeveloper/current/en-us/api_meta/meta_identityverificationprocdef.md -->

# IdentityVerificationProcDef

Represents the definition of the identity verification process.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

IdentityVerificationProcDef components have the suffix .IdentityVerificationProcDef and are stored in the IdentityVerificationProcDefs folder.

## Version

IdentityVerificationProcDef components are available in API version 54.0 and later.

## Special Access Rules

The Health Cloud permission set license is required to use this metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| identityVerificationProcDtls | 
Field Type

[IdentityVerificationProcDtl\[\]](#IdentityVerificationProcDtl)

Description

A list of Identity Verification Process Detail elements.



 |
| masterLabel | 

Field Type

string

Description

Required.

The label of the Identity Verification Process Definition record.



 |
| searchLayoutType | 

Field Type

IdentityVerificationSearchLayoutType (enumeration of type string)

Description

Required.

The display layout of the search component.

Valid values are:

- Stack
- Tab





 |

## IdentityVerificationProcDtl

Represents the verification-related details such as search criteria, verification criteria, or the custom apex class.

| Field Name | Description |
| --- | --- |
| apexClass | 
Field Type

string

Description

The Apex class that is used to search and verify data in an external system.



 |
| dataSourceType | 

Field Type

IdentityVerificationDataSourceType (enumeration of type string)

Description

Required.

The source type of the data.

Valid values are:

- External
- Salesforce





 |
| developerName | 

Field Type

string

Description

Required.

The developer name of Identity verification process detail. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| displayRecordFieldName | 

Field Type

string

Description

The name of the field that contains information about the record that's shown to the user after identity verification is successful. Available in API version 58.0 and later.



 |
| identityVerificationProcFlds | 

Field Type

[IdentityVerificationProcFld\[\]](#IdentityVerificationProcFld)

Description

A list of Identity Verification Process Field elements.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the record is active (true) or not (false).



 |
| isRetryAllowedAfterLimit | 

Field Type

boolean

Description

For internal use only.



 |
| linkedIdVerfProcessDet | 

Field Type

string

Description

The record containing the details of the linked identity verification process. Available in API version 58.0 and later.



 |
| masterLabel | 

Field Type

string

Description

Required.

The label of the Identity Verification Process Detail record.



 |
| objectName | 

Field Type

string

Description

The name of the object on which the search is performed and data is verified.



 |
| optionalVerifiersMinVerfCount | 

Field Type

int

Description

The number of optional verifiers that must be checked.



 |
| retryLimit | 

Field Type

int

Description

For internal use only.



 |
| searchFilter | 

Field Type

string

Description

A comma-separated list of predefined filter conditions that are used to refine the scope of the search.



 |
| searchRecordUniqueIdField | 

Field Type

string

Description

The field storing the unique identifier of a record displayed in the search results.



 |
| searchResultSortBy | 

Field Type

string

Description

The values that are used to sort the search results.



 |
| searchSequenceNumber | 

Field Type

int

Description

Required.

The sequence in which the search is performed and the search result is displayed.



 |
| searchType | 

Field Type

IdentityVerificationSearchType (enumeration of type string)

Description

Required.

The type of search being performed.

Valid values are:

- Object-Based
- Text-Based





 |

## IdentityVerificationProcFld

Represents a set of fields necessary to configure the questions that CCA asks the caller before providing them with the information they need.

| Field Name | Description |
| --- | --- |
| customFieldLabel | 
Field Type

string

Description

The custom label for the field that contains the verification data.



 |
| dataSourceType | 

Field Type

IdentityVerificationProcFldDataSourceType (enumeration of type string)

Description

Required.

The source type of the data.

Valid values are:

- External
- Salesforce





 |
| developerName | 

Field Type

string

Description

Required.

The developer name of Identity Verification Process Field. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

Available in API version 58.0 and later.



 |
| fieldDataType | 

Field Type

IdentityVerificationProcFldFieldDataType (enumeration of type string)

Description

The data type of the field in the external data source that's defined in the identity verification process detail. Available in API version 58.0 and later.

Valid values are:

- address
- checkbox
- currency
- dateonly
- datetime
- email
- number
- other
- percent
- phone
- picklist
- reference
- text
- timeonly
- url





 |
| fieldName | 

Field Type

string

Description

Required.

The label of the field that contains the verification data based on the selected field type. Available in API version 58.0 and later.



 |
| fieldType | 

Field Type

IdentityVerificationProcFldFieldType (enumeration of type string)

Description

Required.

Indicates the type of field.

Valid values are:

- additionalResultField
- optionalVerifier
- requiredVerifier
- resultField
- searchField
- searchFilter





 |
| fieldValueFormula | 

Field Type

string

Description

Stores the formula that is applied to the field value.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the record is active (true) or not (false).



 |
| isManualInput | 

Field Type

boolean

Description

Indicates whether the user can manually enter the identity verification details (true) or not (false).

The default value of this field is false.

Available in API version 58.0 and later.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for Identity Verification Process Field.



 |
| sequenceNumber | 

Field Type

int

Description

Required.

The sequence number of the field.



 |

## Declarative Metadata Sample Definition

This is an example of an IdentityVerificationProcDef component.

<?xml version="1.0" encoding="UTF-8"?>
<IdentityVerificationProcDef xmlns="http://soap.sforce.com/2006/04/metadata">
   <identityVerificationProcDtls\>
      <fullName\>Sample93AccountSearch</fullName\>
      <dataSourceType\>Salesforce</dataSourceType\>
      <developerName\>Sample93AccountSearch</developerName\>
      <identityVerificationProcFlds\>
         <fullName\>Sample93AccountName</fullName\>
         <dataSourceType\>Salesforce</dataSourceType\>
         <developerName\>Sample93AccountName</developerName\>
         <fieldName\>Name</fieldName\>
         <fieldType\>requiredVerifier</fieldType\>
         <isActive\>false</isActive\>
         <masterLabel\>Sample93 Account Name</masterLabel\>
         <fieldValueFormula\>abcd</fieldValueFormula\>
         <customFieldLabel\>Name</customFieldLabel\>
         <sequenceNumber\>1</sequenceNumber\>
         <isManualInput\>false</isManualInput\>
      </identityVerificationProcFlds\>
      <identityVerificationProcFlds\>
         <fullName\>Sample93Phone</fullName\>
         <dataSourceType\>Salesforce</dataSourceType\>
         <developerName\>Sample93Phone</developerName\>
         <fieldName\>phone</fieldName\>
         <fieldType\>optionalVerifier</fieldType\>
         <isActive\>false</isActive\>
         <masterLabel\>Sample93 Phone</masterLabel\>
         <sequenceNumber\>93</sequenceNumber\>
         <isManualInput\>false</isManualInput\>
      </identityVerificationProcFlds\>
      <identityVerificationProcFlds\>
         <fullName\>Sample93PostalCode</fullName\>
         <dataSourceType\>Salesforce</dataSourceType\>
         <developerName\>Sample93PostalCode</developerName\>
         <fieldName\>BillingPostalCode</fieldName\>
         <fieldType\>optionalVerifier</fieldType\>
         <isActive\>true</isActive\>
         <masterLabel\>Sample93 Postal Code</masterLabel\>
         <sequenceNumber\>4</sequenceNumber\>
         <isManualInput\>false</isManualInput\>
      </identityVerificationProcFlds\>
      <identityVerificationProcFlds\>
         <fullName\>Sample93Account</fullName\>
         <dataSourceType\>Salesforce</dataSourceType\>
         <developerName\>Sample93Account</developerName\>
         <fieldName\>Name</fieldName\>
         <fieldType\>resultField</fieldType\>
         <isActive\>false</isActive\>
         <masterLabel\>Sample93 Account</masterLabel\>
         <sequenceNumber\>1</sequenceNumber\>
         <isManualInput\>false</isManualInput\>
      </identityVerificationProcFlds\>
      <isActive\>true</isActive\>
      <masterLabel\>Sample93 Account Search</masterLabel\>
      <objectName\>Account</objectName\>
      <searchRecordUniqueIdField\>Id</searchRecordUniqueIdField\>
      <searchSequenceNumber\>1</searchSequenceNumber\>
      <searchType\>Text-Based</searchType\>
      <searchResultSortBy\>Name</searchResultSortBy\>
      <optionalVerifiersMinVerfCount\>1</optionalVerifiersMinVerfCount\>
      <isRetryAllowedAfterLimit\>false</isRetryAllowedAfterLimit\>
      <retryLimit\>5</retryLimit\>
      <searchFilter\></searchFilter\>
      <displayRecordFieldName\>LastModifiedById</displayRecordFieldName\>
   </identityVerificationProcDtls\>
   <masterLabel\>Sample93 Verification Flow</masterLabel\>
   <searchLayoutType\>Tab</searchLayoutType\>
</IdentityVerificationProcDef\>

This is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>IdentityVerificationProcDef</name\>
    </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=ef26e33c240a5e4ee52e4a0e87285da62e5580374d5417e65bb696e01e2eecd2 url=/legacydeveloper/current/en-us/api_meta/meta_identityverificationprocdtl.md -->

# IdentityVerificationProcDtl

Represents the search functionality configuration and the minimum number of optional verifiers for identity verification. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

IdentityVerificationProcDtl components have the suffix .IdentityVerificationProcDtl and are stored in the IdentityVerificationProcDtls folder.

## Version

IdentityVerificationProcDtl components are available in API version 54.0 and later.

## Special Access Rules

The Health Cloud permission set license is required to use this metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| apexClass | 
Field Type

string

Description

Reserved for future use.



 |
| dataSourceType | 

Field Type

IdentityVerificationDataSourceType (enumeration of type string)

Description

Required.

The source type of the data.

Valid values are:

- External—Reserved for future use.
- Salesforce





 |
| identityVerificationProcFlds | 

Field Type

[IdentityVerificationProcFld\[\]](#IdentityVerificationProcFld)

Description

A list of Identity Verification Process Field elements.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the record is active (true) or not (false).

The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required.

The label of the Identity Verification Process Detail record.



 |
| objectName | 

Field Type

string

Description

The name of the object on which the search is performed and data is verified.



 |
| optionalVerifiersMinVerfCount | 

Field Type

int

Description

The minimum number of optional verifiers that must be checked.



 |
| searchFilter | 

Field Type

string

Description

Conditions on which to filter the search results.

For example, if you want to perform the search only on Person Account records, enter isPersonAccount = true.



 |
| searchRecordUniqueIdField | 

Field Type

string

Description

The field that stores the unique identifier of the records that are displayed in the search results.



 |
| searchResultSortBy | 

Field Type

string

Description

The values that are used to sort the search results.

For example, if you want to sort the results by policy date, enter PolicyDate\_\_c Desc.



 |
| searchSequenceNumber | 

Field Type

int

Description

Required.

Enter 1 as the search sequence number.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

In API version 54.0 and later, this field is reserved for future use, and the value you enter doesn't affect sequencing.















 |
| searchType | 

Field Type

IdentityVerificationSearchType (enumeration of type string)

Description

Required.

The type of search being performed.

Valid values are:

- Object-Based—Reserved for future use.
- Text-Based





 |

## IdentityVerificationProcFld

Represents a set of fields necessary to configure the questions that CCA asks the caller before providing them with the information they need.

| Field Name | Description |
| --- | --- |
| customFieldLabel | 
Field Type

string

Description

The custom label for the field that contains the verification data.



 |
| dataSourceType | 

Field Type

IdentityVerificationProcFldDataSourceType (enumeration of type string)

Description

Required.

The source type of the data.

Valid values are:

- External
- Salesforce





 |
| developerName | 

Field Type

string

Description

Required.

The developer name of Identity Verification Process Field. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

Available in API version 58.0 and later.



 |
| fieldDataType | 

Field Type

IdentityVerificationProcFldFieldDataType (enumeration of type string)

Description

The data type of the field in the external data source that's defined in the identity verification process detail. Available in API version 58.0 and later.

Valid values are:

- address
- checkbox
- currency
- dateonly
- datetime
- email
- number
- other
- percent
- phone
- picklist
- reference
- text
- timeonly
- url





 |
| fieldName | 

Field Type

string

Description

Required.

The label of the field that contains the verification data based on the selected field type. Available in API version 58.0 and later.



 |
| fieldType | 

Field Type

IdentityVerificationProcFldFieldType (enumeration of type string)

Description

Required.

Indicates the type of field.

Valid values are:

- additionalResultField
- optionalVerifier
- requiredVerifier
- resultField
- searchField
- searchFilter





 |
| fieldValueFormula | 

Field Type

string

Description

Stores the formula that is applied to the field value.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the record is active (true) or not (false).



 |
| isManualInput | 

Field Type

boolean

Description

Indicates whether the user can manually enter the identity verification details (true) or not (false).

The default value of this field is false.

Available in API version 58.0 and later.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for Identity Verification Process Field.



 |
| sequenceNumber | 

Field Type

int

Description

Required.

The sequence number of the field.



 |

## Declarative Metadata Sample Definition

The following is an example of an identityVerificationProcDtl component.

<?xml version="1.0" encoding="UTF-8"?>
<IdentityVerificationProcDtl xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataSourceType\>Salesforce</dataSourceType\>
    <isActive\>true</isActive\>    <developerName\>Sample93AccountSearch</developerName\>
    <identityVerificationProcFlds\>
       <fullName\>Sample93AccountName</fullName\>
       <dataSourceType\>Salesforce</dataSourceType\>
       <developerName\>Sample93AccountName</developerName\>
       <fieldName\>Name</fieldName\>
       <fieldType\>requiredVerifier</fieldType\>
       <isActive\>false</isActive\>
       <masterLabel\>Sample93 Account Name</masterLabel\>
       <fieldValueFormula\>abcd</fieldValueFormula\>
       <customFieldLabel\>Name</customFieldLabel\>
       <sequenceNumber\>1</sequenceNumber\>
       <isManualInput\>false</isManualInput\>
    </identityVerificationProcFlds\>
    <identityVerificationProcFlds\>
       <fullName\>Sample93Phone</fullName\>
       <dataSourceType\>Salesforce</dataSourceType\>
       <developerName\>Sample93Phone</developerName\>
       <fieldName\>phone</fieldName\>
       <fieldType\>optionalVerifier</fieldType\>
       <isActive\>false</isActive\>
       <masterLabel\>Sample93 Phone</masterLabel\>
       <sequenceNumber\>93</sequenceNumber\>
       <isManualInput\>false</isManualInput\>
    </identityVerificationProcFlds\>
    <masterLabel\>detail1</masterLabel\>
     <fullName\>detail1</fullName\>
    <objectName\>Account</objectName\>
    <optionalVerifiersMinVerfCount\>11</optionalVerifiersMinVerfCount\>
    <searchFilter\>asd</searchFilter\>
    <searchRecordUniqueIdField\>Id</searchRecordUniqueIdField\>
    <searchResultSortBy\>asd</searchResultSortBy\>
    <searchSequenceNumber\>1</searchSequenceNumber\>
    <searchType\>Text-Based</searchType\>
</IdentityVerificationProcDtl\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>IdentityVerificationProcDtl</name\>
    </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=f9c86da4cff8274cac5db7b782e1aee96ebd5f28b7c0f550bf98ca7f14c59a70 url=/legacydeveloper/current/en-us/api_meta/meta_identityverificationprocfld.md -->

# IdentityVerificationProcFld

Represents the search and verification fields used in identity verification. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

IdentityVerificationProcFld components have the suffix .IdentityVerificationProcFld and are stored in the IdentityVerificationProcFlds folder.

## Version

IdentityVerificationProcFld components are available in API version 54.0 and later.

## Special Access Rules

The Health Cloud permission set license is required to use this metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| customFieldLabel | 
Field Type

string

Description

The custom label for the field that contains the verification data. Translation of custom field labels isn't supported in API version 54.0.



 |
| dataSourceType | 

Field Type

IdentityVerificationProcFldDataSourceType (enumeration of type string)

Description

Required.

The source type of the data.

Valid values are:

- External
    
    An external data source isn’t supported in API version 54.0.
- Salesforce





 |
| fieldDataType | 

Type

picklist

Properties

Filter, Group, Nillable, Restricted picklist, Sort

Description

The type of data stored in an external data source field.

Possible values are:

- address
- checkbox
- currency
- dateonly
- datetime
- email
- number
- other
- percent
- phone
- picklist
- reference
- text
- timeonly
- url





 |
| fieldName | 

Field Type

string

Description

Required.

The label of the field that contains the verification data based on the selected field type.



 |
| fieldType | 

Field Type

IdentityVerificationProcFldFieldType (enumeration of type string)

Description

Required.

Indicates the type of field.

Possible values are:

- additionalResultField—Fetches data as part of the search query, but the data isn’t displayed in search results. Use this value if, for example, you want to fetch the policy number and the age of the policy owner as a result of the search, but the agent isn’t supposed to see this data. You can write custom logic to process this additional data.
- optionalVerifier—Optional verifier.
- requiredVerifier—Required verifier.
- resultField—Displays field type in search results. Use this value if, for example, when an agent searches for a caller, you’d like the search results to include the account name, phone number, and email ID.
- searchField—Reserved for future use.
- searchFilter—A comma-separated list of predefined filter conditions that are used to refine the scope of the search.





 |
| fieldValueFormula | 

Field Type

string

Description

Reserved for future use.



 |
|  |  |
| isActive | 

Field Type

boolean

Description

Indicates whether the record is active (true) or not (false).

The default value is false.



 |
| isManualInput | 

Field Type

boolean

Description

Indicates whether the user can manually enter the identity verification details  (true) or not (false).

The default value is false.

This field is available in API version 58.0 and later.



 |
| masterLabel | 

Field Type

string

Description

Required.

The label of the Identity Verification Process Field record.



 |
| sequenceNumber | 

Field Type

int

Description

Required.

The sequence number of the field.



 |

## Declarative Metadata Sample Definition

The following is an example of an IdentityVerificationProcFld component.

<?xml version="1.0" encoding="UTF-8"?>
<IdentityVerificationProcFld xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <customFieldLabel\>field1</customFieldLabel\>
    <dataSourceType\>External</dataSourceType\>
    <fieldName\>sasa</fieldName\>
    <fieldType\>requiredVerifier</fieldType\>
     <fullName\>field1</fullName\>

    <isActive\>false</isActive\>
    <masterLabel\>field1</masterLabel\>
    <sequenceNumber\>1</sequenceNumber\>
</IdentityVerificationProcFld\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>IdentityVerificationProcFld</name\>
    </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=efb65cbc084f59d5fb423ede164af88f0f792c947c2cf6e0157ceae44bd49ec9 url=/legacydeveloper/current/en-us/api_meta/meta_iframewhitelisturlsettings.md -->

# IframeWhiteListUrlSettings

Represents settings related to the list of trusted external domains that you allow to frame your Visualforce pages or surveys. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

## File Suffix and Directory Location

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

## Version

[IframeWhiteListUrlSettings](#meta_iframewhitelisturlsettings "Represents settings related to the list of trusted external domains that you allow to frame your Visualforce pages or surveys. This type extends the Metadata metadata type and inherits its fullName field.") components are available in API version 49.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| iframeWhiteListUrls | [IframeWhiteListUrl](#IframeWhiteListUrl)\[\] | The list of external domains that you allow to frame your Visualforce pages or surveys. |

## IframeWhiteListUrl

Represents the external domains that you allow to frame your Visualforce pages or surveys.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d573721e160">Field Name</th>

              <th class="featureTableHeader  " id="d573721e163">Field Type</th>

              <th class="featureTableHeader  " id="d573721e166">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d573721e160" data-title="Field Name"><span class="keyword parmname">context</span></td>

              <td class="entry" headers="d573721e163" data-title="Field Type">IFrameWhitelistContext (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d573721e166" data-title="Description">Required. The type of content in the iframe. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">LightningOut</samp>—Reserved for future use.
                    Available in API version 60.0 and later
                  </li>

                  <li class="li"><samp class="codeph nolang">Surveys</samp></li>

                  <li class="li"><samp class="codeph nolang">VisualforcePages</samp></li>

                  <li class="li"><samp class="codeph nolang">DisclosureAndComplianceHubConnector</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d573721e160" data-title="Field Name"><span class="keyword parmname">url</span></td>

              <td class="entry" headers="d573721e163" data-title="Field Type">string</td>

              <td class="entry" headers="d573721e166" data-title="Description">The unique domain that is allowed to frame your Visualforce pages, surveys, or
                Disclosure and Compliance Hub Connector. Accepts these formats: <samp class="codeph nolang">example.com</samp>, <samp class="codeph nolang">*example.com</samp>, and <samp class="codeph nolang">https://example.com</samp>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a [IframeWhiteListUrlSettings](#meta_iframewhitelisturlsettings "Represents settings related to the list of trusted external domains that you allow to frame your Visualforce pages or surveys. This type extends the Metadata metadata type and inherits its fullName field.") component.

<?xml version="1.0" encoding="UTF-8"?>
<IframeWhiteListUrlSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <iframeWhiteListUrl\>
      <context\>Surveys></context\>
      <url\>example1.com</url\>
    </iframeWhiteListUrl\>
    <iframeWhiteListUrl\>
      <context\>VisualforcePages</context\>
      <url\>example2.com</url\>
     </iframeWhiteListUrl\>
     <iframeWhiteListUrl\>
        <context\>DisclosureAndComplianceHubConnector</context\>
        <url\>example3.com</url\>
     </iframeWhiteListUrl\>
</IframeWhiteListUrlSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
      <members\>IframeWhiteListUrlSettings</members\>
      <name\>IframeWhiteListUrlSettings</name\>
   </types\>
    <version\>62.0</version\>
</Package\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=c2ee69d48f9c72021018d5c8a82cd2f923af796e6d342f078dbe0f0416330f17 url=/legacydeveloper/current/en-us/api_meta/meta_inboundcertificate.md -->

# InboundCertificate

Represents a mutual authentication certificate that is imported to your Salesforce org.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

InboundCertificate components have the suffix .inboundCertificate and are stored in the inboundCertificates folder.

## Special Access Rules

InboundCertificate is available when the MutualAuthentication permission is enabled in your org.

## Version

InboundCertificate components are available in API version 49.0 and later.

## Fields

This metadata type contains the following fields:

| Field Name | Field Type | Description |
| --- | --- | --- |
| expirationDate | date | Required. The date on which the certificate expires. |
| issuer | string | Required. The certificate’s issuer. |
| masterLabel | string | Required. A friendly name that you create for the certificate. Limited to 64 characters. |
| serialId | string | Required. The serial number for the certificate. |

## Declarative Metadata Sample Definition

The following is an example of an InboundCertificate component.

<InboundCertificate xmlns="http://soap.sforce.com/2006/04/metadata">
    <expirationDate\>2021-02-04</expirationDate\>
    <issuer>C=USA,ST=CA,L=San Francisco,O=Salesforce.com,OU=00Dxx0000006Jm7,CN=newTestCert</issuer\>
    <masterLabel\>TestMutualAuthCert2</masterLabel\>
    <serialId\>29161320252531323757470546071624</serialId\>
</InboundCertificate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>InboundCertificate</name>
    </types>
    <version>49.0</version>
</Package>

## Usage

To prevent simple impersonation from compromising security, you can require clients and servers to prove their identity to each other with a mutual authentication certificate.

<!-- document id=eb7f7e65bd7967902d423f2b3b5e9d3dd82257368997710ba1a711cad12cfd13 url=/legacydeveloper/current/en-us/api_meta/meta_inboundnetworkconnection.md -->

# InboundNetworkConnection

Represents a private connection between a third-party data service and a Salesforce org. The connection is inbound because the callouts are coming _into_ Salesforce.This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

InboundNetworkConnection components have the suffix .inboundNetworkConnection and are stored in the inboundNetworkConnections folder.

## Version

InboundNetworkConnection components are available in API version 49.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d574737e88">Field Name</th>

              <th class="featureTableHeader  " id="d574737e91">Field Type</th>

              <th class="featureTableHeader  " id="d574737e94">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d574737e88" data-title="Field Name"><span class="keyword parmname">connectionType</span></td>

              <td class="entry" headers="d574737e91" data-title="Field Type">ExternalConnectionType (enumeration of type string)</td>

              <td class="entry" headers="d574737e94" data-title="Description">Required. Specifies the cloud provider of the connection. <a name="ul_hly_52w_sdc"><!-- --></a>
                <ul class="ul bulletList" id="ul_hly_52w_sdc">
                  <li class="li"><samp class="codeph nolang">AwsPrivateLink</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">DataCloudPrivateConnection</samp> (Reserved for
                    internal use)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d574737e88" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d574737e91" data-title="Field Type">string</td>

              <td class="entry" headers="d574737e94" data-title="Description">Required. A description of the connection. Maximum of 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d574737e88" data-title="Field Name"><span class="keyword parmname">inboundNetworkConnProperties</span></td>

              <td class="entry" headers="d574737e91" data-title="Field Type">InboundNetworkConnProperty</td>

              <td class="entry" headers="d574737e94" data-title="Description">Name-value pairs that describe the properties of the inbound network
                connection. Specify a name-value pair for each of the properties.</td>

            </tr>

            <tr>
              <td class="entry" headers="d574737e88" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d574737e91" data-title="Field Type">boolean</td>

              <td class="entry" headers="d574737e94" data-title="Description">Required. Specifies whether the connection is active (<samp class="codeph nolang">true</samp>) or not(<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d574737e88" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d574737e91" data-title="Field Type">string</td>

              <td class="entry" headers="d574737e94" data-title="Description">Required. A user-friendly label for the connection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d574737e88" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d574737e91" data-title="Field Type">ExternalConnectionStatus​(enumeration of type string)</td>

              <td class="entry" headers="d574737e94" data-title="Description">Required. Connection status. The connection is initially Unprovisioned and
                moves through the other states automatically after an admin performs a Provision,
                Sync, or Teardown action. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Unprovisioned</samp></li>

                  <li class="li"><samp class="codeph nolang">Allocating</samp></li>

                  <li class="li"><samp class="codeph nolang">PendingAcceptance</samp></li>

                  <li class="li"><samp class="codeph nolang">PendingActivation</samp></li>

                  <li class="li"><samp class="codeph nolang">RejectedRemotely</samp></li>

                  <li class="li"><samp class="codeph nolang">DeletedRemotely</samp></li>

                  <li class="li"><samp class="codeph nolang">TeardownInProgress</samp></li>

                  <li class="li"><samp class="codeph nolang">Ready</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## InboundNetworkConnProperty

Represents a name-value pair that describes the properties of the inbound network connection.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d574737e262">Field Name</th>

              <th class="featureTableHeader  " id="d574737e265">Field Type</th>

              <th class="featureTableHeader  " id="d574737e268">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d574737e262" data-title="Field Name"><span class="keyword parmname">propertyName</span></td>

              <td class="entry" headers="d574737e265" data-title="Field Type">InboundConnPropertyName​(enumeration of type string)</td>

              <td class="entry" headers="d574737e268" data-title="Description">Required. The name of a property used to establish an InboundNetworkConnection.
                Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AwsVpcEndpointId</samp>—The unique endpoint ID
                    for connections to an AWS Virtual Private Cloud (VPC). The value is read-only
                    when the <span class="keyword parmname">status</span> is <samp class="codeph nolang">Ready</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Region</samp>—The region in which the VPC is
                    hosted.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SourceIpRanges</samp>—The ranges of source IP
                    address allocated to this inbound connection by the Salesforce-managed VPC in
                    your cloud provider.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d574737e262" data-title="Field Name"><span class="keyword parmname">propertyValue</span></td>

              <td class="entry" headers="d574737e265" data-title="Field Type">string</td>

              <td class="entry" headers="d574737e268" data-title="Description">Required. The value of InboundConnPropertyName. An example of the
                <span class="keyword parmname">propertyValue</span> of <samp class="codeph nolang">Region</samp>
                is <samp class="codeph nolang">us-west-2.</samp>
                <div class="p">The
                  <span class="keyword parmname">propertyValue</span> of <samp class="codeph nolang">SourceIpRanges</samp> is a JSON string that lists the start and end IP
                  address for each range. This example shows two IP address
                  ranges.<div class="codeSection nolang">
                    <pre class="codeblock nolang">[
  {
    "startIp":"10.10.10.0",
    "endIp":"10.10.10.3"
  },
  {
    "startIp":"100.100.100.0",
    "endIp":"100.100.100.15"
  }
]</pre>
                  </div>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following sample definition has the suffix .inboundNetworkConnection.

<?xml version="1.0" encoding="UTF-8"?>
<InboundNetworkConnection xmlns="http://soap.sforce.com/2006/04/metadata">
    <connectionType\>AwsPrivateLink</connectionType\>
    <description\>This is an Inbound Connection to make API calls into Salesforce</description\>
    <inboundNetworkConnProperties\>
        <propertyName\>Region</propertyName\>
        <propertyValue\>us-west-2</propertyValue\>
    </inboundNetworkConnProperties\>
    <inboundNetworkConnProperties\>
        <propertyName\>AwsVpcEndpointId</propertyName\>
        <propertyValue\>vpce-02ccb5fac2bacaceb</propertyValue\>
    </inboundNetworkConnProperties\>
    <inboundNetworkConnProperties\>
        <propertyName\>SourceIpRanges</propertyName\>
        <propertyValue\>\[ { "startIp":"10.10.10.0", "endIp":"10.10.10.3" }, { "startIp":"100.100.100.0", "endIp":"100.100.100.15" } \]</propertyValue\>
    </inboundNetworkConnProperties\>
    <isActive\>true</isActive\>
    <label\>MyInboundConnection</label\>
    <status\>Unprovisioned</status\>
</InboundNetworkConnection\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>sampleInboundConnection</fullName\>
    <types\>
        <members\>MyInboundConnection</members\>
        <name\>InboundNetworkConnection</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e55359a77f2bc219ccc197271ce9d6dfab9599cc780f1beec840454904969e61 url=/legacydeveloper/current/en-us/api_meta/meta_incidentmgmtsettings.md -->

# IncidentMgmtSettings

Represents settings for Customer Service Incident Management and Broadcast Communications.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

IncidentMgmtSettings values are stored in the IncidentMgmt.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

IncidentMgmtSettings components are available in API version 54.0 and later.

## Special Access Rules

IncidentMgmtSettings requires a Service Cloud license.

## Fields

| Field Name | Description |
| --- | --- |
| enableAiKnowledgeCreation | 
Field Type

boolean

Description

Indicates whether the ITSM Knowledge Creation feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 65.0 and later.



 |
| enableAlertBroadcastType | 

Field Type

boolean

Description

Indicates whether broadcast communication alerts are enabled (true) or disabled (false) for your org. Lets incident managers send disruptive in-app notifications when an incident occurs. The default value is false. Available in API version 57.0 and later.



 |
| enableAutoClosureOfChildIncident | 

Field Type

boolean

Description

Indicates whether the Automatically Close Child Incidents feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableAutoCreationOfProblem | 

Field Type

boolean

Description

Indicates whether the automatic creation of problem record feature is enabled (true) or disabled (false) for your org. This setting automates creation of a problem record when an incident is approved as a major incident. The default value is false. Available in API version 64.0 and later.



 |
| enableChangePriorityMatrix | 

Field Type

boolean

Description

Indicates whether the Automatic Priority Assignment for IT Service feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 65.0 and later.



 |
| enableChangePriorityOverride | 

Field Type

boolean

Description

Indicates whether the Manual Priority Override feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 65.0 and later.



 |
| enableChangeRequestValidations | 

Field Type

boolean

Description

Indicates whether the Change Request Validations feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableChatToIncidentAi | 

Field Type

boolean

Description

Indicates whether the Chat and Voice to Incident with Al feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableCnfgItemCopyForRecords | 

Field Type

boolean

Description

Indicates whether the feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableDedupE2IncidentAttachment | 

Field Type

boolean

Description

Indicates whether the delete duplicate email attachments feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableEmailBroadcastType | 

Field Type

boolean

Description

Indicates whether broadcast communication emails are enabled (true) or disabled (false) for your org. Lets users send an email with critical information to impacted customers. The default value is false. Available in API version 56.0 and later.



 |
| enableEmailToIncident | 

Field Type

boolean

Description

Indicates whether the Email-to-Incident feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableEmailToIncidentAi | 

Field Type

boolean

Description

Indicates whether the Email-to-Incident with Al feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableITSMChangeMgmt | 

Field Type

boolean

Description

Indicates whether the ITSM Change Management feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 63.0 and later.



 |
| enableITSMIncidentMgmt | 

Field Type

boolean

Description

Indicates whether the ITSM Incident Management feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 63.0 and later.



 |
| enableITSMMajorIncParent | 

Field Type

boolean

Description

Indicates whether the Major Incident Management Parent Incident feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableITSMProblemMgmt | 

Field Type

boolean

Description

Indicates whether the ITSM Problem Management feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 63.0 and later.



 |
| enableIncPriorityMatrix | 

Field Type

boolean

Description

Indicates whether the Automatic Priority Assignment for IT Service feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 65.0 and later.



 |
| enableIncPriorityOverride | 

Field Type

boolean

Description

Indicates whether the Manual Priority Override for Incident feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 65.0 and later.



 |
| enableIncidentMgmt | 

Field Type

boolean

Description

Indicates whether Customer Service Incident Management is enabled (true) or disabled (false) for your org. Customer Service Incident Management is a Service Cloud solution that helps your teams track large-scale disruptions and delegate tasks to the right experts to ensure that your business delivers on customer expectations. The default value is true. Available in API version 54.0 and later.



 |
| enableIncidentValidations | 

Field Type

boolean

Description

Indicates whether the Incident Field Validations feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableProbPriorityMatrix | 

Field Type

boolean

Description

Indicates whether the Automatic Priority Assignment for IT Service feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 65.0 and later.



 |
| enableProbPriorityOverride | 

Field Type

boolean

Description

Indicates whether the Manual Priority Override feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 65.0 and later.



 |
| enableProblemValidations | 

Field Type

boolean

Description

Indicates whether the Problem Field Validations feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableRiskAssessment | 

Field Type

boolean

Description

Indicates whether the Risk Assessment feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableSaveE2IncidentAttachment | 

Field Type

boolean

Description

Indicates whether the Save Email to Incident Attachment feature is enabled (true) or disabled (false) for your org. The default value is false. Available in API version 64.0 and later.



 |
| enableSiteBannerBroadcastType | 

Field Type

boolean

Description

Indicates whether broadcast communication for site banners is enabled (true) or disabled (false) for your org. Lets users add a banner with critical information to your Aura and LWR sites. The default value is false. Available in API version 56.0 and later.



 |
| enableSlackBroadcastType | 

Field Type

boolean

Description

Indicates whether broadcast communication Slack messages are enabled (true) or disabled (false) for your org. Lets incident managers send broadcasts to Slack when an incident occurs. The default value is false. Available in API version 57.0 and later.



 |

## Declarative Metadata Sample Definition

The following is an example of an IncidentMgmtSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<IncidentMgmtSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableAiKnowledgeCreation\>true</enableAiKnowledgeCreation\>
	<enableAlertBroadcastType\>false</enableAlertBroadcastType\>
	<enableAutoClosureOfChildIncident\>true</enableAutoClosureOfChildIncident\>
	<enableAutoCreationOfProblem\>false</enableAutoCreationOfProblem\>
	<enableChangePriorityMatrix\>true</enableChangePriorityMatrix\>
	<enableChangePriorityOverride\>false</enableChangePriorityOverride\>
	<enableChangeRequestValidations\>true</enableChangeRequestValidations\>
	<enableChatToIncidentAi\>true</enableChatToIncidentAi\>
	<enableCnfgItemCopyForRecords\>false</enableCnfgItemCopyForRecords\>
	<enableDedupE2IncidentAttachment\>true</enableDedupE2IncidentAttachment\>
	<enableEmailBroadcastType\>true</enableEmailBroadcastType\>
	<enableEmailToIncident\>true</enableEmailToIncident\>
	<enableEmailToIncidentAi\>false</enableEmailToIncidentAi\>
	<enableITSMChangeMgmt\>true</enableITSMChangeMgmt\>
	<enableITSMIncidentMgmt\>true</enableITSMIncidentMgmt\>
	<enableITSMMajorIncParent\>true</enableITSMMajorIncParent\>
	<enableITSMProblemMgmt\>false</enableITSMProblemMgmt\>
	<enableIncPriorityMatrix\>true</enableIncPriorityMatrix\>
	<enableIncPriorityOverride\>false</enableIncPriorityOverride\>
	<enableIncidentMgmt\>true</enableIncidentMgmt\>
	<enableIncidentValidations\>true</enableIncidentValidations\>
	<enableProbPriorityMatrix\>true</enableProbPriorityMatrix\>
	<enableProbPriorityOverride\>false</enableProbPriorityOverride\>
	<enableProblemValidations\>true</enableProblemValidations\>
	<enableRiskAssessment\>true</enableRiskAssessment\>
	<enableSaveE2IncidentAttachment\>true</enableSaveE2IncidentAttachment\>
	<enableSiteBannerBroadcastType\>false</enableSiteBannerBroadcastType\>
	<enableSlackBroadcastType\>true</enableSlackBroadcastType\>
</IncidentMgmtSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>IncidentMgmt</members\>
        <name\>Settings</name\>
    </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=486fdf420041e62ef1a980b720b17428be472b147d93d19b0066d9c44e722c89 url=/legacydeveloper/current/en-us/api_meta/meta_index.md -->

# Index

Represents an index defined within a custom [big object](https://developer.salesforce.com/docs/atlas.en-us.264.0.bigobjects.meta/bigobjects/big_object.htm). Use this metadata type to define the composite primary key (index) for a custom big object. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

Indexes are user-defined and are part of the custom object definition for big objects. See [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/customobject.htm) for more information.

## Version

The Index type is available in API version 41.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| fields | IndexField\[\] | The definition of the fields in the index. |
| label | string | Required. This name is used to refer to the big object in the user interface. Available in API version 41.0 and later. |

## IndexField

Defines which fields make up the index, their order, and sort direction. The order in which the fields are defined determines the order fields are listed in the index.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d578207e153">Field Name</th>

              <th class="featureTableHeader  " id="d578207e156">Field Type</th>

              <th class="featureTableHeader  " id="d578207e159">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d578207e153" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d578207e156" data-title="Field Type">string</td>

              <td class="entry" headers="d578207e159" data-title="Description">Required. The API name for the field that’s part of the index. This value must
                match the <samp class="codeph nolang">fullName</samp> value for the corresponding
                field in the fields section and be marked as required.<p class="p">It's important to note that
                  when querying a big object record via SOQL and passing the results as arguments to
                  the delete API, if any index field name has a leading or trailing white space, you
                  can't delete the big object record.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578207e153" data-title="Field Name"><span class="keyword parmname">sortDirection</span></td>

              <td class="entry" headers="d578207e156" data-title="Field Type">string</td>

              <td class="entry" headers="d578207e159" data-title="Description">Required. The sort direction of the field in the index. Valid values are
                <samp class="codeph nolang">ASC</samp> for ascending order and <samp class="codeph nolang">DESC</samp> for descending order.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an index contained within the definition of a custom big object, Customer\_Interactions\_\_b.object.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">

    <deploymentStatus\>Deployed</deploymentStatus\>

// Define the fields within the big object
    <fields\>
        <fullName\>Purchase\_\_c</fullName\>
        <label\>Purchase</label\>
        <length\>16</length\>
        <required\>false</required\>
        <type\>Text</type\>
        <unique\>false</unique\>
    </fields\>
    
    <fields\>
        <fullName\>Order\_Number\_\_c</fullName\>
        <label\>Order Number</label\>
        <length\>16</length\>
        <required\>false</required\>
        <type\>Text</type\>
        <unique\>true</unique\>
    </fields\>
    
    <fields\>
        <fullName\>Platform\_\_c</fullName\>
        <label\>Platform</label\>
        <length\>16</length\>
        <required\>true</required\>
        <type\>Text</type\>
        <unique\>false</unique\>
    </fields\>

    <fields\>
        <fullName\>Account\_\_c</fullName\>
        <label\>User Account</label\>
        <referenceTo\>Account</referenceTo\>
        <relationshipName\>User\_Account</relationshipName\>
        <required\>true</required\>
        <type\>Lookup</type\>
    </fields\>

    <fields\>
        <fullName\>Order\_Date\_\_c</fullName\>
        <label\>Order Date</label\>
        <required\>true</required\>
        <type\>DateTime</type\>
    </fields\>

// Define the index
    <indexes\>
        <fullName\>CustomerInteractionsIndex</fullName\>
        <label\>Customer Interactions Index</label\>
        <fields\>
            <name\>Account\_\_c</name\>
            <sortDirection\>DESC</sortDirection\>
        </fields\>
        <fields\>
            <name\>Platform\_\_c</name\>
            <sortDirection\>ASC</sortDirection\>
        </fields\>
        <fields\>
            <name\>Order\_Date\_\_c</name\>
            <sortDirection\>DESC</sortDirection\>
        </fields\>
    </indexes\>
    
    <label\>Customer Interaction</label\>
    <pluralLabel\>Customer Interactions</pluralLabel\>
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_historyretentionpolicy.htm "HistoryRetentionPolicy")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listview.htm "ListView")

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")
- [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.")

<!-- document id=98d130607190abe2b711c52e0078f6c93abd53a677d18cbd9367b3bf80fe3aa7 url=/legacydeveloper/current/en-us/api_meta/industrieseinsteinfeaturesettings_metadata_api.md -->

# IndustriesEinsteinFeatureSettings

Represents the settings for enabling the Industries Einstein feature.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details.

## File Suffix and Directory Location

IndustriesEinsteinFeatureSettings values are stored in a single file named IndustriesEinsteinFeature.settings in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

IndustriesEinsteinFeatureSettings components are available in API version 57.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| documentReaderConfidenceOrgValue | 
Field Type

double

Description

Required.

Specify the confidence score threshold to indicate the reliability of data in a document. You can enter a number from 0 to 100, with up to two decimal places, where 0 is the least confident and 100 is the most confident.





 |

## Declarative Metadata Sample Definition

The following is an example of a IndustriesEinsteinFeatureSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<IndustriesEinsteinFeatureSettings xmlns="http://soap.sforce.com/2006/04/metadata">
   <documentReaderConfidenceOrgValue\>61</documentReaderConfidenceOrgValue\>
</IndustriesEinsteinFeatureSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types\>
    <members\>IndustriesEinsteinFeature</members\>
    <name\>Settings</name\>
  </types\>
  <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=bdb7c0192c627b5de52a53a46db73c66b8e4356d651b4cb8f3681617ebc20aba url=/legacydeveloper/current/en-us/api_meta/industriesloyaltysettings_metadata_api.md -->

# IndustriesLoyaltySettings

Represents the settings to enable capabilities of Loyalty Management.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

[Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") fullName

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details.

## File Suffix and Directory Location

IndustriesLoyaltySettings values are stored in a single file named IndustriesLoyalty.settings in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

IndustriesLoyaltySettings components are available in API version 53.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableAutomaticMemberTierAssessmentSelection | boolean | Indicates whether the capability that automatically selects members as eligible for tier assessment when members’ qualifying points balance changes is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 58.0 or later. |
| enableAutomaticVoucherCodeGeneration | boolean | Indicates whether the capability to automatically generate voucher codes is enabled (true) or not (false). This field is available in API version 57.0 and later. |
| enableConfigureClubs | boolean | Indicates whether the capability to create and manage clubs is enabled (true) or not (false). The default value is false. This field is available in API version 64.0 or later. |
| enableFixedTypeNQPAggregation | boolean | Indicates whether the capability to aggregate and expire fixed type non-qualifying points in batches is enabled (true) or disabled (false) for your org. The default value is true. This field is available in API version 54.0 or later. |
| enableLoyaltyApiAccessForExternalSiteUsers | boolean | Indicates whether the capability that allows customers to join and leave loyalty programs and allows members to join and opt out of promotions from Experience Cloud sites is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 58.0 or later. |
| enableLoyaltyActivityNQPTrace | boolean | Indicates whether the capability to asynchronously create traces that map credit transactions to redemption transactions for non-qualifying points (NQP) using the activity-based expiration model is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 62.0 or later. |
| enableLoyaltyGenerativeAi | boolean | Indicates whether the Einstein AI capabilities of Loyalty Management are enabled (true) or not (false). The default value is false. This field is available in API version 62.0 or later. |
| enableLoyaltyRedeemedPointsExpirationInfoPref | boolean | Indicates whether the capability that automatically calculates and adds the expiration date of points credited back to members for canceled redemptions is enabled (true) or disabled (false) for your org. The default value is true. This field is available in API version 55.0 or later. |
| enableLoyaltyRulesVerifyCdpMemberSegment | boolean | The default value is false. This field is available in API version 55.0 or later. |
| enableLoyaltyServiceExcellence | boolean | Indicates whether Service Console for Loyalty Management is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 57.0 or later. |
| enableNegativePointBalance | boolean | Indicates whether the capability that lets loyalty program members to hold negative point balances for non-qualifying currencies is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 61.0 or later. |
| enableNonQualifyingPointsConsolidation | boolean | Indicates whether the capability to aggregate and expire fixed type non-qualifying points in real time is enabled (true) or disabled (false) for your org. The default value is true. This field is available in API version 58.0 or later. |
| enablePointsLifecycleTracking | boolean | Indicates whether the capability that allows the company to trace how members redeem their accrued fixed-model non-qualifying points is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 62.0 or later. |
| enableProcessTraceableTrxnAsync | boolean | Indicates whether the capability to process traceable transactions asynchronously is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 67.0 or later. |
| enablePromSetupProcRuleStatusInheritDplymt | boolean | Indicates whether the capability, which allows Promotion Setup processes and rules to be deployed to target orgs in the same status as the source orgs when using the LoyaltyProgramSetup metadata type, is enabled (true) or disabled (false). The default value is false. This field is available in API version 62.0 or later. |
| enableQPRealTimePointBalance | boolean | Indicates whether the real time qualifying points balance update capability is enabled (true) or disabled (false) for your org. The default value is true. This field is available in API version 55.0 or later. |
| enableNQPRealTimePointBalance | boolean | Indicates whether the capability to update the non-qualifying point balance of members in real time is enabled (true) or disabled (false) for your org. The default value is true. |
| enableSegmentQueryApiMultipleDataSpace | boolean | Indicates whether the capability that allows Query API to verify the Data Cloud segments that customers are part of across multiple data spaces is enabled (true) or not (false). The default value is false. This field is available in API version 64.0 or later. |
| enableSegmentQueryByDataGraph | boolean | Indicates whether the capability, which uses Data Cloud data graphs to query for Data Cloud segments that customers are part of, is enabled (true) or disabled (false). The default value is false. This field is available in API version 62.0 or later. |
| enableTransferPointsToMemberGroupsRealtime | boolean | Indicates whether the capability that automates real-time transfer of a member's non-qualifying points to associated group is enabled (true) or not (false). The default value is false. This field is available in API version 64.0 or later. |
| enableUsePromPtyUsageForEngmtTrail | boolean | Indicates whether the capability that uses Promotion Party Usage records to store attributes for Engagement Trail promotions is enabled (true) or not (false). The default value is true. This field is available in API version 64.0 or later. |

Indicates whether the capability that allows:

- Loyalty program process rules to process transaction journals only when the loyalty program member is part of a Data Cloud segment associated with the rule's promotion is enabled (true) or disabled (false) for your org.
- The Promotion Eligibility component on Loyalty Program Member record page to categorize promotions based on whether the member belongs to the promotion’s campaign or Data Cloud segment is enabled (true) or disabled (false) for your org.

## Declarative Metadata Sample Definition

The following is an example of a IndustriesLoyaltySettings component.

<?xml version="1.0" encoding="UTF-8"?>
<IndustriesLoyaltySettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableNQPRealTimePointBalance\>true</enableNQPRealTimePointBalance\>
    <enableFixedTypeNQPAggregation\>true</enableFixedTypeNQPAggregation\>
    <enableQPRealTimePointBalance\>true</enableQPRealTimePointBalance\>
    <enableLoyaltyRulesVerifyCdpMemberSegment\>false</enableLoyaltyRulesVerifyCdpMemberSegment\>
    <enableLoyaltyRedeemedPointsExpirationInfoPref\>true</enableLoyaltyRedeemedPointsExpirationInfoPref\>
    <enableLoyaltyServiceExcellence\>true</enableLoyaltyServiceExcellence\>
    <enableAutomaticVoucherCodeGeneration\>true</enableAutomaticVoucherCodeGeneration\>
    <enableLoyaltyApiAccessForExternalSiteUsers\>false</enableLoyaltyApiAccessForExternalSiteUsers\>
    <enableAutomaticMemberTierAssessmentSelection\>false</enableAutomaticMemberTierAssessmentSelection\>
    <enableNonQualifyingPointsConsolidation\>false</enableNonQualifyingPointsConsolidation\>
    <enablePointsLifecycleTracking\>false</enablePointsLifecycleTracking\>
    <enableProcessTraceableTrxnAsync\>false</enableProcessTraceableTrxnAsync\>
    <enableNegativePointBalance\>false</enableNegativePointBalance\>
    <enableSegmentQueryByDataGraph\>false</enableSegmentQueryByDataGraph\>
    <enablePromSetupProcRuleStatusInheritDplymt\>false</enablePromSetupProcRuleStatusInheritDplymt\>
    <enableLoyaltyGenerativeAi\>false</enableLoyaltyGenerativeAi\>
    <enableTransferPointsToMemberGroupsRealtime\>false</enableTransferPointsToMemberGroupsRealtime\>
    <enableUsePromPtyUsageForEngmtTrail\>false</enableUsePromPtyUsageForEngmtTrail\>
    <enableSegmentQueryApiMultipleDataSpace\>true</enableSegmentQueryApiMultipleDataSpace\>
    <enableConfigureClubs\>true</enableConfigureClubs\>
</IndustriesLoyaltySettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types\>
    <members\>IndustriesLoyalty</members\>
    <name\>Settings</name\>
  </types\>
  <version\>53.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=dc97c02b8222420b09822fe8d1c04ed6dee741c9b74d6e39a7ad10efd2881faa url=/legacydeveloper/current/en-us/api_meta/meta_industriespricingsettings.md -->

# IndustriesPricingSettings

Represents the settings for Salesforce Pricing.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details.

## File Suffix and Directory Location

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

## Version

IndustriesPricingSettings components are available in API version 60.0 and later.

## Special Access Rules

This metadata type is available with Salesforce Pricing.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableDebugPriceLogs | boolean | Indicates whether to use price logs to diagnose and resolve pricing issues (true) or not (false). The default value is false. Available in API version 63.0 and later. |
| enableHighAvailability | boolean | Reserved for internal use. |
| enableHighestPriceCompliance | boolean | Indicates whether to track the maximum price of a product over a period of 30 days (true) or not (false). The default value is false. Available in API version 64.0 and later. |
| enableLowestPriceCompliance | boolean | Indicates whether to track the minimum price of a product over a period of 30 days (true) or not (false). The default value is false. Available in API version 62.0 and later. |
| enablePricingProcParallelization | boolean | Indicates whether to run pricing elements in parallel within a pricing procedure to optimize the performance of the pricing execution process (true) or not (false). The default value is false. Available in API version 64.0 and later. |
| enablePricingWaterfall | boolean | Indicates whether to enable Price Waterfall (true) or not (false). The default value is false. Price Waterfall provides insights that include price breakups and reasons for every step of the pricing process. |
| enablePricingWaterfallPersistence | boolean | Indicates whether to enable Price Waterfall Persistence (true) or not (false). The default value is false. Price Waterfall Persistence stores the process logs that provide insights into the internal pricing processes. |
| enableSalesforcePricing | boolean | Indicates whether to enable Salesforce Pricing (true) or not (false). The default value is false. |

## Declarative Metadata Sample Definition

This example shows a sample IndustriesPricingSettings component.

<IndustriesPricingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
     <enableDebugPriceLogs\>true</enableDebugPriceLogs\>
     <enableHighAvailability\>true</enableHighAvailability\>
     <enableHighestPriceCompliance\>true</enableHighestPriceCompliance\>
     <enableLowestPriceCompliance\>true</enableLowestPriceCompliance\>
     <enablePricingProcParallelization\>true</enablePricingProcParallelization\>
     <enablePricingWaterfall\>true</enablePricingWaterfall\>
     <enablePricingWaterfallPersistence\>true</enablePricingWaterfallPersistence\>
     <enableSalesforcePricing\>true</enableSalesforcePricing\>
</IndustriesPricingSettings\>

This example shows a sample package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>IndustriesPricing</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)"). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=934d88a4f6b9e7130b243aaeee05b09b8eeba4d4904caea901abfda81d9c811b url=/legacydeveloper/current/en-us/api_meta/meta_industriesratingsettings.md -->

# IndustriesRatingSettings

Represents the settings for Rate Management.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details.

## File Suffix and Directory Location

The IndustriesRatingSettings values are stored in the IndustriesRating.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

IndustriesRatingSettings components are available in API version 62.0 and later.

## Special Access Rules

This metadata type is available with Rate Management.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableRating | boolean | Indicates whether to enable Rate Management (true) or not (false). The default value is false. |
| enableRatingWaterfall | boolean | Indicates whether to enable Rating Waterfall (true) or not (false). The default value is false. Rating Waterfall provides insights into the rating data, which you can synchronize with your rating lookup tables. |
| enableRatingWaterfallPersistence | boolean | Indicates whether to enable Rating Waterfall Persistence (true) or not (false). The default value is false. Rating Waterfall Persistence stores rating data, which you can use to enhance the internal processes and increase efficiency. |

## Declarative Metadata Sample Definition

The following is an example of an IndustriesRatingSettings component.

<IndustriesRatingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
     <enableRating\>true</enableRating\>
     <enableRatingWaterfall\>true</enableRatingWaterfall\> 
     <enableRatingWaterfallPersistence\>true</enableRatingWaterfallPersistence\>
</IndustriesRatingSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>IndustriesRating</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)"). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=63d44ada17d6be9e642e3185c62040d9a7f909d5930f958c4d5ede26b5a24652 url=/legacydeveloper/current/en-us/api_meta/meta_industriessettings.md -->

# IndustriesSettings

Represents settings for industries verticals such as Financial Services Cloud, Consumer Goods Cloud, Public Sector Solutions, Education Cloud, Salesforce Scheduler, Life Sciences Cloud, and Health Cloud.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

IndustriesSettings are stored in a single file named Industries.settings in the settings directory.

## Version

Industries settings are available in API version 47.0 and later.

Industries settings for Public Sector Solutions features are available in API version 57.0 and later.

## Special Access Rules

Settings are specific to an industry vertical and are only available to customers with org editions where the vertical is enabled.

Users need the FSC Insurance permission set to access the settings available in editions with Financial Services Cloud.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d578795e122">Field Name</th>

              <th class="featureTableHeader  " id="d578795e125">Field Type</th>

              <th class="featureTableHeader  " id="d578795e128">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">allowBenefitAssignmentWithInactiveProgramEnrollment</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether benefit assignment is
                allowed when the associated program enrollment is inactive. The default is <samp class="codeph nolang">false</samp>. This field is available in API version 65.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">allowMultipleProducersToWorkOnSamePolicy</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether multiple producers can be assigned to the same insurance
                policy. The default is <samp class="codeph nolang">false</samp>. This field is
                available in editions where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">brwrCntctFrExtrnlSrcsPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether borrower contact information can be sourced from external
                systems (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, this setting allows the system
                to retrieve and update borrower contact details from integrated external data
                sources. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">collectionAsaAgentPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Collection as an Agent preference is enabled for your org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This setting controls collection agent capabilities and
                workflows. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">clctnAndRecoveryAgntPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Collections and Recovery Agent feature is enabled for
                your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, this feature allows users to
                manage debt collection processes and recovery workflows. The default value is
                <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">createCustomerPropertyFromLAProperty</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. When importing loan application data, indicates whether to create a customer
                property record from a loan application property record to represent the new
                home.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">createFinancialAccountFromLAAsset</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. When importing loan application data, indicates whether to create financial
                account records from the assets listed in the loan application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">createFinancialAccountFromLALiability</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. When importing loan application data, indicates whether to create financial
                account records from the liabilities listed in the loan application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">createFinancialAccountsFromLAFinancials</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. When importing loan application data, indicates whether to create a financial
                account record that represents the mortgage loan.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">createFinancialAccountsFromLAProperty</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. When importing loan application data, indicates whether to create a financial
                account record from the loan application property to represent the new home.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">createFSCAssetFromLAAsset</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. When importing loan application data, indicates whether to create asset records
                from the assets listed in the loan application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">createFSCAssetFromLAProperty</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. When importing loan application data, indicates whether to create an asset
                record from a loan application property record to represent the new home that was
                acquired.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">createFSCLiabilityFromLAFinancial</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. When importing loan application data, indicates whether to create a liability
                record from a loan application property record to represent the new mortgage
                loan.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">createFSCLiabilityFromLALiability</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. When importing loan application data, indicates whether to create liability
                records from the liabilities listed in the loan application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAccessToMasterListOfCoverageTypes</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether insurance agents can access the main list of coverage types.
                The default is <samp class="codeph nolang">false</samp>. This field is available
                in editions where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAccountScoreEnabled</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Account Scoring is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, this feature provides scoring and rating
                capabilities for financial services accounts, helping relationship managers
                prioritize engagement and identify growth opportunities. The default value is
                <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableB2B</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Business-to-Business (B2B) capabilities are enabled for
                Financial Services Cloud (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, this feature provides tools and
                data models for managing B2B financial services relationships, including business
                accounts, commercial lending, and corporate banking. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableB2BAccountPlan</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether B2B Account Planning is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This feature enables relationship managers to create and manage
                strategic account plans for business clients, including growth strategies,
                cross-sell opportunities, and relationship mapping. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableB2BEinstein</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Einstein AI features for B2B Financial Services are enabled
                for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This feature provides AI-powered insights,
                recommendations, and predictive analytics for B2B financial services relationships.
                The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCallReportAdminContextPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether admins can configure the Account Interactions component and
                use a component attribute to control whether end users can view data on the
                component with admin privileges (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCalculationUsingParentPolicyOnly</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the policy premiums are calculated by using only the parent
                policy's premium (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Use this for hierarchical policies where
                premiums are stored at different levels. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCollectionFLowOps</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Collection Flow Operations are enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, this feature provides automated workflows for
                managing collection processes, including dunning, payment plans, and recovery
                actions. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCollectionRiskScoringCFE</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Collection Risk Scoring with Credit and Financial Engine is
                enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This feature enables AI-powered risk
                assessment for collection accounts to prioritize recovery efforts. The default value
                is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCollectionTimeline</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Collection Timeline feature is enabled for your org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, users can view a chronological timeline of
                collection activities, communications, and payment history for accounts in
                collections. The default value is <samp class="codeph nolang">false</samp>. This
                field is available in editions where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCompliantDataSharingForInteraction</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether compliant data sharing is enabled for the Interaction object
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableClaimMgmt</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the recording and processing of the first loss notifications
                and managing claim participants, coverages, and settlements are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCompliantDataSharingForAccount</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Compliant Data Sharing feature is enabled for the Account
                object. The default is <samp class="codeph nolang">false</samp>. This field is
                available in editions where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCompliantDataSharingForCustomObjects</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Compliant Data Sharing feature is enabled for custom
                objects (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. This field is available in editions where
                Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCompliantDataSharingForOpportunity</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Compliant Data Sharing feature is enabled for the
                Opportunity object (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. This field is available in editions where
                Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCompliantDataSharingForInteractionSummary</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Compliant Data Sharing is enabled for the Interaction Summary
                object (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableDealManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Financial Deal Management feature is enabled. The default
                is <samp class="codeph nolang">false</samp>. This field is available in editions
                where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableDigitalLendingPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Digital Lending capabilities are enabled for your org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, this feature provides a comprehensive digital
                lending platform including online applications, automated underwriting, document
                management, and loan servicing capabilities. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableDigitalLendingReadOnlyOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Digital Lending is enabled in read-only mode for your org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, users can view Digital Lending data and reports
                but cannot create or modify loan applications or lending workflows. The default
                value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableDiscoveryFrameworkMetadata</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Assessment Question and Assessment Question Set features
                of the Discovery Framework Metadata are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableEinsteinDocReaderMappings</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Intelligent Form Reader Mappings feature is enabled. The
                default is <samp class="codeph nolang">false</samp>. </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableEnhancedQuestionCreation</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Enhanced Question Creation Experience feature of the
                Discovery Framework is enabled <samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableFinancialAccountMgmt</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Financial Account Management Standard Objects setting is
                enabled for your org. The default is <samp class="codeph nolang">false</samp>.
                This field is available in editions where Financial Services Cloud is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableFinancialDealRoleHierarchy</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether data sharing for the financial deals is configured to follow
                the role-based hierarchy (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableFinancialDealCallReportCmpPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether admins can use junction objects between the Financial Deal
                object and the Interaction and Interaction Summary objects within the Interaction
                Summary/Sharing component (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). This field is available in API
                version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableFinancialDealCallReportPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the junction object is enabled between the Financial Deal
                object and the Interaction and Interaction Summary objects (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field is available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableFSCInsuranceReport</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether sales managers can
                access the dashboard and prebuilt reports. The default is <samp class="codeph nolang">false</samp>. This field is available in API version 48.0
                and later in editions where Financial Services Cloud is enabled. <p class="p">Note: This
                  setting can be enabled only if the
                  <span class="keyword parmname">allowMultipleProducersToWorkOnSamePolicy</span> setting is already
                  set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableIndustriesAssessment</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Industries Assessment feature of the Discovery Framework
                is enabled <samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableIndustriesKYC</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Industries KYC (Know Your Customer) is enabled <samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableInteractionRoleHierarchy</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether role hierarchy-based sharing is available for interactions to
                users in the organization <samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableInteractionSummaryPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Interaction Summary setting is enabled for your org. The
                default is <samp class="codeph nolang">false</samp>. This field is available in
                editions where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableInteractionSummaryRoleHierarchy</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Role-Hierarchy-Based Sharing for Interaction Summaries is
                enabled for your org. The default is <samp class="codeph nolang">false</samp>.
                This field is available in editions where Financial Services Cloud is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableManyToManyRelationships</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether insurance can manage many-to-many relationships between
                claims and cases, claims and assets, and assets and policy participants. For
                example, if set to <samp class="codeph nolang">true</samp>, agents can handle
                multiple claims through one case or have multiple cases handling one claim. The
                default is <samp class="codeph nolang">false</samp>. This field is available in
                editions where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMortgageRlaTotalsOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the calculation of assets and liabilities for residential
                loan application records is enabled for your org (true) or not (false). The default
                is <samp class="codeph nolang">false</samp>. This field is available in editions
                where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enablePolicyAdministration</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the data model related to policy administrator is enabled
                <samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If this option is enabled, entities such as transactions and
                transaction details are available within the policy admin data model. The default
                value is <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enablePublicSectorTaxRevenueAgetnforceCmtyPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Indicates whether the Agentforce for Tax and Revenue feature for community
                users is enabled (<samp class="codeph nolang">true</samp>) for your org or not
                (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. Available in editions where Public Sector
                Solutions is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enablePublicSectorTaxRevenuePref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Indicates whether the Tax and Revenue feature is enabled (<samp class="codeph nolang">true</samp>) for your org or not (<samp class="codeph nolang">false</samp>). The default is (<samp class="codeph nolang">false</samp>). Available in editions where Public Sector Solutions is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableRBLUsingCalcService</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Roll-by-Lookup (RBL) Using Calc Service is enabled for your
                org. The default is <samp class="codeph nolang">false</samp>. This field is
                available in editions where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableRecordRollup</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Record Rollup Optimization is enabled for your org. The
                default is <samp class="codeph nolang">false</samp>. This field is available in
                editions where Financial Services Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableReferralScoring</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether Einstein Referral Scoring for Financial Services Cloud is
                enabled for your org (true) or not (false). The default is <samp class="codeph nolang">false</samp>. This field is available in editions where
                Financial Services Cloud is enabled. </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSlackForCib</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the access to Financial Services Cloud capabilities on Slack
                is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSyncInteractionsPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Sync Interactions with Einstein Activity Capture setting
                is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableTimelinePref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether the Timeline features are enabled for your organization
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableWealthManagementAIPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether AI features for Wealth Management are enabled for your org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When enabled, this feature provides AI-powered capabilities for
                wealth management including portfolio analysis, investment recommendations, risk
                assessment, and client insights. The default value is <samp class="codeph nolang">false</samp>. This field is available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">loanApplicantAddressAutoCreation</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether automatic generation of loan applicant records for new
                residential loan applications that are associated with person accounts is enabled
                for your org. The default is <samp class="codeph nolang">false</samp>. This field
                is available in editions where Financial Services Cloud is enabled. Available in API
                version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">loanApplicantAutoCreation</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether automatic generation of loan applicant address records for
                new residential loan applications that are associated with person accounts is
                enabled for your org. The default is <samp class="codeph nolang">false</samp>.
                This field is available in editions where Financial Services Cloud is enabled.
                Available in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">rlaEditIfAccHasEdit</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether a user can edit a residential loan application only if they
                have edit access on the account (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">showCollectionContactAndAccount</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether collection contact and account information is displayed in
                collection workflows (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This setting controls the visibility of
                contact and account details within the collections management interface. The default
                value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">transformRBLtoDPE</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Financial Services Cloud. Indicates whether you can convert RBL rules into Data Processing Engine
                definitions for faster calculations. The default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAuthorizationCustomSharingPCU</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether to enable custom sharing to give your users access to view
                and manage electronic consent forms. Users with a Customer Community Plus license
                can share Authorization Form Texts and Data Use Purpose records with Accounts,
                Contracts, and Users specified in the Information Authorization Request
                record.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCandidateMatching</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether to enable Candidate Matching to automatically match
                candidates to clinical trials.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCareMgmtSlackAccess</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether Care Coordination for Slack app is enabled for your org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableClinicalDataModel</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether Clinical Data Model is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>.
                Available in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableContactCenterAccess</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether Contact Center for Health Cloud app is enabled for your org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>.
                Available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCustomFlowsOnCycleCount</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether Custom Flows on Cycle Count page for the Health Cloud app is
                enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 56.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCustomFlowsOnExpiryPage</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether Custom Flows on Expiry page for Health Cloud app is enabled
                for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 56.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableDiseaseSurveillancePref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether the disease surveillance preference that monitors infectious
                diseases is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableHcCorePatientConsole</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether to enable the OOTB Health Cloud Console App for Patients
                viewing.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableHcStdRelationshipJunctions</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether to start using the core group membership settings instead of
                the ones coming from package for existing managed customers or for new ones to start
                using the relationships from core directly.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableHlsClinicalDcsnSuptAccessOrgPreference</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether to enable Clinical Decision Support capabilities (OOTB IP,
                Data Model, and others.) (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableHlsFhirSubscriptionSetting</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether to enable Documentation Template Rule (DTR) processes, data
                model underneath, and others for processing DTR use cases for Utilization Management
                &amp; Clinical Decision Support users.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableIndustriesLPIPreference</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether Industries Licensing, Permitting, and Inspections (LPI)
                feature is enabled for your org (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. This field is available in editions where
                Health Cloud is enabled. Available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciencesClinialTrialManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether to enable participant recruitment and enrollment to help
                organizations design and execute clinical trials and manage trial participant
                journeys.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMedicationManagementEnabled</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether Medication Management is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>.This
                field is available in API version 53.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMedicalDeviceEnabled</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether the Intelligent Sales features are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMedRecSetting</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether Medication Reconciliation is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. This
                field is available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMultipleCareProgramEnrolleeOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether Multiple Care Program Enrollee is enabled for your org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableProviderSearchSyncOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether provider data search is synced every six hours (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. This
                field is available in editions where Health Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableRosterFileFeatureOrgPreference</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether this is the org pref used for the roster file in Provider
                Network Management (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableTrialManagementConsentManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether to enable consent management to help organizations take
                consent from prospective or enrolled candidates before storing their data.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableUMPayerAppAccessOrgPreference</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether to enable the OOTB Console Utilization Management (UM) Payers
                App for UM Payers App Enablement. This setting can be enabled by Customers.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableVisitInventoryEnabled</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether the visit data model is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">IsHomeHealthEnabled</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Health Cloud. Indicates whether users can schedule and execute visits for the home healthcare
                services they provide for their patients (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAccountBasedSharing</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable Account-Based Sharing to control data access based
                on account ownership.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAdverseEvents</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Adverse Events and its data model is enabled for your org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAppAlerts</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable in-app alerts and notifications.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCarePlansPreference</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable user preferences for Care Plans.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableComprehendMedical</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Comprehend Medical Analysis is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                This field is available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCPBestConTimeSharing</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable sharing of the best time to contact a patient
                within Care Plans.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCPSocialCustomSharing</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable custom social sharing features within Care
                Plans.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableGroupMembershipPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable user preferences for group memberships.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableIESentimentAnalysis</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Industries Einstein Sentiment Insights is enabled for your
                org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                This field is available in API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableIndCrossObjChangelog</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether a cross-object change log to track changes across multiple
                related objects is enabled for your org.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciGenericWorkflow</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable the generic workflow engine for life sciences
                processes.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciInquiry</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable the Inquiry feature for managing and responding to
                inquiries in a life sciences context.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciListsAndFilters</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable lists and filters for enhanced data sorting and
                searching in life sciences.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciencesActivityPlan</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable the Activity Plan feature for creating and managing
                activity plans within life sciences.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciencesClinialTrailManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Clinical Trial Management and its data model is enabled for
                your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Using this feature, organizations can design
                and execute clinical trials and manage trial participant journeys. The default value
                is <samp class="codeph nolang">false</samp>. Available in API version 61.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciencesConsent</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable the Consent feature for managing patient or
                customer consent within life sciences.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciencesCustomerEngagementBase</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable the foundational components of the Life Sciences
                Customer Engagement.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciencesMergeManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable the Merge Management feature for merging duplicate
                records within life sciences data.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciencesProviderEngagementCompliance</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable compliance features for provider engagement within
                the life sciences industry.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciencesSiteManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable the Site Management feature for managing clinical
                trial or other sites in the life sciences industry.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSC4CEDocumentManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable Document Management for the Life Sciences Customer
                Engagement.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSC4CEEmailAndTemplate</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable email and template management features for the Life
                Sciences Customer Engagement.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSC4CEKeyAccountManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable Key Account Management functionality within the
                Life Sciences Customer Engagement.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSC4CEMedInsights</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable Medical Insights functionality in the Life Sciences
                Customer Engagement platform to provide insights to medical teams.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSC4CEPackage</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable the core package for the Life Sciences Customer
                Engagement.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSC4CERemoteEngagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable features for remote engagement with customers
                within the Life Sciences Customer Engagement.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSC4CEVisits</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable the Visits feature to manage and track customer
                visits within the Life Sciences Customer Engagement.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableNextBestAction</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable Next Best Action, a feature that provides AI-driven
                recommendations for the next best step to take with a customer or patient.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableNextBestCustomer</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable Next Best Customer, a feature that uses data to
                identify and recommend the most valuable customers.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableNextBestMessage</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable Next Best Message, a feature that recommends the
                most effective message to send to a customer or patient.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enablePATSTerritoryBasedSharing</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable Territory-Based Sharing for the Provider and
                Affiliate Tracking System (PATS).</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enablePrimaryProviderRestriction</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable restrictions based on the primary provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableProdAdminBusinessGrpFilter</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable filtering by Business Group in the Product
                Administration interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableProdTerrAlgnPrtHrchyAcc</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable access to the Product Territory Alignment Partner
                Hierarchy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableProdTerrAvlRecSharing</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable sharing of available records for Product
                Territories.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableProviderSummarization</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable data summarization for provider records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSampleLimits</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable sample limits for product distribution.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableTrialManagementRandomization</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Research Study Randomization is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Using this feature, users can design and run randomization
                procedures for their clinical trials. The default value is <samp class="codeph nolang">false</samp>. Available in API version 61.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableVisitInventoryEnabled</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable inventory tracking for visits.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableVisitPlanningAndExecutionAction</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable actions for Visit Planning and Execution.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableWaitlistManagementPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether to enable preferences for Waitlist Management.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSC4CEEDetailing</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether eDetailing for Life Sciences Customer Engagement is enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This feature lets sales representatives deliver digital,
                interactive presentations to healthcare professionals. The default value is
                <samp class="codeph nolang">false</samp>. Available in API version 63.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciFieldEvents</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Life Sciences fields are exposed on Event Management
                objects (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 65.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableInsDocRelationship</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether the Institutional Doctor account record type is enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This record type lets users track sales representatives'
                interactions with healthcare professionals and the healthcare organizations that
                the professionals are affiliated with. The default value is <samp class="codeph nolang">false</samp>. Available in API version 66.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSCAdminConsolePerms</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Life Sciences Customer Engagement Admin Console permissions
                are enforced for your org (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). These permissions control which
                parts of the Admin Console different users can access. The default value is
                <samp class="codeph nolang">false</samp>. Available in API version 66.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableStories</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Briefings is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This feature lets users consume insights in multi-modal
                narrative formats. The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 67.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMngEventBasedSharing</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether access to Subject Assignment records through managed
                event-based derived sharing is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                value is <samp class="codeph nolang">false</samp>. Available in API version 67.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableEvtPtcpTypeRoleSelection</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Type and Role display as picklist fields on the Managed
                Event Participant record (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). When enabled, users can specify a
                participant's type and role directly instead of selecting the related Event
                Management Participant Type Role Mapping record. The default value is <samp class="codeph nolang">false</samp>. Available in API version 67.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMngEvtTypeAutoPopulation</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether the Managed Event Type field on Managed Event records is
                automatically populated based on the Managed Event record type-to-event type
                mapping (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 67.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMngNonLSCShareRowCause</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether records of all sharing types are included in Life Sciences
                workflows (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 67.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableStoreCheck</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Store Check is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This feature lets users conduct store checks for their
                organization. The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLifeSciRecTypeRoutgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether users are routed to different experiences based on the
                record type that they want to create or edit (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                value is <samp class="codeph nolang">false</samp>. Available in API version 68.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSDraftOrderCapture</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether access to Order Capture is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This feature lets users capture and manage draft orders. The
                default value is <samp class="codeph nolang">false</samp>. Available in API
                version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableLSVisitAgent</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether Visit Agent is enabled in the Life Sciences Cloud mobile
                app (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 68.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">noninterchangeable</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Life Sciences Cloud. Indicates whether selective trigger handler execution using JSON
                execution-condition expressions on <span class="keyword parmname">LifeScienceTriggerHandler</span>
                setup records is enabled (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 68.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCriteriaBasedSearchAndFilter</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Automotive Cloud. Indicates whether Criteria-Based Search and Filter is enabled for your org. The
                default is <samp class="codeph nolang">false</samp>. This field is available in
                editions where Automotive Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableGnrcDisclsFrmwrk</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Industries Disclosure and Compliance Hub feature is
                enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) for your org. The default is <samp class="codeph nolang">false</samp>. Available in API version 57.0 and later
                in editions where Disclosure and Compliance Hub is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableInformationLibrary</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Information Library feature is enabled for your org.
                The default is <samp class="codeph nolang">false</samp>. Available in API
                version 59.0 and later in editions where Disclosure and Compliance Hub is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMaterialityAssessment</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Materiality Assessments feature is enabled for
                your org. The default is <samp class="codeph nolang">false</samp>. Available
                in API version 59.0 and later in editions where Net Zero Cloud is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableNZCMngEsgPgm</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Environmental, Social, and Governance Programs
                feature is enabled for your org. The default is <samp class="codeph nolang">false</samp>. Available in API version 59.0 and later in editions where
                Net Zero Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCAssignFootprint</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Assign Carbon Footprint to Energy Use Records feature
                is enabled for your org. The default is <samp class="codeph nolang">false</samp>. Available in API version 54.0 and later in editions where
                Net Zero Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCBEIEnabled</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Building Energy Intensity feature is enabled
                for your org. The default is <samp class="codeph nolang">false</samp>.
                Available in API version 54.0 and later in editions where Net Zero Cloud is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCCarbonAccounting</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Carbon Accounting feature is enabled for your
                org. The default is <samp class="codeph nolang">false</samp>. Available in
                API version 54.0 and later in editions where Net Zero Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCCarbonCreditAlloc</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Allocate Carbon Credits to offset the unavoidable
                emissions feature is enabled for your org. The default is <samp class="codeph nolang">false</samp>. Available in API version 56.0 and later
                in editions where Net Zero Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCCreateFootprint</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Auto-Create Carbon Footprints feature is enabled for
                your org. The default is <samp class="codeph nolang">false</samp>. Available
                in API version 54.0 and later in editions where Net Zero Cloud is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCDGF</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Data Gaps feature is enabled for your org. The
                default is <samp class="codeph nolang">false</samp>. Available in API
                version 54.0 and later in editions where Net Zero Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCExpansionUseCase</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Carbon Accounting for Extended Organizational
                Boundaries feature is enabled for your org. The default is <samp class="codeph nolang">false</samp>. Available in API version 57.0 and later
                in editions where Net Zero Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCExternalEngMgmt</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Supplier Sustainability Data feature is enabled
                for your org. The default is <samp class="codeph nolang">false</samp>.
                Available in API version 54.0 and later in editions where Net Zero Cloud is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCEmssnsForecasting</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Carbon Emissions Forecast feature is enabled
                for your org. The default is <samp class="codeph nolang">false</samp>.
                Available in API version 54.0 and later in editions where Net Zero Cloud is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCSNGManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Social and Governance feature is enabled for
                your org. The default is <samp class="codeph nolang">false</samp>. Available
                in API version 57.0 and later in editions where Net Zero Cloud is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCScope3HubEnabled</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Scope 3 Procurement Hub feature is enabled for
                your org. The default is <samp class="codeph nolang">false</samp>. Available
                in API version 54.0 and later in editions where Net Zero Cloud is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCTargetSetting</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Emissions Target feature is enabled for your
                org. The default is <samp class="codeph nolang">false</samp>. Available in
                API version 54.0 and later in editions where Net Zero Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCWasteManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Waste-Related Data feature is enabled for your
                org. The default is <samp class="codeph nolang">false</samp>. Available in
                API version 54.0 and later in editions where Net Zero Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSCWaterManagement</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Manage Water-Related Data feature is enabled for your
                org. For example, water consumption, withdrawal, and discharge. The default is
                <samp class="codeph nolang">false</samp>. Available in API version 56.0
                and later in editions where Net Zero Cloud is enabled.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableSustainabilityCloud</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Net Zero Cloud. Indicates whether the Net Zero Cloud feature is enabled for your org. The
                default is <samp class="codeph nolang">false</samp>. Available in API
                version 54.0 and later in editions where Net Zero Cloud is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableBenefitAndGoalSharingPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Public Sector Solutions Features. Indicates whether the benefit and goal sharing feature is enabled for your org.
                The default is <samp class="codeph nolang">false</samp>. Available in editions
                where Public Sector Solutions is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableBenefitManagementPreference</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Public Sector Solutions Features. Indicates whether the program and benefit management feature is enabled for
                your org. The default is <samp class="codeph nolang">false</samp>. Available in
                editions where Public Sector Solutions is enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCarePlansPreference</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Public Sector Solutions Features. Indicates whether the care plan feature is enabled for your org. The care plan
                feature lets you create and edit care plans. The default is <samp class="codeph nolang">false</samp>. Available in editions where Public Sector
                Solutions is enabled.<p class="p">This field is available in API version 58.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableEnhancedUIForISPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type"></td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Public Sector Solutions Features. Indicates whether the enhanced interaction note interface feature is enabled
                for your org. The enhanced interaction note interface is a single guided flow that
                enables you to seamlessly create meeting notes; add interaction details, attendees,
                and interest tags; and share the notes with other users. The default is <samp class="codeph nolang">false</samp>. Available in editions where Public Sector
                Solutions is enabled.<p class="p">This field is available in API version 61.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">appointmentDistributionOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether to schedule appointments for service resources based on
                appointment distribution (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 52.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">captureResourceUtilizationOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether to use a background process to calculate the usage of service
                resources from service appointments (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 52.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAnyResourceTypeOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether to enable Salesforce Scheduler to consider service resource
                records with Agent resource type (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). Before enabling this setting, create
                a service resource record as Main for each user, or update one of the service
                resource records as Main for each user. The default value is <samp class="codeph nolang">false</samp>. Available in API version 57.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAppFrmAnywhereOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether to use engagement channels for setting up shifts, work types,
                and booking a service appointment (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 56.0 and later. See
                the <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.ls_prereqs_for_using_engagement_channels.htm&amp;type=5&amp;language=en_US" target="_blank">prerequisites</a> before you enable this
                setting.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableBlockResourceAvailabilityOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether Salesforce Scheduler service appointments are added to users'
                Salesforce calendars. For example, if set to <samp class="codeph nolang">false</samp>, users don’t see their service appointments on their calendars.
                The default is <samp class="codeph nolang">false</samp>. Available in API version
                47.0 and later.<p class="p">This setting is used in Financial Services Cloud.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCapacitySchedulingPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether users can use capacity-based scheduling (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Use capacity-based scheduling to control the number of
                appointments that can be scheduled for a given shift and type of work. Available in
                API version 62.0 and later. See the <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.ls_prereqs_capacity_based_scheduling.htm&amp;language=en_US" target="_blank">prerequisite</a> before you enable this
                setting.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableCreateMultiAttendeeEventOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether users can group individual events, and view the list of all
                attendees under a single event <samp class="codeph nolang">true</samp> or not
                <samp class="codeph nolang">false</samp>. The default is <samp class="codeph nolang">false</samp>. See the <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.ls_prereqs_multiple_attendee_event.htm&amp;type=5&amp;language=en_US" target="_blank">prerequisites</a> before you enable this
                setting. Available in API version 55.0 and later.<p class="p">This setting is used in
                  Financial Services Cloud.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableDropInAppointmentsOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether users can manage drop-in participants (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 58.0 and later. See the <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.ls_prereqs_drop_in_appointments.htm&amp;type=5&amp;language=en_US" target="_blank">prerequisite</a> before you enable this
                setting.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableDropInSkillMatchingOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether skill and skill level matching is enabled for service
                resources that are assigned to waitlists for a service territory (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 58.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableEventManagementOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether users can add Salesforce Scheduler service appointments to
                their Salesforce calendars. The default is <samp class="codeph nolang">false</samp>. Available in API version 47.0 and later.<p class="p">This setting is used
                  in Financial Services Cloud.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableEventWriteOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether to publish high-volume platform events when users create,
                update, or delete service appointments in Salesforce Scheduler (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If enabled, write these events to an external system to update
                it with Salesforce Scheduler service appointments. The default value is <samp class="codeph nolang">false</samp>. Available in API version 49.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMultipleTopicsForShiftsOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether the multiple topics for shifts feature is enabled (<samp class="codeph nolang">true</samp>) or disabled (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 56.0 and later. See the <a class="xref" href="https://help.salesforce.com/s/articleView?id=sf.ls_prereqs_multiple_topics_to_shifts.htm&amp;language=en_US" target="_blank">prerequisite</a> before you enable this
                setting.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMultiResourceOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether users can add multiple service resources to a service
                appointment. The default is <samp class="codeph nolang">false</samp> Available in
                API version 47.0 and later.<p class="p">This setting is used in Financial Services
                  Cloud.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableOverbookingOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether users can add multiple service appointments to a single time
                slot for a service resource. If set to <samp class="codeph nolang">false</samp>,
                concurrent time slots are visible, but can't be modified. The default is <samp class="codeph nolang">false</samp> Available in API version 47.0 and later.<p class="p">This
                  setting is used in Financial Services Cloud.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableShareSaWithArOrgPref</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether to share service appointments with assigned resources
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableTopicOrTemplate</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Salesforce Scheduler. Indicates whether to use Salesforce Scheduler to manage Health Cloud
                appointments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. You must enable the
                <span class="keyword parmname">enableTopicTimeSlot</span> field before enabling this setting.
                Available in API version 52.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableTopicTimeSlot</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">
                <p class="p">Applies to Salesforce Scheduler. Indicates whether to set operating hours for Service Territory Members for Work
                  Type Groups (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version 52.0 and later.</p>

                <p class="p">See the <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.ls_prereqs_operating_hours_for_resources_working_on_appointment_topics.htm&amp;type=5&amp;language=en_US" target="_blank">prerequisites</a> before you enable this
                  setting. After you enable this setting, you can't disable it.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableEducationCloud</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Education Cloud. Indicates whether Education Cloud is enabled in Salesforce (true) or not
                (false). The default is <samp class="codeph nolang">false</samp>. Available in API
                version 57.0 and later in Developer, Enterprise, Performance and Unlimited
                editions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableStudentSuccess</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Education Cloud. Indicates whether Student Success is enabled in Salesforce (true) or not
                (false). The default is <samp class="codeph nolang">false</samp>. Available in API
                version 58.0 and later in Developer, Enterprise, Performance and Unlimited
                editions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAcademicOperations</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Education Cloud. Indicates whether Academic Operations is enabled in Salesforce (true) or not
                (false). The default is <samp class="codeph nolang">false</samp>. Available in API
                version 59.0 and later in Developer, Enterprise, Performance and Unlimited
                editions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAlumniRelations</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Education Cloud. Indicates whether Alumni Relations is enabled (true) or not (false). The
                default is <samp class="codeph nolang">false</samp>. Available in API version 59.0
                and later in Developer, Enterprise, Performance and Unlimited editions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableMentoring</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Education Cloud. Indicates whether Mentoring is enabled (true) or not (false). The default is
                <samp class="codeph nolang">false</samp>. Available in API version 60.0 and
                later in Developer, Enterprise, Performance and Unlimited editions.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAdvancementGenAI</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Education Cloud. Indicates whether Advancement Generative AI features are enabled for Education
                Cloud. The default is false. Available in API version 64.0 and later in Developer,
                Enterprise, Performance and Unlimited editions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableAdvisingAgent</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Education Cloud. Indicates whether the Advising Agent feature is enabled for Education Cloud.
                The default is false. Available in API version 64.0 and later in Developer,
                Enterprise, Performance and Unlimited editions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableEduAdvncdAcadOper</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Education Cloud. Indicates whether Advanced Academic Operations features are enabled for
                Education Cloud. The default is false. Available in API version 64.0 and later in
                Developer, Enterprise, Performance and Unlimited editions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableStudentRecruitmentAgent</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Education Cloud. Indicates whether the Student Recruitment Agent feature is enabled for
                Education Cloud. The default is false. Available in API version 64.0 and later in
                Developer, Enterprise, Performance and Unlimited editions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enableGiftEntryGrid</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Nonprofit Cloud. Indicates whether the Gift Entry Grid feature is enabled for Nonprofit Cloud.
                The default is false. Available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d578795e122" data-title="Field Name"><span class="keyword parmname">enablePhilResearchAgent</span></td>

              <td class="entry" headers="d578795e125" data-title="Field Type">boolean</td>

              <td class="entry" headers="d578795e128" data-title="Description">Applies to Nonprofit Cloud. Indicates whether the Philanthropic Research Agent feature is enabled for
                Nonprofit Cloud. The default is false. Available in API version 64.0 and
                later.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an Industries.Settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>
<IndustriesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCreateMultiAttendeeEventOrgPref\>true</enableCreateMultiAttendeeEventOrgPref\>
    <enableEventManagementOrgPref\>true</enableEventManagementOrgPref\>
    <enableMultiResourceOrgPref\>false</enableMultiResourceOrgPref\>
    <enableOverbookingOrgPref\>true</enableOverbookingOrgPref\>
    <enableBlockResourceAvailabilityOrgPref\>true</enableBlockResourceAvailabilityOrgPref\>
    <enableAccessToMasterListOfCoverageTypes\>true</enableAccessToMasterListOfCoverageTypes\>
    <enableManyToManyRelationships\>true</enableManyToManyRelationships\>
    <allowMultipleProducersToWorkOnSamePolicy\>false</allowMultipleProducersToWorkOnSamePolicy\>
    <enableMortgageRlaTotalsOrgPref\>true</enableMortgageRlaTotalsOrgPref\>
    <enableObjectDetection\>true</enableObjectDetection\>
    <enableProviderSearchSyncOrgPref\>true</enableProviderSearchSyncOrgPref\>
    <enableReferralScoring\>true</enableReferralScoring\>
    <enableFSCInsuranceReport\>true</enableFSCInsuranceReport\>
    <enableSCCarbonAccounting\>true</enableSCCarbonAccounting\>
    <enableBenefitAndGoalSharingPref\>true</enableBenefitAndGoalSharingPref\>
    <enableBenefitManagementPreference\>true</enableBenefitManagementPreference\>
    <enableCarePlansPreference\>true</enableCarePlansPreference\>
</IndustriesSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Industries</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</Package\>

<!-- document id=2de80428b322292492e308ca8c44231bc3b6229f6c4bc33e0239b0ee6e13550e url=/legacydeveloper/current/en-us/api_meta/meta_industriesunifiedinventorysettings.md -->

# IndustriesUnifiedInventorySettings

Represents the settings for Industries Unified Inventory.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

IndustriesUnifiedInventorySettings components have the suffix IndustriesUnifiedInventory.settings and are stored in the settings folder.

## Version

IndustriesUnifiedInventorySettings components are available in API version 64.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| enableBatchManagement | 
Field Type

Boolean

Description

Indicates whether the batch-based inventory management features are enabled (true) or not (false). Within Life Sciences Cloud, this is a core component of the Unified Inventory Extension Entities, supporting Sample Inventory use cases. When enabled, it provides access to the entities ProductionBatch, ProductBatchItem, and InventoryCntProdtBatchItem.



 |
| enableInventoryCount | 

Field Type

Boolean

Description

Indicates whether the Inventory Count is enabled (true) or not (false). The Inventory Count provides the ability to manage inventory count processes by planning inventory counts, counting inventory at designated locations, and tracking count results.



 |
| enableProductInventoryOperations | 

Field Type

Boolean

Description

Indicates whether the Product Inventory Operations that provides the capabilities to perform various actions related to managing product inventory is enabled (true) or not (false).



 |

## Declarative Metadata Sample Definition

The following is an example of an IndustriesUnifiedInventorySettings component.

<?xml version="1.0" encoding="UTF-8"?>
<IndustriesUnifiedInventorySettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableBatchManagement\>true</enableBatchManagement\>
    <enableInventoryCount\>true</enableInventoryCount\>
    <enableProductInventoryOperations\>true</enableProductInventoryOperations\>
</IndustriesUnifiedInventorySettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>IndustriesUnifiedInventory</members\>
        <name\>Settings</name\>
    </types\>
    <version\>64.0</version\>
</Package\>

<!-- document id=aca7a8b07043af9baf0fc2ed2150d5647b41a6035b5e63ffc5b1b562c183f3dc url=/legacydeveloper/current/en-us/api_meta/meta_insplcyLimitconsumptionrule.md -->

# InsPlcyLimitConsumptionRule

Represents configuration for how policy limit consumption rule applies to an insurance policy product, including consumption mode and product binding.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

InsPlcyLimitConsumptionRule components have the suffix .insPlcyLimitConsumptionRule and are stored in the InsPlcyLimitConsumptionRules folder.

## Version

InsPlcyLimitConsumptionRule components are available in API version 67.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| consumptionMode | 
Field Type

PolicyLimitConsumptionMode (enumeration of type string)

Description

Required. Specifies how the nested limits in the insurance policy are consumed when a claim is paid out. Valid value is:

- Full





 |
| isEnabled | 

Field Type

boolean

Description

Indicates whether the policy limit consumption configuration is enabled (true) or not (false).

The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for InsPlcyLimitConsumptionRule, which is defined when the InsPlcyLimitConsumptionRule is created.



 |
| policyProduct | 

Field Type

string

Description

Required. ID of the root product for the insurance policy that this configuration applies to.



 |

## Declarative Metadata Sample Definition

The following is an example of a InsPlcyLimitConsumptionRule component.

<?xml version="1.0" encoding="UTF-8"?>
<InsPlcyLimitConsumptionRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <policyProduct\>AutoPolicyCoverageProduct</policyProduct\>
    <consumptionMode\>Full</consumptionMode\>
    <isEnabled\>false</isEnabled\>
    <masterLabel\>Insurance Policy Limit Consumption Rule</masterLabel\>
</InsPlcyLimitConsumptionRule\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>InsPlcyLimitConsumptionRule</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=33fdcf08906bb6d6b714cb5edf0c37ee2f8c1ce9648c5dfa6a379df0b0edf780 url=/legacydeveloper/current/en-us/api_meta/meta_installedpackage.md -->

# InstalledPackage

Represents a first-generation managed package to be installed or uninstalled. Deploying a newer version of a currently installed package upgrades the package. You can install up to 20 first-generation managed packages in a single deployment. To install an unlocked or second-generation managed package, use the sf package install Salesforce CLI command.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can’t deploy a package along with other metadata types. When you deploy InstalledPackage, it must be the only metadata type specified in the manifest file.

## File Suffix and Directory Location

The package is specified in the installedPackages directory, in a file named after the package’s namespace prefix. The file extension is .installedPackage.

## Version

InstalledPackage is available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d592984e91">Field Name</th>

              <th class="featureTableHeader  " id="d592984e94">Field Type</th>

              <th class="featureTableHeader  " id="d592984e97">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d592984e91" data-title="Field Name"><span class="keyword parmname">activateRSS</span></td>

              <td class="entry" headers="d592984e94" data-title="Field Type">boolean</td>

              <td class="entry" headers="d592984e97" data-title="Description">Required. Determines the state of Remote Site Settings (RSS) and Content
                Security Policy (CSP) at the time of installing the package and must be set to
                either of these values. <dl class="dl detailList">

                  <dt class="dt dlterm">true</dt>

                  <dd class="dd">Keep the isActive state of any RSS or CSP in the package. </dd>



                  <dt class="dt dlterm">false</dt>

                  <dd class="dd">Override the isActive state of any RSS or CSP in the package and set it to
                    <samp class="codeph nolang">false</samp>.
                  </dd>


                </dl>
                The default value is <samp class="codeph nolang">false</samp>. Available in
                API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d592984e91" data-title="Field Name"><span class="keyword parmname">password</span></td>

              <td class="entry" headers="d592984e94" data-title="Field Type">string</td>

              <td class="entry" headers="d592984e97" data-title="Description">Specifies the package password.</td>

            </tr>

            <tr>
              <td class="entry" headers="d592984e91" data-title="Field Name"><span class="keyword parmname">securityType</span></td>

              <td class="entry" headers="d592984e94" data-title="Field Type">string</td>

              <td class="entry" headers="d592984e97" data-title="Description">Determines user access for the installed package.<p class="p">Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">AdminsOnly</samp></li>

                  <li class="li"><samp class="codeph nolang">AllUsers</samp></li>

                </ul>
                <p class="p">The default value is <samp class="codeph nolang">AllUsers</samp>.
                  Available in API version 57.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d592984e91" data-title="Field Name"><span class="keyword parmname">versionNumber</span></td>

              <td class="entry" headers="d592984e94" data-title="Field Type">string</td>

              <td class="entry" headers="d592984e97" data-title="Description">Required. The version number of the package. The version number has the format
                <samp class="codeph nolang"><var class="keyword varname">majorNumber.minorNumber.patchNumber</var></samp> (for example,
                <samp class="codeph nolang">2.1.3</samp>).
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following example specifies a sample package to be installed or uninstalled.

<?xml version="1.0" encoding="UTF-8"?>
        <InstalledPackage xmlns="http://soap.sforce.com/2006/04/metadata">
        <versionNumber\>1.0</versionNumber\>
        <password\>optional\_password</password\>
        <securityType\>AdminsOnly</securityType\>
        <activateRSS\>true</activateRSS\>
        </InstalledPackage\>

The securityType field is optional. If it’s not specified, the default security type is AllUsers.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=19d83ec8329d351538246aac844682090a20005e98401d1394e7270d32da4d6f url=/legacydeveloper/current/en-us/api_meta/meta_integartifactdef.md -->

# IntegArtifactDef

Represents an integration artifact definition.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

IntegArtifactDef components have the suffix .integArtifactDef and are stored in the integArtifactDefs folder.

## Version

IntegArtifactDef components are available in API version 66.0 and later.

## Special Access Rules

Only users with the CustomConnectors permission can access this metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Required. The detailed text description of the integration artifact’s overall purpose and functionality.



 |
| groupId | 

Field Type

string

Description

Required. The identifier that groups related integration artifacts.



 |
| displayName | 

Field Type

string

Description

Required. The name of the integration artifact.



 |
| iconName | 

Field Type

string

Description

The name of the icon for the integration artifact.



 |
| isGlobal | 

Field Type

boolean

Description

Indicates whether the integration artifact is global. A value of true indicates that the artifact is global. A value of false indicates that the artifact isn't global.



 |

<!-- document id=df2a37837549977143e55bbafcf2beff8131f2d3735e88fd786a852aef8be9d6 url=/legacydeveloper/current/en-us/api_meta/meta_integrationproviderdef.md -->

# IntegrationProviderDef

Represents an integration definition associated with a service process. Stores data for the Industries: Send Apex Async Request and Industries: Send External Async Request invocable actions.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

IntegrationProviderDef components have the suffix .integrationProviderDefinition and are stored in the .integrationProviderDefinition folder.

## Version

IntegrationProviderDef components are available in API version 57.0 and later.

## Special Access Rules

Access to the IntegrationProviderDef type requires the AccessToServiceProcess permission.

## Fields

| Field Name | Description |
| --- | --- |
| active | 
Field Type

boolean

Description

Specifies whether this Integration Definition is active. The default is false.



 |
| apexClass | 

Field Type

string

Description

The custom Apex class that the related Industries: Send Apex Async Request invocable action invokes. Specify either apexClass or fileBasedApexClass but not both. Applies only if the type is Apex.



 |
| description | 

Field Type

string

Description

A meaningful explanation of the Integration Definition.



 |
| developerName | 

Field Type

string

Description

Required.

A system name for the Integration Definition.



 |
| externalServiceOperationName | 

Field Type

string

Description

The external service operation that the related Industries: Send External Async Request invocable action invokes. Applies only if the type is LowCode.



 |
| externalServiceRegistration | 

Field Type

string

Description

The external service that the related Industries: Send External Async Request invocable action invokes. Applies only if the type is LowCode.



 |
| fileBasedApexClass | 

Field Type

string

Description

The Salesforce-provided Apex class that the related Industries: Send Apex Async Request invocable action invokes. Specify either apexClass or fileBasedApexClass but not both. Applies only if the type is Apex.



 |
| fileBasedExternalService | 

Field Type

string

Description

The Salesforce-provided external service that the Integration Definition invokes. This field is used for packaged or system-provided external service integrations. Applies only if the type is LowCode.

Available in API version 64.0 and later.



 |
| fileBasedInputDataProcessor | 

Field Type

string

Description

The Salesforce-provided Integration Procedure that processes the specified data. This field references packaged or system-provided data processors. Applies only if the type is LowCode.

Available in API version 64.0 and later.



 |
| fileBasedOmniUiCard | 

Field Type

string

Description

The Salesforce-provided OmniStudio UI Card that's associated with this Integration Definition. This enables packaged UI components for integration configuration.

Available in API version 64.0 and later.



 |
| fileBasedOutputDataProcessor | 

Field Type

string

Description

The Salesforce-provided Integration Procedure that processes the returned data. This field references packaged or system-provided output processors. Applies only if the type is LowCode.

Available in API version 64.0 and later.



 |
| inputDataProcessor | 

Field Type

string

Description

The optional Integration Procedure that processes the sent data. Applies only if the type is LowCode.



 |
| integrationProviderAttributes | 

Field Type

[IntegrationProviderAttr\[\]](#IntegrationProviderAttr)

Description

Custom attributes that store data associated with an Integration Definition.



 |
| javaClassName | 

Field Type

string

Description

Name of the Java class that the Integration Definition invokes. Applies only if the type is Java.

Available in API version 59.0 and later.



 |
| outputDataProcessor | 

Field Type

string

Description

The optional Integration Procedure that processes the returned data. Applies only if the type is LowCode.



 |
| providerLabel | 

Field Type

string

Description

Required.

A meaningful name for the Integration Definition.



 |
| type | 

Field Type

DefinitionType (enumeration of type string)

Description

Required.

What the Integration Definition calls, either an Apex class or an external service.

Values are:

- Apex
- Java
- LowCode





 |

## IntegrationProviderAttr

A custom attribute that stores data associated with an Integration Definition.

| Field Name | Description |
| --- | --- |
| dataType | 
Field Type

AttrDataType (enumeration of type string)

Description

Required.

The data type of the attribute.

Values are:

- Date
- DateTime
- Double
- Integer
- Percentage
- String
- Boolean





 |
| dateTimeValue | 

Field Type

dateTime

Description

The value of the attribute if the dataType is DateTime.



 |
| dateValue | 

Field Type

date

Description

The value of the attribute if the dataType is Date.



 |
| description | 

Field Type

string

Description

A meaningful explanation of the attribute.



 |
| developerName | 

Field Type

string

Description

Required.

A system name for the attribute.



 |
| doubleValue | 

Field Type

double

Description

The value of the attribute if the dataType is Double.



 |
| integerValue | 

Field Type

int

Description

The value of the attribute if the dataType is Integer.



 |
| label | 

Field Type

string

Description

Required.

A meaningful name for the attribute.



 |
| percentageValue | 

Field Type

double

Description

The value of the attribute if the dataType is Percentage.



 |
| required | 

Field Type

boolean

Description

Required.

Specifies whether the attribute is required.



 |
| stringValue | 

Field Type

string

Description

The value of the attribute if the dataType is String.



 |
| trueOrFalseValue | 

Field Type

boolean

Description

The value of the attribute if the dataType is Boolean.



 |

## Declarative Metadata Sample Definition

The following is an example of an IntegrationProviderDef component.

<?xml version="1.0" encoding="UTF-8"?>
<IntegrationProviderDef xmlns="http://soap.sforce.com/2006/04/metadata">
   <developerName\>EmailUpdate</developerName\>
   <providerLabel\>EmailUpdate</providerLabel\>
   <type\>Apex</type\>
   <apexClass\>SendEmailUpdate</apexClass\>
   <integrationProviderAttributes\>
      <developerName\>EmailAddress</developerName\>
      <label\>EmailAddress</label\>
      <dataType\>String</dataType\>
      <stringValue\>person@example.com</stringValue\>
      <required\>true</required\>
   </integrationProviderAttributes\>
</IntegrationProviderDef\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>IntegrationProviderDef</name\>
    </types\>
    <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=b6b17764215ab2afdf59584a383f307a5593e7e87c04df4025714291844761a4 url=/legacydeveloper/current/en-us/api_meta/meta_interesttaggingsettings.md -->

# InterestTaggingSettings

Represents settings for Interest Tags, which your users can add to client records to capture client needs, interests, and prospecting opportunities.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

InterestTaggingSettings values are stored in the InterestTagging.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

InterestTaggingSettings components are available in API version 54.0 and later.

## Special Access Rules

Before you enable Interest Tags, you must enable Topics for Financial Services Cloud objects and assign Interest Tags permissions to users. See [Interest Tags](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_admin_guide.meta/financial_services_cloud_admin_guide/fsc_admin_interest_tags.htm).

## Fields

| Field Name | Description |
| --- | --- |
| enableInterestTagging | 
Field Type

boolean

Description

Enables Interest Tags in your org when set to true.



 |

## Declarative Metadata Sample Definition

The following is an example of an InterestTaggingSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<InterestTaggingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <enableInterestTagging\>true</enableInterestTagging\>
</InterestTaggingSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>InterestTagging</members\>
        <name\>Settings</name\>
    </types\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=0c14487ebc6a5ee0cdbeb3ecb170907caa3f551e722bc783bfd7248ebdaecf39 url=/legacydeveloper/current/en-us/api_meta/meta_internaldataconnector.md -->

# InternalDataConnector

For internal use only.

<!-- document id=1e35d7014a9764f1765138af016beb883454f82f8a49dc8a9395caff2aa5933c url=/legacydeveloper/current/en-us/api_meta/meta_inventorysettings.md -->

# InventorySettings

Represents options for the Salesforce Omnichannel Inventory product.This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

InventorySettings values are stored in the Inventory.settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

## Version

Inventory settings are available in API version 51 and later.

## Special Access Rules

This metadata type is only accessible by developers and customers using Salesforce Omnichannel Inventory.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableOCIB2CIntegration | boolean | Indicates whether Omnichannel Inventory is allowed to exchange inventory data with B2C Commerce (true) or not (false). The default value is false. |
| enableOmniChannelInventory | boolean | Indicates whether Omnichannel Inventory features are enabled (true) or not (false). The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of an InventorySettings component.

<?xml version="1.0" encoding="UTF-8"?>
<InventorySettings xmlns="http://soap.sforce.com/2006/04/metadata" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <enableOmniChannelInventory\>true</enableOmniChannelInventory\>
    <enableOCIB2CIntegration\>true</enableOCIB2CIntegration\>
    </InventorySettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Inventory</members\>
        <name\>Settings</name\>
    </types\>
    <version\>51.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e1089b27df9599b5f5821777691342ee3c960b698618fda4a5b540c4d0acecf9 url=/legacydeveloper/current/en-us/api_meta/meta_invlatepymntriskcalcsettings.md -->

# InvLatePymntRiskCalcSettings

Represents the org’s settings to identify the level of risks associated with payment of invoices.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

InvLatePymntRiskCalcSettings values are stored in the InvLatePymntRiskCalc.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

InvLatePymntRiskCalcSettings components are available in API version 55.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| enableInvLatePymntRiskCalc | 
Field Type

boolean

Description

Indicates the level of risk associated with payment of an invoice when the value is true.



 |

## Declarative Metadata Sample Definition

Theis example shows a sample InvLatePymntRiskCalcSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<InvLatePymntRiskCalcSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableInvLatePymntRiskCalc\>true</enableInvLatePymntRiskCalc\>
</InvLatePymntRiskCalcSettings\>

This example shows a sample package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>InvLatePymntRiskCalc</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=f55de2dfe78e6dc20d23ba754686d663b496addfe7078bdfea7a8a194780764e url=/legacydeveloper/current/en-us/api_meta/meta_invocableactionextension.md -->

# InvocableActionExtension

Represents the configuration that defines how an action's inputs are presented in a user interface.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

InvocableActionExtension components have the suffix .invocableactionextension and are stored in the invocableactionextensions folder.

## Version

InvocableActionExtension components are available in API version 65.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| targets | 
Field Type

[InvocableActionExtensionTarget\[\]](#InvocableActionExtensionTarget)

Description

The target of this invocable action extension.



 |

## InvocableActionExtensionTarget

Represents an extension that can contain attributes for an action's definition, parameters, and types. Use InvocableActionExtensionTarget as the parent element for a given target, such as an ActionParameter. Each assigned attribute is a child of this element.

| Field Name | Description |
| --- | --- |
| attributes | 
Field Type

[InvocableActionExtensionTargetAttribute\[\]](#InvocableActionExtensionTargetAttribute)

Description

The list of attributes.



 |
| targetName | 

Field Type

string

Description

Required.

The name of the target for the attributes.





 |
| targetType | 

Field Type

InvocableActionExtTargetType (enumeration of type string)

Description

Required.

Specifies the type of component within the invocable action.

Values are:

- ActionDefinition—Targets the action class.
- ActionParameter—Targets the specific input/output parameters.
- TypeDefinition—Targets the custom Apex types used by the action.
- TypeProperty—Targets the individual properties within those custom types.





 |

## InvocableActionExtensionTargetAttribute

Represents the individual configuration attributes within an extension target. Use InvocableActionExtensionTargetAttribute as the child element of [InvocableActionExtensionTarget](#InvocableActionExtensionTarget) to define specific behaviors, dependencies, and properties. Each attribute consists of a key-value pair with an associated data type. This configuration determines how the target action parameter, type property, or action definition behaves.

| Field Name | Description |
| --- | --- |
| dataType | 
Field Type

InvocableActionExtAttributeDataType (enumeration of type string)

Description

Required.

The data type of the value stored in the value field.

Values are:

- Boolean
- Date
- Double
- Integer
- Long
- String





 |
| key | 

Field Type

string

Description

Required.

The key field that specifies which standard attribute to provide a value for, or provides a custom key. The available standard keys are:

- CpeName—Assigns a Lightning web component as a partial custom property editor for a primary input parameter in the action's property panel in Flow Builder.
- ConfiguredBy—Links an input parameter to be controlled by another parameter's custom property editor in the action's property panel in Flow Builder.
- ControllingField—Controls the visibility of an input parameter based on another input parameter's existence in the action's property panel in Flow Builder.
- CustomHeaderLwcName—Adds a custom header at the top of the action's property panel in Flow Builder.
- GroupName—Organizes input parameters into collapsible sections in the action's property panel in Flow Builder.
- Order—Controls the vertical display sequence of input parameters in the action's property panel in Flow Builder.
- ProvidedValueList—Defines picklist values for an input parameter in the action's property panel in Flow Builder.

For a custom key, enter any value that contains letters, numbers, or single underscores, starts with a letter, and ends with \_\_c.

This field is available in API version 67.0 and later.



 |
| value | 

Field Type

string

Description

Required.

The value of the associated key. An Invocable Action Extension can have multiple attributes, each with its own value.





 |

## Declarative Metadata Sample Definition

The following example shows an InvocableActionExtension component definition.

<?xml version="1.0" encoding="UTF-8"?>
<InvocableActionExt xmlns="http://soap.sforce.com/2006/04/metadata">
    <targets\>
        <targetType\>ActionParameter</targetType\>
        <targetName\>Example.Request.inputOne</targetName\>
        <attributes\>
            <key\>Order</key\>
            <dataType\>Integer</dataType\>
            <value\>1</value\>
        </attributes\>
        <attributes\>
            <key\>Group</key\>
            <dataType\>String</dataType\>
            <value\>Group A</value\>
        </attributes\>
    </targets\>
    <targets\>
        <targetType\>ActionParameter</targetType\>
        <targetName\>Example.Request.inputTwo</targetName\>
        <attributes\>
            <key\>Order</key\>
            <dataType\>Integer</dataType\>
            <value\>2</value\>
        </attributes\>
        <attributes\>
            <key\>Group</key\>
            <dataType\>String</dataType\>
            <value\>Group A</value\>
        </attributes\>
    </targets\>
    <targets\>
        <targetType\>ActionParameter</targetType\>
        <targetName\>Example.Request.inputThree</targetName\>
        <attributes\>
            <key\>Order</key\>
            <dataType\>Integer</dataType\>
            <value\>3</value\>
        </attributes\>
        <attributes\>
            <key\>Group</key\>
            <dataType\>String</dataType\>
            <value\>Group B</value\>
        </attributes\>
    </targets\>
</InvocableActionExt\>

The following example shows how to define static picklist values for an input parameter.

<?xml version="1.0" encoding="UTF-8"?>
<InvocableActionExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <targets\>
        <targetType\>ActionParameter</targetType\>
        <targetName\>Example.Request.inputOne</targetName\>
        <attributes\>
            <key\>ProvidedValueList</key\>
            <dataType\>String</dataType\>
            <value\>option1|Option 1, option2|Option 2, option3|Option 3</value\>
        </attributes\>
    </targets\>
</InvocableActionExtension\>

The following example shows how to reference a dynamic picklist class for an input parameter.

<?xml version="1.0" encoding="UTF-8"?>
<InvocableActionExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <targets\>
        <targetType\>ActionParameter</targetType\>
        <targetName\>Example.Request.inputOne</targetName\>
        <attributes\>
            <key\>ProvidedValueList</key\>
            <dataType\>String</dataType\>
            <value\>apex://MyDynamicPicklistClass</value\>
        </attributes\>
    </targets\>
</InvocableActionExtension\>

The following example shows how to assign a partial custom property editor to a primary parameter and link a related parameter.

<?xml version="1.0" encoding="UTF-8"?>
<InvocableActionExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <targets\>
        <targetType\>ActionParameter</targetType\>
        <targetName\>Example.Request.inputOne</targetName\>
        <attributes\>
            <key\>CpeName</key\>
            <dataType\>String</dataType\>
            <value\>c:myCustomEditor</value\>
        </attributes\>
    </targets\>
    <targets\>
        <targetType\>ActionParameter</targetType\>
        <targetName\>Example.Request.inputTwo</targetName\>
        <attributes\>
            <key\>ConfiguredBy</key\>
            <dataType\>String</dataType\>
            <value\>inputOne</value\>
        </attributes\>
    </targets\>
</InvocableActionExtension\>

The following example shows how to add a custom header to an action.

<?xml version="1.0" encoding="UTF-8"?>
<InvocableActionExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <targets\>
        <targetType\>ActionDefinition</targetType\>
        <targetName\>Example</targetName\>
        <attributes\>
            <key\>CustomHeaderLwcName</key\>
            <dataType\>String</dataType\>
            <value\>c:myCustomHeader</value\>
        </attributes\>
    </targets\>
</InvocableActionExtension\>

The following example shows a package.xml file that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Example</members\>
        <name\>InvocableActionExtension</name\>
    </types\>
    <version\>65.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=b73d641199e2184c3d8f3454ce9089830a5ec35e09bb686b8de1e1100bcb6986 url=/legacydeveloper/current/en-us/api_meta/meta_invocableactionsettings.md -->

# InvocableActionSettings

Represents the org’s invocable action settings, such as whether partial save is allowed.This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

InvocableActionSettings values are stored in the InvocableAction.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

InvocableActionSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d598653e88">Field Name</th>

              <th class="featureTableHeader  " id="d598653e91">Field Type</th>

              <th class="featureTableHeader  " id="d598653e94">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d598653e88" data-title="Field Name"><span class="keyword parmname">isPartialSaveAllowed</span></td>

              <td class="entry" headers="d598653e91" data-title="Field Type">boolean</td>

              <td class="entry" headers="d598653e94" data-title="Description">Indicates whether partial save is enabled for most invocable actions that are
                invoked via REST API and executed in bulk. When the value is <samp class="codeph nolang">true</samp>, Salesforce tries three times to execute
                invocable actions that run successfully and rolls back only the invocable actions
                that fail to execute. This functionality is called partial save. If the field is set
                to <samp class="codeph nolang">false</samp>, if one invocable action fails,
                Salesforce rolls back other invocable actions in the same transaction and the entire
                transaction fails.<p class="p">Corresponds to the Enable Partial Save for Invocable Actions
                  critical update.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the InvocableAction.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<InvocableActionSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <isPartialSaveAllowed\>false</isPartialSaveAllowed\>
</InvocableActionSettings\>

## Example Package Manifest

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>InvocableAction</members\>
		<name\>Settings</name\>
	</types\>
	<version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b53a6f09948ba0fd595b1258d72d74145f1248507bea1590d3cc44d3b9487c63 url=/legacydeveloper/current/en-us/api_meta/meta_ipaddressrange.md -->

# IPAddressRange

Represents a range of IP addresses to include in or exclude from the specified feature.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

IP Address Range components have the suffix .IPAddressRange and are stored in the IPAddressRanges folder.

## Version

IPAddressRange components are available in API version 52.0 and later.

## Special Access Rules

To access IpAddressRange, enable the HtmlEmail permission in your org.

## Fields

| Field Name | Description |
| --- | --- |
| Description | 
Field Type

string

Description

Not required. The description of the IP address range. For example, the name of the company that owns the IP address range.



 |
| developerName | 

Field Type

string

Description

Not required. Gives you a way to distinguish ipAddressRange entries among developers in your org.



 |
| endIpAddress | 

Field Type

string

Description

The end of the IP address range. Must be an IPv4 or IPv6 Internet address and equal to or greater than the startIpAddress.



 |
| ipAddressFeature | 

Field Type

picklist

Description

The feature that uses the range of IP addresses. Possible values are:

- EmailIpFiltering (default) —Filter email engagement activities such as email opens and email clicks.





 |
| ipAddressUsageScope | 

Field Type

picklist

Description

Whether the specified IP addresses are included or excluded. Possible values are:

- Exclusion
- Inclusion





 |
| isProtected | 

Field Type

boolean

Description

Whether the specified IP address range is protected. The default is false.



 |
| masterLabel | 

Field Type

string

Description

Master label for the IP address range. This internal label doesn’t get translated.



 |
| startIpAddress | 

Field Type

string

Description

The start of the IP address range. Must be an IPv4 or IPv6 Internet address and equal to or smaller than the endIpAddress.



 |

## Declarative Metadata Sample Definition

The following is an example of an ipAddressName component.

<?xml version="1.0" encoding="UTF-8"?>
<IPAddressRange xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Filter emails from google.com</description\>
    <endIpAddress\>221.224.222.158</endIpAddress\>
    <ipAddressFeature\>EmailIpFiltering</ipAddressFeature\>
    <ipAddressUsageScope\>Exclusion</ipAddressUsageScope\>
    <masterLabel\>MasterLabelValue</masterLabel\>
    <startIpAddress\>221.224.0.158</startIpAddress\>
    <isProtected\>false</isProtected\>
</IPAddressRange\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>IPAddressRange</name>
    </types>
    <version>1.0</version>
</Package>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=93f2ab0f7a26dcf4ba8a20ff697d2200201568612224009c4f94a375f4dfba0a url=/legacydeveloper/current/en-us/api_meta/meta_keywordlist.md -->

# KeywordList

Represents a list of keywords used in Experience Cloud site moderation. This keyword list is a type of moderation criteria that defines offensive language or inappropriate content that you don’t want in your site.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

Keep the following things in mind when creating keyword list criteria:

- Your org can have up to 30 keyword list criteria. This limit is per org, not per Experience Cloud site.
- A keyword list can have up to 2,000 keywords.
- Capitalization and trailing punctuation are ignored when matching your keywords to user-generated content. For example, if your criteria includes BadWord, it’s matched when a user types BADWORD or badword.

## File Suffix and Directory Location

KeywordList components have the suffix .keywords and are stored in the moderation directory of the corresponding package directory. The file name format follows site\_name.keyword\_list\_developer\_name.keywords.

## Version

KeywordList components are available in API version 36.0 and later.

## Special Access Rules

To view, create, edit, and delete a keyword list, you need the Manage Experiences or Create and Set Up Experiences permission. As of Spring ’20 and later, only users with permission to edit moderation rules can access this object.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| Description | string | A description of the keyword list. |
| keywords | [Keyword](#keywordlist_keyword)\[\] | The keywords you want moderate in your Experience Cloud site. |
| masterLabel | string | Required. Label for the keyword list. |

## Keyword

Keywords in the keyword list.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d599771e226">Field Name</th>

              <th class="featureTableHeader  " id="d599771e229">Field Type</th>

              <th class="featureTableHeader  " id="d599771e232">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d599771e226" data-title="Field Name"><span class="keyword parmname">keyword</span></td>

              <td class="entry" headers="d599771e229" data-title="Field Type">string</td>

              <td class="entry" headers="d599771e232" data-title="Description">Required. Keywords you want to moderate.<ul class="ul bulletList">
                  <li class="li">Keywords can only be up to 100 characters and can include letters, numbers,
                    spaces, and special characters.</li>

                  <li class="li">Wildcard characters aren’t supported.</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a KeywordList component.

<?xml version="1.0" encoding="UTF-8"?>
<KeywordList xmlns="http://soap.sforce.com/2006/04/metadata">
   <masterLabel\>Bad Word List</masterLabel\>
   <description\>List of bad words updated by Joe in Nov 2015.</description\>
   <keywords\>
     <keyword\>bad-word</keyword\>
   </keywords\>
   <keywords\>
     <keyword\>b a d w o r d</keyword\>
   </keywords\>
   <keywords\>
     <keyword\>b@dword</keyword\>
   </keywords\>
</KeywordList\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
     <name\>KeywordList</name\>
     <members\>site1.badword\_list</members\>
   </types\>
   <version\>36.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=d75003ec13fb41b1763e6b7f3f608f7b2baced44ce599897beca5d6a8aeb08b4 url=/legacydeveloper/current/en-us/api_meta/meta_knowledgesettings.md -->

# KnowledgeSettings

Represents the metadata used to manage settings for Salesforce Knowledge.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

KnowledgeSettings values are stored in a single file named Knowledge.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

KnowledgeSettings is available in API version 27.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| answers | [KnowledgeAnswerSettings](#KnowledgeAnswerSettings) | Represents the metadata used to manage settings for Salesforce Knowledge and Answers. |
| cases | [KnowledgeCaseSettings](#KnowledgeCaseSettings) | Represents the metadata used to manage settings for Salesforce Knowledge and Cases. |
| defaultLanguage | string | Required. The default language for Salesforce Knowledge. Use the abbreviation for the language, for example, en\_US for United States English. |
| enableChatterQuestionKBDeflection | boolean | Indicates whether tracking for case deflection via Chatter is enabled (true) or not (false). |
| enableCreateEditOnArticlesTab | boolean | Indicates whether users can create and edit articles on the articles tab (true) or not (false). |
| enableExternalMediaContent | boolean | Indicates whether connecting to external media is enabled (true) or not (false). |
| enableKbStandardSharing | boolean | Indicates whether standard Salesforce sharing is enabled (true) or not (false). |
| enableKnowledge | boolean | Indicates whether Salesforce Knowledge is enabled (true) or not (false). This field is false by default. |
| enableKnowledgeAgentContribution | boolean | Indicates whether a user can create an article from a case (true) or not (false). (Classic only) |
| enableKnowledgeArticleTextHighlights | boolean | Indicates whether text snippet highlights in Salesforce Knowledge search results are enabled (true) or not (false). This field is true by default. Available in API version 47.0 and later. |
| enableKnowledgeAnswersPromotion | boolean | Indicates whether a user can create an article from a reply (true) or not (false). (Classic Only) |
| enableKnowledgeCaseRL | boolean | Indicates whether creating a list of cases linked to an article is enabled (true) or not (false). (Classic Only) |
| enableKnowledgeKeywordAutoComplete | boolean | Indicates whether auto-complete for keywords is enabled (true) or not (false) when searching Salesforce Knowledge. This field is true by default. Available in API version 47.0 and later. |
| enableKnowledgeTitleAutoComplete | boolean | Indicates whether auto-complete for article titles is enabled (true) or not (false) when searching Salesforce Knowledge. This field is true by default. Available in API version 47.0 and later. |
| enableLightningKbAutoLoadRichTextField | boolean | Indicates whether rich text fields are enabled for editing when an article loads in Lightning Knowledge (true) or not (false). This field is false by default. Available in API version 47.0 and later. |
| enableLightningKnowledge | boolean | Indicates whether Lightning Knowledge is enabled (true) or not (false). |
| languages | [KnowledgeLanguageSettings](#KnowledgeLanguageSettings) | A list of languages enabled for Salesforce Knowledge. |
| showArticleSummariesCustomerPortal | boolean | Indicates whether article summaries appear in the Customer Portal (true) or not (false). |
| showArticleSummariesInternalApp | boolean | Indicates whether article summaries appear in the internal knowledge base (true) or not (false). |
| showArticleSummariesPartnerPortal | boolean | Indicates whether article summaries appear in the partner portal (true) or not (false). |
| showValidationStatusField | boolean | Indicates whether validation status appears on articles (true) or not (false). |
| suggestedArticles | [KnowledgeSuggestedArticlesSettings](#KnowledgeSuggestedArticlesSettings) | Represents the metadata used to manage settings for the case fields used to suggest articles for cases. Available in API version 37.0 and later. |
| votingEnabled | boolean | When true, enables users to vote for a product or feature that uses Vote, such as Articles in Knowledge. Available in API version 50.0 and later. |

## KnowledgeAnswerSettings

Represents the metadata used to manage settings for Salesforce Knowledge and Answers.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignTo | string | Specifies the username an article is assigned to from Answers. |
| defaultArticleType | string | The default article type for articles created from Answers. Uses the API name of the article type. |
| enableArticleCreation | boolean | Indicates whether users can create articles from Answers (true) or not (false). |

## KnowledgeCaseSettings

Represents the metadata used to manage settings for Salesforce Knowledge and Cases.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d600401e666">Field Name</th>

              <th class="featureTableHeader  " id="d600401e669">Field Type</th>

              <th class="featureTableHeader  " id="d600401e672">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">articlePDFCreationProfile</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type">string</td>

              <td class="entry" headers="d600401e672" data-title="Description">The profile used to create a PDF of an article from Cases.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">articlePublicSharingSites</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type"><a class="xref" href="#KnowledgeSitesSettings">KnowledgeSitesSettings</a></td>

              <td class="entry" headers="d600401e672" data-title="Description">Represents the metadata used to manage settings for Salesforce Knowledge and
                Sites.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">articlePublicSharingCommunities</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type"><a class="xref" href="#KnowledgeSitesSettings">KnowledgeSitesSettings</a></td>

              <td class="entry" headers="d600401e672" data-title="Description">Represents the metadata used to manage settings for Salesforce Knowledge and
                Experience Cloud sites.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">articlePublicSharingSitesChatterAnswers</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type"><a class="xref" href="#KnowledgeSitesSettings">KnowledgeSitesSettings</a></td>

              <td class="entry" headers="d600401e672" data-title="Description">Represents the metadata used to manage settings for Salesforce Knowledge and
                Sites with Chatter Answers.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">assignTo</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type">string</td>

              <td class="entry" headers="d600401e672" data-title="Description">Specifies the username an article is assigned to from Cases.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">customizationClass</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type">string</td>

              <td class="entry" headers="d600401e672" data-title="Description">Specifies the Apex class used for customization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">defaultContributionArticleType</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type">string</td>

              <td class="entry" headers="d600401e672" data-title="Description">The default article type for articles created from Cases.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">editor</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type">KnowledgeCaseEditor (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d600401e672" data-title="Description">Indicates the rich text editor type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">simple</samp></li>

                  <li class="li"><samp class="codeph nolang">standard</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">enableArticleCreation</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type">boolean</td>

              <td class="entry" headers="d600401e672" data-title="Description">Indicates whether users can create articles from Cases (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Controls whether other fields on KnowledgeCaseSettings can be
                set.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">enableArticlePublicSharingSites</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type">boolean</td>

              <td class="entry" headers="d600401e672" data-title="Description">Indicates whether articles can be shared via a public site (URL) from Cases
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">enableCaseDataCategoryMapping</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type">boolean</td>

              <td class="entry" headers="d600401e672" data-title="Description">Indicates whether Case Data Category mapping is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e666" data-title="Field Name"><span class="keyword parmname">useProfileForPDFCreation</span></td>

              <td class="entry" headers="d600401e669" data-title="Field Type">boolean</td>

              <td class="entry" headers="d600401e672" data-title="Description">Indicates whether a profile is used to create a PDF of an article from Cases
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

          </tbody>

        </table>

## KnowledgeSitesSettings

Represents the metadata used to manage settings for Salesforce Knowledge and Sites.

| Field Name | Field Type | Description |
| --- | --- | --- |
| site | string\[\] | Specifies the site used for Salesforce Knowledge and Sites. |

## KnowledgeLanguageSettings

A list of languages enabled for Salesforce Knowledge. KnowledgeLanguageSettings is available in API version 28.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| language | [KnowledgeLanguage](#KnowledgeLanguage)\[\] | Represents the metadata used to manage settings for the languages enabled for Salesforce Knowledge. |

## KnowledgeLanguage

Represents the metadata used to manage settings for the languages enabled for Salesforce Knowledge. KnowledgeLanguage is available in API version 28.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d600401e1018">Field Name</th>

              <th class="featureTableHeader  " id="d600401e1021">Field Type</th>

              <th class="featureTableHeader  " id="d600401e1024">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d600401e1018" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d600401e1021" data-title="Field Type">boolean</td>

              <td class="entry" headers="d600401e1024" data-title="Description">Indicates whether the language is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e1018" data-title="Field Name"><span class="keyword parmname">defaultAssignee</span></td>

              <td class="entry" headers="d600401e1021" data-title="Field Type">string</td>

              <td class="entry" headers="d600401e1024" data-title="Description">The default assignee for articles in the language.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e1018" data-title="Field Name"><span class="keyword parmname">defaultAssigneeType</span></td>

              <td class="entry" headers="d600401e1021" data-title="Field Type">KnowledgeLanguageLookupValueType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d600401e1024" data-title="Description">Indicates the default assignee type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">User</samp></li>

                  <li class="li"><samp class="codeph nolang">Queue</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e1018" data-title="Field Name"><span class="keyword parmname">defaultReviewer</span></td>

              <td class="entry" headers="d600401e1021" data-title="Field Type">string</td>

              <td class="entry" headers="d600401e1024" data-title="Description">The default reviewer for articles in the language.</td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e1018" data-title="Field Name"><span class="keyword parmname">defaultReviewerType</span></td>

              <td class="entry" headers="d600401e1021" data-title="Field Type">KnowledgeLanguageLookupValueType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d600401e1024" data-title="Description">Indicates the default reviewer type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">User</samp></li>

                  <li class="li"><samp class="codeph nolang">Queue</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d600401e1018" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d600401e1021" data-title="Field Type">string</td>

              <td class="entry" headers="d600401e1024" data-title="Description">The code for the language name, for example: English is <samp class="codeph nolang">en</samp>. See “What languages does
                Salesforce support?” in the Salesforce Help for a list of supported languages
                and their codes.</td>

            </tr>

          </tbody>

        </table>

## KnowledgeSuggestedArticlesSettings

Represents the metadata used to manage settings for the articles suggested for cases, work orders, and work order line items. The Work Order and Work Order Line Item objects must be enabled in the org to use the associated fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| caseFields | [KnowledgeCaseFieldsSettings](#KnowledgeCaseFieldSettings) | Represents a list of the case fields used to suggest articles for the case. |
| useSuggestedArticlesForCase | boolean | Indicates whether case content is used to suggest articles for cases (true) or not (false). |
| workOrderFields | [KnowledgeWorkOrderFieldsSettings](#KnowledgeWorkOrderFieldSettings) | Represents a list of the work order fields used to suggest articles for the work order. |
| workOrderLineItemFields | [KnowledgeWorkOrderLineItemFieldsSettings](#KnowledgeWorkOrderLineItemFieldSettings) | Represents a list of the work order line item fields used to suggest articles for the work order line item. |

## KnowledgeCaseFieldsSettings

Represents a list of the case fields used to suggest articles for the case. Available in API version 37.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | [KnowledgeCaseField](#KnowledgeCaseField)\[\] | Specifies the names of the case fields used to suggest articles for the case. |

## KnowledgeCaseField

Represents the name of the case field used to suggest articles for the case. Available in API version 37.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Specifies the name of the case field used to suggest articles for the case. |

## KnowledgeWorkOrderFieldsSettings

Represents a list of the work order fields used to suggest articles for the work order. Available in API version 39.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | [KnowledgeWorkOrderField](#KnowledgeWorkOrderField)\[\] | Specifies the names of the work order fields used to suggest articles for the work order. |

## KnowledgeWorkOrderField

Represents the name of the work order field used to suggest articles for the work order. Available in API version 39.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Specifies the name of the work order field used to suggest articles for the work order. |

## KnowledgeWorkOrderLineItemFieldsSettings

Represents a list of the work order line item fields used to suggest articles for the work order line item. Available in API version 39.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | [KnowledgeWorkOrderLineItemField](#KnowledgeWOLIField)\[\] | Specifies the names of the work order line item fields used to suggest articles for the work order line item. |

## KnowledgeWorkOrderLineItemField

Represents the name of the work order line item field used to suggest articles for the work order line item. Available in API version 39.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Specifies the name of the work order line item field used to suggest articles for the work order line item. |

## Declarative Metadata Sample Definition

This is a sample Knowledge settings file.

<?xml version="1.0" encoding="UTF-8"?>
<KnowledgeSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <answers\>
        <enableArticleCreation\>false</enableArticleCreation\>
    </answers\>
    <cases\>
        <articlePDFCreationProfile\>partner portal knowledge profile</articlePDFCreationProfile\>
        <articlePublicSharingSites\>
            <site\>KnowledgeSite</site\>
            <site\>PKB2Site</site\>
            <site\>ChatterAnswersSite</site\>
        </articlePublicSharingSites\>
        <articlePublicSharingSitesChatterAnswers\>
            <site\>ChatterAnswersSite</site\>
        </articlePublicSharingSitesChatterAnswers\>
        <assignTo\>testall@kb.org</assignTo\>
        <defaultContributionArticleType\>Support</defaultContributionArticleType\>
        <editor\>simple</editor\>
        <enableArticleCreation\>true</enableArticleCreation\>
        <enableArticlePublicSharingSites\>true</enableArticlePublicSharingSites\>
        <useProfileForPDFCreation\>true</useProfileForPDFCreation\>
    </cases\>
    <defaultLanguage\>ja</defaultLanguage\>
    <enableCreateEditOnArticlesTab\>true</enableCreateEditOnArticlesTab\>
    <enableExternalMediaContent\>true</enableExternalMediaContent\>
    <enableKnowledge\>true</enableKnowledge\>
    <showArticleSummariesCustomerPortal\>true</showArticleSummariesCustomerPortal\>
    <showArticleSummariesInternalApp\>true</showArticleSummariesInternalApp\>
    <showArticleSummariesPartnerPortal\>true</showArticleSummariesPartnerPortal\>
    <showValidationStatusField\>true</showValidationStatusField\>
    <suggestedArticles\>
      <caseFields\>
         <field\>
            <name\>Subject</name\>
         </field\>
         <field\>
            <name\>SuppliedEmail</name\>
         </field\>
      </caseFields\>
      <useSuggestedArticlesForCase\>true</useSuggestedArticlesForCase\>
    </suggestedArticles\>
</KnowledgeSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=9b1fa52583aacd494872e06b810a058ab936848e9b2a733f26ae24c10b0ab201 url=/legacydeveloper/current/en-us/api_meta/meta_languagesettings.md -->

# LanguageSettings

Represents an organization’s language settings. Language settings control end-user language selection, locale formats, and translation options. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

LanguageSettings values are stored in the Language.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

LanguageSettings is available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d605244e103">Field Name</th>

              <th class="featureTableHeader  " id="d605244e106">Field Type</th>

              <th class="featureTableHeader  " id="d605244e109">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">displayedLanguages</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">string</td>

              <td class="entry" headers="d605244e109" data-title="Description"> A comma-separated list of Salesforce language locale codes to
                display, such as <samp class="codeph nolang">en_US, fr, de,
                  ja</samp>. The order of the codes determines the order in
                which languages appear in the list, matching the language order
                setting in the UI. Specify <samp class="codeph nolang">all</samp>
                to display all languages available to the org. If omitted, the
                existing configuration doesn't change. This field is available in
                API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">enableCanadaIcuFormat</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether the ICU format is enabled for the en_CA locale
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">true</samp> for orgs created
                in API version 47.0 and later. Orgs created prior to API version
                47.0 have a default of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">enableDataTranslation</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether data translation is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>. This field is
                available in API version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="ph" id="enableEndUserLanguages"><a name="enableEndUserLanguages"><!-- --></a><span class="keyword parmname">enableEndUserLanguages</span></span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether end-user languages are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">enableICULocaleDateFormat</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether date and currency are formatted with the
                International Components for Unicode (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">true</samp> for orgs created in API
                version 47.0 and later. Orgs created prior to API version 47.0 have
                a default of <samp class="codeph nolang">false</samp>. <p class="p">See
                  <a class="xref" href="https://help.salesforce.com/articleView?id=icu_migration_overview.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Go
                    Global with New International Locale Formats</a> for more
                  information.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">enableLanguageExtensionPackage
                  (beta)</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether the org has enabled language extension packages
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Language extension packages
                contain translations of components in other packages. This field has
                a default value of <samp class="codeph nolang">false</samp>. This
                field is available in API version 58.0 and later.<div class="p">
                  <div class="box message info" id="note_x3f_233_tdc">
                    <a name="note_x3f_233_tdc"><!-- --></a>
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p>enableLanguageExtensionPackage
                              (beta) is a pilot or beta service that is subject to the
                              Beta Services Terms at <a class="xref" href="https://www.salesforce.com/company/legal/agreements/" target="_blank">Agreements -
                                Salesforce.com</a> or a written Unified Pilot
                              Agreement if executed by Customer, and applicable terms in
                              the <a class="xref" href="https://ptd.salesforce.com/" target="_blank">Product Terms Directory</a>. Use of
                              this pilot or beta service is at the Customer's sole
                              discretion.</p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>

                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">enableLocaleInsensitiveFiltering</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether users can filter query results, regardless of
                the locale or language associated with the user (<samp class="codeph nolang">true</samp>) or if they can’t filter
                results (<samp class="codeph nolang">false</samp>). This field has
                a default value of <samp class="codeph nolang">false</samp>. This
                field is available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">enableLocalNamesForStdObjects</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether local name fields can be defined for standard
                objects (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>. This field is
                available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">enablePlatformLanguages</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether platform-only languages are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>. Setting this
                field to <samp class="codeph nolang">true</samp> also sets
                <span class="keyword parmname">enableEndUserLanguages</span><samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">enableTranslationWorkbench</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether the Translation Workbench is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">enableTranslationWorkbenchConnectAPI</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether the Translation Workbench Connect REST API is
                enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>. This field is
                available in API version 67.0 and later</td>

            </tr>

            <tr>
              <td class="entry" headers="d605244e103" data-title="Field Name"><span class="keyword parmname">useLanguageFallback</span></td>

              <td class="entry" headers="d605244e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d605244e109" data-title="Description">Indicates whether translation follows the language fallback rule
                (<samp class="codeph nolang">true</samp>) or returns the
                primary label (<samp class="codeph nolang">false</samp>). This
                field has a default value of <samp class="codeph nolang">true</samp>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a LanguageSettings file.

<?xml version="1.0" encoding="UTF-8"?>
<LanguageSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <displayedLanguages\>en\_US,fr,de,ja</displayedLanguages\>
    <enableCanadaIcuFormat\>true</enableCanadaIcuFormat\>
    <enableDataTranslation\>false</enableDataTranslation\>
    <enableEndUserLanguages\>true</enableEndUserLanguages\>
    <enableICULocaleDateFormat\>true</enableICULocaleDateFormat\>
    <enableLocalNamesForStdObjects\>false</enableLocalNamesForStdObjects\>
    <enablePlatformLanguages\>false</enablePlatformLanguages\>
    <enableTranslationWorkbench\>true</enableTranslationWorkbench\>
    <useLanguageFallback\>true</useLanguageFallback\>
</LanguageSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/​metadata">
    <types\>
        <members\>Language</members\>
        <name\>Settings</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=33ee8d2be1c15b942bee6687160cb6ca6d1292df59f64730fd5d6be195c313c4 url=/legacydeveloper/current/en-us/api_meta/meta_layouts.md -->

# Layout

Represents the metadata associated with a page layout. For more information, see Page Layouts in Salesforce Help.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

To edit the Ideas layout, specify it by name in the package.xml file. In package.xml, use this code to retrieve the Ideas layout. In the <members> tag, specify the object name (Idea) and then the layout name (Idea Layout), separated by a hyphen.

<types\>
    <members\>Idea-Idea Layout</members\>
    <name\>Layout</name\>
</types\>

## File Suffix and Directory Location

Layouts are stored in the layouts directory of the corresponding package directory. The extension is .layout.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet components that are retrieved in the same package.

## Version

Layouts are available in API version 13.0 and later.

## Fields

This metadata type represents the valid values that define a page layout.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e129">Field Name</th>

              <th class="featureTableHeader  " id="d606498e132">Field Type</th>

              <th class="featureTableHeader  " id="d606498e135">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">customButtons</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e135" data-title="Description">The custom buttons for this layout. Each button is a reference to
                a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm" title="Represents a custom button or link defined in a custom object.">WebLink</a>
                on the same object. For example, a ButtonLink refers to a Weblink on
                the same standard or custom object named ButtonLink.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_customconsolecomponent"><a name="field_customconsolecomponent"><!-- --></a>customConsoleComponents</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#CustomConsoleComponent">CustomConsoleComponents</a></td>

              <td class="entry" headers="d606498e135" data-title="Description">Represents custom console components (Visualforce pages, lookup
                fields, or related lists; Canvas apps not available) on a page
                layout. Custom console components only display in the Salesforce
                console.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">emailDefault</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only relevant if <a class="xref" href="#showEmailCheckbox">showEmailCheckbox</a> is set; indicates
                the default value of that checkbox.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">excludeButtons</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e135" data-title="Description">List of standard buttons to exclude from this layout. For
                example, <samp class="codeph xml"><span class="tag">&lt;excludeButtons</span>&gt;Delete<span class="tag">&lt;/excludeButtons</span>&gt;</samp> excludes
                the <strong class="ph uicontrol">Delete</strong> button from this layout.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">feedLayout</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#FeedLayout">FeedLayout</a></td>

              <td class="entry" headers="d606498e135" data-title="Description">Represents the values that define the feed view of a feed-based
                page layout. Feed-based layouts are available on Account, Case,
                Contact, Lead, Opportunity, custom, and external objects. They
                include a feed view and a detail view.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">headers</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">LayoutHeader[] (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d606498e135" data-title="Description">Layout headers are currently only used for tagging, and only
                appear in the UI if tagging is enabled. Valid string values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">PersonalTagging</samp>—tag is private to
                    user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PublicTagging</samp>—tag is viewable any other
                    user who can access the record.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">layoutSections</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">
                <a class="xref" href="#LayoutSection">LayoutSection</a>[]
              </td>

              <td class="entry" headers="d606498e135" data-title="Description">The main sections of the layout containing fields, s-controls,
                and custom links. The order here determines the layout
                order.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_miniLayout"><a name="field_miniLayout"><!-- --></a>miniLayout</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#MiniLayout">MiniLayout</a></td>

              <td class="entry" headers="d606498e135" data-title="Description"><span class="ph" id="mini_layout_desc"><a name="mini_layout_desc"><!-- --></a>A mini layout is used in the mini view
                  of a record in the Console tab, hover details, and event
                  overlays.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">multilineLayoutFields</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e135" data-title="Description">Fields for the special multiline layout fields that appear in
                OpportunityProduct layouts. These fields are otherwise similar to
                <span class="keyword parmname">miniLayoutFields</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">platformActionList</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#PlatformActionList">PlatformActionList</a></td>

              <td class="entry" headers="d606498e135" data-title="Description">The list of actions and their order that appear in the Salesforce
                mobile app action bar for the layout.<p class="p">This field is available in
                  API version 34.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_quickactionlist"><a name="field_quickactionlist"><!-- --></a>quickActionList</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#QuickActionList">QuickActionList</a></td>

              <td class="entry" headers="d606498e135" data-title="Description">
                <span class="ph" id="field_quickactionlist_desc"><a name="field_quickactionlist_desc"><!-- --></a>The list of quick actions
                  that display in the full Salesforce site for the page
                  layout.</span> This field is available in API version 28.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_relatedcontent"><a name="field_relatedcontent"><!-- --></a>relatedContent</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#RelatedContent">RelatedContent</a></td>

              <td class="entry" headers="d606498e135" data-title="Description">The Related Content section of the page layout. This field is
                available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">relatedLists</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">
                <a class="xref" href="#RelatedList">RelatedListItem</a>[]
              </td>

              <td class="entry" headers="d606498e135" data-title="Description">The related lists for the layout, listed in the order they appear
                in the user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">relatedObjects</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e135" data-title="Description">The list of related objects that appears in the mini view of the
                console. In database terms, these objects are foreign key fields on
                the object for the layout. For more information, see Choose Related
                Objects for the Agent Console’s Mini View in Salesforce
                Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">runAssignmentRulesDefault</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only relevant if <a class="xref" href="#showRunAssignmentRulesCheckbox"><span class="keyword parmname">showRunAssignmentRulesCheckbox</span></a>
                is set; indicates the default value of that checkbox.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showEmailCheckbox"><a name="showEmailCheckbox"><!-- --></a>showEmailCheckbox</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only allowed on Case, CaseClose, and Task layouts. If set, a
                checkbox appears to show email.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showHighlightsPanelCheckbox"><a name="showHighlightsPanelCheckbox"><!-- --></a>showHighlightsPanel</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">
                <span class="ph" id="field_showhighlightspanel"><a name="field_showhighlightspanel"><!-- --></a>If set, the highlights panel
                  displays on pages in the Salesforce console.</span> This field is
                available in API version 22.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showInteractionLogPanelCheckbox"><a name="showInteractionLogPanelCheckbox"><!-- --></a>showInteractionLogPanel</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">
                <span class="ph" id="show_interactionlog"><a name="show_interactionlog"><!-- --></a>If set, the interaction log displays
                  on pages in the Salesforce console.</span> This field is available
                in API version 22.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showKnowledgeComponent"><a name="showKnowledgeComponent"><!-- --></a>showKnowledgeComponent</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">
                <span class="ph" id="field_knowledge_sidebar"><a name="field_knowledge_sidebar"><!-- --></a>Only allowed on Case layouts. If
                  set, the Knowledge sidebar displays on cases in the Salesforce
                  console.</span> This field is available in API version 20.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showRunAssignmentRulesCheckbox"><a name="showRunAssignmentRulesCheckbox"><!-- --></a>showRunAssignmentRulesCheckbox</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only allowed on Case, Lead, and Account objects. If set, a
                checkbox appears on the page to show assignment rules.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">showSolutionSection</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only allowed on CaseClose layout. If set, the built-in solution
                information section shows up on the page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_showSubmitAndAttachButton"><a name="field_showSubmitAndAttachButton"><!-- --></a>showSubmitAndAttachButton</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description"><span class="ph" id="field_showSubmitAndAttachButton_desc"><a name="field_showSubmitAndAttachButton_desc"><!-- --></a>Only allowed on
                  Case layout. If set, the <strong class="ph uicontrol">Submit &amp; Add
                    Attachment</strong> button displays on case edit pages to
                  portal users in the Customer Portal.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">summaryLayout</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#summaryLayout">SummaryLayout</a></td>

              <td class="entry" headers="d606498e135" data-title="Description">Controls the appearance of the highlights panel in Salesforce
                Classic, which summarizes key fields in a grid at the top of a page
                layout, when Case Feed is enabled. This field is available in API
                version 18.0 and later.</td>

            </tr>

          </tbody>

        </table>

## CustomConsoleComponents

Represents custom console components (Visualforce pages, lookup fields, or related lists; Canvas apps not available) on a page layout. Custom console components only appear in the Salesforce console. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| primaryTabComponents | [PrimaryTabComponents](#PrimaryTabComponents) | Represents custom console components on primary tabs in the Salesforce console. Available in API version 25.0 and later. |
| subtabComponents | [SubtabComponents](#SubtabComponents) | Represents custom console components on subtabs in the Salesforce console. Available in API version 25.0 and later. |

## PrimaryTabComponents

Represents custom console components on primary tabs in the Salesforce console. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| component | [ConsoleComponent](#ConsoleComponent)\[\] | Represents a custom console component (Visualforce page, lookup field, or related lists; Canvas apps not available) on a section of a page layout. Custom console components only appear in the Salesforce console. This field is available in API version 29.0 and earlier. |
| containers | [Container](#Container)\[\] | Represents a location and style to display more than one custom console component on the sidebars of the Salesforce console. You can specify up to five components for each of the four locations (left, right, top, and bottom). This field is available in API version 30.0 and later. |

## ConsoleComponent

Represents a custom console component (Visualforce page, lookup field, or related lists; Canvas apps not available) on a section of a page layout. Custom console components only appear in the Salesforce console. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| height | int | Required for components with a location of top or bottom. The height of the custom console component. The value must be specified in pixels and be greater than 0 but less than 999. |
| location | string | Required. The location of the custom console component on the page layout. Valid values are right, left, top, and bottom. A component can have one location for each page layout. |
| visualforcePage | string | Required. The unique name of the custom console component. For example, ConsoleComponentPage. |
| width | int | Required for components with a location of left or right. The width of the custom console component. The value must be specified in pixels and be greater than 0 but less than 999. |

## Container

Represents a location and style to display more than one custom console component in the sidebars of the Salesforce console. For example, you can show multiple components in the right sidebar of the console with a style of either stack, tabs, or accordion. Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e792">Field Name</th>

              <th class="featureTableHeader  " id="d606498e795">Field Type</th>

              <th class="featureTableHeader  " id="d606498e798">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required for components with a location of top or bottom. The
                height of the components’ container. The <a class="xref" href="#unitField"><span class="keyword parmname">unit</span></a> field determines the unit
                of measurement, in pixels or percent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">isContainerAutoSizeEnabled</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required. If set to <samp class="codeph nolang">true</samp>,
                stacked console components in the sidebars autosize vertically. Set
                to <samp class="codeph nolang">true</samp> by default for newly
                created console components. Available in API version 32.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">region</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required. The location of the components’ container. Valid
                values include:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">right</samp></li>

                  <li class="li"><samp class="codeph nolang">left</samp></li>

                  <li class="li"><samp class="codeph nolang">top</samp></li>

                  <li class="li"><samp class="codeph nolang">bottom</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">sidebarComponents</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">
                <a class="xref" href="#SidebarComponent">SidebarComponent</a>[]
              </td>

              <td class="entry" headers="d606498e798" data-title="Description">Represents a specific custom console component to display in the
                components’ container.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">style</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required. The style of the container to display multiple
                components. Valid values include:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">stack</samp>—a content
                    area with multiple frames.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">tabs</samp>—a single
                    content area with a list of multiple panels.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">accordian</samp>—a
                    collapsible content area.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname" id="unitField"><a name="unitField"><!-- --></a>unit</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required. The unit of measurement, in pixels or percent, for the
                height or width of the components’ container. <p class="p">Pixel values
                  are simply the number of pixels, for example, <samp class="codeph nolang">500</samp>, and must be greater than 0
                  but less than 999. Percentage values must include the percent
                  sign, for example, <samp class="codeph nolang">20%</samp>, and
                  must be greater than 0 but less than 100.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required for components with a location of right or left. The
                width of the components’ container. The
                <span class="keyword parmname">unit</span> field determines the unit of
                measurement, in pixels or percent.
              </td>

            </tr>

          </tbody>

        </table>

## SidebarComponent

Represents a specific custom console component to display in a container that hosts multiple components in one of the sidebars of the Salesforce console. You can specify up to five components for each of the four container locations (left, right, top, and bottom). Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e986">Field Name</th>

              <th class="featureTableHeader  " id="d606498e989">Field Type</th>

              <th class="featureTableHeader  " id="d606498e992">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">componentType</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">Specifies the component type. Valid values are <samp class="codeph nolang">KnowledgeOne</samp>, <samp class="codeph nolang">Lookup</samp>, <samp class="codeph nolang">Milestones</samp>, <samp class="codeph nolang">RelatedList</samp>, <samp class="codeph nolang">Topics</samp>, <samp class="codeph nolang">Files</samp>,
                and <samp class="codeph nolang">CaseExperts</samp>. This field is
                available in API version 31.0 and later. The <samp class="codeph nolang">Files</samp> and <samp class="codeph nolang">CaseExperts</samp> values are available in
                API version 32.0 and later.
                <p class="p">Case Experts is available through a pilot program.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">createAction</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a lookup field, the name of the quick action
                used to create a record. This field is available in API version 42.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">enableLinking</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e992" data-title="Description">
                <p class="p">If the component is a lookup field, lets users associate a record
                  with this field. This field is available in API version 42.0 and
                  later.</p>

                <p class="p">If false, the createAction and updateAction can’t be
                  retrieved.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e992" data-title="Description">Required for components with a location of top or bottom. The
                height of the component in the container. The
                <span class="keyword parmname">unit</span> field determines the unit of
                measurement, in pixels or percent.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">The name of the component as it appears to console users.
                Available for components in a container with the style of tabs or
                accordion.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">lookup</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a lookup field, the name of the
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a Visualforce page, the name of the
                Visualforce page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">relatedlists</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">
                <a class="xref" href="#RelatedList2">RelatedList</a>[]
              </td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a related list, the name of the list. This
                field is available in API version 31.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname" id="unitField2"><a name="unitField2"><!-- --></a>unit</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">The unit of measurement, in pixels or percent, for the height or
                width of the component in the container. <p class="p">Pixel values are simply
                  the number of pixels, for example, <samp class="codeph nolang">500</samp>, and must be greater than 0 but less than 999.
                  Percentage values must include the percent sign, for example,
                  <samp class="codeph nolang">20%</samp>, and must be
                  greater than 0 but less than 100.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">updateAction</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a lookup field, the name of the quick action
                used to update a record. This field is available in API version 42.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e992" data-title="Description">Required for components with a location of right or left. The
                width of the component in the container. The
                <span class="keyword parmname">unit</span> field determines the unit of
                measurement, in pixels or percent.
              </td>

            </tr>

          </tbody>

        </table>

## RelatedList

Represents related list custom components on the sidebars of the Salesforce console. Available in API version 31.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| hideOnDetail | boolean | If set to true, the related list is hidden from detail pages where it appears as a component to prevent duplicate information from showing. |
| name | string | The name of the component as it appears to console users. |

## SubtabComponents

Represents custom console components on subtabs in the Salesforce console. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| component | [ConsoleComponent](#ConsoleComponent)\[\] | Represents a custom console component (Visualforce page, lookup field, or related lists; Canvas apps not available) on a section of a page layout. Custom console components only appear in the Salesforce console. This field is available in API version 29.0 and earlier. |
| containers | [Container](#Container)\[\] | Represents a location and style to display more than one custom console component on the sidebars of the Salesforce console. You can specify up to five components for each of the four locations (left, right, top, and bottom). This field is available in API version 30.0 and later. |

## FeedLayout

Represents the values that define the feed view of a feed-based page layout. Feed-based layouts are available on Account, Case, Contact, Lead, Opportunity, custom, and external objects. They include a feed view and a detail view. Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d606498e1369">Field Name</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1372">Field Type</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1375">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">autocollapsePublisher</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e1375" data-title="Description">Specifies whether the publisher is automatically collapsed when
                the page loads (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">compactFeed</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e1375" data-title="Description"><span class="ph" id="compactFeed"><a name="compactFeed"><!-- --></a>Specifies whether the feed-based page layout
                  uses a compact feed (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). If set to
                  <samp class="codeph nolang">true</samp>, feed items on the
                  page are collapsed by default, and the feed view has an updated
                  design.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">feedFilterPosition</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">FeedLayoutFilterPosition (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e1375" data-title="Description">Where the feed filters list is included in the layout. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">centerDropDown</samp>—as a dropdown list in the
                    center column.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">leftFixed</samp>—as a
                    fixed list in the left column.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">leftFloat</samp>—as a
                    floating list in the left column.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">feedFilters</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">
                <a class="xref" href="#FeedLayoutFilter">FeedLayoutFilter</a>[]
              </td>

              <td class="entry" headers="d606498e1375" data-title="Description">The individual filters displayed in the feed filters
                list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">fullWidthFeed</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e1375" data-title="Description">Specifies whether the feed expands horizontally to take up all
                available space on the page (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">hideSidebar</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e1375" data-title="Description">Specifies whether the sidebar is hidden (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">leftComponents</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">
                <a class="xref" href="#FeedLayoutComponent">FeedLayoutComponent</a>[]
              </td>

              <td class="entry" headers="d606498e1375" data-title="Description">The individual components displayed in the left column of the
                feed view.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">rightComponents</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">
                <a class="xref" href="#FeedLayoutComponent">FeedLayoutComponent</a>[]
              </td>

              <td class="entry" headers="d606498e1375" data-title="Description">The individual components displayed in the right column of the
                feed view.</td>

            </tr>

          </tbody>

        </table>

## FeedLayoutComponent

Represents a component in the feed view of a feed-based page layout. Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d606498e1573">Field Name</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1576">Field Type</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1579">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e1573" data-title="Field Name"><span class="keyword parmname">componentType</span></td>

              <td class="entry" headers="d606498e1576" data-title="Field Type">FeedLayoutComponentType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e1579" data-title="Description">Required. The type of component. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">HelpAndToolLinks</samp>—icons that link to the
                    help topic for the page, the page layout, and, the printable
                    view of the page. Available only on Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomButtons</samp>—a
                    custom button.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Following</samp>—an
                    icon that toggles between a Follow button (if the user
                    viewing a record doesn’t already follow it) and a Following
                    indicator (if the user viewing a record does follow
                    it).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Followers</samp>—a list
                    of users who follow the record.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomLinks</samp>—a
                    custom link.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Milestones</samp>—the
                    milestone tracker, which lets users see the status of a
                    milestone on a case. Available only on Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Topics</samp>—a list of
                    topics related to the record.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CaseUnifiedFiles</samp>—a list
                    of all files that are attached to the case.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Visualforce</samp>—a
                    custom Visualforce component.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1573" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d606498e1576" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e1579" data-title="Description">The height, in pixels, of the component. Doesn’t apply to <samp class="codeph nolang">standardComponents</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1573" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d606498e1576" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e1579" data-title="Description">The name of a Visualforce page being used as a custom
                component.</td>

            </tr>

          </tbody>

        </table>

## FeedLayoutFilter

Represents a feed filter option in the feed view of a feed-based page layout. A filter must have only standardFilter or feedItemType set. Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d606498e1713">Field Name</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1716">Field Type</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1719">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e1713" data-title="Field Name"><span class="keyword parmname">feedFilterName</span></td>

              <td class="entry" headers="d606498e1716" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e1719" data-title="Description">The name of a CustomFeedFilter component. Names are prefixed with
                the name of the parent object. For example,
                <kbd class="ph userinput">Case.MyCustomFeedFilter</kbd>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1713" data-title="Field Name"><span class="keyword parmname">feedFilterType</span></td>

              <td class="entry" headers="d606498e1716" data-title="Field Type">FeedLayoutFilterType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e1719" data-title="Description">The type of filter. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AllUpdates</samp>—shows
                    all feed items on a record.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FeedItemType</samp>—shows feed items only for a
                    particular type of activity on the record.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1713" data-title="Field Name"><span class="keyword parmname">feedItemType</span></td>

              <td class="entry" headers="d606498e1716" data-title="Field Type">FeedItemType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e1719" data-title="Description">The type of feed item to display. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ActivityEvent</samp>—feed items related to
                    activity on tasks and events associated with a case.
                    Available only on Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AdvancedTextPost</samp>–feed items related to
                    group announcements posted on a feed. This value is
                    available in API version 31.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AnnouncementPost</samp>–Not used.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ApprovalPost</samp>—feed items related to
                    approvals that are submitted on a feed.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AttachArticleEvent</samp>—feed items for activity
                    related to attaching articles to cases. Available only on
                    Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">BasicTemplateFeedItem</samp>—Not used.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CallLogPost</samp>—feed
                    items for activity from the Log a Call action. Available
                    only on layouts for objects that support Activities (tasks
                    and events).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CanvasPost</samp>—feed
                    items related to posts that a canvas app makes on a
                    feed.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CaseCommentPost</samp>—feed items for activity
                    from the Case Note action. Available only on Case
                    layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ChangeStatusPost</samp>—feed items for activity
                    from the Change Status action. Available only on Case
                    layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ChatTranscriptPost</samp>—feed items for activity
                    related to attaching Chat transcripts to cases. Available
                    only on Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CollaborationGroupCreated</samp>—feed items
                    related to creating a public group.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CollaborationGroupUnarchived</samp>—Not
                    used.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ContentPost</samp>—feed
                    items related to attaching a file to a post.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CreatedRecordEvent</samp>—feed items related to
                    creating a record from the publisher.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DashboardComponentSnapshot</samp>—feed items
                    related to posting a dashboard snapshot on a feed.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EmailMessageEvent</samp>—feed items for activity
                    from the Email action. Available only on Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FacebookPost</samp>—Not
                    used.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LinkPost</samp>—feed
                    items related to attaching a URL to a post.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MilestoneEvent</samp>—feed items for changes to
                    the milestone status on a case. Available only on Case
                    layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PollPost</samp>—feed
                    items related to posting a poll on a feed.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ProfileSkillPost</samp>—feed items related to
                    skills added to a user’s Chatter profile. This value
                    is available in API version 31.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">QuestionPost</samp>—feed items related to posting
                    a question on a feed. This value is available in API version
                    31.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ReplyPost</samp>—feed
                    items for activity from the Portal action. Available only on
                    Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RypplePost</samp>—feed
                    items related to creating a Thanks badge in WDC.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SocialPost</samp>—feed
                    items for activity on Twitter from the Social Post
                    action.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TextPost</samp>—feed
                    items for creating a text post from the publisher.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="type_trackedchange"><a name="type_trackedchange"><!-- --></a>TrackedChange</samp>—feed items related to a
                    change or group of changes to a tracked field.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UserStatus</samp>—Not
                    used.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## MiniLayout

Represents a mini view of a record in the Console tab, hover details, and event overlays.

| Field Name | Field Type | Description |
| --- | --- | --- |
| fields | string\[\] | The fields for the mini-layout, listed in the order they appear in the UI. Fields that appear here must appear in the main layout. |
| relatedLists | [RelatedListItem](#RelatedList)\[\] | The mini related list, listed in the order they appear in the UI. You can’t set sorting on mini related lists. Fields that appear here must appear in the main layout. |

## LayoutSection

LayoutSection represents a section of a page layout, such as the Custom Links section.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e2034">Field Name</th>

              <th class="featureTableHeader  " id="d606498e2037">Field Type</th>

              <th class="featureTableHeader  " id="d606498e2040">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">customLabel</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2040" data-title="Description">Indicates if this section’s label is custom or standard
                (built-in). Custom labels can be any text, but must be translated.
                Standard labels have a predefined set of valid values, for example
                System Information, which are automatically
                translated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">detailHeading</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2040" data-title="Description">Controls if this section appears in the detail page. In the UI,
                this setting corresponds to the checkbox in the section details
                dialog.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">editHeading</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2040" data-title="Description">Controls if this section appears in the edit page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2040" data-title="Description">The label; either standard or custom, based on the
                <span class="keyword parmname">customLabel</span> flag.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">layoutColumns</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">
                <a class="xref" href="#LayoutColumn">LayoutColumn</a>[]
              </td>

              <td class="entry" headers="d606498e2040" data-title="Description">The columns of the layout, depending on the style. 1, 2, or 3
                columns, ordered left to right, are possible.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">style</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">LayoutSectionStyle (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e2040" data-title="Description">The style of the layout:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">TwoColumnsTopToBottom</samp> -
                    Two columns, tab goes top to bottom
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TwoColumnsLeftToRight</samp> -
                    Two columns, tab goes left to right
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OneColumn</samp> - One
                    column
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomLinks</samp> - Contains
                    custom links only
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## LayoutColumn

LayoutColumn represents the items in a column within a layout section.

| Field Name | Field Type | Description |
| --- | --- | --- |
| layoutItems | [LayoutItem](#LayoutItem)\[\] | The individual items within a column (ordered from top to bottom). |
| reserved | string | This field is reserved for Salesforce. The field resolves an issue with some SOAP libraries. Any value entered in the field is ignored. |

## LayoutItem

LayoutItem represents the valid values that define a layout item. An item must have only one of the following values set: component, customLink, field, s-control, page, analyticsCloudComponent, or reportChartComponent.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e2254">Field Name</th>

              <th class="featureTableHeader  " id="d606498e2257">Field Type</th>

              <th class="featureTableHeader  " id="d606498e2260">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">behavior</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">UiBehavior (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Determines the field behavior. Valid string values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Edit</samp>—The layout
                    field can be edited but isn’t required.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Required</samp>—The
                    layout field can be edited and is required.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Readonly</samp>—The
                    layout field is read-only.
                  </li>

                </ul>
                <p class="p">Explicitly
                  specifying UiBehavior for Knowledge articles results in an
                  exception.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">canvas</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">
                <span class="ph" id="layoutitem_canvas_short_desc"><a name="layoutitem_canvas_short_desc"><!-- --></a>Reference to a canvas
                  app.</span>
                <p class="p">This field is available in API version 31.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">component</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Reference to a component. Value must be
                <kbd class="ph userinput">sfa:socialCard</kbd>.<p class="p">This field is available
                  in API version 30.0 and later. This field is allowed only inside
                  a <span class="keyword parmname">RelatedContentItem</span>.
                  <kbd class="ph userinput">sfa:socialCard</kbd> is supported only on
                  page layouts for contacts, accounts, and leads.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">customLink</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">The <span class="keyword parmname">customLink</span> reference. This field is
                allowed only inside a <span class="keyword parmname">CustomLink</span>
                <span class="keyword parmname">layoutSection</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">emptySpace</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Controls if this layout item is a blank space.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">The field name reference, relative to the layout object, for
                example <samp class="codeph nolang">Description</samp> or <samp class="codeph nolang">MyField__c</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e2260" data-title="Description">For s-control and pages only, the height in pixels.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Reference to a Visualforce page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="analyticsCloud_component"><a name="analyticsCloud_component"><!-- --></a>analyticsCloudComponent</span></span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type"><a class="xref" href="#analyticsCloud_layoutitem">AnalyticsCloudComponentLayoutItem</a></td>

              <td class="entry" headers="d606498e2260" data-title="Description">
                <span class="ph" id="analyticsCloud_component_desc"><a name="analyticsCloud_component_desc"><!-- --></a>Refers to a CRM Analytics
                  dashboard that you can add to a standard or custom object
                  page.</span>
                <p class="p">This field is available in API version 34.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="reportChart_component"><a name="reportChart_component"><!-- --></a>reportChartComponent</span></span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type"><a class="xref" href="#reportchart_layoutitem">ReportChartComponentLayoutItem</a></td>

              <td class="entry" headers="d606498e2260" data-title="Description"><span class="ph" id="reportChart_component_desc"><a name="reportChart_component_desc"><!-- --></a>Refers to a report chart that
                  you can add to a standard or custom object page.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">scontrol</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Reference to an s-control.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">showLabel</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2260" data-title="Description">For s-control and pages only, whether to show the label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">showScrollbars</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2260" data-title="Description">For s-control and pages only, whether to show scrollbars.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">For s-control and pages only, the width in pixels or percent.
                Pixel values are simply the number of pixels, for example, <samp class="codeph nolang">500</samp>. Percentage values must include
                the percent sign, for example, <samp class="codeph nolang">20%</samp>.</td>

            </tr>

          </tbody>

        </table>

## AnalyticsCloudComponentLayoutItem

Represents the settings for a CRM Analytics dashboard on a standard or custom page. Available in API version 34.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assetType | string | Required. Specifies the type of CRM Analytics asset to add. The available asset type is dashboard. |
| devName | string | Required. Unique development name of the dashboard to add. |
| error | string | Error string; only populated if an error occurred in the underlying dashboard. |
| filter | string | Communicates initial dashboard filters for mapping data fields in the dashboard to the object’s fields, so that the dashboard shows only the data that’s relevant for the record being viewed. |
| height | int | Specifies the height of the dashboard, in pixels. The default is 400. |
| hideOnError | boolean | Controls whether users see a dashboard that has an error. When this attribute is set to true, if the dashboard has an error, the dashboard doesn’t appear on the page. When set to false, the dashboard appears but doesn’t show any data except the error. An error can happen when a user doesn’t have access to CRM Analytics or to the dashboard. The default is true. |
| showSharing | boolean | If set to true, and the dashboard is shareable, then the dashboard shows the Share icon. Users can click the icon to open the Share dialog and post or download from the dashboard. If set to false, the dashboard doesn’t show the Share icon. This field is available in API version 37.0 and later. |
| showTitle | boolean | If true, includes the dashboard’s title above the dashboard. If false, the dashboard appears without a title. The default is true. |
| width | string | Specifies the width of the dashboard, in pixels or percent. Pixel values are simply the number of pixels, for example, 500. Percentage values must include the percent sign, for example, 20%. The default is 100%. |

## ReportChartComponentLayoutItem

Represents the settings for a report chart on a standard or custom page.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e2744">Field Name</th>

              <th class="featureTableHeader  " id="d606498e2747">Field Type</th>

              <th class="featureTableHeader  " id="d606498e2750">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">cacheData</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2750" data-title="Description">
                <span class="ph" id="meta_reportChartCompLayoutItem_cacheData"><a name="meta_reportChartCompLayoutItem_cacheData"><!-- --></a>Indicates
                  whether to use cached data when displaying the chart. When the
                  attribute is set to <samp class="codeph nolang">true</samp>,
                  data is cached for 24 hours. If the attribute is set to <samp class="codeph nolang">false</samp>, the report isn’t run
                  every time the page is refreshed.</span>
                <p class="p">This field is available
                  in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">contextFilterableField</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2750" data-title="Description">Unique development name of the field by which a report chart is
                filtered to return data relevant to the page. If set, the ID field
                for the parent object of the page or report type is the chart data
                filter. The parent object for the report type and the page must
                match for a chart to return relevant data.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">error</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2750" data-title="Description">
                <span class="ph" id="meta_reportChartCompLayoutItem_error"><a name="meta_reportChartCompLayoutItem_error"><!-- --></a>Error string; only
                  populated if an error occurred in the underlying
                  report.</span>
                <p class="p">This field is available in API version 31.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">hideOnError</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2750" data-title="Description">
                <span class="ph" id="meta_reportChartCompLayoutItem_hideOnError"><a name="meta_reportChartCompLayoutItem_hideOnError"><!-- --></a>Controls
                  whether users see a chart that has an error. When there’s an
                  error and this attribute is set, the chart doesn’t show any data
                  except the error. An error can happen for many reasons, such as
                  when a user doesn’t have access to fields used by the chart or a
                  chart has been removed from the report. Set the attribute to
                  <samp class="codeph nolang">true</samp> to hide the chart
                  from a page on error.</span>
                <p class="p">This field is available in API
                  version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">includeContext</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2750" data-title="Description">If <samp class="codeph nolang">true</samp>, filters the report
                chart to return data that’s relevant to the page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">reportName</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2750" data-title="Description">Unique development name of a report that includes a
                chart.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">showTitle</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2750" data-title="Description">If <samp class="codeph nolang">true</samp>, applies the title
                from the report to the chart.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">size</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">
                <p class="p">ReportChartComponentSize</p>
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d606498e2750" data-title="Description"> The chart size is medium when no value is specified. Valid values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">SMALL</samp></li>

                  <li class="li"><samp class="codeph nolang">MEDIUM</samp></li>

                  <li class="li"><samp class="codeph nolang">LARGE</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## PlatformActionList

PlatformActionList represents the list of actions and their order that appear in the Salesforce mobile app action bar for the layout. Available in API version 34.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e2932">Field Name</th>

              <th class="featureTableHeader  " id="d606498e2935">Field Type</th>

              <th class="featureTableHeader  " id="d606498e2938">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e2932" data-title="Field Name"><span class="keyword parmname">actionListContext</span></td>

              <td class="entry" headers="d606498e2935" data-title="Field Type">PlatformActionListContext (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e2938" data-title="Description">Required. The context of the action list. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Assistant</samp></li>

                  <li class="li"><samp class="codeph nolang">BannerPhoto</samp></li>

                  <li class="li"><samp class="codeph nolang">Chatter</samp></li>

                  <li class="li"><samp class="codeph nolang">Dockable</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedElement</samp></li>

                  <li class="li"><samp class="codeph nolang">Flexipage</samp></li>

                  <li class="li"><samp class="codeph nolang">Global</samp></li>

                  <li class="li"><samp class="codeph nolang">ListView</samp></li>

                  <li class="li"><samp class="codeph nolang">ListViewDefinition</samp></li>

                  <li class="li"><samp class="codeph nolang">ListViewRecord</samp></li>

                  <li class="li"><samp class="codeph nolang">Lookup</samp></li>

                  <li class="li"><samp class="codeph nolang">MruList</samp></li>

                  <li class="li"><samp class="codeph nolang">MruRow</samp></li>

                  <li class="li"><samp class="codeph nolang">ObjectHomeChart</samp></li>

                  <li class="li"><samp class="codeph nolang">Photo</samp></li>

                  <li class="li"><samp class="codeph nolang">Record</samp></li>

                  <li class="li"><samp class="codeph nolang">RecordEdit</samp></li>

                  <li class="li"><samp class="codeph nolang">RelatedList</samp></li>

                  <li class="li"><samp class="codeph nolang">RelatedListRecord</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2932" data-title="Field Name"><span class="keyword parmname">platformActionListItems</span></td>

              <td class="entry" headers="d606498e2935" data-title="Field Type">
                <a class="xref" href="#PlatformActionListItem">PlatformActionListItem</a>[]
              </td>

              <td class="entry" headers="d606498e2938" data-title="Description">The actions in the PlatformActionList.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2932" data-title="Field Name"><span class="keyword parmname">relatedSourceEntity</span></td>

              <td class="entry" headers="d606498e2935" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2938" data-title="Description">When the <span class="keyword parmname">ActionListContext</span> is RelatedList or
                RelatedListRecord, this field represents the API name of the related
                list to which the action belongs.</td>

            </tr>

          </tbody>

        </table>

## PlatformActionListItem

PlatformActionListItem represents an action in the PlatformActionList. Available in API version 34.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e3102">Field Name</th>

              <th class="featureTableHeader  " id="d606498e3105">Field Type</th>

              <th class="featureTableHeader  " id="d606498e3108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e3102" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d606498e3105" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3108" data-title="Description">The API name for the action in the list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3102" data-title="Field Name"><span class="keyword parmname">actionType</span></td>

              <td class="entry" headers="d606498e3105" data-title="Field Type">PlatformActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e3108" data-title="Description">The type of action. Valid values are: <a name="PlatformActionTypeEnumValues"><!-- --></a>
                <ul class="ul bulletList" id="PlatformActionTypeEnumValues">
                  <li class="li">
                    <samp class="codeph nolang">ActionLink</samp>—An
                    indicator on a feed element that targets an API, a web page,
                    or a file, represented by a button in the Salesforce Chatter
                    feed UI.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomButton</samp>—When clicked, opens a URL or a
                    Visualforce page in a window or executes JavaScript.
                  </li>

                  <li class="li"><samp class="codeph nolang">InvocableAction</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ProductivityAction</samp>—Productivity actions are
                    predefined and attached to a limited set of objects.
                    Productivity actions include Send Email, Call, Map, View
                    Website, and Read News. Except for the Call action, you
                    can’t edit productivity actions.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">QuickAction</samp>—A
                    global or object-specific action.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">StandardButton</samp>—A
                    predefined Salesforce button such as New, Edit, and
                    Delete.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3102" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d606498e3105" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e3108" data-title="Description">The placement of the action in the list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3102" data-title="Field Name"><span class="keyword parmname">subtype</span></td>

              <td class="entry" headers="d606498e3105" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3108" data-title="Description">The subtype of the action. For quick actions, the subtype is
                <samp class="codeph nolang">QuickActionType</samp>. For custom
                buttons, the subtype is <samp class="codeph nolang">WebLinkTypeEnum</samp>. For action links, subtypes are
                <samp class="codeph nolang">Api</samp>, <samp class="codeph nolang">ApiAsync</samp>, <samp class="codeph nolang">Download</samp>, and <samp class="codeph nolang">Ui</samp>. Standard buttons and
                productivity actions have no subtype.
              </td>

            </tr>

          </tbody>

        </table>

## QuickActionList

QuickActionList represents the list of actions associated with the page layout. Available in API version 28.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| quickActionListItems | [QuickActionListItem](#QuickActionListItem)\[\] | Array of zero or more QuickActionList objects. |

## QuickActionListItem

QuickActionListItem represents an action in the QuickActionList. Available in API version 28.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| quickActionName | string | The API name of the action. |

## RelatedContent

RelatedContent represents the Mobile Cards section of the page layout. Available in API version 29.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| relatedContentItems | [RelatedContentItem](#RelatedContentItem)\[\] | A list of layout items in the Mobile Cards section of the page layout. |

## RelatedContentItem

RelatedContentItem represents an individual item in the [RelatedContentItem](#RelatedContentItem) list. Available in API version 29.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| layoutItem | [LayoutItem](#LayoutItem) | An individual [LayoutItem](#LayoutItem) in the Mobile Cards section. |

## RelatedListItem

RelatedListItem represents a related list in a page layout.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e3472">Field Name</th>

              <th class="featureTableHeader  " id="d606498e3475">Field Type</th>

              <th class="featureTableHeader  " id="d606498e3478">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">customButtons</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e3478" data-title="Description">A list of custom buttons that are used on the related
                list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">excludeButtons</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e3478" data-title="Description">A list of buttons that are excluded from the related
                list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e3478" data-title="Description">A list of fields that are displayed in the related
                list.<p class="p">Retrieval of standard fields on related lists uses
                  aliases instead of field or API names. For example, the
                  <span class="keyword parmname">Fax</span>, <span class="keyword parmname">Mobile</span>, and
                  <span class="keyword parmname">Home Phone</span> fields are retrieved as
                  Phone2, Phone3, and Phone4, respectively.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">quickActions</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e3478" data-title="Description">A list of quick actions that are used on the related
                list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">relatedList</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3478" data-title="Description">Required. The name of the related list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">sortField</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3478" data-title="Description">The name of the field that is used for sorting.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">SortOrder (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e3478" data-title="Description">If the <span class="keyword parmname">sortField</span> is set, the
                <span class="keyword parmname">sortOrder</span> field determines the sort order.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Asc</samp> - Sort in ascending
                    order
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Desc</samp> - Sort in
                    descending order
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## SummaryLayout

When Case Feed is enabled, controls the appearance of the highlights panel in Salesforce Classic, which summarizes key fields in a grid at the top of a page layout. Available in API version 25.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e3639">Field Name</th>

              <th class="featureTableHeader  " id="d606498e3642">Field Type</th>

              <th class="featureTableHeader  " id="d606498e3645">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Required. The name of the layout label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">sizeX</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Required. Number of columns in the highlights pane, from 1
                through 4 (inclusive).</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">sizeY</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Required. Number of rows in each column, either 1 or
                2.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">sizeZ</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Reserved for future use. If provided, the setting is
                visible to users.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">summaryLayoutItems</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">
                <a class="xref" href="#summaryLayoutItem">SummaryLayoutItem</a>[]
              </td>

              <td class="entry" headers="d606498e3645" data-title="Description">Controls the appearance of an individual field and its column
                and row position within the highlights panel grid, when Case
                Feed is enabled. At least one is required.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">summaryLayoutStyle</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">SummaryLayoutStyle (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Highlights panel style. Valid string values are:<ul class="ul bulletList">
                  <li class="li">Default</li>

                  <li class="li">QuoteTemplate</li>

                  <li class="li">DefaultQuoteTemplate</li>

                  <li class="li">CaseInteraction</li>

                  <li class="li">QuickActionLayoutLeftRight (Available in API version
                    28.0 and later.)</li>

                  <li class="li">QuickActionLayoutTopDown (Available in API version 28.0
                    and later.)</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## SummaryLayoutItem

Controls the appearance of an individual field and its column and row position within the highlights panel grid, when Case Feed is enabled. You can have two fields per each grid in a highlights panel. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| customLink | string | The customLink reference, if the item is a custom link. |
| field | string | The field name reference, relative to the page layout. Must be a standard or custom field that also exists on the detail page. |
| posX | int | Required. The item’s column position in the highlights panel grid. Must be within the range of [sizeX](#sizeXDef). |
| posY | int | Required. The item’s row position in the highlights panel grid. Must be within the range of [sizeY](#sizeYDef). |
| posZ | int | Reserved for future use. If provided, the setting is visible to users. |

## Declarative Metadata Sample Definition

This sample defines a page layout.

<?xml version="1.0" encoding="UTF-8"?>
<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
   <customConsoleComponents\>
    <primaryTabComponents\>
       <container\>
           <region\>left</region\>
          <style\>Stack</style\>
          <unit\>Pixel</unit\>
          <width\>101</width\>
          <sidebarComponent\>
                <width\>60</width\>
                <page\>simplepage1</page\>
                <unit\>Percentage</unit\>
          </sidebarComponent\>
          <sidebarComponent\>
                <width\>40</width\>
                <page\>Hello\_World</page\>
                <unit\>Percentage</unit\>
          </sidebarComponent\>
       </container\>
    </primaryTabComponents\>
    <subtabComponents\>
       <component\>
          <location\>top</location\>
          <visualforcePage\>ConsoleComponentPage2</visualforcePage\>
          <height\>200</height\>
       </component\>
    </subtabComponents\>
   </customConsoleComponents\>
    <customButtons\>ButtonLink</customButtons\>
    <layoutSections\>
        <editHeading\>true</editHeading\>
        <label\>Information</label\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Required</behavior\>
                <field\>Name</field\>
            </layoutItems\>
            <layoutItems\>
                <height\>180</height\>
                <scontrol\>LayoutSControl</scontrol\>
                <showLabel\>true</showLabel\>
                <showScrollbars\>true</showScrollbars\>
                <width\>50%</width\>
            </layoutItems\>
            <layoutItems\>
                <reportChartComponent\>
                   <contextFilterableField\>CUST\_ID</contextFilterableField\>
                   <includeContext\>true</includeContext\>
                   <reportName\>Open\_Accounts\_by\_Cases</reportName\>
                   <showTitle\>false</showTitle\>
                   <size\>LARGE</size\>
                <reportChartComponent\>
            </layoutItems\>
        </layoutColumns\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Edit</behavior\>
                <field\>OwnerId</field\>
            </layoutItems\>
            <layoutItems\>
                <behavior\>Edit</behavior\>
                <field\>CurrencyIsoCode</field\>
            </layoutItems\>
        </layoutColumns\>
        <style\>TwoColumnsTopToBottom</style\>
    </layoutSections\>
    <layoutSections\>
        <editHeading\>true</editHeading\>
        <label\>System Information</label\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>CreatedById</field\>
            </layoutItems\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>Alpha1\_\_c</field\>
            </layoutItems\>
            <layoutItems\>
                <height\>200</height\>
                <page\>mcanvasPage</page\>
                <showLabel\>true</showLabel\>
                <showScrollbars\>false</showScrollbars\>
                <width\>100%</width\>
            </layoutItems\>
        </layoutColumns\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>LastModifiedById</field\>
            </layoutItems\>
            <layoutItems\>
                <behavior\>Edit</behavior\>
                <field\>TextArea\_\_c</field\>
            </layoutItems\>
        </layoutColumns\>
        <style\>TwoColumnsTopToBottom</style\>
    </layoutSections\>
    <layoutSections\>
        <customLabel\>true</customLabel\>
        <detailHeading\>true</detailHeading\>
        <label\>Custom Links</label\>
        <layoutColumns\>
            <layoutItems\>
                <customLink\>CustomWebLink</customLink\>
            </layoutItems\>
        </layoutColumns\>
        <style\>CustomLinks</style\>
    </layoutSections\>
     <quickActionList\>
        <quickActionListItems\>
            <quickActionName\>FeedItem.TextPost</quickActionName\>
        </quickActionListItems\>
        <quickActionListItems\>
            <quickActionName\>FeedItem.ContentPost</quickActionName\>
        </quickActionListItems\>
        <quickActionListItems\>
            <quickActionName\>FeedItem.LinkPost</quickActionName\>
        </quickActionListItems\>
        <quickActionListItems\>
            <quickActionName\>FeedItem.PollPost</quickActionName\>
        </quickActionListItems\>
    </quickActionList\>
    <relatedContent\>
        <relatedContentItems\>
            <layoutItem\>
                <component\>sfa:socialPanel</component\>
            </layoutItem\>
        <relatedContentItems\>
    </relatedContent\>
    <miniLayoutFields\>Name</miniLayoutFields\>
    <miniLayoutFields\>OwnerId</miniLayoutFields\>
    <miniLayoutFields\>CurrencyIsoCode</miniLayoutFields\>
    <miniLayoutFields\>Alpha1\_\_c</miniLayoutFields\>
    <miniLayoutFields\>TextArea\_\_c</miniLayoutFields\>
    <miniRelatedLists\>
        <relatedList\>RelatedNoteList</relatedList\>
    </miniRelatedLists\>
    <relatedLists\>
        <fields\>StepStatus</fields\>
        <fields\>CreatedDate</fields\>
        <fields\>OriginalActor</fields\>
        <fields\>Actor</fields\>
        <fields\>Comments</fields\>
        <fields\>Actor.Alias</fields\>
        <fields\>OriginalActor.Alias</fields\>
        <relatedList\>RelatedProcessHistoryList</relatedList\>
    </relatedLists\>
    <relatedLists\>
        <relatedList\>RelatedNoteList</relatedList\>
    </relatedLists\>
</Layout\>

This example shows a layout using <summaryLayout\>.

<?xml version="1.0" encoding="UTF-8"?>
<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
    <layoutSections\>
        <editHeading\>true</editHeading\>
        <label\>System Information</label\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>CreatedById</field\>
            </layoutItems\>
            <layoutItems\>
                <behavior\>Required</behavior\>
                <field\>Name</field\>
            </layoutItems\>
        </layoutColumns\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>LastModifiedById</field\>
            </layoutItems\>
        </layoutColumns\>
        <style\>TwoColumnsTopToBottom</style\>
    </layoutSections\>
    <summaryLayout\>
        <masterLabel\>Great Name</masterLabel\>
        <sizeX\>4</sizeX\>
        <sizeY\>2</sizeY\>
        <summaryLayoutItems\>
            <posX\>0</posX\>
            <posY\>0</posY\>
            <field\>Name</field\>
        </summaryLayoutItems\>
    </summaryLayout\>
</Layout\>

This example shows a feed-based layout.

<Layout\>
...
    <feedLayout\>
        <leftComponents\>
            <componentType\>customLinks</componentType\>
        </leftComponents\>
        <rightComponents\>
            <componentType\>follow</componentType\>
        </rightComponents\>
        <rightComponents\>
            <componentType\>followers</componentType\>
        </rightComponents\>
        <rightComponents\>
            <componentType\>visualforce</componentType\>
            <page\>accountCustomWidget</page\>
            <height\>200</height\>
        </rightComponents\>
        <hideSidebar\>true</hideSidebar\>
        <feedFilterPosition\>centerDropDown</feedFilterPosition\>
        <feedFilters\>
    <feedFilerType\>allUpdates</feedFilerType\>
        </feedFilters\>
        <feedFilters\>
    <feedFilerType\>feedItemType</feedFilerType\>
    <feedItemType\>CallLogPost</feedItemType\>
        </feedFilters\>
        <feedFilters\>
    <feedFilerType\>feedItemType</feedFilerType\>
    <feedItemType\>TextPost</feedItemType\>
        </feedFilters\>
    </feedLayout\>
...
</Layout\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=2c60acee800838498a36c87267762cc887eed4935b368382ae249d11dcbf9b4a url=/legacydeveloper/current/en-us/api_meta/meta_leadconfigsettings.md -->

# LeadConfigSettings

Represents configuration settings for Leads that control how they are converted and displayed, and what actions are available. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

LeadConfigSettings values are stored in the LeadConfig.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

LeadConfigSettings is available in API versions 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d618509e100">Field Name</th>

              <th class="featureTableHeader  " id="d618509e103">Field Type</th>

              <th class="featureTableHeader  " id="d618509e106">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">doesEnableLeadConvertDefaultSubjectBlankTaskCreation</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">Configures whether tasks without a subject are created during
                lead conversion. If <samp class="codeph nolang">true</samp>, tasks
                are created when the default subject field has no value. If <samp class="codeph nolang">false</samp>, only tasks with a subject
                are created.</td>

            </tr>

            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">doesHideOpportunityInConvertLeadWindow</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">Hides the opportunity section of the Convert Lead window during
                lead conversion. <p class="p">Default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">doesPreserveLeadStatus</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">If your org uses record types, the lead status changes to the
                lead status value of the new owner's record type during conversion.
                Set <span class="keyword parmname">doesPreserveLeadStatus</span> to <samp class="codeph nolang">true</samp> to preserve the value of the
                lead status during conversion.<p class="p">Orgs that use record types can
                  create a lead process that allows different lead status values
                  for different record types. If
                  <span class="keyword parmname">doesPreserveLeadStatus</span> is <samp class="codeph nolang">false</samp>, the lead status might
                  change during lead conversion if the new owner's record type has
                  a different default value for lead status.
                </p>
                <p class="p">Default value
                  is <samp class="codeph nolang">true</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">doesSelectNoOpportunityOnConvertLead</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">Prevents an opportunity from being created when the lead is
                converted.<p class="p">Default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">doesTrackHistory</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">Enables field history tracking for leads. When field history
                tracking is enabled, users can choose the fields they want to track.
                <p class="p">Default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">enableConversionsOnMobile</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">Lets a user convert leads on their mobile devices. The Convert
                Lead action converts qualified leads to contacts. <p class="p">Default value
                  is <samp class="codeph nolang">true</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">enableOrgWideMergeAndDelete</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">Lets a user merge and delete leads. The user must also have the
                Public Read/Write/Transfer permission.<p class="p">Default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">relateEmailsToContactOnConvert</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">Associates the lead's emails with the contact that it's converted
                to.<p class="p">Default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">shouldLeadConvertRequireValidation</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">Enforces validation rules when converting leads. <p class="p">Default value
                  is <samp class="codeph nolang">true</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d618509e100" data-title="Field Name"><span class="keyword parmname">shouldSendNotificationEmailWhenLeadOwnerUpdatesViaApexInLEX</span></td>

              <td class="entry" headers="d618509e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d618509e106" data-title="Description">Indicates whether an email notification is sent when the lead
                owner is updated through Apex in Lightning Experience.<p class="p">Default
                  value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the LeadConfigSettings type:

<?xml version="1.0" encoding="UTF-8"?>
<LeadConfigSettings xmlns="http://soap.sforce.com/2006/04/metadata">
<doesEnableLeadConvertDefaultSubjectBlankTaskCreation\>false</doesEnableLeadConvertDefaultSubjectBlankTaskCreation\>
<doesHideOpportunityInConvertLeadWindow\>false</doesHideOpportunityInConvertLeadWindow\>
<doesPreserveLeadStatus\>true</doesPreserveLeadStatus\>
<doesSelectNoOpportunityOnConvertLead\>false</doesSelectNoOpportunityOnConvertLead\>
<doesTrackHistory\>false</doesTrackHistory\>
<enableConversionsOnMobile\>true</enableConversionsOnMobile\>
<enableOrgWideMergeAndDelete\>false</enableOrgWideMergeAndDelete\>
<shouldLeadConvertRequireValidation\>true</shouldLeadConvertRequireValidation\>
<shouldSendNotificationEmailWhenLeadOwnerUpdatesViaApexInLEX\>false</shouldSendNotificationEmailWhenLeadOwnerUpdatesViaApexInLEX\>
</LeadConfigSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the LeadConfig settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>
<!--

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>LeadConfig</members\>
        <name\>Settings</name\>
    </types\>
    <version\>61.0</version\>
</Package\>

<!-- document id=30bdc836f6273f19b64b217bfd7265584cf48eefde619431c04ff14a8a7d80ac url=/legacydeveloper/current/en-us/api_meta/meta_leadconvertsettings.md -->

# LeadConvertSettings

Represents an organization’s custom field mappings for lead conversion. Custom fields can be mapped from Leads to Accounts, Contacts, and Opportunities. Options for creating opportunities during lead conversion can also be specified. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

LeadConvertSettings components have the suffix LeadConvertSetting and are stored in the LeadConvertSettings folder.

## Version

LeadConvertSettings is available in API versions 39.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| allowOwnerChange | 
Field Type

boolean

Description

Indicates whether to include the **Record Owner** field in the **Convert Lead** dialog box (true) or not (false).



 |
| objectMapping | 

Field Type

[ObjectMapping\[\]](#ObjectMapping)

Description

A set of custom field mappings between objects. Up to three objectMapping types can be declared—one each for account, contact, and opportunity.



 |
| opportunityCreationOptions | 

Field Type

VisibleOrRequired (enumeration of type string)

Description

This field determines whether the **Opportunity** field is visible or required in the **Convert Lead** dialog box.

Values are:

- VisibleOptional—The **Opportunity** field is included in the dialog box but not required. A new opportunity is created if the user enters an opportunity name. This is the default value.
- VisibleRequired—The **Opportunity** field is included in the dialog box and is required. A new opportunity is created based on the name the user enters.
- NotVisible—The **Opportunity** field is not included in the dialog box. No opportunity is created.





 |

## ObjectMapping

Represents a custom field mapping between two objects.

| Field Name | Description |
| --- | --- |
| inputObject | 
Field Type

string

Description

Required.

The name of the object type containing the source fields for mapping. The value is always Lead.



 |
| mappingFields | 

Field Type

[ObjectMappingField\[\]](#ObjectMappingField)

Description

A set of input and output field names of the custom fields to be mapped.



 |
| outputObject | 

Field Type

string

Description

Required.

The object type receiving data during lead conversion.

- Account
- Contact
- Opportunity





 |

## ObjectMappingField

Represents custom field names to be mapped between objects.

| Field Name | Description |
| --- | --- |
| inputField | 
Field Type

string

Description

Required.

The name of a custom lead field supplying source data during lead conversion.



 |
| outputField | 

Field Type

string

Description

Required.

The name of a custom account, contact, or opportunity field that will receive data from source field named in the accompanying inputField entry.



 |

## Declarative Metadata Sample Definition

The following is an example of the LeadConvertSettings type:

<?xml version="1.0" encoding="UTF-8"?>
<LeadConvertSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <allowOwnerChange\>false</allowOwnerChange\>
    <objectMapping\>
        <inputObject\>Lead</inputObject\>
        <mappingFields\>
            <inputField\>custom\_lead\_field\_1</inputField\>
            <outputField\>custom\_account\_field\_1</outputField\>
        </mappingFields\>
        <mappingFields\>
            <inputField\>custom\_lead\_field\_2</inputField\>
            <outputField\>custom\_account\_field\_2</outputField\>
        </mappingFields\>
        <mappingFields\>
            <inputField\>custom\_lead\_field\_3</inputField\>
            <outputField\>custom\_account\_field\_3</outputField\>
        </mappingFields\>
        <outputObject\>Account</outputObject\>
    </objectMapping\>
    <objectMapping\>
        <inputObject\>Lead</inputObject\>
        <mappingFields\>
            <inputField\>custom\_lead\_field\_4</inputField\>
            <outputField\>custom\_opportunity\_field\_1</outputField\>
        </mappingFields\>
        <outputObject\>Opportunity</outputObject\>
    </objectMapping\>
    <opportunityCreationOptions\>VisibleOptional</opportunityCreationOptions\>
</LeadConvertSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=28dfd7edb13efe5d4ab55f727b900ca50c3d82fc3700dfe1fd608ed27894e163 url=/legacydeveloper/current/en-us/api_meta/meta_learningitemtype.md -->

# LearningItemType

Represents a custom exercise type that an Enablement user takes in an Enablement program in the Guidance Center. A custom exercise type also requires a corresponding LearningItem record for the Guidance Center and corresponding EnblProgramTaskDefinition and EnblProgramTaskSubCategory records for when admins create a program in Program Builder.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

LearningItemType components have the suffix .learningItemType and are stored in the learningItemTypes folder.

## Version

LearningItemType components are available in API version 62.0 and later.

## Special Access Rules

- For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license.
- For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Custom exercises aren’t compatible with Partner Enablement programs.

## Fields

| Field Name | Description |
| --- | --- |
| apexEvaluationHandler | 
Field Type

string

Description

The ID of the Apex class that specifies how progress and completion of the custom exercise is assessed when users take the program in the Guidance Center.



 |
| apexSerializerDeserializer | 

Field Type

string

Description

The ID of the Apex class that specifies how data related to the custom exercise type is retrieved and deployed with change sets or managed packages.



 |
| customField | 

Field Type

string

Description

Required. The programmatic name of a custom lookup field on the [LearningItem object](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_learningitem.htm "HTML (New Window)") that references the custom object used with this custom exercise.

For example, if a custom exercise type shows a screen flow, maybe the custom object’s name is ScreenFlow\_Object\_\_c and the custom field on LearningItem is named ScreenFlow\_Field\_\_c. For details, see [Implement Custom Exercise Types for Enablement Programs](https://developer.salesforce.com/docs/sales/enablement/guide/enablement-custom-exercises-intro.html "HTML (New Window)") in the _Sales Programs and Partner Tracks with Enablement Developer Guide_.

This field is unique within your organization.





 |
| customObject | 

Field Type

string

Description

Required. The programmatic name of the custom object used with this custom exercise.

For example, if a custom exercise type shows a screen flow, maybe the custom object’s name is ScreenFlow\_Field\_\_c. For details, see [Implement Custom Exercise Types for Enablement Programs](https://developer.salesforce.com/docs/sales/enablement/guide/enablement-custom-exercises-intro.html "HTML (New Window)") in the _Sales Programs and Partner Tracks with Enablement Developer Guide_.

This field is unique within your organization.





 |
| developerName | 

Field Type

string

Description

Required. The unique programmatic name for the LearningItemType record.





 |
| icon | 

Field Type

string

Description

Required. The icon to use for the custom exercise type in the Guidance Center.

Use the format iconType:iconName, where the values correspond to icon categories and names from the [Salesforce Lightning Design System](https://www.lightningdesignsystem.com/icons/ "HTML (New Window)").

- iconType is the type of icon, such as standard or doctype.
- iconName is the icon name, such as flow or slide.

For example, to use the Standard type Flow icon, this value is standard:flow.





 |
| lightningComponentDefinition | 

Field Type

string

Description

Required. The ID of the Lightning Web Component used to show the custom exercise’s content when a user opens the exercise in the Guidance Center.

This field sets the value of the LightningComponentName field on the [LearningItemType object](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_learningitemtype.htm "HTML (New Window)").





 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for the LearningItemType, which is defined when it’s created.





 |

## Declarative Metadata Sample Definition

The following is an example of a LearningItemType component for a custom exercise type that shows a screen flow.

<?xml version="1.0" encoding="UTF-8"?>
<LearningItemType xmlns="http://soap.sforce.com/2006/04/metadata">
    <apexEvaluationHandler\>ScreenFlowEvaluationHandler</apexEvaluationHandler\>
    <apexSerializerDeserializer\>ScreenFlowSerializerDeserializer</apexSerializerDeserializer\>
    <customField\>ScreenFlow\_Field\_\_c</customField\>
    <customObject\>ScreenFlow\_Object\_\_c</customObject\>
    <developerName\>ScreenFlowLearningItemType</developerName\>
    <icon\>standard:flow</icon\>
    <lightningComponentDefinition\>screenFlowViewer</lightningComponentDef\>
    <masterLabel\>Screen Flow Exercise</masterLabel\>
</LearningItemType\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ScreenFlowLearningItemType</members\>
        <name\>LearningItemType</name\>
    </types\>
    <version\>62.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=b10d5fc593ed05cbec149f425c89392f82e66d0f2fabc5367cb1a75f9a9ec803 url=/legacydeveloper/current/en-us/api_meta/meta_letterhead.md -->

# Letterhead

Represents formatting options for the letterhead in an email template. A letterhead defines the logo, page color, and text settings for your HTML email templates. Use letterheads to ensure a consistent look and feel in your company’s emails.

For more information, see “Create Classic Letterheads for Email Templates” in the Salesforce online help. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

The file suffix for letterheads is .letter and components are stored in the letterhead directory of the corresponding package directory.

## Version

Letterheads are available in API version 12.0 and later.

## Fields

With the exception of logo, and horizontal and vertical alignment, all of these fields are required.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d621375e101">Field Name</th>

              <th class="featureTableHeader  " id="d621375e104">Field Type</th>

              <th class="featureTableHeader  " id="d621375e107">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">available</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type">boolean</td>

              <td class="entry" headers="d621375e107" data-title="Description">Required. Indicates whether this letterhead can be used (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>), for example, in an email
                template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">backgroundColor</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type">string</td>

              <td class="entry" headers="d621375e107" data-title="Description">Required. The background color, in hexadecimal, for example
                <samp class="codeph nolang">#FF6600</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">bodyColor</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type">string</td>

              <td class="entry" headers="d621375e107" data-title="Description">Required. The body color in hexadecimal.</td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">bottomLine</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type">LetterheadLine (enumeration of type string)</td>

              <td class="entry" headers="d621375e107" data-title="Description">Required. The style for the bottom line. Valid style values
                include:<a name="LetterheadLine"><!-- --></a>
                <ul class="ul bulletList" id="LetterheadLine">
                  <li class="li">
                    <samp class="codeph nolang">color</samp>. The color of the
                    line in hexadecimal, as a string value.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">height</samp>. The height of
                    the line, as an int value.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type">string</td>

              <td class="entry" headers="d621375e107" data-title="Description">Text description of how this letterhead differs from other
                letterheads.</td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type">string</td>

              <td class="entry" headers="d621375e107" data-title="Description">The internal name of the letterhead, based on the
                <span class="keyword parmname">name</span>, but with white spaces and special
                characters escaped out for validity.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">footer</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type"><a class="xref" href="#LetterheadHeaderFooterTitle">LetterheadHeaderFooter</a></td>

              <td class="entry" headers="d621375e107" data-title="Description">Required. The style for the footer.</td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname" id="emailtemplate_type"><a name="emailtemplate_type"><!-- --></a>header</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type"><a class="xref" href="#LetterheadHeaderFooterTitle">LetterheadHeaderFooter</a></td>

              <td class="entry" headers="d621375e107" data-title="Description">Required. The style for the header.</td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">middleLine</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type"><a class="xref" href="#LetterheadLineTitle">LetterheadLine</a></td>

              <td class="entry" headers="d621375e107" data-title="Description">Required. The style for the middle border line in your
                letterhead. Valid style values include:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">color</samp>. The color of the
                    line in hexadecimal, as a string value.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">height</samp>. The height of
                    the line, as an int value.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type">string</td>

              <td class="entry" headers="d621375e107" data-title="Description">Required. The name of the letterhead.</td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e101" data-title="Field Name"><span class="keyword parmname">topLine</span></td>

              <td class="entry" headers="d621375e104" data-title="Field Type"><a class="xref" href="#LetterheadLineTitle">LetterheadLine</a></td>

              <td class="entry" headers="d621375e107" data-title="Description">Required. The style for the top horizontal line below the header.
                Valid style values include:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">color</samp>. The color of the
                    line in hexadecimal, as a string value.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">height</samp>. The height of
                    the line, as an int value.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## LetterheadHeaderFooter

LetterheadHeaderFooter represents the properties of a header or footer.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d621375e340">Field</th>

              <th class="featureTableHeader  " id="d621375e343">Field Type</th>

              <th class="featureTableHeader  " id="d621375e346">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d621375e340" data-title="Field"><span class="keyword parmname">backgroundColor</span></td>

              <td class="entry" headers="d621375e343" data-title="Field Type">string</td>

              <td class="entry" headers="d621375e346" data-title="Description">Required. The background color of the header or footer in
                hexadecimal format.</td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e340" data-title="Field"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d621375e343" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dashboard.htm#DashboardComponent">DashboardComponent</a>[]
              </td>

              <td class="entry" headers="d621375e346" data-title="Description">Required. The height of the header or footer.</td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e340" data-title="Field"><span class="keyword parmname">horizontalAlignment</span></td>

              <td class="entry" headers="d621375e343" data-title="Field Type">LetterheadHorizontalAlignment (enumeration of type
                string)</td>

              <td class="entry" headers="d621375e346" data-title="Description">The horizontal alignment of the header or footer. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Left</samp></li>

                  <li class="li"><samp class="codeph nolang">Center</samp></li>

                  <li class="li"><samp class="codeph nolang">Right</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e340" data-title="Field"><span class="keyword parmname">logo</span></td>

              <td class="entry" headers="d621375e343" data-title="Field Type">string</td>

              <td class="entry" headers="d621375e346" data-title="Description">The logo which is a reference to a document, for example <samp class="codeph nolang">MyFolder/MyDocument.gif</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d621375e340" data-title="Field"><span class="keyword parmname">verticalAlignment</span></td>

              <td class="entry" headers="d621375e343" data-title="Field Type">LetterheadVerticalAlignment (enumeration of type string)</td>

              <td class="entry" headers="d621375e346" data-title="Description">The vertical alignment of the header or footer. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Top</samp></li>

                  <li class="li"><samp class="codeph nolang">Middle</samp></li>

                  <li class="li"><samp class="codeph nolang">Bottom</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## LetterheadLine

LetterheadLine represents the properties of a line.

| Field | Field Type | Description |
| --- | --- | --- |
| color | string | Required. The color of the line in hexadecimal format. |
| height | int | Required. The height of the line. |

## Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>
<Letterhead xmlns="http://soap.sforce.com/2006/04/metadata">
    <available\>true</available\>
    <backgroundColor\>#CCCCCC</backgroundColor\>
    <bodyColor\>#33FF33</bodyColor\>
    <bottomLine\>
        <color\>#3333FF</color\>
        <height\>5</height\>
    </bottomLine\>
    <description\>INITIAL</description\>
    <footer\>
        <backgroundColor\>#FFFFFF</backgroundColor\>
        <height\>100</height\>
        <horizontalAlignment\>Left</horizontalAlignment\>
        <verticalAlignment\>Top</verticalAlignment\>
    </footer\>
    <header\>
        <backgroundColor\>#FFFFFF</backgroundColor\>
        <height\>100</height\>
        <horizontalAlignment\>Left</horizontalAlignment\>
        <verticalAlignment\>Top</verticalAlignment\>
    </header\>
    <middleLine\>
        <color\>#AAAAFF</color\>
        <height\>5</height\>
    </middleLine\>
    <name\>SimpleLetterheadLabel</name\>
    <topLine\>
        <color\>#FF99FF</color\>
        <height\>5</height\>
    </topLine\>
</Letterhead\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=4edf22ab76c155feb051b520759aa7930bea70c5c93b3ed7225dae36ecd2c5be url=/legacydeveloper/current/en-us/api_meta/meta_lightningbolt.md -->

# LightningBolt

Represents the definition of a Lightning Bolt Solution, which can include custom apps, flow categories, and Experience Builder templates. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

LightningBolt components have the suffix .lightningBolt and are stored in the lightningBolts folder.

## Version

LightningBolt components are available in API version 43.0 and later.

## Special Access Rules

To add Experience Builder templates to a Lightning Bolt Solution, enable digital experiences in your org.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d623036e98">Field Name</th>

              <th class="featureTableHeader  " id="d623036e101">Field Type</th>

              <th class="featureTableHeader  " id="d623036e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d623036e98" data-title="Field Name"><span class="keyword parmname">category</span></td>

              <td class="entry" headers="d623036e101" data-title="Field Type">LightningBoltCategory (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d623036e104" data-title="Description">Required. The primary industry that the Lightning Bolt Solution is aimed at.
                Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Communications</samp></li>

                  <li class="li"><samp class="codeph nolang">Education</samp></li>

                  <li class="li"><samp class="codeph nolang">FinancialServices</samp></li>

                  <li class="li"><samp class="codeph nolang">GeneralBusiness</samp></li>

                  <li class="li"><samp class="codeph nolang">Government</samp></li>

                  <li class="li"><samp class="codeph nolang">HealthcareLifeSciences</samp></li>

                  <li class="li"><samp class="codeph nolang">HighTech</samp></li>

                  <li class="li"><samp class="codeph nolang">Manufacturing</samp></li>

                  <li class="li"><samp class="codeph nolang">Media</samp></li>

                  <li class="li"><samp class="codeph nolang">Nonprofits</samp></li>

                  <li class="li"><samp class="codeph nolang">ProfessionalServices</samp></li>

                  <li class="li"><samp class="codeph nolang">RealEstate</samp></li>

                  <li class="li"><samp class="codeph nolang">Retail</samp></li>

                  <li class="li"><samp class="codeph nolang">TravelTransportationHospitality</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d623036e98" data-title="Field Name"><span class="keyword parmname">lightningBoltFeatures</span></td>

              <td class="entry" headers="d623036e101" data-title="Field Type">
                <a class="xref" href="#LightningBoltFeatures">LightningBoltFeatures</a>[]
              </td>

              <td class="entry" headers="d623036e104" data-title="Description">
                <p class="p">The list of feature descriptions of this Lightning Bolt Solution.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d623036e98" data-title="Field Name"><span class="keyword parmname">lightningBoltImages</span></td>

              <td class="entry" headers="d623036e101" data-title="Field Type">
                <a class="xref" href="#LightningBoltImages">LightningBoltImages</a>[]
              </td>

              <td class="entry" headers="d623036e104" data-title="Description">The list of images of this Lightning Bolt Solution.</td>

            </tr>

            <tr>
              <td class="entry" headers="d623036e98" data-title="Field Name"><span class="keyword parmname">lightningBoltItems</span></td>

              <td class="entry" headers="d623036e101" data-title="Field Type">
                <a class="xref" href="#LightningBoltItems">LightningBoltItems</a>[]
              </td>

              <td class="entry" headers="d623036e104" data-title="Description">The list of items (custom apps, flow categories, and Experience Builder
                templates) that comprise this Lightning Bolt Solution.</td>

            </tr>

            <tr>
              <td class="entry" headers="d623036e98" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d623036e101" data-title="Field Type">string</td>

              <td class="entry" headers="d623036e104" data-title="Description">Required. The label of the Lightning Bolt Solution, which appears on the
                solution detail page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d623036e98" data-title="Field Name"><span class="keyword parmname">publisher</span></td>

              <td class="entry" headers="d623036e101" data-title="Field Type">string</td>

              <td class="entry" headers="d623036e104" data-title="Description">Required. The name of the partner org associated with this Lightning Bolt
                Solution.</td>

            </tr>

            <tr>
              <td class="entry" headers="d623036e98" data-title="Field Name"><span class="keyword parmname">summary</span></td>

              <td class="entry" headers="d623036e101" data-title="Field Type">string</td>

              <td class="entry" headers="d623036e104" data-title="Description">Required. The summary description of the Lightning Bolt Solution.</td>

            </tr>

          </tbody>

        </table>

## LightningBoltFeatures

Represents the list of feature descriptions of a Lightning Bolt Solution.

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | A description of the feature of the Lightning Bolt Solution. |
| order | int | Required. An integer specifying the position of this feature relative to others in the list. 1 is the first position, and 4 is the max position. |
| title | string | Required. The title of the feature, which appears on the solution detail page. |

## LightningBoltImages

Represents the list of images of a Lightning Bolt Solution.

| Field Name | Field Type | Description |
| --- | --- | --- |
| image | string | Required. The developer name of the [ContentAsset](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_contentasset.htm "Represents the metadata for creating an asset file. Asset files enable a Salesforce file to be used for org setup and configuration purposes. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.") type, which is used as a preview image for this Lightning Bolt Solution. |
| order | int | Required. An integer specifying the position of this image relative to others in the list. 1 is the first position, and 3 is the max position. |

## LightningBoltItems

Represents the list of items (custom apps, flow categories, and Experience Builder templates) that comprise a Lightning Bolt Solution.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d623036e464">Field Name</th>

              <th class="featureTableHeader  " id="d623036e467">Field Type</th>

              <th class="featureTableHeader  " id="d623036e470">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d623036e464" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d623036e467" data-title="Field Type">string</td>

              <td class="entry" headers="d623036e470" data-title="Description">Required. The name of the item, which appears on the solution detail
                page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d623036e464" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d623036e467" data-title="Field Type">string</td>

              <td class="entry" headers="d623036e470" data-title="Description">Required. The type of the item included in the Lightning Bolt Solution. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CommunityTemplateDefinition</samp></li>

                  <li class="li"><samp class="codeph nolang">CustomApplication</samp></li>

                  <li class="li"><samp class="codeph nolang">FlowCategory</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a LightningBolt component.

<?xml version="1.0" encoding="UTF-8"?>
<LightningBolt xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <category\>Sales</category\>
    <lightningBoltFeatures\>
        <description\>bb</description\>
        <order\>1</order\>
        <title\>aa</title\>
    </lightningBoltFeatures\>
    <lightningBoltImages\>
        <image\>prm1</image\>
        <order\>1</order\>
    </lightningBoltImages\>
    <lightningBoltItems\>
        <name\>PolaConsole</name\>
        <type\>CustomApplication</type\>
    </lightningBoltItems\>
    <lightningBoltItems\>
        <name\>Banking\_Service\_Console</name\>
        <type\>CustomApplication</type\>
    </lightningBoltItems\>
    <lightningBoltItems\>
        <name\>Banking\_Service\_Portal</name\>
        <type\>CommunityTemplateDefinition</type\>
    </lightningBoltItems\>
    <lightningBoltItems\>
        <name\>Banking\_Sales\_Portal</name\>
        <type\>CommunityTemplateDefinition</type\>
    </lightningBoltItems\>
    <lightningBoltItems\>
        <name\>myorgdev\_\_updatebenefits</name\>
        <type\>FlowCategory</type\>
    </lightningBoltItems\>
    <masterLabel\>BoltTe</masterLabel\>
    <publisher\>aaaa</publisher\>
    <summary\>This is a summary.</summary\>

</LightningBolt\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>BoltTe</members\>
        <name\>LightningBolt</name\>
    </types\>
    <version\>43.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=303bf73d75dc1114ee2fac56b203c6b0b0e0667658e3bd3639b5eb168b9ac010 url=/legacydeveloper/current/en-us/api_meta/meta_lightningcomponentbundle.md -->

# LightningComponentBundle

Represents a Lightning web component bundle. A bundle contains Lightning web component resources.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Special Access Rules

LightningComponentBundle components can be created only in orgs with defined namespaces.

As of Summer ’20 and later, only your Salesforce org's internal users can access this type.

For more information on packaging a Lightning web component bundle, see the [Second-Generation Managed Packaging Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/packaging_packageable_components.htm#mdc_lightning_component).

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d624501e82">Field Name</th>

              <th class="featureTableHeader  " id="d624501e85">Field Type</th>

              <th class="featureTableHeader  " id="d624501e88">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">ai</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d624501e88" data-title="Description">An internal AI description of the Lightning web component. This description is
                supported only in orgs that have <a class="xref" href="https://help.salesforce.com/s/articleView?id=xcloud.setup_agentforce_overview.htm&amp;language=en_US" target="_blank">Setup with Agentforce</a> enabled. This
                description enables Agentforce to analyze the component for inclusion in
                agent-generated Lightning pages. For more information, see <a class="xref" href="https://developer.salesforce.com/docs/platform/lwc/guide/use-config-for-agentforce.html" target="_blank">Configure a Component for Use in Setup with
                  Agentforce</a>.<div class="codeSection xml">
                  <pre class="codeblock xml"><span class="tag">&lt;ai</span>&gt;
    <span class="tag">&lt;description</span>&gt;AI component description Example: The component enables users to add and style text content for dashboards, supporting features such as hyperlinks, bullet points, and text alignment. Ideal for adding formatted text sections such as instructions<span class="tag">&lt;/description</span>&gt;
    <span class="tag">&lt;property</span><span class="attribute"> name=</span>"prop1"<span class="attribute"> aiDescription=</span>"AI description for prop1"/&gt;
    <span class="tag">&lt;property</span><span class="attribute"> name=</span>"prop2"<span class="attribute"> aiDescription=</span>"AI description for prop2"/&gt;
<span class="tag">&lt;/ai</span>&gt;</pre>
                </div>
                <p class="p">Available in API version 66.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">apiVersion</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">double</td>

              <td class="entry" headers="d624501e88" data-title="Description">A double value that binds the component to a Salesforce API version.</td>

            </tr>

            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">capabilities</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">
                <a class="xref" href="#capabilities">Capabilities</a>[]
              </td>

              <td class="entry" headers="d624501e88" data-title="Description">A list of capabilities. A capability is something that a component can do, as
                opposed to a target, which defines where you can use a component. Available in API
                version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">string</td>

              <td class="entry" headers="d624501e88" data-title="Description">A user-facing description of the Lightning web component. This description
                appears in list views, like the list of Lightning Components in Setup, and as a
                tooltip in the builders like Lightning App Builder and Experience Builder.</td>

            </tr>

            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">isExplicitImport</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d624501e88" data-title="Description"><span class="ph" id="isExplicit"><a name="isExplicit"><!-- --></a>Indicates whether imports between files are done explicitly
                  by the developer (<samp class="codeph nolang">true</samp>) or implicitly by the
                  framework (<samp class="codeph nolang">false</samp>).</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">isExposed</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">boolean</td>

              <td class="entry" headers="d624501e88" data-title="Description"><span class="ph" id="isExposed"><a name="isExposed"><!-- --></a>If <samp class="codeph nolang">true</samp>, the component
                  is available to other namespaces. If <samp class="codeph nolang">true</samp> and
                  a <span class="keyword parmname">targets</span> value is also provided, the component is available
                  to Salesforce builders such as Lightning App Builder and Experience Builder. If
                  <samp class="codeph nolang">false</samp>, the component isn't available to
                  builders and other namespaces.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">lwcResources</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">
                <a class="xref" href="#lwcResources">LwcResources</a>[]
              </td>

              <td class="entry" headers="d624501e88" data-title="Description">A list of resources inside a bundle.</td>

            </tr>

            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">string</td>

              <td class="entry" headers="d624501e88" data-title="Description">The component title that appears in the list view.</td>

            </tr>

            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">targetConfigs</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d624501e88" data-title="Description">Configurations for each target. Each target is a Lightning page type. For
                example, this configuration allows a Lightning web component to be used on a Contact
                record page in Lightning App
                Builder.<div class="codeSection xml">
                  <pre class="codeblock xml"><span class="tag">&lt;targetConfigs</span>&gt;
    <span class="tag">&lt;targetConfig</span><span class="attribute"> targets=</span>"lightning__RecordPage"&gt;
        <span class="tag">&lt;objects</span>&gt;
            <span class="tag">&lt;object</span>&gt;Contact<span class="tag">&lt;/object</span>&gt;
        <span class="tag">&lt;/objects</span>&gt;
    <span class="tag">&lt;/targetConfig</span>&gt;
<span class="tag">&lt;/targetConfigs</span>&gt;</pre>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d624501e82" data-title="Field Name"><span class="keyword parmname">targets</span></td>

              <td class="entry" headers="d624501e85" data-title="Field Type">
                <a class="xref" href="#targets">Targets</a>[]
              </td>

              <td class="entry" headers="d624501e88" data-title="Description">A list of targets where the Lightning web component can be used, such as in
                Lightning App Builder or Experience Builder sites.</td>

            </tr>

          </tbody>

        </table>

## Capabilities

Represents a list of capabilities. A capability is something that a component can do, as opposed to a target, which defines where you can use a component. Available in API version 48.0 and later. For more information, see [XML Configuration File Elements](https://developer.salesforce.com/docs/platform/lwc/guide/reference-configuration-tags.html).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d624501e300">Field</th>

              <th class="featureTableHeader  " id="d624501e303">Field Type</th>

              <th class="featureTableHeader  " id="d624501e306">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d624501e300" data-title="Field"><span class="keyword parmname">capability</span></td>

              <td class="entry" headers="d624501e303" data-title="Field Type">string</td>

              <td class="entry" headers="d624501e306" data-title="Description">Specifies something that a component can do. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph xml">lightningCommunity__RelaxedCSP</samp></li>

                  <li class="li"><samp class="codeph xml">lightning__dynamicComponent</samp></li>

                  <li class="li"><samp class="codeph xml">lightning__ServerRenderable</samp></li>

                  <li class="li"><samp class="codeph xml">lightning__ServerRenderableWithHydration</samp></li>

                  <li class="li"><samp class="codeph xml">lightning__ServiceCloudVoiceToolkitApi</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## LwcResources

Represents a list of resources inside a LightningComponentBundle.

| Field | Field Type | Description |
| --- | --- | --- |
| lwcResource | [LwcResource](#lwcResource) | A resource inside a LightningComponentBundle. |

## LwcResource

Represents a resource inside a LightningComponentBundle.

| Field | Field Type | Description |
| --- | --- | --- |
| filePath | string | Required. The file path of a resource. |
| source | base64Binary | Required. The content of a resource. |

## Targets

Represents a list of supported containers for a Lightning web component. For more information, see [XML Configuration File Elements](https://developer.salesforce.com/docs/platform/lwc/guide/reference-configuration-tags.html).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d624501e501">Field</th>

              <th class="featureTableHeader  " id="d624501e504">Field Type</th>

              <th class="featureTableHeader  " id="d624501e507">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d624501e501" data-title="Field"><span class="keyword parmname">target</span></td>

              <td class="entry" headers="d624501e504" data-title="Field Type">string</td>

              <td class="entry" headers="d624501e507" data-title="Description">Specifies the type of Lightning page the component can be added to in the
                builders, such as in Lightning App Builder, Experience Builder, Flow Builder, or
                Document Builder.<p class="p">For valid values, see <a class="xref" href="https://developer.salesforce.com/docs/platform/lwc/guide/reference-configuration-tags.html#target" target="_blank">XML Configuration File Elements:
                    target</a>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This package.xml file retrieves all the LightningComponentBundle components in an org.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>LightningComponentBundle</name\>
    </types\>
    <version\>45.0</version\>
</Package\>

In the retrieved zip file, each Lightning web component is nested under an lwc folder.

This example shows the directory structure in the zip file of one component with a name of hello.

lwc
    hello
        hello.html
        hello.js
        hello.js-meta.xml

Here are the contents of the files in the hello directory.

Content of hello.html:

<template\>

    <lightning-card title="Hello" icon-name="custom:custom14"\>
        <div class="slds-m-around\_medium"\>
            Hello, {greeting}!
        </div\>
    </lightning-card\>

</template\>

Content of hello.js:

import { LightningElement } from 'lwc';

export default class Hello extends LightningElement {
    greeting = 'World';
}

Content of hello.js-meta.xml.

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion\>45.0</apiVersion\>
    <isExposed\>true</isExposed\>
    <targets\>
        <target\>lightning\_\_AppPage</target\>
        <target\>lightning\_\_RecordPage</target\>
        <target\>lightning\_\_HomePage</target\>
    </targets\>
</LightningComponentBundle\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e9f68a5eaa776a61d2cf95fdfe9244f11d7c12a6e4aa95cc665cd4318c4678de url=/legacydeveloper/current/en-us/api_meta/meta_lightningexperiencesettings.md -->

# LightningExperienceSettings

Represents the settings that modify an org’s Lightning Experience configuration. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

A LightningExperienceSettings component has the suffix .settings and is stored 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

LightningExperienceSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d626114e102">Field Name</th>

              <th class="featureTableHeader  " id="d626114e105">Field Type</th>

              <th class="featureTableHeader  " id="d626114e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">activeThemeName</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">string</td>

              <td class="entry" headers="d626114e108" data-title="Description">If specified, indicates the API name of the custom <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningexperiencetheme.htm" title="Represents the details of a custom theme, including the BrandingSet. Themes enable admins to specify configurable attributes, such as three colors and five images. The colors and some of the images override SLDS token values and influence the generation of app.css.">LightningExperienceTheme</a> that’s currently active in the org. If the field isn’t specified,
                then the org uses one of the built-in themes that Salesforce provides. Custom themes
                are available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableAccessCheckCrucPref</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 47.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableApiUserLtngOutAccessPref</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 48.0 and later because the feature is no longer
                available. This field corresponds to the API Only Users Can Access Only Salesforce
                APIs critical update, which was enforced in Spring ’20. If a user has the API Only
                User permission, they can access Salesforce only via APIs, regardless of their other
                permissions. This restriction already applied to other Salesforce features, but the
                critical update enforced the restriction in Lightning Out also.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableAuraBoxcarReductionPref</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type"></td>

              <td class="entry" headers="d626114e108" data-title="Description">If <samp class="codeph nolang">true</samp>, dynamic boxcar optimization for
                the Aura framework is disabled. With dynamic boxcar optimization, a limited number
                of server-side Aura actions are grouped in a single network request, which improves
                the performance of Lightning components and apps. For more information, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.258.0.lightning.meta/lightning/controllers_server_actions_boxcar_dynamic.htm" target="_blank">Boxcar Grouping and Optimization</a> in the
                <cite class="cite">Lightning Aura Components Developer Guide</cite>.<p class="p">The default value is
                  <samp class="codeph nolang">false</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableAuraCDNPref</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether Lightning Experience and other apps use a content delivery
                network (CDN) to serve the static content for Lightning Component framework. A CDN
                generally speeds up page load time, but it also changes the source domain that
                serves the files. If your company has IP range restrictions for content served from
                Salesforce, test thoroughly before enabling this setting. The default is <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableAuraDepAccessChksCRUCPref</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Removed in API version 51.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableAuraSecStaticResCRUCPref</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Removed in API version 68.0 and later because the Enable Secure Static
                Resources for Lightning Components release update was cancelled. In Summer ’26 and
                later, all static resources are served automatically from the
                <span class="ph filepath">lightning</span> domain, regardless of the API version.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableDeferRenderingWorkspacePage</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether the “Defer loading inactive console workspace pages” setting
                is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">true</samp>. This field is available in API version 64.0 and
                later. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=service.console_lex_defer_loading_inactive_pages.htm&amp;type=5&amp;language=en_US" target="_blank">Defer Loading Inactive Lightning Console Workspace
                  Pages</a> in Salesforce Help. </td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableErrorExperienceEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableFeedbackInMobile</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether users can send feedback to Salesforce from the mobile app.
                The default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableGoogleSheetsForSfdcEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Reserved. Do not use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableIE11DeprecationMsgHidden</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 47.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableIE11LEXCrucPref</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 47.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableInAppLearning</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether Learning Paths is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                is <samp class="codeph nolang">true</samp>. If <samp class="codeph nolang">false</samp>, you can’t assign learning items to users, and users can’t view
                assigned learning items in the Guidance Center or access Learning Home. This field
                is available in API version 54.0 and later. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.customhelp_lex_learning_intro.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Learning Paths</a> in
                Salesforce Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableInAppTooltips</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether users see onboarding tips in the mobile app. The default is
                <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableLEXOnIpadEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether Lightning Experience is turned on for iPad Browsers (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. See
                <a class="xref" href="https://help.salesforce.com/articleView?id=lex_ipad_browser_enable.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Give Users Access to
                  Lightning Experience on iPad Browsers (Beta)</a> in Salesforce Help.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableLexEndUsersNoSwitching</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether Salesforce Classic is turned off for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Removes the Switcher for all users in the org. The default is
                <samp class="codeph nolang">false</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=lex_turn_off_classic.htm&amp;language=en_US" target="_blank">Turn Off Salesforce Classic for Your Org</a> in
                Salesforce Help. This field is similar to
                <span class="keyword parmname">enableUsersAreLightningOnly</span>. If either field is set to
                <samp class="codeph nolang">true</samp>, users are blocked from switching to
                Salesforce Classic.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableLightningPreviewPref</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether Local Dev is turned on for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                See <a class="xref" href="https://developer.salesforce.com/docs/platform/lwc/guide/get-started-test-components.html" target="_blank">Preview Components with Local Dev</a> in
                Salesforce Developers. This field is available in API version 62.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableNavPersonalizationOptOut</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether users are blocked from personalizing the Lightning Experience
                navigation bar (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp> (that is, users can personalize the navigation bar by default).
                Salesforce recommends disabling personalization at the app level, not the org level.
                See <a class="xref" href="https://help.salesforce.com/articleView?id=customize_ui_settings.htm&amp;language=en_US" target="_blank">Configure User Interface Settings</a> in
                Salesforce
                Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableNoBackgroundNavigations</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether consecutive API navigation calls in Visualforce pages are
                allowed (<samp class="codeph nolang">false</samp>) or blocked (<samp class="codeph nolang">true</samp>). The default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableQuip</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether Quip is available for your org. This field is available in
                API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableRemoveThemeBrandBanner</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 47.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableS1BannerPref</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 47.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableS1BrowserEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether all users can access the Salesforce mobile web view from a
                supported mobile browser (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If <samp class="codeph nolang">false</samp>, then users must access the Salesforce mobile full site view from a
                mobile browser. Full site view doesn’t have the full functionality of mobile web
                view. Salesforce Classic and Lightning Experience aren’t supported on mobile
                browsers.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableS1DesktopEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether Lightning Experience is turned on in the org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). After it’s enabled, this setting can’t be disabled via the user
                interface or the API. See <a class="xref" href="https://help.salesforce.com/articleView?id=lex_enable_turn_on.htm&amp;language=en_US" target="_blank">Turn on Lightning Experience for Your Org</a> in
                Salesforce Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableS1UiLoggingEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 47.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableSidToken3rdPartyAuraApp</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Reserved for internal
                use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableSkypeChatEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 50.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableSparkAllUsers</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 50.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableSparkConversationEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 50.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableSplitViewOnStandard</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Removed in API version 52.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableStackedModalManagerEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether the Enable LWC Stacked Modals release update is enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). For orgs created before Summer ’24, the default value is <samp class="codeph nolang">false</samp>. For orgs created in Summer ’24 and later, the
                default value is <samp class="codeph nolang">true</samp>. This field is available
                in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableTryLightningOptOut</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether the Try Lightning Experience Now prompt is hidden from users
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. See
                <a class="xref" href="https://help.salesforce.com/articleView?id=lex_encourage_work_try_lex.htm&amp;language=en_US" target="_blank">Try Lightning Experience Now Prompt</a> in
                Salesforce Help.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableUseS1AlohaDesktop</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 47.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableUsersAreLightningOnly</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether Salesforce Classic is turned off for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Removes the Switcher for all users in the org. The default is
                <samp class="codeph nolang">false</samp>. This field is similar to
                <span class="keyword parmname">enableLexEndUsersNoSwitching</span>. If either field is set to
                <samp class="codeph nolang">true</samp>, users are blocked from switching to
                Salesforce Classic.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableWebExEnabled</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 50.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">enableWebexAllUsers</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Deprecated in API version 50.0 and later because the feature is no longer
                available.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">isLEXExtensionComponentCustomizationOff</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether all users can enable the Lightning Extension Component
                Customization feature. If <samp class="codeph nolang">false</samp>, the feature is
                disabled for all users, even users who had it enabled. See <a class="xref" href="https://help.salesforce.com/articleView?id=lex_lightning_extension.htm&amp;type=5&amp;language=en_US" target="_blank">Try New Features with the Lightning Extension for
                  Chrome</a>. This field is available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">isLEXExtensionDarkModeOff</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether all users can enable the Lightning Extension Dark Mode
                feature. If <samp class="codeph nolang">false</samp>, the feature is disabled for
                all users, even users who had it enabled. This field is available in API version
                48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">isLEXExtensionLinkGrabberOff</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether all users can enable the Lightning Extension Link Grabber
                feature. If <samp class="codeph nolang">false</samp>, the feature is disabled for
                all users, even users who had it enabled. This field is available in API version
                48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d626114e102" data-title="Field Name"><span class="keyword parmname">isLEXExtensionOff</span></td>

              <td class="entry" headers="d626114e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d626114e108" data-title="Description">Indicates whether all users can enable the Lightning Extension for your org. If
                <samp class="codeph nolang">false</samp>, your users can’t enable the Lightning
                Extension, even if they already have it installed. This field is available in API
                version 48.0 and later.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a LightningExperienceSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<LightningExperienceSettings xmlns="http://soap.sforce.com/2006/04/metadata">

    <enableAuraCDNPref\>true</enableAuraCDNPref\>
    <enableFeedbackInMobile\>true</enableFeedbackInMobile\>
    <enableInAppTooltips\>true</enableInAppTooltips\>
    <enableLEXOnIpadEnabled\>true</enableLEXOnIpadEnabled\>
    <enableLexEndUsersNoSwitching\>true</enableLexEndUsersNoSwitching\>
    <enableNavPersonalizationOptOut\>true</enableNavPersonalizationOptOut\>
    <enableS1BrowserEnabled\>false</enableS1BrowserEnabled\>
    <enableS1DesktopEnabled\>true</enableS1DesktopEnabled\>
    <enableTryLightningOptOut\>true</enableTryLightningOptOut\>
    <enableUsersAreLightningOnly\>true</enableUsersAreLightningOnly\>
</LightningExperienceSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>LightningExperience</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=eab24c37a7b214752a14faee30f15dd554ca7c8f02d3dd2b66f7ca24e10d87c6 url=/legacydeveloper/current/en-us/api_meta/meta_lightningexperiencetheme.md -->

# LightningExperienceTheme

Represents the details of a custom theme, including the [BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm#meta_brandingset "Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme."). Themes enable admins to specify configurable attributes, such as three colors and five images. The colors and some of the images override SLDS token values and influence the generation of app.css.

To activate a custom theme with Metadata API, set the activeThemeField on the [LightningExperienceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningexperiencesettings.htm "Represents the settings that modify an org’s Lightning Experience configuration. This type extends the Metadata metadata type and inherits its fullName field.") component to the API name of the LightningExperienceTheme.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

LightningExperienceTheme components have the suffix .lightningExperienceTheme and are stored in the lightningExperienceThemes folder.

## Version

LightningExperienceTheme components are available in API version 42.0 and later.

## Special Access Rules

The LightningExperieceTheme type is available when the S1DesktopAllowed permission is enabled in your org.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d629252e129">Field Name</th>

              <th class="featureTableHeader  " id="d629252e132">Field Type</th>

              <th class="featureTableHeader  " id="d629252e135">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">defaultBrandingSet</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">string</td>

              <td class="entry" headers="d629252e135" data-title="Description">Required. The ID of the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm#meta_brandingset" title="Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.">BrandingSet</a> properties associated with this
                LightningExperienceTheme.</td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">string</td>

              <td class="entry" headers="d629252e135" data-title="Description">The optional description text of this LightningExperienceTheme. Limited to 1000
                characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">designSystemVersion</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">LightningDesignSystemVersion (enumeration of type string)</td>

              <td class="entry" headers="d629252e135" data-title="Description">Represents the version of Salesforce Lightning Design System (SLDS) on which
                the theme is built.<p class="p">Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">SLDS_v1</samp></li>

                  <li class="li"><samp class="codeph nolang">SLDS_v2</samp></li>

                </ul>
                <p class="p">If you don’t define a value, the default value is <samp class="codeph nolang">SLDS_v1</samp>.</p>
                <p class="p">Available in API version 64.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">isDarkModeEnabled</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d629252e135" data-title="Description">Indicates whether individual users can enable dark mode (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) for this LightningExperienceTheme. The default value is <samp class="codeph nolang">false</samp>. Available for custom SLDS 2 themes in select
                editions. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=xcloud.customize_ui_enhancedlex.htm&amp;type=5&amp;language=en_US" target="_blank">Salesforce Cosmos Theme and SLDS 2
                  Availability</a>. Available in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">string</td>

              <td class="entry" headers="d629252e135" data-title="Description">Required. The label for this LightningExperienceTheme, which displays in Setup.
                Limited to 70 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">shouldOverrideLoadingImage</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d629252e135" data-title="Description">If <samp class="codeph nolang">true</samp>, the LightningExperienceTheme
                overrides the splash screen image.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a LightningExperienceTheme component. See [BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm#meta_brandingset "Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.") for an example of the BrandingSet component.

<?xml version="1.0" encoding="UTF-8"?>
<LightningExperienceTheme xmlns="http://soap.sforce.com/2006/04/metadata">
    <defaultBrandingSet\>SummerCelebrationBrand</defaultBrandingSet\>
    <description\>Theme for summer celebration week.</description\>
    <masterLabel\>Summer Celebration</masterLabel\>
    <shouldOverrideLoadingImage\>false</shouldOverrideLoadingImage\>
</LightningExperienceTheme\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>LEXTHEMINGThemeName</members\>
        <name\>BrandingSet</name\>
    </types\>
    <types\>
    	<members\>Summer Celebration</members\>
    	<name\>LightningExperienceTheme</name\>
    </types\>
    <version\>42.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=3553255a8ed84bd040f4556b0742f9c7e7d229d07745e03ee6cc21191b386049 url=/legacydeveloper/current/en-us/api_meta/meta_lightningmessagechannel.md -->

# LightningMessageChannel

Represents the metadata associated with a Lightning Message Channel. A Lightning Message Channel represents a secure channel to communicate across UI technologies, such as Lightning Web Components, Aura Components, and Visualforce.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Before you include a Lightning Message Channel in a managed package, review these considerations.

- To pass the [AppExchange Security Review](https://developer.salesforce.com/docs/atlas.en-us.264.0.packagingGuide.meta/packagingGuide/security_review_guidelines.htm "HTML (New Window)"), you must set the isExposed field to false.
- If you set the isExposed field to true, you can’t change the value to false at a later time. This consideration applies to Lightning Message Channels in managed packages and Lightning Message Channels that other components reference.
- Visualforce supports only Lightning Message Channels where isExposed is true, so managed packages with a Lightning Message Channel in Visualforce can’t pass the AppExchange Security Review. See [Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.pages.meta/pages/message_channel_considerations.htm "HTML (New Window)") in the _Visualforce Developer Guide_.

## File Suffix and Directory Location

LightningMessageChannel components have the suffix .messageChannel and are stored in the messageChannels folder.

## Version

LightningMessageChannel components are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | The description of the Lightning Message Channel. |
| isExposed | boolean | Indicates whether a Lightning Message Channel is exposed to components in other namespaces (true) or not (false). The default value is false. |
| lightningMessageFields | [LightningMessageField](#LightningMessageField)\[\] | A list of message payload fields for a given Lightning Message Channel. |
| masterLabel | string | Required. The label for a Lightning Message Channel. |

## LightningMessageField

Represents a message payload field for a given Lightning Message Channel.

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | The description for a Lightning Message Field. |
| fieldName | string | Required. Unique identifier of the Lightning Message Field. |

## Declarative Metadata Sample Definition

Here’s a simple example of a LightningMessageChannel component.

<?xml version="1.0" encoding="UTF-8"?>
<LightningMessageChannel xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel>SampleMessageChannel</masterLabel>
    <isExposed>true</isExposed>
    <description>This is a sample Lightning Message Channel.</description>
</LightningMessageChannel>

Here’s an example of a LightningMessageChannel component with LightningMessageFields.

<?xml version="1.0" encoding="UTF-8"?>
<LightningMessageChannel xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel>SampleMessageChannel</masterLabel>
    <isExposed>true</isExposed>
    <description>This is a sample Lightning Message Channel.</description>
    <lightningMessageFields>
        <fieldName>recordId</fieldName>
        <description>This is the record Id that changed</description>
    </lightningMessageFields>
    <lightningMessageFields>
        <fieldName>recordData</fieldName>
        <description>The current data representing the record that changed</description>
    </lightningMessageFields>
</LightningMessageChannel>

Here’s an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>LightningMessageChannel</name>
    </types>
    <version>47.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [_Lightning Web Components Developer Guide_: Communicate Across the DOM with Lightning Message Service](https://developer.salesforce.com/docs/platform/lwc/guide/use-message-channel.html "Lightning Web Components Developer Guide:
    Communicate Across the DOM with Lightning Message
    Service - html (New Window)")
- [_Second-Generation Managed Packaging Developer Guide_: Components Available in Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/packaging_packageable_components.htm "Second-Generation Managed Packaging Developer
    Guide: Components Available in Managed Packages - html (New Window)")

<!-- document id=b04d19bc75f7442566316e5ce9a40d4f33adf847bf778f423ab4e521d43cf678 url=/legacydeveloper/current/en-us/api_meta/meta_lightningonboardingconfig.md -->

# LightningOnboardingConfig

Represents the feedback provided when users switch from Lightning Experience to Salesforce Classic. Admins can customize the question, how frequently the form appears, and where the feedback is stored in Chatter from the Adoption Assistance page in Lightning Experience Setup. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

LightningOnboardingConfig components have the suffix .lightningOnboardingConfig and are stored in the LightningOnboardingConfigs folder.

## Version

LightningOnboardingConfig components are available in API version 49.0 and later.

## Special Access Rules

See [Switch to Salesforce Classic Feedback Form](https://help.salesforce.com/articleView?id=lex_encourage_work_feedback.htm&language=en_US) in Salesforce Help for details.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| collaborationGroup | string | Required. The ID of the Chatter Group where the user feedback is posted. |
| customQuestion | string | Text of the custom question added by the admin. Maximum of 1,000 characters. |
| feedbackFormDaysFrequency | int | Required. The number of days between showing the feedback form when a user switches between Lightning Experience and Salesforce Classic. A value of 0 indicates that the form is shown for every switch. Maximum of 30. |
| isCustom | boolean | Required. Indicates if a feedback form includes a custom question ( true) or not (false). |
| masterLabel | string | Required. The label of the in-app guidance. Maximum of 80 characters. |
| promptDelayTime | int | Required. Indicates the amount of time, in seconds, to delay between instances of all in-app content, both custom content created by org and standard content created by Salesforce. Minimum of 0 hours and 0 minutes. Maximum of 99 hours and 59 minutes. |
| sendFeedbackToSalesforce | boolean | Required. Indicates if the user feedback can be shared with Salesforce (true) or not (false). Even if the feedback isn’t shared with Salesforce, the feedback is shared in the Chatter Group chosen when customizing the feedback form. The default is false. |

## Declarative Metadata Sample Definition

The following is an example of a LightningOnboardingConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<LightningOnboardingConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <collaborationGroup\>{Org ID}</collaborationGroup\>
    <customQuestion\>Please take a minute to tell us why you’re switching.</customQuestion\>
    <feedbackFormDaysFrequency\>0</feedbackFormDaysFrequency\>
    <isCustom\>true</isCustom\>
    <masterLabel\>Feedback Form</masterLabel\>
    <promptDelayTime\>3600</promptDelayTime\>
    <sendFeedbackToSalesforce\>true</sendFeedbackToSalesforce\>
</LightningOnboardingConfig\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=933b8c4c266629662b46e654df11991ab05698abc2df30369ceda852b018b080 url=/legacydeveloper/current/en-us/api_meta/meta_lightningtypebundle.md -->

# LightningTypeBundle

Represents a custom Lightning type. Use this type to override the default user interface to create a customized appearance based on your business requirements. Deploy this bundle to your organization to implement the overrides.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Structure and Directory Location

LightningTypeBundle components are stored in the lightningTypes folder.

Here’s an example of the LightningTypeBundle structure.

+--myMetadataPackage
    +--lightningTypes (1)
        +--TYPE\_NAME (2)
           +--schema.json (3)
           +--CHANNEL\_NAME (4)
              +--editor.json (5) OR +--renderer.json (6)

The bundle includes these resources.

- The lightningTypes folder (1) contains a folder for each created custom Lightning type in the format {typeName} (2).
- Each custom lightning type folder contains a schema.json file (3) that defines the JSON schema that drives the custom Lightning type validation.
- Optional channel-specific folders (4). To override the default UI for a specific Salesforce application, the bundle contains a folder named after that channel. The supported channel folders are:
    
    - lightningDesktopGenAi (Agentforce Employee agent in Lightning Experience)
    - enhancedWebChat (Agentforce Service agent via Enhanced Chat v2)
    - lightningMobileGenAi (Agentforce Employee agent on Mobile and Agentforce Service agent via Enhanced Chat v2 on Mobile)
    - experienceBuilder (Experience Builder)
    
    Inside the {channelName} folder, you can configure:
    
    - The editor.json file (5) containing custom user interface and editor information
    - The renderer.json file (6) containing custom user interface and renderer information
        
        ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
        
        #### Note
        
        This file isn’t supported in experienceBuilder.

## Version

LightningTypeBundle components are available in API version 64.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Describes the lightning type.



 |
| masterLabel | 

Field Type

string

Description

Required. Represents the name of a LightningTypeBundle which is defined when the LightningTypeBundle is created.





 |
| resources | 

Field Type

[LightningTypeBundleResource\[\]](#LightningTypeBundleResource)

Description

The list of resource files in the lightningTypes folder.



 |

## LightningTypeBundleResource

Represents a resource inside a LightningTypeBundle.

| Field Name | Description |
| --- | --- |
| fileName | 
Field Type

string

Description

Required. Name of the resource file.





 |
| filePath | 

Field Type

string

Description

Required. Path of the resource file.





 |
| source | 

Field Type

base64Binary

Description

Required. The JSON content of the resource.





 |

## Declarative Metadata Sample Definition

This package.xml file retrieves all the LightningTypeBundle components in an org.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>LightningTypeBundle</name\>
    </types\>
    <version\>64.0</version\>
</Package\>

In the retrieved .zip file, each custom Lightning type is nested under a lightningTypes folder.

This example shows the directory structure in the .zip file of a custom Lightning type named flightResponse:

+--lightningTypes
    +--flightResponse
        +--schema.json
        +--lightningDesktopGenAi
            +--renderer.json

In this example, the custom Lightning type flightResponse is a complex type that references an Apex class named Flight.

global class Flight {

    @AuraEnabled
    global String flightId;

    @AuraEnabled
    global Integer numLayovers;

    @AuraEnabled
    global Boolean isPetAllowed;

    @AuraEnabled
    global Long price;

    @AuraEnabled
    global Double discountPercentage;

    @AuraEnabled
    global Integer durationInMin;

    global Flight(String flightId, Integer numLayovers, Boolean isPetAllowed,
                  Long price, Double discountPercentage, Integer durationInMin) {
        this.flightId = flightId;
        this.numLayovers = numLayovers;
        this.isPetAllowed = isPetAllowed;
        this.price = price;
        this.discountPercentage = discountPercentage;
        this.durationInMin = durationInMin;
     }
}
global class FlightRequestFilter {

    @AuraEnabled
    global Long price;

    @AuraEnabled
    global Double discountPercentage;
}

Here are the contents of the files in the flightResponse directory. This sample code shows the contents of the schema.json file.

{
  "title": "My Flight Response",
  "description": "My Flight Response",
  "lightning:type": "@apexClassType/c\_\_Flight"
}

The lightningDesktopGenAi folder (optional) includes a renderer.json file that overrides the default UI of the custom Lightning type flightResponse when you use the Flight Apex class as an output parameter for an agent action.

Contents of the renderer.json file.

{
  "renderer": {
    "componentOverrides": {
      "$": {
        "definition": "c/flightDetails"
      }
    }
  }
}

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

flightDetails is a custom LWC component referenced in renderer.json file.

This example shows the directory structure in the .zip file of a custom Lightning type named flightFilter:

+--lightningTypes
    +--flightFilter
        +--schema.json
        +--lightningDesktopGenAi
            +--editor.json

In this example, the custom Lightning type flightFilter is a complex type that references an Apex class named FlightRequestFilter.

global class Flight {

    @AuraEnabled
    global String flightId;

    @AuraEnabled
    global Integer numLayovers;

    @AuraEnabled
    global Boolean isPetAllowed;

    @AuraEnabled
    global Long price;

    @AuraEnabled
    global Double discountPercentage;

    @AuraEnabled
    global Integer durationInMin;

    global Flight(String flightId, Integer numLayovers, Boolean isPetAllowed,
                  Long price, Double discountPercentage, Integer durationInMin) {
        this.flightId = flightId;
        this.numLayovers = numLayovers;
        this.isPetAllowed = isPetAllowed;
        this.price = price;
        this.discountPercentage = discountPercentage;
        this.durationInMin = durationInMin;
     }
}
global class FlightRequestFilter {

    @AuraEnabled
    global Long price;

    @AuraEnabled
    global Double discountPercentage;
}

Here are the contents of the files in the flightFilter directory. This sample code shows the contents of the schema.json file.

{
  "title": "Flight Filter",
  "description": "Flight Filter",
  "lightning:type": "@apexClassType/c\_\_FlightRequestFilter"
}

The lightningDesktopGenAi folder (optional) includes an editor.json file that overrides the default UI of the custom Lightning type flightFilter when you use the Flight Apex class as an input parameter for an agent action.

Contents of the editor.json file.

{
  "editor": {
    "componentOverrides": {
      "$": {
        "definition": "c/flightFilter"
      }
    }
  }
}

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

flightFilter is a custom LWC component referenced in editor.json file.

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

#### See Also

- [Lightning Types Developer Guide](https://developer.salesforce.com/docs/platform/lightning-types/guide/lightning-types.html "Lightning Types Developer Guide - html (New Window)")
- [Custom Lightning Type Examples](https://developer.salesforce.com/docs/einstein/genai/guide/lightning-types-examples.html "Custom Lightning Type Examples - html (New Window)")

<!-- document id=a2dabdaf6e7b39ec8774f8b608a3159c1655e09b17e727664fd15a3c6ffd6428 url=/legacydeveloper/current/en-us/api_meta/meta_listmetadata.md -->

# listMetadata()

This call retrieves property information about metadata components in your organization. Data is returned for the components that match the criteria specified in the queries parameter. The queries array can contain up to three ListMetadataQuery queries for each call. This call supports every metadata type: both top-level, such as CustomObject and ApexClass, and child types, such as CustomField and RecordType.

## Syntax

[FileProperties](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm#meta_retrieveresult_fileproperties)\[\] = metadataConnection.listMetadata([ListMetadataQuery](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listmetadataquery.htm "The ListMetadataQuery parameter represents a list of objects that specify which components you are interested in.")\[\] queries, double asOfVersion);

## Usage

This call is useful when you want to identify individual components in package.xml for a [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") call or if you want a high-level view of particular metadata types in your organization. For example, you can use this call to return a list of names of all the [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.") or [Layout](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_layouts.htm) components in your organization. You can use this information to make a subsequent [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") call to return a subset of these components. For more information about working with package.xml, see [Declarative (File-Based) Metadata API Calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based.htm).

This call is synchronous, so the results are returned in one call. This call differs from asynchronous calls, such as [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization."), where at least one subsequent call is required to get the results.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Sample Code—Java

This sample code lists information about your custom objects. The code assumes that the SOAP binding has already been established.

public void listMetadata() {
  try {
    ListMetadataQuery query = new ListMetadataQuery();
    query.setType("CustomObject");
    //query.setFolder(null);
    double asOfVersion = 68.0;
    // Assuming that the SOAP binding has already been established.
    FileProperties\[\] lmr = metadataConnection.listMetadata(
        new ListMetadataQuery\[\] {query}, asOfVersion);
    if (lmr != null) {
      for (FileProperties n : lmr) {
        System.out.println("Component fullName: " + n.getFullName());
        System.out.println("Component type: " + n.getType());
      }
    }            
  } catch (ConnectionException ce) {
    ce.printStackTrace();
  }
}

## Arguments

### queries

- **Type**: [ListMetadataQuery](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listmetadataquery.htm "The ListMetadataQuery parameter represents a list of objects that specify which components you are interested in.")\[\]
- **Description**: A list of objects that specify which components you’re interested in.

### asOfVersion

- **Type**: double
- **Description**: The API version for the metadata listing request. If you don't specify a value in this field, it defaults to the API version specified when you logged in. This field allows you to override the default and set another API version. For example, you can list the metadata for a metadata type that was added in a later version than the API version specified when you logged in. This field is available in API version 18.0 and later.

## Response

[FileProperties](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm#meta_retrieveresult_fileproperties)

<!-- document id=4a03cd75501d171bcd751658290415ac96ab76bf28b998e5262c943554e9f5cb url=/legacydeveloper/current/en-us/api_meta/meta_listmetadataquery.md -->

# ListMetadataQuery

The ListMetadataQuery parameter represents a list of objects that specify which components you are interested in.

## folder

- **Type**: string
- **Description**: The folder associated with the component. This field is required for components that use folders, such as [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_dashboard.htm), [Document](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_document.htm), [EmailTemplate](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_emailtemplate.htm), or [Report](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_report.htm).

## type

- **Type**: string
- **Description**: Required. The metadata type, such as CustomObject, CustomField, or ApexClass.

<!-- document id=2e90e16cddc2cdf84f9e330690d0bf9a1cb53b4efd5e9431bd3b02c40a49e6d8 url=/legacydeveloper/current/en-us/api_meta/meta_listview.md -->

# ListView

ListView allows you to see a filtered list of records, such as contacts, accounts, or custom objects.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. See “Create a Custom List View in Salesforce Classic” in Salesforce Help.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

List views with the Visible only to me Restrict Visibility option aren’t accessible in Metadata API. Each of these list views is associated with a particular user.

## Declarative Metadata File Suffix and Directory Location

List views are stored within a CustomObject component. The component can represent a custom object or a standard object, such as an account.

## Version

ListView components for custom objects are available in API version 14.0 and later. ListView components for standard objects, such as accounts, are available in API version 17.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d632551e101">Field</th>

              <th class="featureTableHeader  " id="d632551e104">Field Type</th>

              <th class="featureTableHeader  " id="d632551e107">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type">string</td>

              <td class="entry" headers="d632551e107" data-title="Description">This field represents an Advanced Option for a filter. Advanced
                Options in filters allow you to build up filtering conditions that
                use a mixture of AND and OR boolean operators across multiple filter
                line items. For example, <samp class="codeph nolang">(1 AND 2) OR
                  3</samp> finds records that match both the first two filter
                line items or the third.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname">columns</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type">string[]</td>

              <td class="entry" headers="d632551e107" data-title="Description"> The list of fields in the list view. The field name relative to
                the object name, for example MyCustomField__c, is specified for each
                custom field.
                <p class="p">Field names in the ListView columns don’t always
                  match their API name counterparts. If person accounts are
                  enabled in your organization, standard fields merged from a
                  contact into an account start with the <span class="keyword parmname">PC_</span>
                  prefix, while the corresponding API name starts with the
                  <span class="keyword parmname">Person</span> prefix. For example, the
                  ListView column name is <span class="keyword parmname">PC_Email</span> for a
                  corresponding API field name of
                  <span class="keyword parmname">PersonEmail</span>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname" id="field_division"><a name="field_division"><!-- --></a>division</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type">string</td>

              <td class="entry" headers="d632551e107" data-title="Description">
                <span class="ph" id="field_division_desc"><a name="field_division_desc"><!-- --></a>If your organization uses divisions
                  to segment data and you’ve got the “Affected by
                  Divisions” permission, records in the list view must
                  match this division. This field is only available if you’re
                  searching all records.</span>
                <p class="p">This field is available in API
                  version 17.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname" id="field_filterScope"><a name="field_filterScope"><!-- --></a>filterScope</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type">
                <a class="xref" href="#filterScope">FilterScope</a> (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)
              </td>

              <td class="entry" headers="d632551e107" data-title="Description">Required. This field indicates whether you’re filtering by owner
                or viewing all records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname">filters</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type">
                <a class="xref" href="#listViewFilter">ListViewFilter</a>[]
              </td>

              <td class="entry" headers="d632551e107" data-title="Description">The list of filter line items.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type">string</td>

              <td class="entry" headers="d632551e107" data-title="Description">Required. Inherited from Metadata <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm" title="Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.">Metadata</a>, this field is defined in
                the WSDL for this metadata type. It must be specified when creating,
                updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a> to see an
                example of this field specified for a call.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type">string</td>

              <td class="entry" headers="d632551e107" data-title="Description">Required. The list view name.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname" id="field_language"><a name="field_language"><!-- --></a>language</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm#translation_languages">Language</a></td>

              <td class="entry" headers="d632551e107" data-title="Description">
                <span class="ph" id="field_language_desc"><a name="field_language_desc"><!-- --></a>The language used for filtering if
                  your organization uses the Translation Workbench and you’re
                  using the <samp class="codeph soql">startsWith</samp> or
                  <samp class="codeph soql">contains</samp> operator. The
                  values entered as search terms must be in the same language as
                  the filter language.</span>
                <p class="p">For a list of valid language values,
                  see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm" title="Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.">Language</a>.</p>
                <p class="p">This field is available in API
                  version 17.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname">queue</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type">string</td>

              <td class="entry" headers="d632551e107" data-title="Description">The name of a queue. Objects are sometimes assigned to a queue so
                that the users who have access to the queue can monitor and manage
                them. When you create a queue, a corresponding list view is
                automatically created. See “Create Queues” in
                Salesforce Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e101" data-title="Field"><span class="keyword parmname" id="field_sharedTo"><a name="field_sharedTo"><!-- --></a>sharedTo</span></td>

              <td class="entry" headers="d632551e104" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm" title="SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.">SharedTo</a></td>

              <td class="entry" headers="d632551e107" data-title="Description">
                <span class="ph" id="field_sharedTo_desc"><a name="field_sharedTo_desc"><!-- --></a>Sharing access for the list
                  view.</span>
                <p class="p">This field is available in API version 17.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ListViewFilter

ListViewFilter represents a filter line item.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d632551e349">Field</th>

              <th class="featureTableHeader  " id="d632551e352">Field Type</th>

              <th class="featureTableHeader  " id="d632551e355">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d632551e349" data-title="Field"><span class="keyword parmname">filter</span></td>

              <td class="entry" headers="d632551e352" data-title="Field Type">string</td>

              <td class="entry" headers="d632551e355" data-title="Description">Required. Represents the field specified in the filter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e349" data-title="Field"><span class="keyword parmname">operation</span></td>

              <td class="entry" headers="d632551e352" data-title="Field Type">FilterOperation (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d632551e355" data-title="Description">Required. The operation used by the filter, such as <samp class="codeph java">equals</samp>. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph soql">equals</samp></li>

                  <li class="li"><samp class="codeph soql">notEqual</samp></li>

                  <li class="li"><samp class="codeph soql">lessThan</samp></li>

                  <li class="li"><samp class="codeph soql">greaterThan</samp></li>

                  <li class="li"><samp class="codeph soql">lessOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">greaterOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">contains</samp></li>

                  <li class="li"><samp class="codeph soql">notContain</samp></li>

                  <li class="li"><samp class="codeph soql">startsWith</samp></li>

                  <li class="li"><samp class="codeph soql">includes</samp></li>

                  <li class="li"><samp class="codeph soql">excludes</samp></li>

                  <li class="li">
                    <samp class="codeph soql">within</samp> (<samp class="codeph nolang">DISTANCE</samp> criteria
                    only)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e349" data-title="Field"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d632551e352" data-title="Field Type">string</td>

              <td class="entry" headers="d632551e355" data-title="Description">Represents the value of the filter item being operated upon, for
                example, if the filter is <samp class="codeph nolang">my_number_field__c &gt; 1</samp>, the value of <samp class="codeph nolang">value</samp> is <samp class="codeph nolang">1</samp>.</td>

            </tr>

          </tbody>

        </table>

## FilterScope

The FilterScope is an enumeration of type string that represents the filtering criteria for the records. The valid values are listed in the table:

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d632551e497">Enumeration Value</th>

              <th class="featureTableHeader  " id="d632551e500">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname">Everything</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">All records, for example All Opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname">Mine</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Records owned by the user running the list view, for example My
                Opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname">MineAndMyGroups</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Records owned by the user running the list view, and records
                assigned to the user’s queues.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname">AssignedToMe</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Records assigned to the user running the list view.<p class="p">The <samp class="codeph nolang">AssignedToMe</samp> scope is supported
                  for the ServiceAppointment object only.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname">Queue</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Records assigned to a queue.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname" id="option_Delegated"><a name="option_Delegated"><!-- --></a>Delegated</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Records delegated to another user for action: for example, a
                delegated task. This option is available in API version 17.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname" id="option_MyTerritory"><a name="option_MyTerritory"><!-- --></a>MyTerritory</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Records in the territory of the user seeing the list view. <span class="ph" id="option_territory_mgmt"><a name="option_territory_mgmt"><!-- --></a>This option is available if territory
                  management is enabled for your organization.</span> Opportunities
                can’t be filtered by <samp class="codeph nolang">MyTerritory</samp>. This option is available in API version
                17.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname" id="option_MyTeamTerritory"><a name="option_MyTeamTerritory"><!-- --></a>MyTeamTerritory</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Records in the territory of the team of the user seeing the list
                view. <samp class="codeph nolang">This option is available if territory
                  management is enabled for your organization.MyTeamTerritory</samp>. This option is available in API
                version 17.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname" id="option_Team"><a name="option_Team"><!-- --></a>Team</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Records assigned to a team. In the Lightning Experience UI, the
                corresponding list view filter is <strong class="ph uicontrol">My team’s
                  opportunities</strong>. This option is available in API
                version 17.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname">SalesTeam</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Opportunities assigned to an opportunity team. In the Lightning
                Experience UI, the corresponding list view filter is <strong class="ph uicontrol">My
                  opportunity teams</strong>. This option is available in API
                version 49.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d632551e497" data-title="Enumeration Value"><span class="keyword parmname">ScopingRule</span></td>

              <td class="entry" headers="d632551e500" data-title="Description">Records that meet a scoping rule's record criteria. In Lightning
                Experience, scoping rules are applied to list views only if the user
                selects <strong class="ph uicontrol">Filter by scope</strong>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample XML definition of a list view in a custom object is shown.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
. . .
    <listViews\>
        <fullName\>All\_Mileages</fullName\>
        <filterScope\>everything</filterScope\>
        <label\>All Mileages</label\>
    </listViews\>
    <listViews\>
        <fullName\>My\_Mileages</fullName\>
        <booleanFilter\>1 AND 2</booleanFilter\>
        <columns\>NAME</columns\>
        <columns\>CREATED\_DATE</columns\>
        <filterScope\>mine</filterScope\>
        <filters\>
            <field\>NAME</field\>
            <operation\>equals</operation\>
            <value\>Eric Bristow</value\>
        </filters\>
        <filters\>
            <field\>City\_\_c</field\>
            <operation\>equals</operation\>
            <value\>Paris</value\>
        </filters\>
        <label\>My Mileages</label\>
    </listViews\>
. . .
</CustomObject\>

## Usage

In general, avoid including unedited default list views in managed packages. We discourage including a modified default list view in a managed package, as it can result in duplicated list views in the target org. See [Incorrect List View Loads Due to Possibility of Existing Duplicate List Views](https://help.salesforce.com/s/articleView?id=000386164&type=1&language=en_US).

Metadata API retrieve doesn't return standard list views for some objects, including Task and Event, because they already exist on all targets. After you've modified a standard list view from its original content, you can retrieve and deploy it. Standard list views on other objects, such as Account, are retrievable. To customize a standard list view, create a custom list view.

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_index.htm "Index")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_marketingobject.htm "MarketingObject")

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")
- [Sample package.xml Manifest Files](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/manifest_samples.htm "This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if you want to work with all the metadata in one batch.")

<!-- document id=f3a86534fbef53f1f4c78aacef48c3a6b9f38245d2d72a752a22b16bb5dbb275 url=/legacydeveloper/current/en-us/api_meta/meta_liveagentsettings.md -->

# LiveAgentSettings

Represents an organization’s Chat settings, such as whether Chat is enabled. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

LiveAgentSettings values are stored in the LiveAgent.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## Version

LiveAgentSettings is available in API version 28.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableChatFindOrCreateEnable | boolean | Indicates whether the findOrCreate method of the Chat API is enabled for agents (true) or not (false). Available in API version 53.0 and later. |
| enableLiveAgent | boolean | Indicates whether Chat is enabled (true) or not (false). |
| enableQuickTextEnabled | boolean | Indicates whether Quick Text is enabled (true) or not (false). |

## Declarative Metadata Sample Definition

This is a sample Chat settings file.

<?xml version="1.0" encoding="UTF-8"?>
<LiveAgentSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableLiveAgent\>true</enableLiveAgent\>
</LiveAgentSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [_Service Cloud Chat Developer Guide:_ findOrCreate](https://developer.salesforce.com/docs/atlas.en-us.264.0.live_agent_dev.meta/live_agent_dev/live_agent_creating_records.htm "Service Cloud Chat Developer Guide:
    findOrCreate - HTML (New Window)")

<!-- document id=b830461e3719086336554b03d64511d02353ad23988f48a459cbb03be5b8d8a4 url=/legacydeveloper/current/en-us/api_meta/meta_livechatagentconfig.md -->

# LiveChatAgentConfig

Represents the configuration of an organization’s Chat deployment, such as how many chats can be assigned to an agent and whether chat sounds are enabled.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

LiveChatAgentConfig configurations are referenced in the <developer\_name>.liveChatAgentConfig file in the liveChatAgentConfigs directory.

## Version

LiveChatAgentConfig is available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d635042e99">Field Name</th>

              <th class="featureTableHeader  " id="d635042e102">Field Type</th>

              <th class="featureTableHeader  " id="d635042e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">assignments</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type"><a class="xref" href="#agentconfigassignments">AgentConfigAssignments</a></td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies how agent configurations are assigned to Chat users.
                Agent configurations can be assigned to sets of users or sets of
                profiles.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">autoGreeting</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the greeting that displays when a customer begins a
                chat with an agent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">capacity</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">int</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the maximum number of chats in which an agent can be
                engaged at a time.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="CriticalWaitTime-FA139B64"><a name="CriticalWaitTime-FA139B64"><!-- --></a>criticalWaitTime</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">int</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the number of seconds an agent can wait to answer an
                engaged chat before the chat tab flashes to alert the agent to
                answer it.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="CustomAgentName"><a name="CustomAgentName"><!-- --></a>customAgentName</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the custom name for an agent, if one has been set.
                Available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">disableTransferConferenceGreeting</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether the greeting is disabled for agents during chat
                transfer and chat conferencing (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 53.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableAgentFileTransfer</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether file transfer is enabled for agents (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 31.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="enableAgentSneakPeek"><a name="enableAgentSneakPeek"><!-- --></a>enableAgentSneakPeek</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies whether a supervisor can see the content of an
                agent’s message before they send it to a customer (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableAssistanceFlag</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">
                <span class="ph" id="assistance_flag"><a name="assistance_flag"><!-- --></a>Indicates whether agents can raise an
                  assistance flag to notify a supervisor that they need help.</span>
                Available in API version 35.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableAutoAwayOnDecline</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether an agent appears as “away”
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) when an agent declines a chat
                with a customer.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableAutoAwayOnPushTimeout</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether an agent appears as “away”
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) when a chat request that's
                been pushed to the agent times out. Available in API version 34.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatConferencing</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether chat conferencing is enabled for agents
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 34.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatMonitoring</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether chat monitoring is enabled for support
                supervisors (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). Available in API
                version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatTransferToAgent</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether agents can transfer a chat to another agent
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 36.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatTransferToButton</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether agents can transfer a chat to a button (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 36.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatTransferToSkill</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether agents can transfer a chat to a skill group
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 36.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableLogoutSound</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether a sound plays (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) when an agent logs out of Chat.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableNotifications</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether notifications of incoming chats appear for
                agents (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableRequestSound</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether a sound plays (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) when a customer requests to chat with an
                agent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableSneakPeek</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether previews of customers’ messages are
                displayed as customers type (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) in
                the agent’s Chat window. Available in API version 29.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableVisitorBlocking</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether an agent can block a visitor by IP address
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 34.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableWhisperMessage</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether support supervisors can send whisper messages
                to agents during a chat (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>). Available in API
                version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Required. Specifies the name of the configuration for
                agents’ default chat settings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="SupervisorDefaultAgentStatusFilter-055C8ED2"><a name="SupervisorDefaultAgentStatusFilter-055C8ED2"><!-- --></a>supervisorDefaultAgentStatusFilter</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">SupervisorAgentStatusFilter (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the Chat status for filtering the Agent Status list in
                the Supervisor Panel. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph xml">Online</samp></li>

                  <li class="li"><samp class="codeph xml">Away</samp></li>

                  <li class="li"><samp class="codeph xml">Offline</samp></li>

                </ul>
                <p class="p">Available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="SupervisorDefaultButtonFilter-055D186A"><a name="SupervisorDefaultButtonFilter-055D186A"><!-- --></a>supervisorDefaultButtonFilter</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the default button for filtering the Agent Status list
                in the Supervisor Panel. Available in API version 29.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="SupervisorDefaultSkillFilter-055D2022"><a name="SupervisorDefaultSkillFilter-055D2022"><!-- --></a>supervisorDefaultSkillFilter</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the default skill for filtering the Agent Status list
                in the Supervisor Panel. Available in API version 29.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="SupervisorSkills-055D2784"><a name="SupervisorSkills-055D2784"><!-- --></a>supervisorSkills</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type"><a class="xref" href="#supervisoragentconfigskills">SupervisorAgentConfigSkills</a></td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the list of agent skills that are assigned to a
                supervisor, as specified in their assigned Chat configuration.
                Available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">transferableButtons</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type"><a class="xref" href="#agentconfigbuttons">AgentConfigButtons</a></td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the list of chat buttons that agents can transfer chats
                to. Available in API version 31.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">transferableSkills</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type"><a class="xref" href="#agentconfigskills">AgentConfigSkills</a></td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the list of skill groups that agents can transfer chats
                to. Available in API version 31.0 and later.</td>

            </tr>

          </tbody>

        </table>

## AgentConfigAssignments

Represents the assignments of an organization’s profiles and users to a Chat configuration.

| Field Name | Field Type | Description |
| --- | --- | --- |
| profiles | [AgentConfigProfileAssignments](#agentconfigprofileassignments) | Specifies the profiles that are associated with a specific agent configuration. |
| users | [AgentConfigUserAssignments](#agentconfiguserassignments) | Specifies the users that are associated with a specific agent configuration. |

## AgentConfigButtons

Represents the chat buttons that agents who are associated with the Chat configuration can transfer chats to.

| Field Name | Field Type | Description |
| --- | --- | --- |
| button | string\[\] | Specifies the chat buttons that agents can transfer chats to. |

## AgentConfigProfileAssignments

Represents the profiles associated with a specific Chat configuration.

| Field Name | Field Type | Description |
| --- | --- | --- |
| profile | string | Specifies the custom name of the profile associated with a specific agent configuration. |

## AgentConfigSkills

Represents the skill groups that agents who are associated with the Chat configuration can transfer chats to.

| Field Name | Field Type | Description |
| --- | --- | --- |
| skill | string\[\] | Specifies the skill groups that agents can transfer chats to. |

## AgentConfigUserAssignments

Represents the users associated with a specific Chat configuration.

| Field Name | Field Type | Description |
| --- | --- | --- |
| user | string | Specifies the username of the user associated with a specific agent configuration. |

## SupervisorAgentConfigSkills

Represents the agent skills associated with a supervisor’s Chat configuration. Available in API version 29.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| skill | string | Specifies the agent skills available for filtering the Agent Status list in the Supervisor Panel. |

## Declarative Metadata Sample Definition

This is a sample of a liveChatAgentConfig file.

<?xml version="1.0" encoding="UTF-8"?>
<LiveChatAgentConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>My Agent Configuration 1</label\>
    <autoGreeting\>Hi, how can I help you?</autoGreeting\>
    <capacity\>5</capacity\>
    <enableAutoAwayOnDecline\>true</enableAutoAwayOnDecline\>
    <enableLogoutSound\>true</enableLogoutSound\>
    <enableNotifications\>true</enableNotifications\>
    <enableRequestSound\>true</enableRequestSound\>
    <enableSneakPeek\>true</enableSneakPeek\>
    <enableWhisperMessage\>true</enableWhisperMessage\>
    <assignments\>
        <profiles\>
            <profile\>standard</profile\>
        </profiles\>
        <users\>
            <user\>jdoe@acme.com</user\>
        </users\>
    </assignments\>
</LiveChatAgentConfig\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=209872b37f12888a4d3b04f9ed58c0eb3d853ac7af6b09ce5b3aa6d3905a7886 url=/legacydeveloper/current/en-us/api_meta/meta_livechatbutton.md -->

# LiveChatButton

Represents a Chat deployment’s settings for the button that customers click to chat with an agent and the chat window, such as the label that appears on the button and the pre-chat form that appears before a chat begins. This type extends the Metadata metadata type and inherits its fullName field.

Chats routed with Omni-Channel aren’t supported in the Metadata API.

## File Suffix and Directory Location

[LiveChatButton](#livechatbutton "Represents a Chat deployment’s settings for the button that customers click to chat with an agent and the chat window, such as the label that appears on the button and the pre-chat form that appears before a chat begins. This type extends the Metadata metadata type and inherits its fullName field.") configurations are stored in the <developer\_name>.liveChatButton file in the liveChatButtons directory.

## Version

[LiveChatButton](#livechatbutton "Represents a Chat deployment’s settings for the button that customers click to chat with an agent and the chat window, such as the label that appears on the button and the pre-chat form that appears before a chat begins. This type extends the Metadata metadata type and inherits its fullName field.") is available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d638118e110">Field Name</th>

              <th class="featureTableHeader  " id="d638118e113">Field Type</th>

              <th class="featureTableHeader  " id="d638118e116">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">animation</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">LiveChatButtonPresentation (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d638118e116" data-title="Description">The type of animation for a chat invitation. Valid values are:<ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">Slide</span></li>

                  <li class="li"><span class="keyword parmname">Fade</span></li>

                  <li class="li"><span class="keyword parmname">Appear</span></li>

                  <li class="li"><span class="keyword parmname">Custom</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">autoGreeting</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">The customized greeting message that the customer receives when
                an agent accepts a chat request from the chat button or
                invitation.<p class="p">Available in API version 29.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">chasitorIdleTimeout</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">int</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the amount of idle time before the chat times out. The
                idle time starts being counted after the agent sends the last chat
                message. Available in API version 35.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">chasitorIdleTimeoutWarning</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">int</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the amount of idle time before a warning appears. The
                idle time starts being counted after the agent sends the last chat
                message. Available in API version 35.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">chatPage</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the page that hosts your chat if that page differs from
                the Chat window.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">customAgentName</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">The agent’s name as it appears to customers in the chat
                window.<p class="p">Available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">deployments</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type"><a class="xref" href="#livechatbuttondeployments">LiveChatButtonDeployments</a></td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the deployments associated with the button.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">enableQueue</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d638118e116" data-title="Description">Indicates whether queuing is enabled (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">inviteEndPosition</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">LiveChatButtonInviteEndPosition (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d638118e116" data-title="Description">The end position of the chat invitation. Valid values include:<ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">TopLeft</span></li>

                  <li class="li"><span class="keyword parmname">Top</span></li>

                  <li class="li"><span class="keyword parmname">TopRight</span></li>

                  <li class="li"><span class="keyword parmname">Left</span></li>

                  <li class="li"><span class="keyword parmname">Center</span></li>

                  <li class="li"><span class="keyword parmname">Right</span></li>

                  <li class="li"><span class="keyword parmname">BottomLeft</span></li>

                  <li class="li"><span class="keyword parmname">Bottom</span></li>

                  <li class="li"><span class="keyword parmname">BottomRight</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">inviteImage</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">The custom button graphic that appears for the
                invitation.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">inviteStartPosition</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">LiveChatButtonInviteStartPosition (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d638118e116" data-title="Description">The start position of the chat invitation. Valid values include:<ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">TopLeft</span></li>

                  <li class="li"><span class="keyword parmname">TopLeftTop</span></li>

                  <li class="li"><span class="keyword parmname">Top</span></li>

                  <li class="li"><span class="keyword parmname">TopRightTop</span></li>

                  <li class="li"><span class="keyword parmname">TopRight</span></li>

                  <li class="li"><span class="keyword parmname">TopRightRight</span></li>

                  <li class="li"><span class="keyword parmname">Right</span></li>

                  <li class="li"><span class="keyword parmname">BottomRightRight</span></li>

                  <li class="li"><span class="keyword parmname">BottomRight</span></li>

                  <li class="li"><span class="keyword parmname">BottomRightBottom</span></li>

                  <li class="li"><span class="keyword parmname">Bottom</span></li>

                  <li class="li"><span class="keyword parmname">BottomLeftBottom</span></li>

                  <li class="li"><span class="keyword parmname">BottomLeft</span></li>

                  <li class="li"><span class="keyword parmname">BottomLeftLeft</span></li>

                  <li class="li"><span class="keyword parmname">Left</span></li>

                  <li class="li"><span class="keyword parmname">TopLeftLeft</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies whether the chat button or invitation is
                active.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the text that appears on the button.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">numberOfReroutingAttempts</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">int</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the number of times a chat request can be rerouted to
                available agents if all agents reject the chat request. Available in
                API version 30.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">offlineImage</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the image that appears on the button when no agents are
                available to chat.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">onlineImage</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the image that appears on the button when agents are
                available to chat.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">optionsCustomRoutingIsEnabled</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d638118e116" data-title="Description">Indicates whether custom routing is enabled for incoming chat
                requests (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 30.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">optionsHasChasitorIdleTimeout</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d638118e116" data-title="Description">Indicates whether the visitor idle timeout feature is enabled.
                Available in API version 35.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">optionsHasInviteAfterAccept</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d638118e116" data-title="Description">Indicates whether a new chat invitation triggers after a customer
                accepts a previous chat invitation (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">optionsHasInviteAfterReject</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d638118e116" data-title="Description">Indicates whether a new chat invitation triggers after a customer
                rejects a previous chat invitation (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">optionsHasRerouteDeclinedRequest</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d638118e116" data-title="Description">Indicates whether a chat request, which has been rejected by all
                available agents, is rerouted to available agents again (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 30.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">optionsIsAutoAccept</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d638118e116" data-title="Description">Indicates whether a chat request is automatically accepted by the
                agent it’s assigned to (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>). For chat buttons and
                automated chat invitations with <span class="keyword parmname">routingType</span> set
                to <samp class="codeph nolang">MostAvailable</samp> or <samp class="codeph nolang">LeastActive</samp>. Available in API
                version 30.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">optionsIsInviteAutoRemove</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">boolean</td>

              <td class="entry" headers="d638118e116" data-title="Description">Indicates whether a chat invitation is set to automatically
                disappear from a customer’s screen after a certain amount of
                time (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">overallQueueLength</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">int</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the maximum number of chat requests that are allowed to
                queue.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">perAgentQueueLength</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">int</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the number of chat requests that are allowed to queue
                for an agent with the required skills.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">postChatPage</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the name of the post-chat form to which customers are
                routed when the chat ends.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">postChatUrl</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the URL of the post-chat form to which customers are
                routed when the chat ends.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">preChatFormPage</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the name of the pre-chat form to which customers are
                routed before a chat begins.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">preChatFormUrl</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the URL of the pre-chat form to which customers are
                routed when the chat begins.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">pushTimeOut</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">int</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the number of seconds an agent has to answer an
                incoming chat request before the request is routed to another
                agent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">routingType</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">LiveChatButtonRoutingType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies how incoming chats are routed to agents when a customer
                pushes a button. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph xml">Choice</samp></li>

                  <li class="li"><samp class="codeph xml">LeastActive</samp></li>

                  <li class="li"><samp class="codeph xml">MostAvailable</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">site</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">string</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the Salesforce site that hosts your custom chat button
                images or custom chat page.
                <p class="p"><span class="ph" id="custom_domain_perm_req"><a name="custom_domain_perm_req"><!-- --></a>You must have the CustomDomain
                    permission enabled in your organization before you can use a Salesforce
                    site with Chat.</span></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">skills</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type"><a class="xref" href="#livechatbuttonskills">LiveChatButtonSkills</a></td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the skills associated with the button. When a customer
                clicks the button to chat, they’re automatically routed to agents
                with those skills.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">timeToRemoveInvite</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">int</td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies how long the invitation is displayed (in seconds) to
                customers before it disappears.</td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type">LiveChatButtonType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d638118e116" data-title="Description">Required. The chat button type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">Standard</span></li>

                  <li class="li"><span class="keyword parmname">Invite</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d638118e110" data-title="Field Name"><span class="keyword parmname">windowLanguage</span></td>

              <td class="entry" headers="d638118e113" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm#meta_translations" title="Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.">Language</a></td>

              <td class="entry" headers="d638118e116" data-title="Description">Specifies the language preferences for the chat window associated
                with the button.</td>

            </tr>

          </tbody>

        </table>

## LiveChatButtonSkills

Represents the skills associated with a chat button or invitation.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| skill | string | Specifies the name of the skill. |

## LiveChatButtonDeployments

Represents the deployments associated with a chat button or invitation.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| deployment | string | Specifies the name of the deployment. |

## Declarative Metadata Sample Definition

Here’s a sample of a liveChatButton file.

<?xml version="1.0" encoding="UTF-8"?>
<LiveChatButton xmlns="http://soap.sforce.com/2006/04/metadata">
    <deployments/\>
    <enableQueue\>false</enableQueue\>
    <isActive\>true</isActive\>
    <label\>CustomerSupportButton</label\>
    <optionsCustomRoutingIsEnabled\>false</optionsCustomRoutingIsEnabled\>
    <optionsHasChasitorIdleTimeout\>false</optionsHasChasitorIdleTimeout\>
    <optionsHasInviteAfterAccept\>false</optionsHasInviteAfterAccept\>
    <optionsHasInviteAfterReject\>false</optionsHasInviteAfterReject\>
    <optionsHasRerouteDeclinedRequest\>false</optionsHasRerouteDeclinedRequest\>
    <optionsIsAutoAccept\>false</optionsIsAutoAccept\>
    <optionsIsInviteAutoRemove\>false</optionsIsInviteAutoRemove\>
    <postChatUrl\>https://help.salesforce.com</postChatUrl\>
    <routingType\>Choice</routingType\>
    <skills\>
        <skill\>Chat</skill\>
    </skills\>
    <type\>Standard</type\>
</LiveChatButton\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If you update your chat button through the Metadata API, be sure to update all Web pages that use the same chat button code.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=287fe5c1193f6811eb464c2d49d68beaf595ebe39e5443cf5edc4b09df2e7f62 url=/legacydeveloper/current/en-us/api_meta/meta_livechatdeployment.md -->

# LiveChatDeployment

Represents the configuration settings for a specific Chat deployment, such as the branding image for the deployment and whether or not chat transcripts are automatically saved.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

LiveChatDeployment values are stored in the <developer\_name>.liveChatDeployment file in the liveChatDeployments directory.

## Version

LiveChatDeployment is available in API version 28.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| brandingImage | string | Specifies the branding image for the deployment. |
| connectionTimeoutDuration | int | Indicates the amount of time before the chat times out, in seconds. |
| ConnectionWarningDuration | int | Indicates the amount of time before a time-out warning is displayed to the agent, in seconds. |
| displayQueuePosition | boolean | (Pilot) Determines whether a customer’s queue position is displayed in a standard chat window while the customer waits for an agent to respond to the chat request (true) or not (false). This field is available as a pilot in API version 32.0. To enable this field, contact Salesforce. |
| domainWhiteList | [LiveChatDeploymentDomainWhiteList](#livechatdeploymentwhitelist) | Specifies the list of domains that can host the deployment. |
| enablePrechatApi | boolean | Indicates whether or not the pre-chat API is enabled for the deployment (true) or not (false). |
| enableTranscriptSave | boolean | Indicates whether chat transcripts are automatically saved after a chat ends (true) or not (false). |
| label | string | Specifies the name of the deployment. |
| mobileBrandingImage | string | Specifies the branding image for the deployment that appears when customers access the deployment on a mobile device. |
| site | string | Specifies the site that hosts the images for the deployment. You must have the CustomDomain permission enabled in your organization before you can use a Salesforce site with Chat. |
| windowTitle | string | Specifies the title of the window associated with the deployment. |

## LiveChatDeploymentDomainWhiteList

Represents a Chat deployment’s domain whitelist.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| domain | string | Specifies a domain that can host the deployment. |

## Declarative Metadata Sample Definition

This is a sample of a liveChatDeployment file.

<?xml version="1.0" encoding="UTF-8"?>
<LiveChatDeployment xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>My Deployment 1</label\>
    <brandingImage\>pkb\_image\_bannerBg</brandingImage\>
    <mobileBrandingImage\>pkb\_image\_bgBottom</mobileBrandingImage\>
    <domainWhiteList\>
        <domain\>mydomain</domain\>
        <domain\>test</domain\>
    </domainWhiteList\>
    <enableTranscriptSave\>true</enableTranscriptSave\>
    <site\>GL\_Knowledge\_Base</site\>
    <windowTitle\>My window title</windowTitle\>
</LiveChatDeployment\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If you update your deployment through the Metadata API, be sure to update all Web pages that use the same deployment code.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ca00aa586d05c0b00ad4a794b8688365ae2a14df68dc8e6814b8465bcf398525 url=/legacydeveloper/current/en-us/api_meta/meta_livechatsensitivedatarule.md -->

# LiveChatSensitiveDataRule

Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex).

Use this object to mask or delete data of specified patterns, such as credit card, social security, phone and account numbers, or even profanity. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

LiveChatSensitiveDataRule components have the suffix .liveChatSensitiveDataRule and are stored in the liveChatSensitiveDataRule folder.

## Version

LiveChatSensitiveDataRule components are available in API version 35.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d642404e98">Field Name</th>

              <th class="featureTableHeader  " id="d642404e101">Field Type</th>

              <th class="featureTableHeader  " id="d642404e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d642404e98" data-title="Field Name"><span class="keyword parmname">actionType</span></td>

              <td class="entry" headers="d642404e101" data-title="Field Type">SensitiveDataActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d642404e104" data-title="Description">Required. The action to take on the text when the sensitive data rule is
                triggered. Possbile values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Remove</samp></li>

                  <li class="li"><samp class="codeph nolang">Replace</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d642404e98" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d642404e101" data-title="Field Type">string</td>

              <td class="entry" headers="d642404e104" data-title="Description">The description of the sensitive data rule—for example, “Block social security
                numbers.”</td>

            </tr>

            <tr>
              <td class="entry" headers="d642404e98" data-title="Field Name"><span class="keyword parmname">enforceOn</span></td>

              <td class="entry" headers="d642404e101" data-title="Field Type">int</td>

              <td class="entry" headers="d642404e104" data-title="Description">Required. Determines the roles on which the rule is enforced. The value is
                determined using bitwise OR operation. There are seven possible values:<ol class="ol enumList">
                  <li class="li">Rule enforced on Agent</li>

                  <li class="li">Rule enforced on Visitor</li>

                  <li class="li">Rule enforced on Agent and Visitor</li>

                  <li class="li">Rule enforced on Supervisor</li>

                  <li class="li">Rule enforced on Agent and Supervisor</li>

                  <li class="li">Rule enforced on Visitor and Supervisor</li>

                  <li class="li">Rule enforced on Agent, Visitor, and Supervisor</li>

                </ol>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d642404e98" data-title="Field Name"><span class="keyword parmname">isEnabled</span></td>

              <td class="entry" headers="d642404e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d642404e104" data-title="Description">Required. Specifies whether a sensitive data rule is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Default value (if none is provided) is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d642404e98" data-title="Field Name"><span class="keyword parmname">pattern</span></td>

              <td class="entry" headers="d642404e101" data-title="Field Type">string</td>

              <td class="entry" headers="d642404e104" data-title="Description">Required. The pattern of text blocked by the rule. Written as a JavaScript
                regular expression (regex).</td>

            </tr>

            <tr>
              <td class="entry" headers="d642404e98" data-title="Field Name"><span class="keyword parmname">replacement</span></td>

              <td class="entry" headers="d642404e101" data-title="Field Type">string</td>

              <td class="entry" headers="d642404e104" data-title="Description">The string of characters that replaces the blocked text (if
                <span class="keyword parmname">ActionType</span>
                <kbd class="ph userinput">Replace</kbd> is selected).
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a LiveChatSensitiveDataRule component.

<LiveChatSensitiveDataRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionType\>REPLACE</actionType\>
    <enforceOn\>7</enforceOn\> 
    <isEnabled\>true</isEnabled\> 
    <pattern\>\[aeiou\]</pattern\> 
    <replacement\>œ</replacement\>
</LiveChatSensitiveDataRule\>

The following is an example package.xml that references the previous definition.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <!-- To be used from support.liveagent.testsuite.unifiedouting.testDeployButtonMDAPIWithExistingQueue -->
    <apiAccessLevel\>Unrestricted</apiAccessLevel\>

    <types\>        
        <members\>Change\_For\_all</members\>    
        <name\>LiveChatSensitiveDataRule</name\>
    </types\>

    <version\>35.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=eb83677a8e9524514ca4c8e51f048933d88d6894a130129153cdced17bb873ce url=/legacydeveloper/current/en-us/api_meta/meta_livemessagesettings.md -->

# LiveMessageSettings

Represents an org’s LiveMessage settings.

## Version

LiveMessageSettings components are available in API version 42.0 and later.

## File Suffix and Directory Location

LiveMessageSettings values are stored in the LiveMessage.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.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d643100e76">Field Name</th>

              <th class="featureTableHeader  " id="d643100e79">Field Type</th>

              <th class="featureTableHeader  " id="d643100e82">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d643100e76" data-title="Field Name"><span class="keyword parmname">enableCheckCEUserPerm</span></td>

              <td class="entry" headers="d643100e79" data-title="Field Type">boolean</td>

              <td class="entry" headers="d643100e82" data-title="Description">Gives access to ConversationEntry objects only to users with the Access
                Conversation Entries user permission enabled (true) or to all users (false) in an
                org.<p class="p">For orgs created before API version 50.0, the default value is <samp class="codeph nolang">false</samp>.</p>
                <p class="p">For orgs created on or after API
                  version 50.0, the default value is <samp class="codeph nolang">true</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d643100e76" data-title="Field Name"><span class="keyword parmname">enableLiveMessage</span></td>

              <td class="entry" headers="d643100e79" data-title="Field Type">boolean</td>

              <td class="entry" headers="d643100e82" data-title="Description">Turns LiveMessage on (<samp class="codeph java">true</samp>) or off (<samp class="codeph java">false</samp>) in an org. The default value is <samp class="codeph java">false</samp>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a liveMessageSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<LiveMessageSettings xmlns="http://soap.sforce.com/2006/04/metadata">
   <enableLiveMessage\>true</enableLiveMessage\>
</LiveMessageSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>LiveMessage</members\>
        <name\>Settings</name\>
    </types\>
    <version\>44.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=d4c1e807a18e776289a7587173cbf7500c9a63f87c6c25fe248f84ffbee6597f url=/legacydeveloper/current/en-us/api_meta/meta_loyaltyprogramsetup.md -->

# LoyaltyProgramSetup

Represents the configuration of a loyalty program process including its parameters and rules. Program processes determine how new transaction journals are processed. When new transaction journals meet the criteria and conditions for a program process, actions that are set up in the process are triggered for the transaction journals.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

LoyaltyProgramSetup components have the suffix loyaltyProgramSetup and are stored in the loyaltyProgramSetups folder.

## Version

LoyaltyProgramSetup components are available in API version 54.0 and later for Loyalty Management and in API version 59.0 and later for Referral Marketing.

## Special Access Rules

To use this metadata type, your org must have either B2C - Loyalty, B2C - Loyalty Plus, Loyalty Management - Growth, Loyalty Management - Advanced, or Referral Marketing license enabled.

## Fields

| Field Name | Description |
| --- | --- |
| label | 
Field Type

string

Description

Name of the loyalty program that the program process is associated with. If a loyalty program or referral program with the specified name doesn't exist, a new LoyaltyProgram record is created. The name of a program must contain at least one alphanumeric character.



 |
| programProcesses | 

Field Type

[LoyaltyProgramProcess\[\]](#subtype_LoyaltyProgramProcess)

Description

Collection of loyalty program processes associated with a loyalty program or a referral program.



 |

## LoyaltyProgramProcess

Represents a collection of fields relating to a loyalty program process.

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The description of the loyalty program process.



 |
| executionType | 

Field Type

LoyaltyPgmProcExecutionType (enumeration of type string)

Description

The mode of processing transaction journals by the loyalty program process.

Possible values are:

- Batch
- BatchAndRealTime
- RealTime





 |
| journalSubType | 

Field Type

string

Description

The subtype of transaction journals processed by the loyalty program process.



 |
| journalType | 

Field Type

string

Description

The type of transaction journal processed by the loyalty program process.

Possible values for loyalty program:

- Accrual
- Redemption

Possible value for referral program:

- Referral





 |
| loyaltyTierGroup | 

Field Type

string

Description

The tier group of a loyalty program. This field is available in API version 56.0 and later. This field isn’t applicable for referral programs.



 |
| parameters | 

Field Type

[LoyaltyProgramProcessParameter\[\]](#subtype_LoyaltyProgramProcessParameter)

Description

The parameters associated with the loyalty program process.



 |
| processName | 

Field Type

string

Description

Required.

The name of the loyalty program process.



 |
| processType | 

Field Type

string

Description

Required.

The type of records processed by the loyalty program process. For referral programs, the process type is TransactionJournal.



 |
| rules | 

Field Type

[LoyaltyProgramProcessRule\[\]](#subtype_LoyaltyProgramProcessRule)

Description

The rules associated with the loyalty program process.



 |
| status | 

Field Type

LoyaltyPgmProcStatus (enumeration of type string)

Description

The status of the loyalty program process.

Possible values are:

- Active
- Draft
- Inactive

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Only active program processes can process transaction journals.















 |

## LoyaltyProgramProcessParameter

Represents a collection of fields relating to a parameter that's associated with the program process. Parameters are dynamic or fixed values that are used in rule. You can define the value of a parameter based on its type and data type.

| Field Name | Description |
| --- | --- |
| condition | 
Field Type

[LoyaltyProgramProcessCondition](#subtype_LoyaltyProgramProcessCondition)

Description

The filter condition that decides which records are stored in the parameter.



 |
| dataType | 

Field Type

LoyaltyPgmProcParmDataType (enumeration of type string)

Description

The data type of the parameter. Determines the type of value that can be stored in the parameter.

Possible values are:

- Boolean
- Date
- DateTime
- Numeric
- Sobject
- Text





 |
| decimalPlaces | 

Field Type

int

Description

The number of decimal places supported by the parameter when it is of the type Variable and data type Numeric.



 |
| description | 

Field Type

string

Description

The description of the parameter.



 |
| isCollection | 

Field Type

boolean

Description

Indicates whether the parameter can store multiple values when it is of the type Variable.



 |
| isInput | 

Field Type

boolean

Description

Indicates whether a parameter can be used as an input outside the loyalty program process.



 |
| isOutput | 

Field Type

boolean

Description

Indicates whether a parameter can be used as an output outside the loyalty program process.



 |
| objectName | 

Field Type

string

Description

Name of the object whose records are stored by the parameter when it is of the type Variable and data type sObject.



 |
| parameterName | 

Field Type

string

Description

Required.

The name of the parameter.



 |
| parameterType | 

Field Type

LoyaltyPgmProcParmType (enumeration of type string)

Description

The type of value the parameter can store.

Possible values are:

- Constant
- Formula
- Variable





 |
| value | 

Field Type

string

Description

The value of the parameter when it is of the type Variable or Formula and isn't of the data type sObject.



 |

## LoyaltyProgramProcessCondition

Represents a collection of fields relating to a condition. Conditions filter records that parameters store or check whether child actions must be triggered for a transaction journal.

| Field Name | Description |
| --- | --- |
| conditionCriteria | 
Field Type

string

Description

Required.

The criteria that determine when the condition is met by a record or by a transaction journal.



 |
| conditionFilterCriteria | 

Field Type

[LoyaltyProgramProcessConditionFilterCriteria\[\]](#subtype_LoyaltyProgramProcessConditionFilterCriteria)

Description

The filter criteria that determines which records or transaction journals are filtered.



 |
| conditionName | 

Field Type

string

Description

Required.

The name of the condition.



 |
| conditionType | 

Field Type

LoyaltyPgmProcRuleType (enumeration of type string)

Description

Specifies the type of condition in the loyalty program process.

Values

Values are:

- Condition
- Action
- ConditionGroup
- DefaultPath





 |

## LoyaltyProgramProcessConditionFilterCriteria

Represents a collection of fields relating to a filter criteria that's part of a condition. Multiple filter criteria can be added for a condition. Filter criteria determine which records are filtered by related condition.

| Field Name | Description |
| --- | --- |
| operator | 
Field Type

LoyaltyPgmProcCondOperator (enumeration of type string)

Description

Required.

The operator of the filter criteria.

Possible values are:

- Contains
- DoesNotContain
- Equals
- GreaterThan
- GreaterThanOrEquals
- IsNotNull
- IsNull
- LessThan
- LessThanOrEquals
- NotEquals





 |
| sequence | 

Field Type

int

Description

Required.

The sequence number of the filter criteria within a condition.



 |
| sourceFieldName | 

Field Type

string

Description

Required.

The name of the field used in the filter criteria.



 |
| value | 

Field Type

string

Description

The value of the filter criteria.



 |
| valueType | 

Field Type

LoyaltyPgmProcCondType (enumeration of type string)

Description

Required.

The type of value specified in the filter criteria.

Possible values are:

- Formula
- Literal
- Lookup
- Parameter





 |

## LoyaltyProgramProcessRule

Represents a collection of fields relating to a rule. A rule consists of a set of conditions and actions.

| Field Name | Description |
| --- | --- |
| actions | 
Field Type

[LoyaltyProgramProcessAction\[\]](#subtype_LoyaltyProgramProcessAction)

Description

The actions associated with the rule.



 |
| conditions | 

Field Type

[LoyaltyProgramProcessCondition\[\]](#subtype_LoyaltyProgramProcessCondition)

Description

The conditions associated with the rule.



 |
| description | 

Field Type

string

Description

The description of the rule.



 |
| endDate | 

Field Type

date

Description

The date until which the rule processes transaction journals.



 |
| isProcessEligibilityRule | 

Field Type

boolean

Description

Indicates whether the rule is used to determine eligibility for processing the loyalty program process (true) or not (false). When set to true, the rule is evaluated as a process eligibility rule. When set to false, the rule is evaluated as a standard program process rule.



 |
| previousRule | 

Field Type

string

Description

The rule that processes new transaction journals before the current rule. The current rule is triggered when the previous rule completes processing transaction journals.



 |
| promotion | 

Field Type

string

Description

The promotion associated with the rule. When a promotion is associated with a rule, the start date, end date, and status of the promotion determines the corresponding fields of the rule.



 |
| ruleName | 

Field Type

string

Description

Required.

The name of the rule.



 |
| startDate | 

Field Type

date

Description

The date from which the rule starts processing transaction journals.



 |
| status | 

Field Type

LoyaltyPgmProcRuleStatus (enumeration of type string)

Description

The status of the rule.

Possible values are:

- Active
- Draft
- Inactive





 |
| stepMappings | 

Field Type

[LoyaltyProgramProcessRuleStepMapping\[\]](#subtype_LoyaltyProgramProcessRuleStepMapping)

Description

The list of step mappings associated with rule.



 |

## LoyaltyProgramProcessAction

Represents a collection of fields relating to an action.

| Field Name | Description |
| --- | --- |
| actionName | 
Field Type

string

Description

Required.

The name of the action.



 |
| actionParameters | 

Field Type

[LoyaltyProgramProcessActionParameter\[\]](#subtype_LoyaltyProgramProcessActionParameter)

Description

The parameters of the action.



 |
| actionType | 

Field Type

LoyaltyPgmProcActionType (enumeration of type string)

Description

Required.

The type of action.

Possible values are:

- These values are used in Loyalty Management:
    - AssignParameterValues—Assigns values to parameters.
    - AssignBadgeToMember—Assigns a badge to a loyalty program member. This value is available in API version 56.0 and later.
    - Crud—Creates or updates records in the target object. This value is available in API version 56.0 and later.
    - CheckMemberBadgeAssignment—Checks whether a badge is assigned to a loyalty program member. This value is available in API version 56.0 and later.
    - ChangeMemberTier—Changes the tier of a loyalty program member. This value is available in API version 56.0 and later.
    - CreditPoints—Credits points to the loyalty program member associated with the transaction journal that's processed by the rule.
    - DebitPoints—Debits points from the points balance of the loyalty program member associated with the transaction journal that's processed by the rule.
    - GetMemberAttributesValues—Gets the details of a loyalty program member’s attribute value for the selected engagement attribute. This value is available in API version 55.0 and later.
    - GetMemberPartnerLinkageStatus—Gets the partner linkage status of the loyalty program member associated with the transaction journal that's processed by the rule.
    - GetMemberPointBalance—Gets the points balance of a loyalty program member.
    - GetMemberPromotions—Get promotions of a loyalty program member. This value is available in API version 56.0 and later.
    - GetMemberTier—Gets the tier details of a loyalty program member.
    - GetOutputsFromDecisionTable—Gets outputs provided by a decision table. This value is available in API version 56.0 and later.
    - IncreaseUsageForCumulativePromotion—Increases a loyalty program member’s usage for a cumulative promotion.
    - IssueVoucher—Issues a voucher to the loyalty program member associated with the transaction journal that's processed by the rule.
    - RedeemVoucher—Redeems a voucher for the loyalty program member associated with the transaction journal that's processed by the rule. This value is available in API version 58.0 and later.
    - —Updates the loyalty program member's usage towards achieving a cumulative promotion by a specified value.
    - RunFlow—Runs a flow.
    - RunProgramProcess—Runs an active loyalty program process as a subprocess. This value is available in API version 56.0 and later.
    - SendMail—Sends emails to the loyalty program member for whom the process is run. This value is available in API version 59.0 and later.
    - UpdateCurrentValueForMemberAttribute—Updates the loyalty program member's current attribute value for the selected engagement attribute. This value is available in API version 55.0 and later.
    - UpdatePointBalance—Updates the points balance of the loyalty program member associated with the transaction journal that's processed by the rule.
    - UpdateUsageForCumulativePromotion—Updates a loyalty program member’s usage for a cumulative promotion.
- These values are used in Referral Marketing:
    - AssignParameterValues—Assigns values to parameters.
    - Crud—Creates or updates records in the target object.
    - GetMemberAttributesValues—Gets the details of an advocate's attribute value for the selected engagement attribute.
    - GetMemberPromotions—Gets the promotions of an advocate.
    - GetOutputsFromDecisionTable—Gets outputs provided by a decision table.
    - IssueExtendedReward—Issues an extended reward to an advocate or a referred friend. This value is available in API version 64.0 and later.
    - IssueVoucher—Issues a voucher to an advocate or a referred friend.
    - RedeemVoucher—Redeems a voucher for an advocate or a friend.
    - SendMail—Sends emails to a referral program’s advocates and referrals.
    - UpdateCurrentValueForMemberAttribute—Updates an advocate’s current attribute value for the selected engagement attribute.
- These values are reserved for internal use:
    - GetCustomerPromotionAttrValue—This value is available in API version 64.0 and later.
    - UpdateCustomerPromotionAttrValue—This value is available in API version 64.0 and later.





 |
| crudActionType | 

Field Type

LoyaltyPgmProcCrudActType (enumeration of type string)

Description

The type of operation to perform on target object records by the action. This field is available from API version 56.0 and later.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field is required when the actionType field value is CRUD.

Possible values are:

- create
- update







 |
| decisionTable | 

Field Type

string

Description

The decision that's invoked by the action for the transaction journal that's processed by the rule.



 |
| decisionTableDatasetLink | 

Field Type

string

Description

The dataset link associated with the selected decision table.



 |
| entityApiName | 

Field Type

string

Description

The API name of the target object. This field is available from API version 56.0 and later.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field is required when the actionType field value is CRUD.















 |
| flowDefinition | 

Field Type

string

Description

The flow that's run by the action for the transaction journal that's processed by the rule. The selected flow must be of the type LoyaltyManagementFlow.



 |
| loyaltyProgramProcess | 

Field Type

string

Description

The subprogram processes that’s run by the action. This field is available from API version 56.0 and later.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field is required when the actionType field value is RunProgramProcess.















 |

## LoyaltyProgramProcessActionParameter

Represents a collection of fields relating to an action parameter. A parameter is either an input or an output for the action. Input parameters store the values used by the action. Output parameters store the result of the action.

| Field Name | Description |
| --- | --- |
| operator | 
Field Type

LoyaltyPgmProcActParamOper (enumeration of type string)

Description

The type of operator used in the action. This field is available in API version 56.0 and later.

Possible value is:

- Equals







 |
| parameterName | 

Field Type

string

Description

Required.

The name of parameter. The parameter name must be the same as the input or the output field that's supported depending on the associated action's type.



 |
| sequenceNumber | 

Field Type

int

Description

The sequence number of the parameter in the action. This field is available in API version 56.0 and later.



 |
| value | 

Field Type

string

Description

Required.

The value of the parameter.



 |
| valueType | 

Field Type

LoyaltyPgmProcActParamType (enumeration of type string)

Description

The type of value to provide in the parameter. This field is available in API version 56.0 and later.

Possible values are:

- Literal—A constant value.
- Parameter—A runtime value passed using a parameter.





 |

## LoyaltyProgramProcessRuleStepMapping

Represents a collection of fields relating to a step mapping. Map conditions with child actions or map an action without a parent step.

| Field Name | Description |
| --- | --- |
| associatedStep | 
Field Type

string

Description

Required.

The action that's associated with the mapping.



 |
| parentStep | 

Field Type

string

Description

The condition that contains one or more child actions.



 |
| sequence | 

Field Type

int

Description

Required.

The sequence number of the mapping within a rule.



 |

## Declarative Metadata Sample Definition

The following is an example of a LoyaltyProgramSetup component.

<?xml version="1.0" encoding="UTF-8"?>
<LoyaltyProgramSetup xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>Cloud Kicks Inner Circle</label\>
    <programProcesses\>
        <executionType\>RealTime</executionType\>
        <parameters\>
            <dataType\>Numeric</dataType\>
            <decimalPlaces\>0</decimalPlaces\>
            <isCollection\>false</isCollection\>
            <isInput\>false</isInput\>
            <isOutput\>false</isOutput\>
            <parameterName\>VoucherValue</parameterName\>
            <parameterType\>Constant</parameterType\>
            <value\>50</value\>
        </parameters\>
        <processName\>Issue Vouchers</processName\>
        <processType\>Transaction Journal</processType\>
        <rules\>
            <isProcessEligibilityRule\>false</isProcessEligibilityRule\>
            <actions\>
                <actionName\>Issue High Transaction Value Voucher</actionName\>
                <actionParameters\>
                    <operator\>Equals</operator\>
                    <parameterName\>VoucherDefinitionName</parameterName\>
                    <sequenceNumber\>1</sequenceNumber\>
                    <value\>Voucher for High Value Transactions</value\>
                    <valueType\>Literal</valueType\>
                </actionParameters\>
                <actionParameters\>
                    <operator\>Equals</operator\>
                    <parameterName\>VoucherCode</parameterName\>
                    <sequenceNumber\>2</sequenceNumber\>
                    <value\>{!TransactionJournal.Order.Id}</value\>
                </actionParameters\>
                <actionParameters\>
                    <operator\>Equals</operator\>
                    <parameterName\>VoucherEffectiveDate</parameterName\>
                    <sequenceNumber\>3</sequenceNumber\>
                    <value\>DATEVALUE(&quot;2021-11-21 00:00:00&quot;)</value\>
                </actionParameters\>
                <actionParameters\>
                    <operator\>Equals</operator\>
                    <parameterName\>VoucherExpirationDate</parameterName\>
                    <sequenceNumber\>4</sequenceNumber\>
                    <value\>DATEVALUE(&quot;2022-01-01 00:00:00&quot;)</value\>
                </actionParameters\>
                <actionParameters\>
                    <operator\>Equals</operator\>
                    <parameterName\>VoucherFaceValue</parameterName\>
                    <sequenceNumber\>5</sequenceNumber\>
                    <value\>{!VoucherValue}</value\>
                </actionParameters\>
                <actionType\>IssueVoucher</actionType\>
            </actions\>
            <conditions\>
                <conditionCriteria\>1</conditionCriteria\>
                <conditionFilterCriteria\>
                    <operator\>GreaterThanOrEquals</operator\>
                    <sequence\>1</sequence\>
                    <sourceFieldName\>TransactionJournal.TransactionAmount</sourceFieldName\>
                    <value\>100</value\>
                    <valueType\>Literal</valueType\>
                </conditionFilterCriteria\>
                <conditionName\>New Condition</conditionName\>
                <conditionType\>Condition</conditionType\>
            </conditions\>
            <endDate\>2022-01-01</endDate\>
            <ruleName\>Issue Voucher for Transactions Above $100</ruleName\>
            <startDate\>2021-11-21</startDate\>
            <status\>Draft</status\>
            <stepMappings\>
                <associatedStep\>New Condition</associatedStep\>
                <sequence\>1</sequence\>
            </stepMappings\>
            <stepMappings\>
                <associatedStep\>Issue High Transaction Value Voucher</associatedStep\>
                <parentStep\>New Condition</parentStep\>
                <sequence\>1</sequence\>
            </stepMappings\>
        </rules\>
        <status\>Draft</status\>
    </programProcesses\>
</LoyaltyProgramSetup\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   ~ Copyright 2020 Salesforce, Inc.
   ~ All Rights Reserved
   ~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>LoyaltyProgramSetup</name\>
   </types\>
   <version\>54.0</version\>
</Package\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

To retrieve metadata specific to any loyalty program, mention the loyalty program name in the <members> tag. The generated file contains all the information regarding that loyalty program.

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=28fc295821c47c1874891f5cd612b11d9d386f699c5075624b66fd55537e0a66 url=/legacydeveloper/current/en-us/api_meta/meta_macrosettings.md -->

# MacroSettings

Represents an organization’s Macro settings, such as whether or not folders is enabled. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

MacroSettings values are stored in the Macro.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## Version

MacroSettings is available in API version 39.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableAdvancedSearch | boolean | Indicates whether users can search all macro text fields (true) or not (false). |
| macrosInFolders | boolean | Indicates whether users can organize and share macros using folders (true) or not (false). Available in API version 44.0 and later. |

## Declarative Metadata Sample Definition

This is a sample Macro settings file.

<?xml version="1.0" encoding="UTF-8"?>
<MacroSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAdvancedSearch\>true</enableAdvancedSearch\>
    <macrosInFolders\>true</macrosInFolders\>
</MacroSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=f35186018c87c6fd932cf394f175b4e8e3211febb0b266b702434b1801fafd12 url=/legacydeveloper/current/en-us/api_meta/meta_mailmergesettings.md -->

# MailMergeSettings

Represents the settings for Extended Mail Merge functionality.

## File Suffix and Directory Location

A MailMerge component file has the suffix MailMerge.settings and is stored in the settings directory.

## Version

MailMergeSettings components are available in API version 51.0 and later. Before API version 51.0, fields from MailMergeSettings were found within OrgSettings components.

## Fields

| Field Name | Field Type | Descriptions |
| --- | --- | --- |
|  |  |  |
| enableExtendedMailMerge | boolean | Indicates whether the Salesforce Classic product, Extended Mail Merge, is enabled (true) or not (false). Use Extended Mail Merge to generate Microsoft Word documents — such as form letters or address labels — from Salesforce records using Word document templates. Default value is false. |
| saveMailMergeDocsAsSalesforceDocs | boolean | Indicates whether mail-merged documents are saved to the My Personal Documents folder of the user who generated the mail merge. (true) or not (false). If (false), only documents over 3 MB are saved to the user’s documents folder. Smaller documents are emailed to the user. Default value is (false). |

## Declarative Metadata Sample Definition

The following is an example of a MailMergeSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<MailMergeSettings xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <enableExtendedMailMerge\>true</enableExtendedMailMerge\>
</MailMergeSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve mail merge settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?> 
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
       <members\>MailMerge</members\>
       <name\>Settings</name\>
    </types\>
    <version\>62.0</version\> 
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=a279e6cfcee776da0f25766653d90993b57f8eecdfb0c90d6f5d30dfc9fab8f2 url=/legacydeveloper/current/en-us/api_meta/meta_user_references.md -->

# Maintaining User References

User fields are preserved during a metadata deployment.

When a component in your deployment refers to a specific user, such as a recipient of a workflow email notification or a dashboard running user, then Salesforce attempts to locate a matching user in the destination organization by comparing usernames during the deployment.

For example, when you copy data to a sandbox, the fields containing usernames from the production organization are altered to include the sandbox name. In a sandbox named test, the username user@acme.com becomes user@acme.com.test. When you deploy the metadata in the sandbox to another organization, the test in the username is ignored.

For user references in deployments, Salesforce performs the following sequence:

1. Salesforce compares usernames in the source environment to the destination environment and adapts the organization domain name.
2. If two or more usernames match, Salesforce lists the matching names and requests one of the users in the source environment be renamed.
3. If a username in the source environment doesn’t exist in the destination environment, Salesforce displays an error, and the deployment stops until the usernames are removed or resolved to users in the destination environment.

<!-- document id=708162d9f80f98a58549a74ad30076816fb12383047bac41716801942820000d url=/legacydeveloper/current/en-us/api_meta/meta_use_cases_large_config_changes.md -->

# Make Large Metadata Configuration Changes

Metadata API is better suited than other APIs for deploying large changes to your Salesforce org.

Metadata API deploy() and retrieve() calls are file-based and therefore asynchronous. With synchronous commands, large configuration changes require unreasonably long load times. Instead, deploy and retrieve calls begin an asynchronous process that notifies you when it’s complete. Because file-based calls are asynchronous, Metadata API can also handle a queue of deploy requests.

#### See Also

- [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.")
- [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.")

<!-- document id=dc0537cc6e3be6203d9d796a4351f985d4c9dc051436bf03503ff3c41e476b2d url=/legacydeveloper/current/en-us/api_meta/meta_managedcontenttype.md -->

# ManagedContentType

Represents the definition of custom content types for use with Salesforce CMS. Custom content types are displayed as forms with defined fields.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

ManagedContentType components have the suffix managedContentType and are stored in the managedContentTypes folder.

## Version

ManagedContentType components are available in API version 47.0 and later.

## Special Access Rules

ManagedContentType is only available if Salesforce CMS and digital experiences are enabled for your org.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Describes the custom content type defined in this ManagedContentType declaration. |
| developerName | string | Required. Unique name for the custom content type. For example: OurSpecialContent\_c |
| isMetadataContent | boolean | When true, any content created from this content type is converted to metadata. Default value is false. Availabe in API version 63.0 and later. |
| managedContentNodeTypes | [ManagedContentNodeType](#managedContentNodeType)\[\] | Nodes included as part of this custom content type. When rendered as a form in the Digital Experiences app, each node is represented as an individual field. |
| masterLabel | string | Required. Declares the name of the content type as it appears in the UI. |

## ManagedContentNodeType

Represents the structure of individual nodes within the custom content type.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d649737e227">Field Name</th>

              <th class="featureTableHeader  " id="d649737e230">Field Type</th>

              <th class="featureTableHeader  " id="d649737e233">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d649737e227" data-title="Field Name"><span class="keyword parmname">helpText</span></td>

              <td class="entry" headers="d649737e230" data-title="Field Type">string</td>

              <td class="entry" headers="d649737e233" data-title="Description">Provides assistive text in the UI, displayed as an info bubble for the field.
                If this field is empty, no info bubble icon or text is displayed. <p class="p">For example:
                  &lt;IMG?&gt;</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d649737e227" data-title="Field Name"><span class="keyword parmname">isLocalizable</span></td>

              <td class="entry" headers="d649737e230" data-title="Field Type">boolean</td>

              <td class="entry" headers="d649737e233" data-title="Description">Declares a field as localizable and consumable by &lt;loc MDAPI reference&gt;
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Default is <samp class="codeph nolang">false</samp>.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>NodeTypes <samp class="codeph nolang">IMG</samp>, <samp class="codeph nolang">URL</samp>, <samp class="codeph nolang">DATE</samp>, and
                            <samp class="codeph nolang">DATETIME</samp> can’t be localized.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d649737e227" data-title="Field Name"><span class="keyword parmname" id="isrequired"><a name="isrequired"><!-- --></a>isRequired</span></td>

              <td class="entry" headers="d649737e230" data-title="Field Type">boolean</td>

              <td class="entry" headers="d649737e233" data-title="Description">Declares a field as required (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). Fields declared as required are
                indicated by a red asterisk. If a value isn’t added to the field in the custom
                content type, the form can’t be saved and a standard error is displayed. Default is
                <samp class="codeph nolang">false</samp>.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>When <span class="keyword parmname"><a class="xref" href="#nodetype">nodeType</a></span> is set to
                            <samp class="codeph nolang">NAMEFIELD</samp> on a field,
                            <span class="keyword parmname">isRequired</span> must also be set to <samp class="codeph nolang">True</samp> for that field.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d649737e227" data-title="Field Name"><span class="keyword parmname">nodeLabel</span></td>

              <td class="entry" headers="d649737e230" data-title="Field Type">string</td>

              <td class="entry" headers="d649737e233" data-title="Description">Required. Declares the label for the field as it appears in the UI. <p class="p">In
                  enhanced workspaces, the system generates a Title field by default. To prevent
                  having multiple Title fields on the UI when you create a custom content type for
                  use in an enhanced workspace, don't use Title as the label for
                  <span class="keyword parmname">nodeLabel</span>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d649737e227" data-title="Field Name"><span class="keyword parmname">nodeName</span></td>

              <td class="entry" headers="d649737e230" data-title="Field Type">string</td>

              <td class="entry" headers="d649737e233" data-title="Description">Required. Unique name of the <span class="keyword parmname">nodeType</span> within the content
                type. <span class="keyword parmname">nodeName</span> is a simple text field that allows up to 100
                alphanumeric characters and underscores. The name must begin with a letter, not
                include spaces, can’t have two consecutive underscores, and can’t end with an
                underscore. <p class="p">In enhanced workspaces, the system generates a Title field by
                  default. To prevent having multiple Title fields on the UI when you create a
                  custom content type for use in an enhanced workspace, don't use Title as the label
                  for <span class="keyword parmname">nodeName</span>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d649737e227" data-title="Field Name"><span class="keyword parmname" id="nodetype"><a name="nodetype"><!-- --></a>nodeType</span></td>

              <td class="entry" headers="d649737e230" data-title="Field Type">MCNodeType (enumeration of type string)</td>

              <td class="entry" headers="d649737e233" data-title="Description">Required. Identifies the supported type of content in the node. Passed as a
                string. There’s a maximum of 15 node types per content type. Values are case
                insensitive but are returned in all capital letters as shown. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">TEXT</samp>
                    <p class="p">Simple text node (max length=255
                      characters)</p>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MTEXT</samp>
                    <p class="p">Multi-line text node (max
                      length=2000 characters)</p>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RTE</samp>
                    <p class="p">Rich text node (max length=65536
                      characters)</p>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IMG</samp>
                    <p class="p">Image node</p>
                    <div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p><samp class="codeph nolang">IMG</samp> node types can’t be localized. Set
                                <span class="keyword parmname">isLocalizable</span> to false for images.
                              </p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">URL</samp>
                    <div class="p">URL node (max length=255
                      characters)<div class="box message info">
                        <div class="inner">
                          <div class="bd">
                            <div class="media">
                              <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                              <div class="mediaBd">
                                <h4 class="mbs">Note</h4>
                                <p><samp class="codeph nolang">URL</samp> accepts protocol
                                  string values starting with http://, https://, mailto:, tel:, and
                                  /.</p>
                              </div>
                            </div>
                          </div>
                        </div>
                      </div>
                      <div class="box message info">
                        <div class="inner">
                          <div class="bd">
                            <div class="media">
                              <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                              <div class="mediaBd">
                                <h4 class="mbs">Note</h4>
                                <p><samp class="codeph nolang">URL</samp> node types can’t
                                  be localized. Set <span class="keyword parmname">isLocalizable</span> to false for
                                  URLs.</p>
                              </div>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DATE</samp>
                    <p class="p">Date node </p>
                    <div class="p">
                      <div class="box message info">
                        <div class="inner">
                          <div class="bd">
                            <div class="media">
                              <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                              <div class="mediaBd">
                                <h4 class="mbs">Note</h4>
                                <p><samp class="codeph nolang">DATE</samp> accepts dates only in the
                                  format yyyy-MM-dd.</p>
                              </div>
                            </div>
                          </div>
                        </div>
                      </div>

                      <div class="box message info">
                        <div class="inner">
                          <div class="bd">
                            <div class="media">
                              <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                              <div class="mediaBd">
                                <h4 class="mbs">Note</h4>
                                <p><samp class="codeph nolang">DATE</samp> node types can’t be localized.
                                  Set <span class="keyword parmname">isLocalizable</span> to false for dates.</p>
                              </div>
                            </div>
                          </div>
                        </div>
                      </div>

                    </div>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DATETIME</samp>
                    <p class="p">Datetime node
                    </p>
                    <div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p><samp class="codeph nolang">DATETIME</samp> accepts date and
                                time in the format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (UTC datetime in ISO 8601
                                format).</p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                    <div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p><samp class="codeph nolang">DATETIME</samp> node types
                                can’t be localized. Set <span class="keyword parmname">isLocalizable</span> to false for
                                datetime notes.</p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NAMEFIELD</samp>
                    <div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p><samp class="codeph nolang">NAMEFIELD</samp> declares the field as the name that
                                represents the content when referenced in the UI. For example, text entered in
                                this field displays as a list of available content in the Digital Experiences
                                app or as a piece of content available for inclusion in a collection in an
                                Experience Cloud site.
                              </p><p class="p">One, and only one, <span class="keyword parmname">nodeType</span> in
                                your managed content type must be declared as <samp class="codeph nolang">NAMEFIELD</samp>. <samp class="codeph nolang">NAMEFIELD</samp> is a
                                string of 200 characters or fewer.</p>
                              <p class="p">In enhanced workspaces, the system
                                generates a Title field by default. To prevent having multiple Title fields
                                on the UI when you create a custom content type for use in an enhanced
                                workspace, don't use Title as the label for <span class="keyword parmname">nodeName</span> or
                                <span class="keyword parmname">nodeLabel</span> for the <samp class="codeph nolang">NAMEFIELD</samp> node. If you've already named
                                <span class="keyword parmname">nodeName</span> Title, choose a different label for
                                <span class="keyword parmname">nodeLabel</span> to prevent confusion on the content
                                creation page.
                              </p>
                              <p class="p">When <samp class="codeph nolang">NAMEFIELD</samp> is
                                used, <span class="keyword parmname"><a class="xref" href="#isrequired">isRequired</a></span> must also be set to
                                <samp class="codeph nolang">true</samp> for the field.
                              </p>
                              <p></p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d649737e227" data-title="Field Name"><span class="keyword parmname">placeholderText</span></td>

              <td class="entry" headers="d649737e230" data-title="Field Type">string</td>

              <td class="entry" headers="d649737e233" data-title="Description">Provides assistive text in the UI, displayed as placeholder, or ghost text, in
                a field before any entry is made. For example, <samp class="codeph nolang">Enter a
                  title for your article...</samp>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ManagedContentType component.

<?xml version="1.0" encoding="UTF-8"?>
<ManagedContentType xmlns="http://soap.sforce.com/2006/04/metadata">
  <developerName\>myContentType</developerName\>
	<masterLabel\>My Content Type</masterLabel\>
	<description\>This is the description for my content type</description\>
	<managedContentNodeTypes\>
		<nodeName\>title</nodeName\>
		<nodeLabel\>Content Title</nodeLabel\>
		<nodeType\>NAMEFIELD</nodeType\>
		<placeholderText\>Placeholder Text for title</placeholderText\>
		<helpText\>Help Text for title</helpText\>
		<isLocalizable\>true</isLocalizable\>
		<isRequired\>true</isRequired\>
	</managedContentNodeTypes\>
	<managedContentNodeTypes\>
		<nodeName\>textnode</nodeName\>
		<nodeLabel\>Content Text</nodeLabel\>
		<nodeType\>TEXT</nodeType\>
		<placeholderText\>Placeholder Text for Content Text</placeholderText\>
		<helpText\>Help Text for Content Text</helpText\>
		<isLocalizable\>true</isLocalizable\>
		<isRequired\>false</isRequired\>
	</managedContentNodeTypes\>
	<managedContentNodeTypes\>
		<nodeName\>richtextnode</nodeName\>
		<nodeLabel\>Content RichText</nodeLabel\>
		<nodeType\>RTE</nodeType\>

	</managedContentNodeTypes\>
	<managedContentNodeTypes\>
		<nodeName\>multilinetextnode</nodeName\>
		<nodeLabel\>Content MultilineText</nodeLabel\>
		<nodeType\>MTEXT</nodeType\>
	</managedContentNodeTypes\>
	<managedContentNodeTypes\>
		<nodeName\>imagenode</nodeName\>
		<nodeLabel\>Content Image</nodeLabel\>
		<nodeType\>IMG</nodeType\>

	</managedContentNodeTypes\>
</ManagedContentType\>

## Usage

For each custom content type you create, there must also be a CMS Content page created in any Experience Cloud site that displays the content. Each Content page serves as the detail page for all content of a single content type. See [Create Custom Pages with Experience Builder](https://help.salesforce.com/articleView?id=community_builder_create_page.htm&type=0&language=en_US).

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=aea80a4a20355831000841b226faf76e4c625575f8a9b7753dbaa919d2b691d3 url=/legacydeveloper/current/en-us/api_meta/meta_managedeventsubscription.md -->

# ManagedEventSubscription (Beta)

Represents a managed event subscription in Pub/Sub API. Use a managed event subscription to track the events that a subscriber client consumed and resume a subscription where it left off. This type extends the metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

## File Suffix and Directory Location

ManagedEventSubscription components have the suffix .managedEventSubscription and are stored in the managedEventSubscriptions folder.

## Version

ManagedEventSubscription components are available in API version 60.0 and later.

## Special Access Rules

You must have the Customize Application permission to deploy and retrieve this type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d651254e100">Field Name</th>

              <th class="featureTableHeader  " id="d651254e103">Field Type</th>

              <th class="featureTableHeader  " id="d651254e106">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d651254e100" data-title="Field Name"><span class="keyword parmname">defaultReplay</span></td>

              <td class="entry" headers="d651254e103" data-title="Field Type">EventSubscriptionReplayPreset (enumeration of type
                string)</td>

              <td class="entry" headers="d651254e106" data-title="Description">The position in the stream where the subscription starts when the
                client initiates the subscription for the first time or if the
                client doesn’t commit a Replay ID. Possible values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">LATEST</samp>—(Default)
                    The subscription starts from the latest events received.
                    This option skips sending events that were published when
                    the client was disconnected.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EARLIEST</samp>—The
                    subscription starts from the earliest events stored in the
                    event bus. This option sends new events and any other events
                    less than 72 hours old. You can reprocess all stored events
                    and catch up on missed events. Use this option sparingly.
                    Subscribing with the <samp class="codeph nolang">EARLIEST</samp> option when a large number of event
                    messages are stored can slow performance and exhaust the
                    event delivery allocation.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d651254e100" data-title="Field Name"><span class="keyword parmname">errorRecoveryReplay</span></td>

              <td class="entry" headers="d651254e103" data-title="Field Type">EventSubscriptionReplayPreset (enumeration of type
                string)</td>

              <td class="entry" headers="d651254e106" data-title="Description">The position in the stream where the subscription restarts if the
                committed Replay ID is invalid. The Replay ID can be invalid if it’s
                older than the event retention window. Possible values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">LATEST</samp>—(Default)
                    The subscription restarts from the latest events received.
                    This option skips sending events that were published when
                    the client was disconnected.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EARLIEST</samp>—The
                    subscription restarts from the earliest events stored in the
                    event bus. This option sends new events and any other events
                    less than 72 hours old. You can reprocess all stored events
                    and catch up on missed events. Use this option sparingly.
                    Subscribing with the <samp class="codeph nolang">EARLIEST</samp> option when a large number of event
                    messages are stored can slow performance and exhaust the
                    event delivery allocation.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d651254e100" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d651254e103" data-title="Field Type">string</td>

              <td class="entry" headers="d651254e106" data-title="Description">The label for the managed subscription.</td>

            </tr>

            <tr>
              <td class="entry" headers="d651254e100" data-title="Field Name"><span class="keyword parmname">state</span></td>

              <td class="entry" headers="d651254e103" data-title="Field Type">EventSubscriptionAdminState (enumeration of type string)</td>

              <td class="entry" headers="d651254e106" data-title="Description">The execution state that the <samp class="codeph nolang">ManagedSubscribe</samp> RPC call consumes. If
                <span class="keyword parmname">state</span> is set to <samp class="codeph nolang">RUN</samp>, the subscription starts when the <samp class="codeph nolang">ManagedSubscribe</samp> RPC call is made.
                Otherwise, the subscription doesn't start. If an administrator later
                changes <span class="keyword parmname">state</span> from <samp class="codeph nolang">RUN</samp> to <samp class="codeph nolang">STOP</samp>, the
                system notifies the Pub/Sub API client of the new
                <span class="keyword parmname">state</span> value and the subscription
                disconnects. Also, the stored Replay ID value that was committed
                previously is deleted. The next time the <samp class="codeph nolang">ManagedSubscribe</samp> RPC call is made after
                <span class="keyword parmname">state</span> is changed from <samp class="codeph nolang">STOP</samp> to <samp class="codeph nolang">RUN</samp>, the subscription starts from the
                <span class="keyword parmname">defaultReplay</span> value. You must wait at least
                5 minutes after changing the <span class="keyword parmname">state</span> to
                <samp class="codeph nolang">STOP</samp> before changing it back to
                <samp class="codeph nolang">RUN</samp>.
                <p class="p">The possible values
                  for <span class="keyword parmname">state</span> are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">RUN</samp>—(Default)
                    The subscription is running and delivering new events to the
                    Pub/Sub API client.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">STOP</samp>—The
                    subscription is stopped. No events are delivered to the
                    Pub/Sub API client during this state and the previously
                    committed Replay ID is deleted.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PAUSE</samp>—Reserved
                    for internal use.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d651254e100" data-title="Field Name"><span class="keyword parmname">topicName</span></td>

              <td class="entry" headers="d651254e103" data-title="Field Type">string</td>

              <td class="entry" headers="d651254e106" data-title="Description">The topic name of the platform event or change event or the
                channel name of a custom platform event channel or custom or
                standard change data capture channel. The topic name can be one of
                the following values.<ul class="ul bulletList">
                  <li class="li">For a platform event—<samp class="codeph nolang">/event/EventName__e</samp>
                  </li>

                  <li class="li">For a custom platform event channel—<samp class="codeph nolang">/event/CustomPEChannel__chn</samp>
                  </li>

                  <li class="li">For the standard change event channel—<samp class="codeph nolang">/data/ChangeEvents</samp>
                  </li>

                  <li class="li">For a change event (replace <samp class="codeph nolang">Object</samp> with the object name)—<samp class="codeph nolang">/data/ObjectChangeEvent</samp>.
                    For example, for Account, it’s <samp class="codeph nolang">/data/AccountChangeEvent</samp>.</li>

                  <li class="li">For a custom change event channel—<samp class="codeph nolang">/data/CustomChangeChannel__chn</samp>
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d651254e100" data-title="Field Name"><span class="keyword parmname">version</span></td>

              <td class="entry" headers="d651254e103" data-title="Field Type">string</td>

              <td class="entry" headers="d651254e106" data-title="Description">Reserved for internal use.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ManagedEventSubscription component with the file name My\_Managed\_Subscription.managedSubscription.

<?xml version="1.0" encoding="UTF-8"?>
<ManagedEventSubscription xmlns="http://soap.sforce.com/2006/04/metadata">
    <defaultReplay\>LATEST</defaultReplay\>
    <errorRecoveryReplay\>LATEST</errorRecoveryReplay\>
    <label\>My Managed Subscription</label\>
    <state\>RUN</state\>
    <topicName\>/event/Order\_Event\_\_e</topicName\>
</ManagedEventSubscription\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>My\_Managed\_Subscription</members\>
        <name\>ManagedEventSubscription</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=2a5b21414ee5ab41e7c46abf497a535a132674f4d997aa8260d7bf38e2032267 url=/legacydeveloper/current/en-us/api_meta/meta_managedtopics.md -->

# ManagedTopics

Represents navigational and featured topics managed in an Experience Cloud site.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The related Experience Cloud site must exist before you deploy managed topics. (This occurs automatically when deploying an entire org.)

## File Suffix and Directory Location

Components have the suffix managedTopics and are stored in the managedTopics folder. In that folder, you find separate files for each Experience Cloud site (for example, SiteNameA.managedTopics and SiteNameB.managedTopics).

## Version

ManagedTopics components are available in API version 32.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| ManagedTopic | [ManagedTopic](#ManagedTopic_title) | Represents a specific navigational or featured topic. |

## ManagedTopic

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d652124e140">Field Name</th>

              <th class="featureTableHeader  " id="d652124e143">Field Type</th>

              <th class="featureTableHeader  " id="d652124e146">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d652124e140" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d652124e143" data-title="Field Type">string</td>

              <td class="entry" headers="d652124e146" data-title="Description">The topic name.</td>

            </tr>

            <tr>
              <td class="entry" headers="d652124e140" data-title="Field Name"><span class="keyword parmname">managedTopicType</span></td>

              <td class="entry" headers="d652124e143" data-title="Field Type">string</td>

              <td class="entry" headers="d652124e146" data-title="Description">The topic type: “Navigational” or “Featured”</td>

            </tr>

            <tr>
              <td class="entry" headers="d652124e140" data-title="Field Name"><span class="keyword parmname">topicDescription</span></td>

              <td class="entry" headers="d652124e143" data-title="Field Type">string</td>

              <td class="entry" headers="d652124e146" data-title="Description">An optional description of topic contents. This field is
                accessible only via the API; there is no corollary in the user
                interface. </td>

            </tr>

            <tr>
              <td class="entry" headers="d652124e140" data-title="Field Name"><span class="keyword parmname" id="parentName_field"><a name="parentName_field"><!-- --></a>parentName</span></td>

              <td class="entry" headers="d652124e143" data-title="Field Type">string</td>

              <td class="entry" headers="d652124e146" data-title="Description">
                <span class="ph" id="parentName_desc1"><a name="parentName_desc1"><!-- --></a>The name of a parent topic for which
                  this topic is a child. Child topics are accessible from the
                  subtopics section of the parent topic page and their feeds are
                  added to the parent topic feed.</span>
                <p class="p"><span class="ph" id="parentName_desc2"><a name="parentName_desc2"><!-- --></a>Only navigational topics support parent-child
                    relationships.</span></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d652124e140" data-title="Field Name"><span class="keyword parmname">position</span></td>

              <td class="entry" headers="d652124e143" data-title="Field Type">int</td>

              <td class="entry" headers="d652124e146" data-title="Description">The placement of this topic relative to others of the same type.
                The results differ depending on topic type:<ul class="ul bulletList">
                  <li class="li">For top-level navigational topics,
                    <span class="keyword parmname">position</span> arranges the Topics menu
                    in the Experience Cloud site.
                  </li>

                  <li class="li">For child navigational topics, it arranges sibling topics in
                    the subtopics section.</li>

                  <li class="li">For featured topics, it arranges topic thumbnail images on
                    the Experience Cloud site home page.</li>

                </ul>
                <p class="p">Enter a number between 0 and 24. (The maximum amount of
                  navigational or featured topics is 25.)</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following example retrieves or deploys managed topics for all sites:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ManagedTopics</name\>
    </types\>
    <version\>32.0</version\>
</Package\>

The following example shows a package.xml file referencing the ManagedTopics component:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>SiteName</members\>
        <name\>ManagedTopics</name\>
    </types\>
    <version\>32.0</version\>
</Package\>

The following example shows the ManagedTopics component itself:

<?xml version="1.0" encoding="UTF-8"?>
<ManagedTopics\>
    <ManagedTopic\>
        <name\>Running</name\>
        <managedTopicType\>Navigational</managedTopicType\>
        <topicDescription\>Training advice</topicDescription\>
        <parentName\></parentName\>
        <position\>0</position\>
    </ManagedTopic\>
    <ManagedTopic\>
        <name\>Hiking</name\>
        <managedTopicType\>Navigational</managedTopicType\>
        <topicDescription\>Routes and gear</topicDescription\>
        <parentName\></parentName\>
        <position\>1</position\>
    </ManagedTopic\>
        <ManagedTopic\>
            <name\>Trails</name\>
            <managedTopicType\>Navigational</managedTopicType\>
            <topicDescription\>Maps for local favorites</topicDescription\>
            <parentName\>Hiking</parentName\>
            <position\>0</position\>
        </ManagedTopic\>
        <ManagedTopic\>
            <name\>Backpacks</name\>
            <managedTopicType\>Navigational</managedTopicType\>
            <topicDescription\>Recommended models</topicDescription\>
            <parentName\>Hiking</parentName\>
            <position\>1</position\>
        </ManagedTopic\>
    <ManagedTopic\>
        <name\>Footwear</name\>
        <managedTopicType\>Featured</managedTopicType\>
        <topicDescription\>Suggested types for each sport</topicDescription\>
        <parentName\></parentName\>
        <position\>0</position\>
    </ManagedTopic\>
    <ManagedTopic\>
        <name\>Conditioning</name\>
        <managedTopicType\>Featured</managedTopicType\>
        <topicDescription\>How to get fit for any activity</topicDescription\>
        <parentName\></parentName\>
        <position\>1</position\>
    </ManagedTopic\>
</ManagedTopics\>

## Usage

Managed topic images that are uploaded in API version 50.0 and later are stored as asset files. To migrate managed topic images that are uploaded in API version 50.0 and later, use the ContentAsset metadata type. To migrate managed topic images that were uploaded in API version 49.0 and earlier, use the Document metadata type.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ac5ff9126a52573328429ec4bef1485e0b2ddb50487b25a7415d4729b1b9a66e url=/legacydeveloper/current/en-us/api_meta/meta_mapandlocationsettings.md -->

# MapAndLocationSettings

Represents an org’s map and location settings.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## Declarative Metadata File Suffix and Directory Location

MapAndLocationSettings values are stored in a single file named Mapandlocation.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

Map and location settings are available in API version 46.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| enableAddressAutoComplete | boolean | Indicates whether auto-complete is enabled on address fields (true) or not (false). |
| enableMapsAndLocation | boolean | Indicates whether the maps and location services are enabled (true) or not (false) |

## Declarative Metadata Sample Definition

This is a sample mapandlocation.settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>
<MapsAndLocationSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAddressAutoComplete\>false</enableAddressAutoComplete\>
    <enableMapsAndLocation\>false</enableMapsAndLocation\>
</MapsAndLocationSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=79c19cf6e2987f471bece926adfdcd2deaf3464ab8362d810c02bf8a263c95c6 url=/legacydeveloper/current/en-us/api_meta/meta_marketingappextension.md -->

# MarketingAppExtension

Represents an integration with a third-party app or service that is used to work with prospects.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") type and inherits its fullName field.

## File Suffix and Directory Location

MarketingAppExtension components have the suffix .marketingappextension and are stored in the marketingappextensions folder.

## Version

MarketingAppExtension components are available in API version 54.0 and later.

## Special Access Rules

The first Salesforce or designated marketing admin to access Marketing App Extensions in an org must have the Manage Public List Views user permission. Subsequent users don’t need the permission to work with the feature.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The description of the extension for internal reference. Appears in the UI.



 |
| isActive | 

Field Type

boolean

Description

This field makes data for a Marketing App Extension available to use in Account Engagement automations. Label is Active in Automations.

The default value is false. Appears in the UI.



 |
| isProtected | 

Field Type

boolean



 |
| marketingAppExtActions | 

Field Type

[MarketingAppExtAction](#subtype_MarketingAppExtAction)\[\]

Description

This field is a related list of associated external actions.



 |
| marketingAppExtActivities | 

Field Type

[MarketingAppExtActivity](#subtype_MarketingAppExtActivity)\[\]

Description

This field is a related list of associated external prospect activities.



 |
| masterLabel | 

Field Type

string

Description

Required. Label for the MarketingAppExtension. In the UI, this field is Extension Name.





 |

## MarketingAppExtActivity

Represents an Activity Type, which is a prospect activity that occurs in a third-party app and can be used in Account Engagement automations.

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The description of the activity for internal reference. Appears in the UI.



 |
| endpointUrl | 

Field Type

string

Description

A sample endpoint that can be used to help connect the activity type to a third-party app. Appears in the UI.



 |
| isActive | 

Field Type

boolean

Description

This field makes data for the Activity Type available to use in Account Engagement automations. Label is Active in Automations.

The default value is false. Appears in the UI.



 |
| isProtected | 

Field Type

boolean



 |
| marketingAppExtension | 

Field Type

string

Description

Required. The Marketing App Extension associated with the activity.



 |
| masterLabel | 

Type

string

Description

Required. Label for the MarketingAppExtActivity. In the UI, this field is Activity Name.



 |

## Declarative Metadata Sample Definition

This example retrieves all Activity Types associated with the MarketingAppExtension component.

<?xml version="1.0" encoding="UTF-8"?>
<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>VidLand extension for US region</description\>
    <isActive\>true</isActive\>
    <marketingAppExtActivities\>
        <fullName\>user\_attended</fullName\>
        <description\>User attended activity capture for VidLand</description\>
        <isActive\>true</isActive\>
        <marketingAppExtension\>VidLand\_US</marketingAppExtension\>
        <masterLabel\>user attended</masterLabel\>
    </marketingAppExtActivities\>
    <marketingAppExtActivities\>
        <fullName\>user\_registered</fullName\>
        <description\>User registered activity capture for VidLand</description\>
        <isActive\>true</isActive\>
        <marketingAppExtension\>VidLand\_US</marketingAppExtension\>
        <masterLabel\>user registered</masterLabel\>
    </marketingAppExtActivities\>
    <masterLabel\>VidLand\_US</masterLabel\>
</MarketingAppExtension\>

This example package.xml references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2021 Salesforce, Inc.
~ All Rights Reserved
~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>VidLand\_US</members\>
<name\>MarketingAppExtension</name\>
</types\>
</Package\>

This example retrieves a specific Activity Type from the associated MarketingAppExtension component.

<?xml version="1.0" encoding="UTF-8"?>
<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>VidLand extension for US region</description\>
    <isActive\>true</isActive\>
    <marketingAppExtActivities\>
        <fullName\>user\_attended</fullName\>
        <description\>User attended activity capture for VidLand</description\>
        <isActive\>true</isActive\>
        <marketingAppExtension\>VidLand\_US</marketingAppExtension\>
        <masterLabel\>user attended</masterLabel\>
    </marketingAppExtActivities\>
    <masterLabel\>VidLand\_US</masterLabel\>
</MarketingAppExtension\>

This example package.xml references the previous definition.

<<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2021 salesforce.com, inc.
~ All Rights Reserved
~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>VidLand\_US.user\_attended</members\>
<name\>MarketingAppExtActivity</name\>
</types\>
<types\>
<members\>VidLand\_US</members\>
<name\>MarketingAppExtension</name\>
</types\>
</Package\>

## MarketingAppExtAction

Represents an Action Type, which is an action that executes in a third-party app and can be used in Engagement Studio programs.

| Field Name | Description |
| --- | --- |
| actionName | 
Field Type

string

Description

The name of the action for internal use. Appears in the UI.



 |
| actionParams | 

Field Type

string

Description

The parameters for the invocable action. Appears in the UI.



 |
| actionSchema | 

Field Type

string

Description

The JSON schema for the invocable action. Appears in the UI.



 |
| actionSelector | 

Type

string

Description

Invocable action selector. Appears in the UI.



 |
| apiName | 

Field Type

string

Description

This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API. Appears in the UI.



 |
| Description | 

Field Type

string

Description

The description of the action for internal reference. Appears in the UI.



 |
| isActive | 

Field Type

boolean

Description

This field makes data for the Action Type available to use in Engagement Studio Label is Active in Automations.

The default value is false. Appears in the UI.



 |
| marketingAppExtension | 

Field Type

string

Description

Required. The Marketing App Extension associated with the action.



 |

## Declarative Metadata Sample Definition

This example retrieves a specific action associated the MarketingAppExtension component.

<?xml version="1.0" encoding="UTF-8"?>
<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>VidLand\_US</fullName\>
    <description\>VidLand extension for US region</description\>
    <isActive\>true</isActive\>
    <marketingAppExtActions\>
        <marketingAppExtension\>VidLand\_US</marketingAppExtension\>
        <apiName\>register\_user</apiName\>
        <isActive\>true</isActive\>
        <description\>Register User for VidLand</description\>>
        <actionSelector\>VidLand\_Register\_User</actionSelector\>
        <actionSchema\>
			<!\[CDATA\[
   				{
	"properties": {
	  "UserId": {
		"type": "string",
		"title": ""
	  },
	  "WebinarId": {
		"type": "string",
		"value": "webinarIdXYZ"
	  }
	},
	"view": {
	  "components": \[{
		"definition": "lightning/control",
		"scope": "#/properties/UserId"
	  }\]
	},
	"required": \[
	  "UserId",
	  "WebinarId",
	  "From",
	  "Body"
	\]
  }
			\]\]>
        </actionSchema\>
        <actionParams\>
        <!\[CDATA\[
   				{
	"isStandard": false,
    "type": "apex"
  }
			\]\]>
        </actionParams\>
        <actionName\>Register User</actionName\>
    </marketingAppExtActions\>
    <masterLabel\>VidLand US</masterLabel\>
</MarketingAppExtension\>

This example package.xml references the previous definition.

<<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2021 salesforce.com, inc.
~ All Rights Reserved
~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>VidLand\_US</members\>
<name\>MarketingAppExtension</name\>
</types\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=fedb763ba32defb9d852282eb0c44602e85715ed4ad971978fcd4fd9b13cc193 url=/legacydeveloper/current/en-us/api_meta/meta_marketingobject.md -->

# MarketingObject

A marketing object is a high-volume, low-latency custom object that stores data for personalizing content in your marketing campaigns. A marketing object supports a subset of CustomObject fields and uses the \_\_mo suffix instead of \_\_c.

## Declarative Metadata File Suffix and Directory Location

Marketing objects are defined as part of the custom object definition. See [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.") for more information.

## Version

MarketingObject components are available in API version 68.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. A label that represents the object throughout the Salesforce user interface. |
| description | string | A description of the object. Maximum of 1,000 characters. |
| fields | CustomField\[\] | Represents one or more fields on the marketing object. See [CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm "Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects."). |
| marketingObjectIndexes | MarketingObjectIndex\[\] | Defines one or more indexes on the marketing object. |

Marketing objects don't support other CustomObject fields.

## Declarative Metadata Sample Definition

The following is a sample XML definition of a lead business process.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
....
    <label\>Campaign Interaction</label\>
      <description\>Stores high-volume campaign interaction records.</description\>
      <fields\>
          <fullName\>CampaignId\_\_c</fullName\>
          <label\>Campaign Id</label\>
          <type\>Text</type\>
          <length\>18</length\>
          <required\>true</required\>
      </fields\>
      <fields\>
          <fullName\>InteractionType\_\_c</fullName\>
          <label\>Interaction Type</label\>
          <type\>Text</type\>
          <length\>40</length\>
      </fields\>
      <marketingObjectIndexes\>
          <fields\>
              <name\>CampaignId\_\_c</name\>
              <ordinal\>1</ordinal\>
              <sortDirection\>ASC</sortDirection\>
          </fields\>
          <label\>Primary Key</label\>
          <isUnique\>true</isUnique\>
          <isPrimary\>true</isPrimary\>
      </marketingObjectIndexes\>
....
</CustomObject\>

## MarketingObjectIndex

Represents an index defined on a marketing object. Referenced from the marketingObjectIndexes field of CustomObject.

Unlike [Index](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_index.htm "Represents an index defined within a custom big object. Use this metadata type to define the composite primary key (index) for a custom big object. This type extends the Metadata metadata type and inherits its fullName field."), which is its own Metadata component with a unique fullName, MarketingObjectIndex is a value type that's always defined inline within the marketing object's CustomObject definition. An index doesn't have a fullName. Its only identifier is label.

| Field | Field Type | Description |
| --- | --- | --- |
| fields | MarketingObjectIndexField\[\] | The ordered list of fields that make up the index. |
| isPrimary | boolean | Required. Specifies whether this index is the primary key index for the marketing object. Every marketing object must define exactly one index with isPrimary set to true. |
| isUnique | boolean | Required. If true, the fields in the index must be unique. |
| label | string | Required. A label that identifies the index. This is the only identifier for a MarketingObjectIndex—it doesn't have a fullName. |

Usage notes:

- A marketing object supports a maximum of 10 indexes, and each index supports a maximum of 5 fields. (Both limits are org-configurable defaults.)
- A marketing object must define exactly one index with isPrimary set to true. If the org requires it, every field referenced by the primary-key index must also be marked required on the marketing object.

## MarketingObjectIndex

Represents a single field participating in a MarketingObjectIndex.

| Field | Field Type | Description |
| --- | --- | --- |
| name | string | Required. The API name of the CustomField being indexed. |
| ordinal | int | Required. The position of this field within the index. The first field has a value of 1. |
| sortDirection | string | The sort order for this field within the index. Valid values are ASC and DESC. |

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listview.htm "ListView")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/namedfilter.htm "NamedFilter")

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")
- [CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm "Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.")

<!-- document id=1309d5fe21a226ca093873a632a1c7c84c2fca78d4bb8ad17e836951299bc304 url=/legacydeveloper/current/en-us/api_meta/meta_marketsegmentdefinition.md -->

# MarketSegmentDefinition

Represents the field values for MarketSegmentDefinition. MarketSegmentDefinition is used to store the exportable metadata of a segment, such as segment criteria and other attributes. Developers can create segment definition packages, pass segment definition in the form of data build tool (DBT), and publish it on AppExchange for subscriber organizations to install and instantiate these segments.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") type and inherits its fullName field.

## File Suffix and Directory Location

MarketSegmentDefinition components have the suffix .marketSegmentDefinition and are stored in the marketSegmentDefinitions folder.

## Version

MarketSegmentDefinition components are available in API version 55.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| additionalMetadata | 
Field Type

string

Description

An XML CLOB to hold name-value pairs for storing additional metadata. Not applicable for DBT type segment.



 |
| excludeCriteria | 

Field Type

string

Description

Holds the JSON exclude criteria for UI based segments. Not applicable for DBT or Lookalike segments.



 |
| includeCriteria | 

Field Type

string

Description

An XML wrapped in a CDATA section that captures DBT definition. Only single model DBT is supported.



 |
| masterLabel | 

Field Type

string

Description

Required. Specifies the display name of the field value.





 |
| segmentOn | 

Field Type

string

Description

Required when segmentType is UI. Points to relevant MktDataModelObject entity instance. A valid developerName for an MktDataModelObject instance of Profile type.



 |
| segmentType | 

Field Type

MarketSegmentType (enumeration of type string)

Description

Required. Specifies the type of the segment to be created. Only DBT is supported via API.

Values are:

- DBT
- Dynamic
- Lookalike
- UI
- EinsteinGPTSegmentsUI





 |

## Declarative Metadata Sample Definition

The following is an example of a MarketSegmentDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<MarketSegmentDefinition\>
    <segmentType\>DBT</segmentType\>
    <includeCriteria\>
    <!\[CDATA\[
        <DbtPipeline\>
            <models\>
                <model\>
                    <name\>m1</name\>
                    <sql\>select ssot\_\_Individual\_\_dlm.ssot\_\_Id\_\_c from ssot\_\_Individual\_\_dlm</sql\>
                </model\>
            </models\>
        </DbtPipeline\>
        \]\]>
    </includeCriteria\>
    <masterLabel\>msd2\_simple</masterLabel\>
</MarketSegmentDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:Package xmlns:ns2="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>MarketSegmentDefinition</name\>
    </types\>
    <version\>55.0</version\>
</ns2: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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b9dcf2f3757f44d983886665d8952c6d44c0efb3fe2851e290cd15722ab04bc9 url=/legacydeveloper/current/en-us/api_meta/meta_matchingrule.md -->

# MatchingRule

Represents a matching rule that is used to identify duplicate records.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

Matching rule components have the .matchingRule suffix and are stored in the matchingRules folder. The name of the component file is the standard or custom object name that is associated with the matching rule.

In API version 39.0 and later, MatchingRule supports the Person Account object.

- The component file name is PersonAccount.matchingRule.
- The component directory is matchingRules.

## Version

MatchingRule is available in API version 33.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d656744e114">Field Name</th>

              <th class="featureTableHeader  " id="d656744e117">Field Type</th>

              <th class="featureTableHeader  " id="d656744e120">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d656744e114" data-title="Field Name"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d656744e117" data-title="Field Type">string</td>

              <td class="entry" headers="d656744e120" data-title="Description">Specifies filter logic conditions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d656744e114" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d656744e117" data-title="Field Type">string</td>

              <td class="entry" headers="d656744e120" data-title="Description">The description of the matching rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d656744e114" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d656744e117" data-title="Field Type">string</td>

              <td class="entry" headers="d656744e120" data-title="Description">Required. The name of the matching rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d656744e114" data-title="Field Name"><span class="keyword parmname">matchingRuleItems</span></td>

              <td class="entry" headers="d656744e117" data-title="Field Type"><a class="xref" href="#MatchingRuleItem">MatchingRuleItem</a></td>

              <td class="entry" headers="d656744e120" data-title="Description">The criteria that make up a matching rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d656744e114" data-title="Field Name"><span class="keyword parmname">ruleStatus</span></td>

              <td class="entry" headers="d656744e117" data-title="Field Type">MatchingRuleStatus (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d656744e120" data-title="Description">Required. The activation status of the matching rule. Values are:<ul class="ul bulletList">
                  <li class="li"><kbd class="ph userinput">Inactive</kbd></li>

                  <li class="li"><kbd class="ph userinput">Deactivating</kbd></li>

                  <li class="li"><kbd class="ph userinput">DeactivationFailed</kbd></li>

                  <li class="li"><kbd class="ph userinput">Active</kbd></li>

                  <li class="li"><kbd class="ph userinput">Activating</kbd></li>

                  <li class="li"><kbd class="ph userinput">ActivationFailed</kbd></li>

                </ul>
                <div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                        <div class="mediaBd">
                          <h4 class="mbs">Important</h4>
                          <p>The only valid values you can declare when deploying a package
                            are <kbd class="ph userinput">Active </kbd> and <kbd class="ph userinput"> Inactive</kbd>.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## MatchingRuleItem

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d656744e258">Field Name</th>

              <th class="featureTableHeader  " id="d656744e261">Field Type</th>

              <th class="featureTableHeader  " id="d656744e264">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d656744e258" data-title="Field Name"><span class="keyword parmname">blankValueBehavior</span></td>

              <td class="entry" headers="d656744e261" data-title="Field Type">BlankValueBehavior (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d656744e264" data-title="Description">Specifies how blank fields affect whether the fields being compared are considered
                matches. Valid values are: <ul class="ul bulletList">
                  <li class="li"><kbd class="ph userinput">MatchBlanks</kbd></li>

                  <li class="li">
                    <kbd class="ph userinput">NullNotAllowed</kbd> (default)
                  </li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d656744e258" data-title="Field Name"><span class="keyword parmname">fieldName</span></td>

              <td class="entry" headers="d656744e261" data-title="Field Type">string</td>

              <td class="entry" headers="d656744e264" data-title="Description">Required. Indicates which field to compare when determining if a record is similar
                enough to an existing record to be considered a match.</td>

            </tr>

            <tr>
              <td class="entry" headers="d656744e258" data-title="Field Name"><span class="keyword parmname">matchingMethod</span></td>

              <td class="entry" headers="d656744e261" data-title="Field Type">MatchingMethod (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d656744e264" data-title="Description">Required. Defines how the fields are compared. Choose between the exact matching
                method and various fuzzy matching methods. Valid values are:<ul class="ul bulletList">
                  <li class="li"><kbd class="ph userinput">Exact</kbd></li>

                  <li class="li"><kbd class="ph userinput">FirstName</kbd></li>

                  <li class="li"><kbd class="ph userinput">LastName</kbd></li>

                  <li class="li"><kbd class="ph userinput">CompanyName</kbd></li>

                  <li class="li"><kbd class="ph userinput">Phone</kbd></li>

                  <li class="li"><kbd class="ph userinput">City</kbd></li>

                  <li class="li"><kbd class="ph userinput">Street</kbd></li>

                  <li class="li"><kbd class="ph userinput">Zip</kbd></li>

                  <li class="li"><kbd class="ph userinput">Title</kbd></li>

                </ul>
                For details on each matching method, see “Matching Methods Used with Matching Rules” in
                the Salesforce Help.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is a sample XML definition of a matching rule. A matching rule can be associated with either a standard or a custom object.

<?xml version="1.0" encoding="UTF-8"?>
<MatchingRules xmlns="http://soap.sforce.com/2006/04/metadata">
<matchingRules\>
<fullName\>AccountMatchingRule</fullName\>
<label\>Matching rule for accounts</label\>
<description\>this is sample rule description</description\>
<matchingRuleItems\>
<blankValueBehavior\>NullNotAllowed</blankValueBehavior\>
<fieldName\>BillingCity</fieldName\>
<matchingMethod\>City</matchingMethod\>
</matchingRuleItems\>

<matchingRuleItems\>
<blankValueBehavior\>NullNotAllowed</blankValueBehavior\>
<fieldName\>Name</fieldName\>
<matchingMethod\>CompanyName</matchingMethod\>
</matchingRuleItems\>

<ruleStatus\>Inactive</ruleStatus\>
</matchingRules\>
</MatchingRules\>

The following package.xml shows how to reference a matching rule by name. It specifies the type name of MatchingRule.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>Account.AccountMatchingRule</members\>
<name\>MatchingRule</name\>
</types\>
<version\>68.0</version\>
</Package\>

The following package.xml shows how to reference all matching rules by specifying the plural MatchingRules type name and using a wildcard to include all members.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>\*</members\>
<name\>MatchingRules</name\>
</types\>
<version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=fd33f8cd0299d403ca46db79d0a55c8ecc2068a9a59b527b38e6a6fea5bf1dba url=/legacydeveloper/current/en-us/api_meta/meta_mcetransformationssettings.md -->

# MCETransformationsSettings

Controls Flow Builder's integration with Marketing Cloud Engagement (MCE), including sending contacts to MCE emails and journeys. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

MCETransformationsSettings values are stored in the MCETransformations.settings file in the settings folder. The .settings files are different from other named components because there's only one settings file for each settings component.

## Version

MCETransformationsSettings is available in API version 68.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableMceTransformations | boolean | Enables Flow Builder access to Marketing Cloud Engagement (MCE) sending capabilities for the org. This field must be enabled before the other MCETransformationsSettings fields take effect. |
| enableMcetContactKeyOverride | boolean | Allows flows to override the ContactKey field when sending a contact to a Marketing Cloud Journey via the Send to Journey action. Requires enableMceTransformations to be enabled. |
| enableMcetSendToEmail | boolean | Allows flows to send contacts to Marketing Cloud Emails via the Send to MCE Email action. Requires enableMceTransformations to be enabled. |
| enableMcetTriggerJourney | boolean | Allows flows to send contacts to Marketing Cloud Journeys via the Send to Journey action. Requires enableMceTransformations to be enabled. |

## Declarative Metadata Sample Definition

The following is an example of the MCETransformations.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<MCETransformationsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableMceTransformations\>true</enableMceTransformations\>
	<enableMcetContactKeyOverride\>true</enableMcetContactKeyOverride\>
	<enableMcetSendToEmail\>true</enableMcetSendToEmail\>
	<enableMcetTriggerJourney\>true</enableMcetTriggerJourney\>
</MCETransformationsSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the MCETransformations settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>MCETransformations</members\>
		<name\>Settings</name\>
	</types\>
	<version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a7b8714e27ff7db3e94874c6b7103f11ee2eeca4ba82555f82b45cec2834ee47 url=/legacydeveloper/current/en-us/api_meta/meta_meetingssettings.md -->

# MeetingsSettings

Represents the settings to enable Salesforce Meetings and the integration with Zoom video conferencing.

## Version

MeetingsSettings components are available in API version 51.0 and later.

## Special Access Rules

The MeetingsSettings type isn’t available in scratch orgs.

## Fields

| Field Name | Description |
| --- | --- |
| enableSalesforceMeetings | 
Field Type

boolean

Description

Indicates whether the Salesforce Meetings feature is enabled (true) or not (false). When set to true, Salesforce admins can assign the Salesforce Meetings user permission to grant users access to the Meeting Digest and other Salesforce Meetings features. The default value is false.



 |
| enableSalesforceMeetingsSyncCheck | 

Field Type

boolean

Description

Indicates whether your company uses an activity sync solution (true) or hasn’t made that indication (false). Indicating your company uses an activity solution such as Einstein Activity Capture is required to enable Salesforce Meetings. The default value is false.



 |
| enableZoomVideoConference | 

Field Type

boolean

Description

Indicates whether users can connect their company Zoom accounts to Salesforce (true) or not (false). When set to true, Zoom can be added as a recording in Einstein Conversation Insights. The default value is false.



 |

## Declarative Metadata Sample Definition

The following is an example of a MeetingsSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<MeetingsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
        <enableSalesforceMeetings\>true</enableSalesforceMeetings\>
        <enableSalesforceMeetingsSyncCheck\>true</enableSalesforceMeetingsSyncCheck\>
        <enableZoomVideoConference\>false</enableZoomVideoConference\>
</MeetingsSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MeetingsSettings</members\>
        <name\>Settings</name\>
    </types\>
    <version\>51.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=1f414d96b0d1c2d08d1543e937be614471ff5c710562970fccfaec48f688dd05 url=/legacydeveloper/current/en-us/api_meta/meta_messagingchannel.md -->

# MessagingChannel

Represents the metadata associated with an Embedded Service Messaging channel.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

MessagingChannel components have the suffix messagingChannel and are stored in the messagingChannels folder.

## Version

MessagingChannel components are available in API version 55.0 and later.

## Special Access Rules

This type is available if your org has the “Configure Messaging” and “View Setup and Configuration” permissions for Messaging enabled.

## Fields

| Field Name | Description |
| --- | --- |
| automatedResponses | 
Field Type

[MessagingAutoResponse\[\]](#MessagingAutoResponse)

Description

The auto-responses associated with the messaging channel.



 |
| channelUsages | 

Field Type

[MessagingChannelUsage\[\]](#MessagingChannelUsage)

Description

The deployment types and consent configuration for the messaging channel. Available in API version 62.0 and later.



 |
| countryCode | 

Field Type

string

Description

The ISO country code for the messaging channel. Available in API version 62.0 and later.



 |
| customParameters | 

Field Type

[MessagingChannelCustomParameter\[\]](#MessagingChannelCustomParameter)

Description

The custom parameters associated with the messaging channel.



 |
| description | 

Field Type

string

Description

The channel description.



 |
| embeddedConfig | 

Field Type

[EmbeddedConfig\[\]](#EmbeddedConfig)

Description

The settings associated with the messaging channel.



 |
| endUserIdleTimeout | 

Type

int

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The number of minutes of end-user inactivity until the conversation is automatically marked inactive. Valid values are from 5 through 30. Available in API version 66.0 and later.



 |
| externalAccountId | 

Field Type

string

Description

The external account identifier for the messaging channel. Available in API version 62.0 and later.



 |
| masterLabel | 

Field Type

string

Description

Required. The channel label.





 |
| messagingChannelType | 

Field Type

MessagingChannelType (enumeration of type string)

Description

Required. Values are:

- AppleMessagesForBusiness—Apple Messages for Business. Available in API version 65.0 and later.
- Custom—Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS. Available in API version 61.0 and later.
- EmbeddedMessaging—Enhanced Chat.
- Facebook—Facebook Messenger. Available in API version 65.0 and later.
- Line—Line. Available in API version 65.0 and later.
- PstnVoice—Agentforce Voice (PSTN). Available in API version 65.0 and later.
- Text—SMS. Available in API version 65.0 and later.
- SipVoice—Represents an Agentforce Voice channel that uses SIP. Available in API version 65.0 and later.
- Voice—Service Cloud Voice. Available in API version 58.0 and later.
- WhatsApp—WhatsApp. Available in API version 65.0 and later.
- WhatsAppVoice—Available in API version 65.0 and later.

Third-party Messaging channels in Salesforce, such as WhatsApp and Facebook Messenger, don’t use this metadata type.



 |
| messagingKeywords | 

Field Type

[MessagingKeyword\[\]](#MessagingKeyword)

Description

Keywords associated with the messaging channel.



 |
| platformKey | 

Field Type

string

Description

The platform key for the messaging channel. Available in API version 62.0 and later.



 |
| queueRoutingConfig | 

Field Type

string

Description

The queue routing configuration for the messaging channel. Available in API version 64.0 and later.



 |
| sessionHandlerFlow | 

Field Type

string

Description

The Omni-Channel flow used to route the channel’s messaging sessions.



 |
| sessionHandlerQueue | 

Field Type

string

Description

Required. The queue used to route messages. If a sessionHandlerFlow is also selected, sessionHandlerQueue is the fallback queue used if a message can’t be routed using the selected flow.





 |
| sessionHandlerType | 

Field Type

MessagingSessionHandlerType (enumeration of type string)

Description

Required. The method used to route messages in the channel. Values are:

- AgentforceServiceAgent
- Flow
- Queue
- User





 |
| sessionHandlerUser | 

Field Type

string

Description

The user to handle routing for the messaging channel. Available in API version 62.0 and later.



 |
| standardParameters | 

Field Type

[MessagingChannelStandardParameter\[\]](#MessagingChannelStandardParameter)

Description

Parameters added to the messaging channel.



 |

## EmbeddedConfig

Represents settings specific to an embedded messaging channel.

| Field Name | Description |
| --- | --- |
| isEstimatedWaitTimeEnabled | 
Field Type

Boolean

Description

Indicates whether estimated wait time is enabled. The default value is false.



 |
| authMode | 

Field Type

EmbeddedServiceAuthModeType (enumeration of type string)

Description

Required. Auth/UnAuth Mode Types For Embedded Chat. Valid values are:

- Auth
- UnAuth





 |
| verifiedUserJwtExpirationTime | 

Field Type

Integer

Description

If authMode is set to true, this value represents the JWT expiry value in minutes.



 |
| anonymousUserJwtExpirationTime | 

Field Type

Integer

Description

If authMode is set to false, this value represents the JWT expiry value in minutes.



 |
| isAttachmentUploadEnabled | 

Field Type

Boolean

Description

Indicates whether inbound file attachments are allowed. The default value is false.



 |
| isSaveTranscriptEnabled | 

Field Type

Boolean

Description

Indicates whether transcripts can be downloaded. The default value is false.



 |
| messagingAuthorizations | 

Field Type

MessagingAuthorization

Description

Represents authorization settings specific to a given MessagingChannel.



 |

## MessagingAuthorization

This junction entity stores the messaging channel authorization for a Messaging Channel (Embedded Messaging Channel). On this entity, we configure different authorization methods supported by the Messaging for In-App and Web \`(Embedded Messaging) channel. This entity is available in API version 62.0 or later.

| Field Name | Description |
| --- | --- |
| authIdentifier | 
Field Type

String

Description

Required. Represents an identifier for the MessagingAuthorization entity. The value must begin with a letter. Only alphanumeric characters and \_ are allowed.



 |
| authProviderName | 

Field Type

String

Description

This field should never be set. Although this field is exposed, it isn't supported. The field represents the name of the AuthProvider that’s referenced in the MessagingAuthorization. It’s a required field if authorizationType is set to AuthProvider.



 |
| authorizationType | 

Field Type

MessagingAuthorizationType (enumeration of type string)

Description

Required. Indicates whether MessagingAuthorization has been configured to reference a PublicKeyCertificateSet or an AuthProvider. Valid values are:

- PublicKeyCertificateSet - Indicates that a PublicKeyCertificateSet is referenced in the MessagingAuthorization entity. This is the only option that will lead to a fully functional User Verification setup.
- AuthProvider - This option should never be selected. It indicates that an AuthProvider is referenced in the MessagingAuthorization, but we don’t support it.





 |
| enabled | 

Field Type

Boolean

Description

Indicates whether messaging authorization is enabled. Defaults to false.



 |
| publicKeyCertificateSetName | 

Field Type

String

Description

Name of the public key certificate set that's referenced in the MessagingAuthorization entity. This is a required field if authorizationType is set to PublicKeyCertificateSet.



 |

## MessagingAutoResponse

Represents an automated response used in a channel.

| Field Name | Description |
| --- | --- |
| autoResponseContentType | 
Field Type

string

Description

The content type of the auto-response: TextResponse or MessageDefinition.



 |
| language | 

Field Type

string

Description

The language of the auto response.



 |
| messageDefinitionName | 

Field Type

string

Description

The name of the messaging component.



 |
| response | 

Field Type

string

Description

The text of the auto response.



 |
| responseTimeoutInMins | 

Field Type

integer

Description

The number of minutes after which a response can no longer be sent. The value can range from 5 to 60.



 |
| type | 

Field Type

MessagingAutoResponseType (enumeration of type string)

Description

Required. The type of response, which determines when it’s used in a messaging session. Values are:

- AgentEndEngagementResponse
- AgentEngagedResponse
- CustomResponse (Available in API version 65.0 and later.)
- DoubleOptInPrompt (Available in API version 65.0 and later.)
- EndUserIdleResponse (Available in API version 65.0 and later.)
- EndUserInactiveResponse (Available in API version 65.0 and later.)
- HelpResponse (Available in API version 65.0 and later.)
- InitialResponse
- OptInConfirmation (Available in API version 65.0 and later.)
- OptInPrompt (Available in API version 65.0 and later.)
- OptOutConfirmation (Available in API version 65.0 and later.)
- RerouteResponse (Available in API version 68.0 and later.)





 |

## MessagingChannelCustomParameter

Represent a custom parameter added to a channel.

| Field Name | Description |
| --- | --- |
| actionParameterMappings | 
Field Type

[MessagingChannelActionParameterMapping\[\]](#MessagingChannelActionParameterMapping)

Description

The mapping used to map the parameter value to a flow or task.



 |
| externalParameterName | 

Field Type

string

Description

Required. The external name of the parameter.



 |
| masterLabel | 

Field Type

string

Description

Required. The label of the parameter.



 |
| maxLength | 

Field Type

int

Description

The maximum length of the parameter value.



 |
| name | 

Field Type

string

Description

Required. The name of the parameter.



 |
| parameterDataType | 

Field Type

FlowDataType (enumeration of type string)

Description

Required. The format of the parameter. Values are:

- Apex
- Boolean
- Currency
- Date
- DateTime
- Multipicklist
- Number
- Picklist
- SObject
- String
- Time





 |

## MessagingChannelActionParameterMapping

Represents a mapping between a parameter and an Omni-Channel flow or agent task.

| Field Name | Description |
| --- | --- |
| actionParameterName | 
Field Type

string

Description

Required. The name of the flow that the custom or standard parameters are mapped to.



 |

## MessagingChannelStandardParameter

Represents a standard parameter used to pass information into a channel.

| Field Name | Description |
| --- | --- |
| actionParameterMappings | 
Field Type

[MessagingChannelActionParameterMapping\[\]](#MessagingChannelActionParameterMapping)

Description

The mapping associated with the parameter.



 |
| externalInteractionId | 

Field Type

MessagingChannelStandardParameterType (enumeration of type string)

Description

An ID assigned to the external interaction, such as a campaign ID.



 |
| externalInteractionName | 

Field Type

MessagingChannelStandardParameterType (enumeration of type string)

Description

The name of the external interaction, such as a campaign name.



 |
| externalInteractionType | 

Field Type

MessagingChannelStandardParameterType (enumeration of type string)

Description

The type of external interaction, such as MarketingCampaign.



 |
| parameterType | 

Field Type

MessagingChannelStandardParameterType (enumeration of type string)

Description

Required. The type of parameter. Values are:

- Email
- FirstName
- LastName
- Subject





 |

## MessagingChannelUsage

Represents the deployment type and consent configuration for a messaging channel. Available in API version 62.0 and later.

| Field Name | Description |
| --- | --- |
| channelConsentType | 
Field Type

MessagingChannelConsentType (enumeration of type string)

Description

Optional. The consent type for the messaging channel. Values are:

- ImplicitOptIn
- ExplicitOptIn
- DoubleOptIn





 |
| deploymentType | 

Field Type

MessagingChannelUsageDeploymentType (enumeration of type string)

Description

Required. The deployment type for the messaging channel. Values are:

- DigitalEngagementConversation
- UnifiedConversation
- MessagingEngagement
- MarketingJourneyBuilder





 |

## MessagingKeyword

Represents settings specific to an EmbeddedMessaging MessagingChannel. Available in API version 62 or later.

| Field Name | Description |
| --- | --- |
| keywordType | 
Field Type

MessagingKeywordType (enumeration of type string)

Description

Required. The type of messaging keyword for the auto response. Valid values are:

- OptIn
- DoubleOptIn
- OptOut
- Help
- Custom





 |
| language | 

Field Type

String

Description

Required. The language of the messaging keyword



 |
| keyword | 

Field Type

String

Description

The messaging keyword value.



 |

## Declarative Metadata Sample Definition

The following is an example of a MessagingChannel component. This messaging channel passes custom and standard parameters from the messaging channel to a flow, and it routes to a flow with a fallback queue.

<?xml version="1.0" encoding="UTF-8"?>
<MessagingChannel xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Test in-app messaging channel</description\>
    <masterLabel\>TestInAppChannel</masterLabel\>
    <messagingChannelType\>EmbeddedMessaging</messagingChannelType\>
    <sessionHandlerQueue\>Demo\_Queue</sessionHandlerQueue\>
    <sessionHandlerType\>Queue</sessionHandlerType\>
    <embeddedConfig\>
        <authMode\>Auth</authMode\>
        <isAttachmentUploadEnabled\>true</isAttachmentUploadEnabled\>
        <isSaveTranscriptEnabled\>false</isSaveTranscriptEnabled\>
        <isEstimatedWaitTimeEnabled\>false</isEstimatedWaitTimeEnabled\>
        <verifiedUserJwtExpirationTime\>360</verifiedUserJwtExpirationTime\>
        <messagingAuthorizations\>
            <authorizationType\>PublicKeyCertificateSet</authorizationType\>
            <authProviderName\></authProviderName\>
            <publicKeyCertificateSetName\>pcks1</publicKeyCertificateSetName\>
            <enabled\>false</enabled\>
            <authIdentifier\>auth\_identifier\_one</authIdentifier\>
        </messagingAuthorizations\>
    </embeddedConfig\>
    <automatedResponses\>
        <autoResponseContentType\>MessageDefinition</autoResponseContentType\>
        <messageDefinitionName\>Sample</messageDefinitionName\>
        <type\>EndUserInactiveResponse</type\>
        <responseTimeoutInMins\>10</responseTimeoutInMins\>
    </automatedResponses\>
    <automatedResponses\>
        <autoResponseContentType\>MessageDefinition</autoResponseContentType\>
        <messageDefinitionName\>Sample</messageDefinitionName\>
        <type\>InitialResponse</type\>
    </automatedResponses\>
    <automatedResponses\>
        <autoResponseContentType\>MessageDefinition</autoResponseContentType\>
        <messageDefinitionName\>Sample</messageDefinitionName\>
        <type\>AgentEndEngagementResponse</type\>
    </automatedResponses\>
    <automatedResponses\>
        <autoResponseContentType\>MessageDefinition</autoResponseContentType\>
        <messageDefinitionName\>Sample</messageDefinitionName\>
        <type\>AgentEngagedResponse</type\>
    </automatedResponses\>
    <automatedResponses\>
        <autoResponseContentType\>TextResponse</autoResponseContentType\>
        <language\>en\_US</language\>
        <response\>You've opted out of receiving messages from us, so we won't contact you again.</response\>
        <type\>OptOutConfirmation</type\>
    </automatedResponses\>
    <automatedResponses\>
        <autoResponseContentType\>TextResponse</autoResponseContentType\>
        <language\>en\_US</language\>
        <response\>Custom response1</response\>
        <type\>CustomResponse</type\>
    </automatedResponses\>
    <automatedResponses\>
        <autoResponseContentType\>TextResponse</autoResponseContentType\>
        <language\>en\_US</language\>
        <response\>Opt In Confirmation response</response\>
        <type\>OptInConfirmation</type\>
    </automatedResponses\>
    <automatedResponses\>
        <autoResponseContentType\>TextResponse</autoResponseContentType\>
        <language\>en\_US</language\>
        <response\>Text STOP to opt out of further messages.</response\>
        <type\>HelpResponse</type\>
    </automatedResponses\>
    <messagingKeywords\>
        <keyword\>stopall</keyword\>
        <keyword\>cancel</keyword\>
        <keyword\>stop</keyword\>
        <keyword\>unsubscribe</keyword\>
        <keyword\>end</keyword\>
        <keyword\>quit</keyword\>
        <keywordType\>OptOut</keywordType\>
        <language\>en\_US</language\>
    </messagingKeywords\>
    <messagingKeywords\>
        <keyword\>help</keyword\>
        <keywordType\>Help</keywordType\>
        <language\>en\_US</language\>
    </messagingKeywords\>
    <messagingKeywords\>
        <keyword\>customkeyword1</keyword\>
        <keywordType\>Custom</keywordType\>
        <language\>en\_US</language\>
    </messagingKeywords\>
    <messagingKeywords\>
        <keyword\>OptInkeyword1</keyword\>
        <keywordType\>OptIn</keywordType\>
        <language\>en\_US</language\>
    </messagingKeywords\>
</MessagingChannel\>

If you route the messaging channel to a queue, there’s no fallback flow.

<?xml version="1.0" encoding="UTF-8"?>
<MessagingChannel xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel>EmbeddedChannel2</masterLabel>
    <messagingChannelType>EmbeddedMessaging</messagingChannelType>
    <sessionHandlerQueue>DemoQueueName</sessionHandlerQueue>
    <sessionHandlerType>Queue</sessionHandlerType>
</MessagingChannel>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>MessagingChannel</name\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=c36784d1e0f6d9bf39a29e928fd8e1d5e966d06fe57f78d9eabfbef370caa957 url=/legacydeveloper/current/en-us/api_meta/metadata.md -->

# Metadata

The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.

Metadata is analogous to sObject , which represents all standard objects. Metadata represents all components and fields in the Metadata API. Instead of identifying each component with an ID, each custom object or custom field has a unique fullName, which must be distinct from standard object names, as it must be when you create custom objects or custom fields in the Salesforce user interface.

## Version

Metadata components are available in API version 10.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1040952e75">Field Name</th>

              <th class="featureTableHeader  " id="d1040952e78">Field Type</th>

              <th class="featureTableHeader  " id="d1040952e81">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1040952e75" data-title="Field Name"><span class="keyword parmname" id="meta_fullname"><a name="meta_fullname"><!-- --></a>fullName</span></td>

              <td class="entry" headers="d1040952e78" data-title="Field Type">string</td>

              <td class="entry" headers="d1040952e81" data-title="Description">Required. The name of the component. For components with parent objects, such
                as fields and list views, the name must specify the name of the parent, for example
                <samp class="codeph nolang">Account.FirstName</samp>. The __c suffix must be
                appended to custom object names and custom field names when you’re setting the
                <span class="keyword parmname">fullName</span>. For example, a custom field in a custom object
                could have a <span class="keyword parmname">fullName</span> of <samp class="codeph nolang">MyCustomObject__c.MyCustomField__c</samp>.<p class="p">To reference a component in a
                  package, prepend the package’s namespace prefix to the component name in the
                  <span class="keyword parmname">fullName</span> field. Use the following syntax: <samp class="codeph nolang"><var class="keyword varname">namespacePrefix</var>__<var class="keyword varname">ComponentName</var></samp>.
                  For example, for the custom field component <samp class="codeph nolang">MyCustomObject__c.MyCustomField__c</samp> and the namespace <samp class="codeph nolang">MyNS</samp>, the full name is <samp class="codeph nolang">MyNS__MyCustomObject__c.MyCustomField__c</samp>.
                </p>
                <p class="p">A namespace prefix
                  is a 1-character to 15-character alphanumeric identifier that distinguishes your
                  package and its contents from other publishers’ packages. For more information,
                  see Create and Register Your Namespace for Second-Generation Managed
                  Packages.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")
- [CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm "Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.")
- [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.")

<!-- document id=95a95cb92532bebbc49b6df2e11ff7835671b07731ed7c931962d1aadbf7d0e7 url=/legacydeveloper/current/en-us/api_meta/meta_developer_tools.md -->

# Metadata API Developer Tools

Use the Salesforce Extensions for Visual Studio Code on Salesforce CLI to access Metadata API commands. Salesforce CLI and the Salesforce Extensions for Visual Studio Code streamline the process of using Metadata API.

The easiest way to access the functionality in Metadata API is to use the Salesforce Extensions for Visual Studio Code or Salesforce CLI. Both tools are built on top of Metadata API and use the standard tools to simplify working with Metadata API.

- The Salesforce Extensions for Visual Studio Code includes tools for developing on the Salesforce platform in the lightweight, extensible VS Code editor. These tools provide features for working with development orgs (scratch orgs, sandboxes, and DE orgs), Apex, Aura components, and Visualforce.
- Salesforce CLI is ideal if you use scripting or the command line for moving metadata between a local directory and a Salesforce org.

For more information about the Salesforce Extensions for Visual Studio Code or Salesforce CLI, see [Salesforce Tools and Toolkits](https://developer.salesforce.com/tools "HTML (New Window)").

If you prefer to build your own client applications, the underlying calls of Metadata API have been exposed for you to use directly. This guide gives you more information about working directly with Metadata API.

You can use the Metadata API to manage setup and customization information (metadata) in Salesforce. For example:

- Export customizations as XML metadata files. See [Working with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.") and [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.").
- Migrate configuration changes between orgs. See [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") and [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.").
- Modify existing customizations using XML metadata files. See [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") and [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.").
- Manage customizations programmatically. See [CRUD-Based Metadata Development](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_calls_intro.htm "Use the CRUD-based metadata calls to create, update, or delete setup and configuration components for your organization or application. These configuration components include custom objects, custom fields, and other configuration metadata. The metadata calls mimic the behavior in the Salesforce user interface for creating, updating, or deleting components. Whatever rules apply there also apply to these calls.").

You can modify metadata in test orgs in Developer Edition or sandboxes, and then deploy tested changes to production orgs in Enterprise, Unlimited, or Performance Editions. You can also create scripts to populate a new org with your custom objects, custom fields, and other components.

#### See Also

- [Declarative (File-Based) Metadata API Calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based.htm)

<!-- document id=b5687688f8db5c1ff119ab107cb453ff6a191aa52bc2defccbc85e768afc3258 url=/legacydeveloper/current/en-us/api_meta/meta_metadata_perm.md -->

# Metadata API Edit Access

To use Metadata API, a user must have these things.

- One of these editions: Enterprise, Unlimited, or Developer
- Either the Modify Metadata Through Metadata API Functions OR Modify All Data permission
- Permission that enables use of the feature supported by the metadata that they want to modify
- Permission that enables their deployment tool, such as Salesforce CLI, or change sets

With the Modify Metadata Through Metadata API Functions permission, a user can access and edit metadata via Metadata API as long as the user has any additional permission needed to access certain metadata types. This additional permission information is listed in the Metadata API Developer Guide for each metadata type. With the Modify All Data permission, a user can access and edit all data.

The Modify Metadata Through Metadata API Functions permission doesn’t affect direct customization of metadata using Setup UI pages because those pages don’t use Metadata API for updates.

Some metadata, such as Apex, executes in system context, so be careful how you delegate the Modify Metadata Through Metadata API Functions permission. The Modify Metadata Through Metadata API Functions permission allows deployment of Apex metadata, but it doesn’t allow certain Apex development and debugging features that still require the Modify All Data permission.

The Modify Metadata Through Metadata API Functions permission is enabled automatically when either the Deploy Change Sets OR Author Apex permission is selected.

When the Manage Prompts user permission and the Modify Metadata Through Metadata API Functions permission are combined, users can manage In-App Guidance in Lightning Experience.

<!-- document id=c4bf5442380d650b07f1408f59688061385ca694da695150124707b56d869559 url=/legacydeveloper/current/en-us/api_meta/meta_rns.md -->

# Metadata API Release Notes

Use the Salesforce Release Notes to learn about the most recent updates and changes to Metadata API.

For updates and changes that impact the Salesforce Platform, including Metadata API, see the [API Release Notes](https://help.salesforce.com/s/articleView?id=release-notes.rn_api.htm&language=en_US).

For new, changed, and deprecated metadata types and other changes specific to Metadata API, see [Metadata API](https://help.salesforce.com/s/articleView?id=release-notes.rn_api_meta.htm&language=en_US) in the Salesforce Release Notes.

<!-- document id=a9c1d8172b052c438d9493d7ecf807e5fcf82fd0ca94d37b2eaf438fe52efb70 url=/legacydeveloper/current/en-us/api_meta/meta_support_policy.md -->

# Metadata API Support Policy

Salesforce supports previous versions of Metadata API. However, your new client applications should use the most recent version of the Lightning Platform Metadata API WSDL file to fully exploit the benefits of richer features and greater efficiency.

**Backward Compatibility**

Salesforce strives to make backward compatibility easy when using the Lightning Platform.

Each new Salesforce release consists of two components:

- A new release of platform software that resides on Salesforce systems
- A new version of the API

For example, the Spring '07 release included API version 9.0 and the Summer '07 release included API version 10.0.

We maintain support for each API version across releases of the platform software. The API is backward compatible in that an application created to work with a given API version will continue to work with that same API version in future platform software releases.

Salesforce does not guarantee that an application written against one API version will work with future API versions: Changes in method signatures and data representations are often required as we continue to enhance the API. However, we strive to keep the API consistent from version to version with minimal, if any, changes required to port applications to newer API versions.

For example, an application written using API version 9.0, which shipped with the Spring ’07 release, will continue to work with API version 9.0 on the Summer ’07 release, and on future releases beyond that. However, that same application might not work with API version 10.0 without modifications to the application.

<!-- document id=b933addbcbc54a64e51b38146196e7fa9c8d4fded8bf090e4c99265af22362a9 url=/legacydeveloper/current/en-us/api_meta/meta_objects_intro.md -->

# Metadata Components and Types

Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.

For example, CustomObject is a metadata type for custom objects, and the MyCustomObject\_\_c component is an instance of a custom object.

A metadata type can be identified in the metadata WSDL as any complexType that extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) complexType. A complexType that is a metadata type includes the following element in its WSDL definition:

<xsd:extension base="tns:Metadata">

CustomObject and BusinessProcess extend Metadata so they are metadata types; ActionOverride doesn't extend Metadata so it's not a metadata type.

You can individually deploy or retrieve a component for a metadata type. For example, you can retrieve an individual BusinessProcess component, but you can't retrieve an individual ActionOverride component. You can only retrieve an ActionOverride component by retrieving its encompassing CustomObject component.

Metadata components can be manipulated by [asynchronous Metadata API calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_calls_intro.htm "Use the CRUD-based metadata calls to create, update, or delete setup and configuration components for your organization or application. These configuration components include custom objects, custom fields, and other configuration metadata. The metadata calls mimic the behavior in the Salesforce user interface for creating, updating, or deleting components. Whatever rules apply there also apply to these calls.") or [declarative (or file-based) Metadata API calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based.htm).

Most of the components can be accessed using Salesforce Extensions for Visual Studio Code. Exceptions are noted in the description of the object.

## Field Data Types

Each component field has a specific field type. These field types can correspond to other components defined in the WSDL, or primitive data types, like string, that are commonly used in strongly typed programming languages.

These field data types are used in the messages that are exchanged between your client application and the API. When writing your client application, follow the data typing rules defined for your programming language and development environment. Your development tool handles the mapping of typed data in your programming language with these data types.

For more information, see [Primitive Data Types in the Salesforce Object Reference](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/primitive_data_types.htm "html (New Window)").

## Enumeration Fields

Some component fields have a data type that is an enumeration. An enumeration is the API equivalent of a picklist. The valid values of the field are restricted to a strict set of possible values, all having the same data type. These values are listed in the field description column for each enumeration field. See [Dashboard: sortBy](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_dashboard.htm) for an example of an enumeration field of type string. The XML below shows a sample definition of an enumeration of type string in the WSDL.

<xsd:simpleType name="DashboardComponentFilter">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="RowLabelAscending"/>
        <xsd:enumeration value="RowLabelDescending"/>
        <xsd:enumeration value="RowValueAscending"/>
        <xsd:enumeration value="RowValueDescending"/>
    </xsd:restriction\>
</xsd:simpleType\>

## Supported Calls

All of the metadata types are supported by the main calls, unless it is stated otherwise in the individual component sections. The main Metadata API calls are:

- [CRUD calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects."), such as [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") and [deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm "Deletes one or more metadata components from your organization synchronously.")
- [File-based calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_file_based_calls_intro.htm "Use file-based calls to deploy or retrieve XML components."), such as [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") and [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.")
- [Utility calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_utility_calls_intro.htm "Use utility calls to gather information that is useful for working with the file-based or CRUD-based calls."), such as [listMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listmetadata.htm "This call retrieves property information about metadata components in your organization. Data is returned for the components that match the criteria specified in the queries parameter. The queries array can contain up to three ListMetadataQuery queries for each call. This call supports every metadata type: both top-level, such as CustomObject and ApexClass, and child types, such as CustomField and RecordType.") and [describeMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describe.htm "This call retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types.")

<!-- document id=73ff2855cbed20b795ec6ee4464bcf97c2cdc25340570ed9b0690fd0abd94998 url=/legacydeveloper/current/en-us/api_meta/meta_coverage_report.md -->

# Metadata Coverage Report

Launch the Metadata Coverage report to determine supported metadata components. The Metadata Coverage report is the ultimate source of truth for metadata coverage across several channels. These channels include Metadata API, scratch org source tracking, unlocked packages, second-generation managed packages, classic managed packages, and more.

To view the [Metadata Coverage report](https://developer.salesforce.com/docs/success/metadata-coverage-report/references/coverage-report/metadata-coverage-report.html), you don’t have to be logged into an org.

<!-- document id=0274f52c124527660a2c4559b65cd6a95e7b7b51c0d5758d95f82555215e9d38 url=/legacydeveloper/current/en-us/api_meta/meta_quickstart_retrieve_prereqs.md -->

# Metadata Development Prerequisites

Complete these prerequisites before you start developing with Metadata API.

- To access Metadata API through the command line, [install Salesforce CLI](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm).
- To create a development environment, [sign up for Salesforce Developer Edition](https://developer.salesforce.com/signup). A Developer Edition org is a free development environment for building and testing solutions independent of production data.
- Install [Salesforce Extensions for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode). These tools provide features for working with development orgs (scratch orgs, sandboxes, and DE orgs), Apex, Aura components, and Visualforce.
- Confirm that you have API Enabled permission and Modify Metadata Through Metadata API Functions permission or Modify All Data permission. If you don’t have these permissions set, [modify your metadata permissions](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_modify_metadata_perm.htm).
- [Enable Dev Hub in your org](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_setup_enable_devhub.htm). Dev Hub allows you to create and manage scratch orgs so that you can develop without affecting your production data or metadata.
- To allow access to protected resources such as production data and metadata, [authorize your org](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth.htm) .

- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_add_components.htm "Step 1: (Optional) Add Metadata Components to an Org Using the UI")

<!-- document id=7ee5a8824e9295178fa87e326860cde17f6afac24019b4ad16579e2cc6cd93eb url=/legacydeveloper/current/en-us/api_meta/meta_field_types.md -->

# Metadata Field Types

These field types extend the field types described in the _Salesforce Object Reference_.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

<table class="featureTable sort_table" summary="">



        <thead class="thead sorted" align="left">
          <tr>
            <th class="featureTableHeader  " id="d500029e61">Field Type</th>

            <th class="featureTableHeader  " id="d500029e64">Objects</th>

            <th class="featureTableHeader  " id="d500029e67">What the Field Contains</th>

          </tr>

        </thead>

        <tbody class="tbody">
          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type">CustomField</td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom object<p class="p">Custom field</p>
            </td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains">Represents a custom field.</td>

          </tr>

          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type">DeleteConstraint</td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom field</td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains">A string that represents deletion options for lookup relationships. Valid values are:<ul class="ul bulletList">
                <li class="li"><samp class="codeph nolang">SetNull</samp></li>

                <li class="li"><samp class="codeph nolang">Restrict</samp></li>

                <li class="li"><samp class="codeph nolang">Cascade</samp></li>

              </ul>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type">DeploymentStatus</td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom object<p class="p">Custom field</p>
            </td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains">
              <p class="p" id="meta_type_deploy_stat_desc"><a name="meta_type_deploy_stat_desc"><!-- --></a>A string that represents the deployment status of
                a custom object or field. Valid values are:</p>

              <ul class="ul bulletList">
                <li class="li"><samp class="codeph nolang">InDevelopment</samp></li>

                <li class="li"><samp class="codeph nolang">Deployed</samp></li>

              </ul>

            </td>

          </tr>

          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type">FieldType</td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom field</td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains">Indicates the type of a custom field. Valid values are:
              <a name="field_type_options"><!-- --></a>
              <ul class="ul bulletList" id="field_type_options">
                <li class="li"><samp class="codeph nolang">Address</samp></li>

                <li class="li"><samp class="codeph nolang">AutoNumber</samp></li>

                <li class="li"><samp class="codeph nolang">Lookup</samp></li>

                <li class="li"><samp class="codeph nolang">MasterDetail</samp></li>

                <li class="li"><samp class="codeph nolang">MetadataRelationship</samp></li>

                <li class="li"><samp class="codeph nolang">Checkbox</samp></li>

                <li class="li"><samp class="codeph nolang">Currency</samp></li>

                <li class="li"><samp class="codeph nolang">Date</samp></li>

                <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                <li class="li"><samp class="codeph nolang">Email</samp></li>

                <li class="li">
                  <samp class="codeph nolang">EncryptedText</samp>
                  <div class="box message info">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p>This page is about
                              Classic Encryption, not Shield Platform Encryption. <a class="xref" href="https://help.salesforce.com/s/articleView?id=xcloud.security_pe_vs_classic_encryption.htm&amp;type=5&amp;language=en_US" target="_blank">What's the difference?</a></p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>
                </li>

                <li class="li"><samp class="codeph nolang">ExternalLookup</samp></li>

                <li class="li"><samp class="codeph nolang">IndirectLookup</samp></li>

                <li class="li">
                  <samp class="codeph nolang">Number</samp><sup class="ph sup">1</sup>
                </li>

                <li class="li"><samp class="codeph nolang">Percent</samp></li>

                <li class="li"><samp class="codeph nolang">Phone</samp></li>

                <li class="li"><samp class="codeph nolang">Picklist</samp></li>

                <li class="li"><samp class="codeph nolang">MultiselectPicklist</samp></li>

                <li class="li"><samp class="codeph nolang">Summary</samp></li>

                <li class="li"><samp class="codeph nolang">Text</samp></li>

                <li class="li"><samp class="codeph nolang">TextArea</samp></li>

                <li class="li"><samp class="codeph nolang">LongTextArea</samp></li>

                <li class="li"><samp class="codeph nolang">Url</samp></li>

                <li class="li"><samp class="codeph nolang">Hierarchy</samp></li>

                <li class="li"><samp class="codeph nolang">File</samp></li>

                <li class="li"><samp class="codeph nolang">Html</samp></li>

                <li class="li">
                  <samp class="codeph nolang">Location</samp> (use for geolocation fields)
                </li>

                <li class="li"><samp class="codeph nolang">Time</samp></li>

                <li class="li"><samp class="codeph nolang">Array</samp></li>

                <li class="li"><samp class="codeph nolang">Integer</samp></li>

                <li class="li"><samp class="codeph nolang">Long</samp></li>

              </ul>
              <sup class="ph sup">1</sup> A <samp class="codeph nolang">Number</samp> custom field, internally represented as a field of type double. Setting the scale of the <samp class="codeph nolang">Number</samp> field to 0 gives you a double that behaves like
              an int.
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type">Gender</td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom object</td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains">
              <span class="ph" id="gender_desc"><a name="gender_desc"><!-- --></a>Indicates the gender of the noun that represents the object.
                Used for languages where words need different treatment depending on their
                gender.</span> Valid values are:<a name="gender_ul"><!-- --></a>
              <ul class="ul bulletList" id="gender_ul">
                <li class="li"><span class="keyword parmname">Masculine</span></li>

                <li class="li"><span class="keyword parmname">Feminine</span></li>

                <li class="li"><span class="keyword parmname">Neuter</span></li>

                <li class="li">
                  <span class="keyword parmname">AnimateMasculine</span> (<span class="ph" id="west_slavic_languages_list"><a name="west_slavic_languages_list"><!-- --></a>Slavic languages—currently Czech, Polish, Russian, Slovak, Slovenian, and
                    Ukrainian</span>)
                </li>

                <li class="li">
                  <span class="keyword parmname">ClassI</span>, <span class="keyword parmname">ClassIII</span>,
                  <span class="keyword parmname">ClassV</span>, <span class="keyword parmname">ClassVII</span>,
                  <span class="keyword parmname">ClassIX</span>, <span class="keyword parmname">ClassXI</span>,
                  <span class="keyword parmname">ClassXIV</span>, <span class="keyword parmname">ClassXV</span>,
                  <span class="keyword parmname">ClassXVI</span>, <span class="keyword parmname">ClassXVII</span>,
                  <span class="keyword parmname">ClassXVIII</span> (African languages—currently Afrikaans, Xhosa,
                  and Zulu)
                </li>

              </ul>
              <div class="box message info">
                <div class="inner">
                  <div class="bd">
                    <div class="media">
                      <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                      <div class="mediaBd">
                        <h4 class="mbs">Note</h4>
                        <p>The following genders appear on the Rename Tabs and Labels page in
                          Setup but are stored internally as “Feminine”. When setting them through the
                          Metadata API, use “Feminine”.
                        </p><ul class="ul bulletList">
                          <li class="li"><span class="keyword parmname">Euter (Swedish)</span></li>

                          <li class="li"><span class="keyword parmname">Common (Dutch)</span></li>

                        </ul>
                        <p></p>
                      </div>
                    </div>
                  </div>
                </div>
              </div>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm" title="Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.">Picklist (Including Dependent
                Picklist)</a></td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom field</td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains">(This field type isn’t used in Metadata API. CustomField includes this field type
              for Tooling API support). Represents a picklist, a set of labels and values that can
              be selected from a picklist.</td>

          </tr>

          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type">SharingModel</td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom object</td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains">Represents the sharing model for the custom object. Depending on the object,
              valid values are:<a name="ExSharing"><!-- --></a>
              <ul class="ul bulletList" id="ExSharing">
                <li class="li"><samp class="codeph nolang">Private</samp></li>

                <li class="li"><samp class="codeph nolang">Read</samp></li>

                <li class="li"><samp class="codeph nolang">ReadWrite</samp></li>

                <li class="li"><samp class="codeph nolang">ReadWriteTransfer</samp></li>

                <li class="li"><samp class="codeph nolang">FullAccess</samp></li>

                <li class="li"><samp class="codeph nolang">ControlledByParent</samp></li>

                <li class="li"><samp class="codeph nolang">ControlledByCampaign</samp></li>

                <li class="li"><samp class="codeph nolang">ControlledByLeadOrContact</samp></li>

              </ul>
              <p class="p" id="ExSharing_obj"><a name="ExSharing_obj"><!-- --></a>For example, the User object supports <samp class="codeph nolang">Private</samp> and <samp class="codeph nolang">Read</samp>
                values. Accounts, opportunities, and custom objects support <samp class="codeph nolang">Private</samp>, <samp class="codeph nolang">Read</samp>
                and <samp class="codeph nolang">ReadWrite</samp> values. Campaign members support
                <samp class="codeph nolang">ControlledByCampaign</samp> and <samp class="codeph nolang">ControlledByLeadOrContact</samp>.
              </p>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type">StartsWith</td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom object<p class="p">Custom field</p>
            </td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains">
              <span class="ph" id="startsWith_desc"><a name="startsWith_desc"><!-- --></a>Indicates whether the noun starts with a vowel,
                consonant, or is a special character. This is used for languages where words need
                different treatment depending on the first character.</span> Valid values are:<a name="startsWith_ul"><!-- --></a>
              <ul class="ul bulletList" id="startsWith_ul">
                <li class="li"><span class="keyword parmname">Consonant</span></li>

                <li class="li"><span class="keyword parmname">Vowel</span></li>

                <li class="li"><span class="keyword parmname">Special (for nouns starting with z, or s plus
                    consonants)</span></li>

              </ul>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type">TreatBlanksAs</td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom field</td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains">Indicates how blanks should be treated. Valid values are:<ul class="ul bulletList">
                <li class="li"><samp class="codeph nolang">BlankAsBlank</samp></li>

                <li class="li"><samp class="codeph nolang">BlankAsZero</samp></li>

              </ul>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d500029e61" data-title="Field Type">ValueSet</td>

            <td class="entry" headers="d500029e64" data-title="Objects">Custom field</td>

            <td class="entry" headers="d500029e67" data-title="What the Field Contains"><span class="ph" id="ValueSet_descr"><a name="ValueSet_descr"><!-- --></a>Represents a set of values that can be selected from a
                custom picklist field. Defines the valueSet of a custom picklist field.</span></td>

          </tr>

        </tbody>

      </table>

## ValueSet

Represents a set of values that can be selected from a custom picklist field. Defines the valueSet of a custom picklist field.

| Field Type | Field Type | Description |
| --- | --- | --- |
| controllingField | string | The fullname of the controlling field if this is a dependent picklist. A controlling field can be a checkbox or picklist field, but in this case it’s a picklist. The controlling picklist filters the available values in the dependent picklist. |
| restricted | boolean | Whether the picklist’s values are limited to only the values defined by a Salesforce admin. Values are true or false. |
| valueSetDefinition | ValueSetValuesDefinition | Defines value-specific settings for a custom dependent picklist. Indicates whether the value set of the custom picklist field is sorted alphabetically. |
| valueSetName | string | The masterLabel of the global value set to be used for this picklist field. |
| valueSettings | ValueSettings | Used for the settings that describe a value in a custom picklist field. The picklist can have its own unique value set, or inherit the values from a global value set. You can add field dependency values via the Metadata API but not remove them. |

## ValueSetValuesDefinition

| Field Name | Field Type | Description |
| --- | --- | --- |
| sorted | boolean | Whether the picklist’s value set is displayed in alphabetical order in the user interface. |
| value | CustomValue | Required. The list of values for this local, custom picklist. |

## ValueSettings

| Field Name | Field Type | Description |
| --- | --- | --- |
| controllingFieldValue | stringstring\[\] | Applies only to dependent custom picklists. A list of values in the controlling or parent picklist (that the custom picklist values depend on). You can add field dependency values via the Metadata API but not remove them. |
| valueName | string | Defines the values in the custom dependent picklist. |

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm "WebLink")

<!-- document id=18821514cfd6fdb6eccbccf0a88dff73f3ade35c84d46199f222c3a59633f4a1 url=/legacydeveloper/current/en-us/api_meta/meta_metadata_type_limits.md -->

# Metadata Type Limits

Certain metadata types have deploy and retrieve limits. Limits apply to each individual deploy or retrieve transaction, and there are daily limits for specific metadata types.

The individual deploy and retrieve limits represent the maximum count that a metadata type may be deployed or retrieved in a single package zip. Daily deploy and retrieve limits apply to individual org usage within a 24-hour period.

Metadata Deploy Limits

- Individual Metadata Deploy: 50
- Daily Metadata Deploys: 100

Metadata Retrieve Limits

- Individual Metadata Retrieve: 100
- Daily Metadata Retrievals: 200

Deploy and Retrieve Metadata Limits apply to:

- AIAuthoringBundle
- AnalyticsDashboard
- AnalyticsVisualization
- AnalyticsWorkspace

<!-- document id=20770a410bc38658f77d232628363fbbca0501a6cc0fb3286bd370b2494f835b url=/legacydeveloper/current/en-us/api_meta/meta_types_list.md -->

# Metadata Types

Metadata API enables you to access some entities and feature settings that you can customize in the user interface.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

- Metadata type names are case-sensitive. Specifying a type name with an invalid case results in a deployment error.
- Metadata types don’t always correspond directly to their related data types. In some cases, the information is accessible but not organized as expected. For example, dependent picklists are exposed as a type of picklist, not a separate metadata type.
- The wildcard character doesn’t apply to metadata types for feature settings, like AccountSettings. The wildcard applies only when retrieving all settings and not an individual setting. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm).

- **[Metadata Coverage Report](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_coverage_report.htm)**  
    Launch the Metadata Coverage report to determine supported metadata components. The Metadata Coverage report is the ultimate source of truth for metadata coverage across several channels. These channels include Metadata API, scratch org source tracking, unlocked packages, second-generation managed packages, classic managed packages, and more.
- **[Unsupported Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_unsupported_types.htm)**  
    Some Salesforce features have metadata types that aren’t available in Metadata API. These metadata types can’t be retrieved or deployed with Metadata API. To make changes to these types, you must do it manually in each of your organizations.
- **[Special Behavior in Metadata API Deployments](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_special_behavior.htm)**  
    Important considerations for specific types and contents of a deployment.
- **[Metadata Type Limits](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_type_limits.htm)**  
    Certain metadata types have deploy and retrieve limits. Limits apply to each individual deploy or retrieve transaction, and there are daily limits for specific metadata types.
- **[Data 360 Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_data_cloud_types.htm)**  
    Check out the metadata types that are used for development in Data 360.
- **[AccountPlanObjMeasCalcDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_accountplanobjmeascalcdef.htm)**  
    Represents the metadata associated with an account plan objective measure calculation definition. An account plan objective measure calculation definition contains a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure.
- **[AccountRelationshipShareRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_accountrelationshipsharerule.htm)**  
    The rule that determines which object records are shared, how they’re shared, the account relationship type that shares the records, and the level of access granted to the records.
- **[AccountingFieldMapping](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_accountingfieldmapping.htm)**  
    Represents the accounting field mappings to organize your data and bring it to ledger entry records.
- **[AccountingModelConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_accountingmodelconfig.htm)**  
    Represents the mapping of the financial data model to a logical data model and configuration for the generation of Transaction Journal records.
- **[ActionLinkGroupTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_actionlinkgrouptemplate.htm)**  
    Represents the action link group template. Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking on an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. Every action link belongs to an action link group and action links within the group are mutually exclusive.
- **[ActionPlanTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_actionplantemplate.htm)**  
    Represents the instance of an action plan template.
- **[ActionableListDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_actionablelistdefinition.htm)**  
    Represents the data source definition details associated with an actionable list.
- **[AdvAccountForecastSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_advaccountforecastset.htm)**  
    Represents the forecast sets that define the forecast configurations for each business unit or different groups of accounts. With separate forecast sets at account or business unit level, you can focus on account-specific data and manage configuration updates for one business unit without impacting any other business unit’s data.
- **[AffinityScoreDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/fundraising_affinityscoredefinition_metadata_api.htm)**  
    Represents the affinity information used in calculations to analyze and categorize contacts for marketing purposes.
- **[AiAgentDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aiagentdefinition.htm)**  
    Represents an Agentforce agent and the settings that apply to all its versions, such as its type and its context variables. Each version of the agent is a separate AiAgentDefinitionVersion component. For information about retrieving and deploying an Agentforce agent, see Use [Use Metadata to Move an Agent to a New Org](https://developer.salesforce.com/docs/ai/agentforce/guide/agent-dx-deploy-metadata.html).
- **[AiAgentDefinitionVersion](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aiagentdefinitionversion.htm)**  
    Represents a version of an Agentforce agent definition, conversation variables, planner configuration, and behavior settings. For information about retrieving and deploying an Agentforce agent, see Use [Use Metadata to Move an Agent to a New Org](https://developer.salesforce.com/docs/ai/agentforce/guide/agent-dx-deploy-metadata.html).
- **[AIApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aiapplication.htm)**  
    Represents an instance of an AI application. For example, Einstein Prediction Builder.
- **[AIApplicationConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aiapplicationconfig.htm)**  
    Additional prediction information related to an AI application. This type extends the Metadata metadata type and inherits its fullName field.
- **[AiAuthoringBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aiauthoringbundle.htm)**  
    Represents an AI authoring bundle, which is a container for AI-related authoring content. For example, an AI authoring bundle for an Agentforce agent contains an Agent Script file and the associated metadata content.
- **[AiEvaluationDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aievaluationdefinition.htm)**  
    Represents an agent evaluation, including subject metadata and a set of test cases.
- **[AiPlannerVoiceDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aiplannervoicedef.htm)**  
    Represents a voice definition for an Agentforce voice agent. It stores the speech-to-text and text-to-speech configuration settings used during voice interactions, including model selection, voice persona, and audio synthesis parameters.
- **[AIScoringModelDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aiscoringmodeldefinition.htm)**  
    Represents information about a machine learning model that’s used by the Scoring Framework for Industries Cloud Einstein. The machine learning model is used for scoring, including its configuration.
- **[AIUsecaseDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aiusecasedefinition.htm)**  
    Represents a collection of fields in your Salesforce org used to define a machine learning use case and get real-time predictions.
- **[AnalyticsDashboard](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_analyticsdashboard.htm)**  
    Represents a Tableau Next dashboard.
- **[AnalyticSnapshot](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_analyticsnapshot.htm)**  
    Represents a reporting snapshot. A reporting snapshot lets you report on historical data. Authorized users can save tabular or summary report results to fields on a custom object, then map those fields to corresponding fields on a target object. They can then schedule when to run the report to load the custom object's fields with the report's data. Reporting snapshots enable you to work with report data similarly to how you work with other records in Salesforce.
- **[AnalyticsVisualization](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_analyticsvisualization.htm)**  
    Represents a Tableau Next visualization.
- **[AnalyticsWorkspace](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_analyticsworkspace.htm)**  
    Represents a Tableau Next workspace.
- **[AnimationRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_animationrule.htm)**  
    Represents criteria for determining when an animation is displayed to Path users.This type extends the Metadata metadata type and inherits its fullName field.
- **[AppFrameworkApp](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_appframeworkapp.htm)**  
    Represents an installed app framework app.
- **[AppFrameworkTemplateBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_appframeworktemplatebundle.htm)**  
    Represents the app framework template bundle. Use these templates for Data 360 and Tableau Next assets.
- **[ArticleType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_articletype.htm)**  
    Represents the metadata associated with an article type.
- **[ApexClass](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_classes.htm)**  
    Represents an Apex class. An Apex class is a template or blueprint from which Apex objects are created. Classes consist of other classes, user-defined methods, variables, exception types, and static initialization code.
- **[ApexComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_component.htm)**  
    Represents a Visualforce component.
- **[ApexEmailNotifications](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexemailnotifications.htm)**  
    The ApexEmailNotifications type allows you to define users and email addresses that receive email for unhandled Apex errors. Flow errors can also use this metadata type.
- **[ApexPage](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pages.htm)**  
    Represents a Visualforce page.
- **[ApexTestSuite](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apextestsuite.htm)**  
    Represents a suite of Apex test classes to include in a test run.
- **[ApexTrigger](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_triggers.htm)**  
    Represents an Apex trigger. A trigger is Apex code that executes before or after specific data manipulation language (DML) events occur, such as before object records are inserted into the database, or after records have been deleted.
- **[AppMenu](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_appmenu.htm)**  
    Represents the app menu or the Salesforce mobile navigation menu. Reserved for future use.
- **[AppointmentAssignmentPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_appointmentassignmentpolicy.htm)**  
    Represents the information about a resource assignment rule. This type extends the Metadata metadata type and inherits its fullName field.
- **[AppointmentSchedulingPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_appointmentschedulingpolicy.htm)**  
    Represents a set of rules for scheduling appointments using Lightning Scheduler. This type extends the Metadata metadata type and inherits its fullName field.
- **[ApprovalProcess](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_approvalprocess.htm)**  
    Represents the metadata associated with an approval process. An approval process automates how records are approved in Salesforce. An approval process specifies each step of approval, including who to request approval from and what to do at each point of the process.
- **[AssignmentRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_assignmentrule.htm)**  
    Represents assignment rules that allow you to automatically route cases to the appropriate users or queues. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object.
- **[AssessmentQuestion](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_assessmentquestion.htm)**  
    Represents the container object that stores the questions required for an assessment.
- **[AssessmentQuestionSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_assessmentquestionset.htm)**  
    Represents the container object for Assessment Questions.
- **[Audience](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_audience.htm)**  
    Represents the audience in an Experience Builder site. An audience consists of different types of criteria, where the audience can be assigned and used for targeting in a site. This type extends the Metadata metadata type and inherits its fullName field.
- **[AuraDefinitionBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_auradefinitionbundle.htm)**  
    Represents an Aura definition bundle. A bundle contains an Aura definition, such as an Aura component, and its related resources, such as a JavaScript controller. The definition can be a component, application, event, interface, or a tokens collection.
- **[AuthProvider](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_authproviders.htm)**  
    Represents an authentication provider (auth provider). An auth provider lets users log in to Salesforce from an external service provider such as Facebook, Google, or GitHub. This type extends the Metadata metadata type and inherits its fullName field.
- **[AutoResponseRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_autoresponserules.htm)**  
    Represents an auto-response rule that sets conditions for sending automatic email responses to lead or case submissions based on the attributes of the submitted record. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object.
- **[BatchCalcJobDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_batchcalcjobdefinition.htm)**  
    Represents a Data Processing Engine definition.
- **[BatchProcessJobDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_batchprocessjobdefinition.htm)**  
    Represents the details of a Batch Management job definition.
- **[BillingSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_billingsettings.htm)**  
    Represents the settings for Salesforce Billing.
- **[BlacklistedConsumer](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_blacklistedconsumer.htm)**  
    Represents a connected app that is inaccessible to your Salesforce org’s users. This type extends the Metadata metadata type and inherits its fullName field.
- **[Bot](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_bot.htm)**  
    Represents a definition of an Einstein Bot configuration that can have one or more versions. Only one version can be active.
- **[BotBlock](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_botblock.htm)**  
    Represents the configuration details for a specific Einstein Bot block, including dialogs and variables.
- **[BotTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_bottemplate.htm)**  
    Represents the configuration details for a specific Einstein Bot template, including dialogs and variables.
- **[BotVersion](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_botversion.htm)**  
    Represents the configuration details for a specific Einstein Bot version, including dialogs and variables.
- **[BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm)**  
    Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.
- **[BriefcaseDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_briefcasedefinition.htm)**  
    Represents a briefcase definition. A briefcase makes selected records available for specific users and groups to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android. This type extends the Metadata metadata type and inherits its fullName field.
- **[BusinessProcessGroup](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_businessprocessgroup.htm)**  
    Represents the surveys used to track customers’ experiences across different stages in their lifecycle. This type extends the Metadata metadata type and inherits its fullName field.
- **[CallCenter](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_callcenter.htm)**  
    Represents the Call Center definition used to integrate Salesforce with a third-party computer-telephony integration (CTI) system, a partner telephony system, or partner Contact Center as a Service (CCaaS) system.
- **[CallCenterRoutingMap](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_callcenterroutingmap.htm)**  
    Represents the mapping between a user or queue in a Salesforce org to a user or queue in an external system’s call center.
- **[CallCoachingMediaProvider](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_callcoachingmediaprovider.htm)**  
    Represents the CallCoachingMediaProvider configuration. Use CallCoachingMediaProvider to configure which providers of voice recordings that Einstein Conversation Insights can use. For example, Sales Dialer can provide voice recordings. Einstein Conversation Insights then stores and analyzes call recordings to surface insights and trends in customer conversations.This type extends the Metadata metadata type and inherits its fullName field.
- **[CampaignInfluenceModel](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_campaigninfluencemodel.htm)**  
    Represents a campaign influence model used by Customizable Campaign Influence. You can’t configure Customizable Campaign Influence via the Metadata API, but you can add a campaign influence model.
- **[CaseSubjectParticle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_casesubjectparticle.htm)**  
    Represents the Social Business Rules custom format for the **Case Subject** field on cases created from inbound social posts.
- **[CareBenefitVerifySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_carebenefitverifysettings.htm)**  
    Represents the configuration settings for benefit verification requests.
- **[CareLimitType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_carelimittype.htm)**  
    Defines the characteristics of limits on benefit provision.
- **[CareSystemFieldMapping](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_caresystemfieldmapping.htm)**  
    Represents a mapping from source system fields to Salesforce objects and fields. This type extends the Metadata metadata type and inherits its fullName field.
- **[CareProviderSearchConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_careprovidersearchconfig.htm)**  
    Represents the information about the fields that appear in care provider search results. This type extends the Metadata metadata type and inherits its fullName field.
- **[CareRequestConfiguration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_carerequestconfiguration.htm)**  
    Represents the details for a record type such as service request, drug request, or admission request. One or more record types can be associated with a care request.
- **[CatalogedApi](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_catalogedapi.htm)**  
    Represents an API brought into API Catalog for Salesforce from an external source.
- **[CatalogedApiArtifactVersionInfo](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_catalogedapiartifactversioninfo.htm)**  
    Represents API version information in API Catalog that’s referenced by other entities.
- **[CatalogedApiVersion](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_catalogedapiversion.htm)**  
    Represents a version of an API that is consumable in Salesforce using API Catalog.
- **[Certificate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_certificate.htm)**  
    Represents a certificate used for digital signatures that verify that requests are coming from your org. Certificates are used for either authenticated single sign-on with an external website, or when using your org as an identity provider. This type extends the Metadata With Content metadata type and inherits its content and fullName fields.
- **[ChatterExtension](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_chatterextensions.htm)**  
    Represents the metadata used to describe a Rich Publisher App that’s integrated with the Chatter publisher.
- **[ChoiceList](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_choicelist.htm)**  
    Represents the Choicelist dropdown field that’s used for pre-chat.
- **[ClaimFinancialSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_claimfinancialsettings.htm)**  
    Represents the configuration settings for Insurance Claim Financial Services.
- **[ClauseCatgConfiguration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_clausecatgconfiguration.htm)**  
    Represents the configuration about the clause category that can be used to categorize your disclosure and compliance reports from standardized disclosure templates in a response document.
- **[CleanDataService](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cleandataservice.htm)**  
    Represents a data service that adds and updates data in standard objects.
- **[CMSConnectSource](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cmsconnectsource.htm)**  
    Represents the connection information for external content management systems that feed content to Experience Builder sites. This type extends the Metadata metadata type and inherits its fullName field.
- **[Community (Zone)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_community.htm)**  
    Represents a zone that contains Ideas or Chatter Answers objects. Zones are shared by the Ideas, Answers, and Chatter Answers features, allowing you to view and create zones from those locations.This type extends the Metadata metadata type and inherits its fullName field.
- **[CommerceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_commercesettings.htm)**  
    Represents settings for various Commerce features.
- **[CommunityTemplateDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_communitytemplatedefinition.htm)**  
    Represents the definition of an Experience Builder site template. This type extends the Metadata metadata type and inherits its fullName field.
- **[CommunityThemeDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_communitythemedefinition.htm)**  
    Represents the definition of a theme for an Experience Builder site. This type extends the Metadata metadata type and inherits its fullName field.
- **[ConnectedApp](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_connectedapp.htm)**  
    Represents a connected app configuration. A connected app enables an external application to integrate with Salesforce using APIs and standard protocols, such as SAML, OAuth, and OpenID Connect. Connected apps use these protocols to authenticate, authorize, and provide single sign-on (SSO) for external apps. The external apps that are integrated with Salesforce can run on the customer success platform, other platforms, devices, or SaaS subscriptions.
- **[ContentAsset](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_contentasset.htm)**  
    Represents the metadata for creating an asset file. Asset files enable a Salesforce file to be used for org setup and configuration purposes. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.
- **[ContentTypeBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_contenttypebundle.htm)**  
    Represents the definition of enhanced custom content types for use with enhanced CMS workspaces. When you create an enhanced custom content type, deploy this bundle to your org. Enhanced custom content types are displayed as forms with defined fields. When deployed, enhanced custom content types are available for use with enhanced LWR site channels. To use enhanced custom content types with Aura and non-enhanced LWR site channels, use enhanced CMS workspaces resources.
- **[ContextDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_contextdefinition.htm)**  
    Represents the details of a context definition that describe the relationship between the node structures within a context.
- **[ConversationMessageDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_conversationmessagedefinition.htm)**  
    Represents a messaging component in an Enhanced Messaging channel or Messaging for In-App and Web session.
- **[ConversationMessageDefinitionTranslation](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_conversationmessagedefinitiontranslation.htm)**  
    Represents translated labels and constant values for conversation message definitions in Enhanced Messaging and Messaging for In-App and Web.
- **[ConversationVendorInfo](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_conversationvendorinfo.htm)**  
    Represents the connection between the partner vendor system and the Service Cloud feature. For example, for Service Cloud Voice, this type contains information about the partner telephony system or Contact Center as a Service (CCaaS) system. For Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS, this type contains information about the partner messaging system or CCaaS system.
- **[ConvIntelligenceSignalRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_convintelligencesignalrule.htm)**  
    Represents the conversation intelligence signal rule. The rule triggers actions based on real-time intelligence signals from your telephony system or keywords mentioned by support reps or customers. The rule contains a set of conditions (subrules) and the filter logic used to evaluate those conditions to determine whether to trigger actions.
- **[CorsWhitelistOrigin](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_corswhitelistorigin.htm)**  
    Represents an origin in the CORS allowlist.
- **[CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_csptrustedsite.htm)**  
    Represents a trusted URL. For each CspTrustedSite component, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite components included only CSP directives and were referred to as CSP Trusted Sites.
- **[CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customapplication.htm)**  
    CustomApplication represents a custom or standard application. In API version 29.0 and earlier, CustomApplication represents only a custom application. An application is a list of tab references, with a description and a logo. This type extends the Metadata metadata type and inherits its fullName field.
- **[CustomApplicationComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customapplicationcomponent.htm)**  
    Represents a custom console component (Visualforce page) assigned to a CustomApplication that is marked as a Salesforce console. Custom console components extend the capabilities of Salesforce console apps. See Customize a Console with Custom Components in Salesforce Classic in Salesforce Help.
- **[CustomFeedFilter](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customfeedfilter.htm)**  
    Represents a custom feed filter that limits the feed view to feeds from the Cases object. The custom feed filter shows only feed items that satisfy the criteria specified in the CustomFeedFilter definition. This type extends the Metadata metadata type and inherits its fullName field.
- **[CustomFieldDisplay](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customfielddisplay.htm)**  
    Represents the view type assigned to product attribute custom fields. This type extends the Metadata metadata type and inherits its fullName field.
- **[CustomHelpMenuSection](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customhelpmenusection.htm)**  
    Represents the section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources for the org. The custom section contains help resources added by the admin. This type extends the Metadata metadata type and inherits its fullName field.
- **[CustomIndex](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customindex.htm)**  
    Represents an index used to increase the speed of queries.This type extends the Metadata metadata type and inherits its fullName field.
- **[CustomLabels](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customlabels.htm)**  
    The CustomLabels metadata type allows you to create custom labels that can be localized for use in different languages, countries, and currencies.
- **[Custom Metadata Types (CustomObject)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_custommetadatatypes.htm)**  
    Represents the metadata associated with a custom metadata type.
- **[CustomNotificationType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customnotificationtype.htm)**  
    Represents the metadata associated with a custom notification type.
- **[CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm)**  
    Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.
- **[CustomObjectTranslation](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customobjecttranslation.htm)**  
    This metadata type allows you to translate custom objects for a variety of languages.
- **[CustomPageWebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/custompageweblink.htm)**  
    Represents a custom link defined in a home page component.
- **[CustomPermission](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_custompermission.htm)**  
    Represents a permission that grants access to a custom feature. This type extends the Metadata metadata type and inherits its fullName field.
- **[CustomSite](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sites.htm)**  
    Represents a Salesforce site. Create public websites and applications that are directly integrated with your Salesforce organization, but don't require users to log in with a username and password.
- **[CustomTab](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_tab.htm)**  
    Represents a custom tab. Custom tabs let you display custom object data or other web content in Salesforce. When you add a custom tab to an app in Salesforce Classic, it appears as a tab. When you add a custom tab to an app in Lightning Experience, it appears as an item in the app’s navigation bar and in the App Launcher. When a tab displays a custom object, the tab name is the same as the custom object name. For page, s-control, or URL tabs, the name is arbitrary.
- **[CustomValue](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customvalue.htm)**  
    Represents the definition of a value used in a global value set or local custom picklist. Custom picklist fields can be local and unique, or can inherit their values from a global picklist (called a global value set in API version 38.0). This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.
- **[Dashboard](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dashboard.htm)**  
    Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.
- **[DataCategoryGroup](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datacategorygroup.htm)**  
    Represents a data category group.
- **[DataMaskPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datamaskpolicy.htm)**  
    Represents a masking policy for use with Data Mask & Seed.
- **[DataMaskSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datamasksettings.htm)**  
    Represents org-level setup (features and preferences) for use with Data Mask & Seed.
- **[DataObjectSearchIndexConf](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dataobjectsearchindexconf.htm)**  
    Represents the source Data 360 data model object (DMO) for Search Answers and holds the search index that Search Answers uses when searching DMO records.
- **[DataWeaveResource](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dataweaveresource.htm)**  
    Represents the DataWeaveScriptResource class that is generated for all DataWeave scripts. DataWeave scripts can be directly invoked from Apex.
- **[DecisionTable](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_decisiontable.htm)**  
    Represents the information about a decision table.
- **[DecisionTableDatasetLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_decisiontabledatasetlink.htm)**  
    Represents the information about a dataset link associated with a decision table. In a dataset link, select an object for whose records, the decision table must provide an outcome. This type extends the Metadata metadata type and inherits its fullName field.
- **[DecisionMatrixDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_decisionmatrixdefinition.htm)**  
    Represents a definition of a decision matrix.
- **[DelegateGroup](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delegategroup.htm)**  
    Represents a group of users who have the same administrative privileges. These groups are different from public groups used for sharing.
- **[DgtAssetMgmtProvider](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dgtassetmgmtprovider.htm)**  
    Represents external content providers, such as digital asset management (DAM) systems, that integrate with Salesforce CMS. When combined with the DgtAssetMgmtPrvdLghtCpnt type, this metadata type enables organizations to configure external content systems as content providers within the Salesforce platform.
- **[DgtAssetMgmtPrvdLghtCpnt](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dgtassetmgmtprvdlghtcpnt.htm)**  
    Represents the Lightning web component configurations for external content providers, such as digital asset management (DAM) systems. This metadata type enables the integration of external content systems with Salesforce CMS using custom Lightning web components.
- **[DigitalExperienceBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm)**  
    Represents a text-based code structure of your organization’s workspaces, organized by workspace type, and each workspace’s content items.
- **[DigitalExperienceConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperienceconfig.htm)**  
    Represents details for your organization’s workspaces, such as the site label, site URL path prefix, and workspace type.
- **[DisclosureDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_disclosuredefinition.htm)**  
    Represents information that defines a disclosure type, such as details of the publisher or vendor who created or implemented the report.
- **[DisclosureDefinitionVersion](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_disclosuredefinitionversion.htm)**  
    Represents the version information about the disclosure definition.
- **[DisclosureType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_disclosuretype.htm)**  
    Represents the types of disclosures that are done by an individual or an organization and the associated metadata.
- **[DiscoveryAIModel](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_discoveryaimodel.htm)**  
    Represents the metadata associated with a model used in Einstein Discovery.
- **[DiscoveryGoal](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_discoverygoal.htm)**  
    Represents the metadata associated with an Einstein Discovery prediction definition.
- **[DiscoveryStory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_discoverystory.htm)**  
    Represents the metadata associated with a story used in Einstein Discovery.
- **[Document](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_document.htm)**  
    Represents a Document. All documents must be in a document folder, such as sampleFolder/TestDocument.
- **[DocumentCategory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_documentcategory.htm)**  
    Represents a document category.
- **[DocumentCategoryDocumentType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_documentcategorydocumenttype.htm)**  
    Represents the junction between a DocumentCategory and a DocumentType. Puts a DocumentType in a DocumentCategory.
- **[DocumentChecklistSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_documentchecklistsettings.htm)**  
    Represents an org’s DocumentChecklistItem settings.
- **[DocumentType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_documenttype.htm)**  
    Represents a document type.
- **[DuplicateRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_duplicaterule.htm)**  
    Represents a rule that specifies how duplicate records in an object are detected. This type extends the Metadata metadata type and inherits its fullName field.
- **[EclairGeoData](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eclairgeodata.htm)**  
    Represents an Analytics custom map chart. Custom maps are user-defined maps that are uploaded to Analytics and are used just as standard maps are. Custom maps are accessed in Analytics from the list of maps available with the map chart type.
- **[EmailServicesFunction](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailservicesfunction.htm)**  
    Represents an email service. This type extends the Metadata metadata type and inherits its fullName field.
- **[EmailTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailtemplate.htm)**  
    Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only.
- **[EmbeddedServiceBranding](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_embeddedservicebranding.htm)**  
    Represents the branding for each Embedded Service deployment. This type extends the Metadata metadata type and inherits its fullName field.
- **[EmbeddedServiceConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_embeddedserviceconfig.htm)**  
    Represents a setup node for creating an Embedded Service for Web deployment. This type extends the Metadata metadata type and inherits its fullName field.
- **[EmbeddedServiceFieldService](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_embeddedservicefieldservice.htm)**  
    Represents a setup node for creating an embedded Appointment Management deployment. This type extends the Metadata metadata type and inherits its fullName field.
- **[EmbeddedServiceFlowConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_embeddedserviceflowconfig.htm)**  
    Represents a setup node for creating an embedded flow. This type extends the Metadata metadata type and inherits its fullName field.
- **[EmbeddedServiceLiveAgent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_embeddedserviceliveagent.htm)**  
    Represents a setup node for creating an embedded chat deployment. This type extends the Metadata metadata type and inherits its fullName field.
- **[EmbeddedServiceMenuSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_embeddedservicemenusettings.htm)**  
    Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business. This type extends the Metadata metadata type and inherits its fullName field.
- **[EnablementMeasureDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_enablementmeasuredefinition.htm)**  
    Represents an Enablement measure, which specifies the job-related activity that a user performs to complete a milestone or outcome in an Enablement program. A measure identifies a source object and optional related objects, with optional field filters and filter logic, for tracking the activity. To avoid deployment errors, deploy measures before you deploy programs.
- **[EnablementProgramDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_enablementprogramdefinition.htm)**  
    Represents an Enablement program, which includes exercises and measurable milestones to help users such as sales reps achieve specific outcomes related to your company’s revenue goals.
- **[EnblProgramTaskSubCategory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_enblprogramtasksubcategory.htm)**  
    Represents a custom exercise type that an Enablement admin adds to an Enablement program in Program Builder. A custom exercise type also requires a corresponding EnblProgramTaskDefinition record for Program Builder and corresponding LearningItem and LearningItemType records for when users take the exercise in the Guidance Center.
- **[EntitlementProcess](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_entitlementprocess.htm)**  
    Represents the settings for an entitlement process.
- **[EntitlementTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_entitlementtemplate.htm)**  
    Represents an entitlement template. Entitlement templates are predefined terms of customer support that you can quickly add to products. For example, you can create entitlement templates for Web or phone support so that users can easily add entitlements to products offered to customers.
- **[EscalationRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_escalationrules.htm)**  
    Represents case escalation rules to escalate cases automatically if they aren’t resolved within a certain time. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object.
- **[EventDelivery](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eventdelivery.htm)**  
    Represents how an event instance maps to a target payload. Removed in API version 46.0. This type extends the Metadata metadata type and inherits its fullName field.
- **[EventRelayConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eventrelayconfig.htm)**  
    Represents the configuration of an event relay, which relays platform events and change data capture events from Salesforce to Amazon EventBridge.
- **[EventSubscription](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eventsubscription.htm)**  
    Represents a subscription to an event type. Removed in API version 46.0. This type extends the Metadata metadata type and inherits its fullName field.
- **[ExperienceBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencebundle.htm)**  
    Represents a text-based code structure of the settings and site components, such as pages, branding sets, and themes that make up an Experience Builder site. Developers can quickly update and deploy Experience Builder sites _programmatically_ using their preferred development tools. This type extends the Metadata metadata type and inherits its fullName field.
- **[ExperiencePropertyTypeBundle (Beta)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencepropertytypebundle.htm)**  
    Represents a property type. Replaced in Spring ’26 by the updated LightningPropertyType. When you create a custom property type for a Lightning web component, use LightningPropertyType instead, and deploy that bundle to your org.
- **[ExplainabilityMsgTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_explainabilitymsgtemplate.htm)**  
    Represents information about the template that contains the decision explanation message for a specified expression set step type.
- **[ExpressionSetDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_expressionsetdefinition.htm)**  
    Represents an expression set definition.
- **[ExpressionSetMessageToken](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_expressionsetmessagetoken.htm)**  
    Represents an interface to retrieve, deploy, create, update, or delete information on Expression Set Message Token.
- **[ExpressionSetObjectAlias](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_expressionsetobjectalias.htm)**  
    Represents information about the alias of the source object that’s used in an expression set.
- **[ExternalAuthIdentityProvider](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalauthidentityprovider.htm)**  
    Represents an external authentication (auth) identity provider. An external auth identity provider links to an external credential and obtains OAuth tokens for outbound callouts to external systems.
- **[ExternalClientApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalclientapplication.htm)**  
    Represents the header file for an external client application configuration.
- **[ExternalCredential](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalcredential.htm)**  
    Represents the details of how Salesforce authenticates to the external system.
- **[ExternalAIModel](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalaimodel.htm)**  
    Represents the state of a given model for an Einstein for Service feature, such as Einstein Reply Recommendations.
- **[ExternalServiceRegistration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalserviceregistration.htm)**  
    Represents the external service configuration for an org.
- **[ExtlClntAppCanvasSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappcanvassettings.htm)**  
    Represents an external client app’s canvas app settings.
- **[ExtlClntAppConfigurablePolicies](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappconfigurablepolicies.htm)**  
    Represents the policies for an external client app to disable or enable plugins.
- **[ExtlClntAppGlobalOauthSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappglobaloauthsettings.htm)**  
    Represents the global settings for the OAuth plugin in an external client app. These settings include private and sensitive OAuth consumer information that can’t be packaged and must not be added to source control.
- **[ExtlClntAppMobileConfigurablePolicies](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappmobileconfigurablepolicies.htm)**  
    Represents an external client app’s mobile policies configuration.
- **[ExtlClntAppMobileSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappmobilesettings.htm)**  
    Represents an external client app’s mobile app settings, such as screen lock on a mobile device.
- **[ExtlClntAppNotificationSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappnotificationsettings.htm)**  
    Represents an external client app’s notification subscriptions for mobile.
- **[ExtlClntAppOauthConfigurablePolicies](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappoauthconfigurablepolicies.htm)**  
    Represents the policies configured by the admin for an OAuth-enabled external client app.
- **[ExtlClntAppOauthSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappoauthsettings.htm)**  
    Represents the settings configuration for the external client app’s OAuth plugin.
- **[ExtlClntAppPushConfigurablePolicies](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntapppushconfigurablepolicies.htm)**  
    Represents an external client app’s push notification policies configuration.
- **[ExtlClntAppPushSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntapppushsettings.htm)**  
    Represents an external client app’s push notification settings.
- **[ExtlClntAppSamlConfigurablePolicies](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappsamlconfigurablepolicies.htm)**  
    Represents SAML configuration policies for an external client app. Use this type to configure Salesforce as an identity provider for SAML single sign-on (SSO). In this type of SSO configuration, users log in to a third-party service provider, such as Google, using their Salesforce credentials.
- **[FeatureParameterBoolean](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_featureparameterboolean.htm)**  
    Represents a boolean feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package. This type extends the Metadata metadata type and inherits its fullName field.
- **[FeatureParameterDate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_featureparameterdate.htm)**  
    Represents a date feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package. This type extends the Metadata metadata type and inherits its fullName field.
- **[FeatureParameterInteger](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_featureparameterinteger.htm)**  
    Represents an integer feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package. This type extends the Metadata metadata type and inherits its fullName field.
- **[FieldMappingConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/npc_fundraising_api_objects_fieldmappingconfig.htm)**  
    Represents the configuration for fields mapped between a source object and one or more destination objects and fields. This object is available in API version 63.0 and later.
- **[FieldRestrictionRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fieldrestrictionrule.htm)**  
    Represents a field visibility rule that controls whether a field is visible to a user, based on the field’s inclusion in a field set. If Enhanced Personal Information Management setting was enabled before Spring ’22, field visibility is based on the field’s compliance categorization. This type extends the Metadata metadata type and inherits its fullName field.
- **[FlexiPage](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_flexipage.htm)**  
    Represents the metadata associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components.
- **[Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm)**  
    Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.
- **[FlowCategory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_flowcategory.htm)**  
    Represents a list of flows that are grouped by category. Flows aren’t added directly to a Lightning Bolt Solution. Instead, add the category the flows are in to the Lightning Bolt Solution. This type extends the Metadata metadata type and inherits its fullName field.
- **[FlowDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_flowdefinition.htm)**  
    Represents the flow definition’s description and active flow version number.
- **[FlowTest](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_flowtest.htm)**  
    Represents the metadata associated with a flow test. Before you activate a record-triggered, autolaunched, or Data Cloud-triggered flow, you can test it to verify its expected results and identify flow run-time failures.
- **[FlowValueMap](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_flowvaluemap.htm)**  
    Represents the metadata associated with creating a reusable entity for defining and managing mappings between source and target values used within a flow.
- **[Folder](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_folder.htm)**  
    Represents a folder. This type extends the Metadata metadata type and inherits its fullName field.
- **[ForecastingFilter](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingfilter.htm)**  
    Represents the custom filter for including or excluding data from opportunity forecasts.
- **[ForecastingFilterCondition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingfiltercondition.htm)**  
    Represents the custom filter condition logic for including or excluding data from opportunity forecasts.
- **[ForecastingSourceDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingsourcedefinition.htm)**  
    Represents the object, measure, date type, and hierarchy that a forecast uses to project sales.
- **[ForecastingType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingtype.htm)**  
    Represents a forecast type.
- **[ForecastingTypeSource](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingtypesource.htm)**  
    Represents the mapping of a forecasting source definition to a forecast type.
- **[FuelType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fueltype.htm)**  
    Represents a custom fuel type in an org.
- **[FuelTypeSustnUom](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fueltypesustnuom.htm)**  
    Represents a mapping between the custom fuel types and their corresponding unit of measure (UOM) values defined by a customer in an org.
- **[FunctionReference](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_functionreference.htm)**  
    Represents information about a deployed Salesforce Function that can be invoked from the org. This type extends the Metadata metadata type and inherits its fullName field.
- **[FundraisingConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fundraisingconfig.htm)**  
    Represents a collection of settings to configure the fundraising product.
- **[GatewayProviderPaymentMethodType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_gatewayproviderpaymentmethodtype.htm)**  
    Represents an entity that allows integrators and payment providers to choose an active payment to receive an order's payment data rather than allowing the Salesforce Order Management platform to select a default payment method. This object is available in API version 51 and later.
- **[GenAiFunction](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaifunction.htm)**  
    Represents an agent action that can be added to an AI agent.
- **[GenAiPlanner](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplanner.htm)**  
    Represents a planner for an agent. It’s a container for all the topics and actions used to interact with a large language model (LLM).
- **[GenAiPlannerBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplannerbundle.htm)**  
    Represents a planner for an agent or agent template. It’s a container for all the topics and actions used to interact with a large language model (LLM).
- **[GenAiPlugin](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm)**  
    Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents.
- **[GenAiPluginInstructionDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugininstructiondef.htm)**  
    Represents a topic instruction.
- **[GenAiPromptTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiprompttemplate.htm)**  
    Represents the definition of a prompt template, including its related objects and fields.
- **[GenAiPromptTemplateActv](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiprompttemplateactv.htm)**  
    Represents the activation status of a Salesforce-provided prompt template.
- **[GiftEntryGridTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_giftentrygridtemplate.htm)**  
    Represents templates that customize the gift entry grid in Fundraising.
- **[GlobalPicklist](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalpicklist.htm)**  
    Represents a global picklist, or the set of shared picklist values that custom picklist fields can use. In contrast, the custom picklist fields that are based on a global picklist are of type CustomValue. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.
- **[GlobalPicklistValue](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalpicklistvalue.htm)**  
    Represents the definition of a value used in a global picklist. Custom picklist fields can inherit the picklist value set from a global picklist.
- **[GlobalValueSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalvalueset.htm)**  
    Represents the metadata for a global picklist value set, which is the set of shared values that custom picklist fields can use. A global value set isn’t a field itself. In contrast, the custom picklist fields that are based on a global picklist are of type ValueSet. This type extends the Metadata metadata type and inherits its fullName field.
- **[GlobalValueSetTranslation](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalvaluesettranslation.htm)**  
    Contains details for a global value set translation. Global value sets are lists of values that can be shared by multiple custom picklist fields, optionally across objects. This type extends the Metadata metadata type and inherits its fullName field.
- **[GoogleAppsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_googleappssettings.htm)**  
    Represents the settings for Google Apps in Salesforce.
- **[Group](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_group.htm)**  
    Represents a set of public groups, which can have users, roles, and other groups.
- **[HomePageComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm)**  
    Represents the metadata associated with a home page component. You can customize the Home tab in Salesforce Classic to include components such as sidebar links, a company logo, a dashboard snapshot, or custom components that you create. Use to create, update, or delete home page component definitions.
- **[HomePageLayout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm)**  
    Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile.
- **[IdentityVerificationProcDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_identityverificationprocdef.htm)**  
    Represents the definition of the identity verification process.
- **[IdentityVerificationProcDtl](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_identityverificationprocdtl.htm)**  
    Represents the search functionality configuration and the minimum number of optional verifiers for identity verification. This type extends the Metadata metadata type and inherits its fullName field.
- **[IdentityVerificationProcFld](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_identityverificationprocfld.htm)**  
    Represents the search and verification fields used in identity verification. This type extends the Metadata metadata type and inherits its fullName field.
- **[InboundCertificate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_inboundcertificate.htm)**  
    Represents a mutual authentication certificate that is imported to your Salesforce org.
- **[InboundNetworkConnection](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_inboundnetworkconnection.htm)**  
    Represents a private connection between a third-party data service and a Salesforce org. The connection is inbound because the callouts are coming _into_ Salesforce.This type extends the Metadata metadata type and inherits its fullName field.
- **[IndustriesPricingSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_industriespricingsettings.htm)**  
    Represents the settings for Salesforce Pricing.
- **[IndustriesRatingSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_industriesratingsettings.htm)**  
    Represents the settings for Rate Management.
- **[IndustriesUnifiedInventorySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_industriesunifiedinventorysettings.htm)**  
    Represents the settings for Industries Unified Inventory.
- **[InsPlcyLimitConsumptionRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_insplcyLimitconsumptionrule.htm)**  
    Represents configuration for how policy limit consumption rule applies to an insurance policy product, including consumption mode and product binding.
- **[InstalledPackage](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_installedpackage.htm)**  
    Represents a first-generation managed package to be installed or uninstalled. Deploying a newer version of a currently installed package upgrades the package. You can install up to 20 first-generation managed packages in a single deployment. To install an unlocked or second-generation managed package, use the sf package install Salesforce CLI command.
- **[IntegArtifactDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_integartifactdef.htm)**  
    Represents an integration artifact definition.
- **[IntegrationProviderDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_integrationproviderdef.htm)**  
    Represents an integration definition associated with a service process. Stores data for the Industries: Send Apex Async Request and Industries: Send External Async Request invocable actions.
- **[IPAddressRange](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ipaddressrange.htm)**  
    Represents a range of IP addresses to include in or exclude from the specified feature.
- **[InvocableActionExtension](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_invocableactionextension.htm)**  
    Represents the configuration that defines how an action's inputs are presented in a user interface.
- **[KeywordList](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_keywordlist.htm)**  
    Represents a list of keywords used in Experience Cloud site moderation. This keyword list is a type of moderation criteria that defines offensive language or inappropriate content that you don’t want in your site.
- **[Layout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_layouts.htm)**  
    Represents the metadata associated with a page layout. For more information, see Page Layouts in Salesforce Help.
- **[LearningItemType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_learningitemtype.htm)**  
    Represents a custom exercise type that an Enablement user takes in an Enablement program in the Guidance Center. A custom exercise type also requires a corresponding LearningItem record for the Guidance Center and corresponding EnblProgramTaskDefinition and EnblProgramTaskSubCategory records for when admins create a program in Program Builder.
- **[Letterhead](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_letterhead.htm)**  
    Represents formatting options for the letterhead in an email template. A letterhead defines the logo, page color, and text settings for your HTML email templates. Use letterheads to ensure a consistent look and feel in your company’s emails.
- **[LightningBolt](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningbolt.htm)**  
    Represents the definition of a Lightning Bolt Solution, which can include custom apps, flow categories, and Experience Builder templates. This type extends the Metadata metadata type and inherits its fullName field.
- **[LightningComponentBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningcomponentbundle.htm)**  
    Represents a Lightning web component bundle. A bundle contains Lightning web component resources.
- **[LightningExperienceTheme](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningexperiencetheme.htm)**  
    Represents the details of a custom theme, including the [BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm#meta_brandingset "Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme."). Themes enable admins to specify configurable attributes, such as three colors and five images. The colors and some of the images override SLDS token values and influence the generation of app.css.
- **[LightningMessageChannel](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningmessagechannel.htm)**  
    Represents the metadata associated with a Lightning Message Channel. A Lightning Message Channel represents a secure channel to communicate across UI technologies, such as Lightning Web Components, Aura Components, and Visualforce.
- **[LightningOnboardingConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningonboardingconfig.htm)**  
    Represents the feedback provided when users switch from Lightning Experience to Salesforce Classic. Admins can customize the question, how frequently the form appears, and where the feedback is stored in Chatter from the Adoption Assistance page in Lightning Experience Setup. This type extends the Metadata metadata type and inherits its fullName field.
- **[LightningTypeBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningtypebundle.htm)**  
    Represents a custom Lightning type. Use this type to override the default user interface to create a customized appearance based on your business requirements. Deploy this bundle to your organization to implement the overrides.
- **[LiveChatAgentConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_livechatagentconfig.htm)**  
    Represents the configuration of an organization’s Chat deployment, such as how many chats can be assigned to an agent and whether chat sounds are enabled.
- **[LiveChatButton](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_livechatbutton.htm)**  
    Represents a Chat deployment’s settings for the button that customers click to chat with an agent and the chat window, such as the label that appears on the button and the pre-chat form that appears before a chat begins. This type extends the Metadata metadata type and inherits its fullName field.
- **[LiveChatDeployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_livechatdeployment.htm)**  
    Represents the configuration settings for a specific Chat deployment, such as the branding image for the deployment and whether or not chat transcripts are automatically saved.
- **[LiveChatSensitiveDataRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_livechatsensitivedatarule.htm)**  
    Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex).
- **[LoyaltyProgramSetup](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_loyaltyprogramsetup.htm)**  
    Represents the configuration of a loyalty program process including its parameters and rules. Program processes determine how new transaction journals are processed. When new transaction journals meet the criteria and conditions for a program process, actions that are set up in the process are triggered for the transaction journals.
- **[ManagedContentType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_managedcontenttype.htm)**  
    Represents the definition of custom content types for use with Salesforce CMS. Custom content types are displayed as forms with defined fields.
- **[ManagedEventSubscription (Beta)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_managedeventsubscription.htm)**  
    Represents a managed event subscription in Pub/Sub API. Use a managed event subscription to track the events that a subscriber client consumed and resume a subscription where it left off. This type extends the metadata type and inherits its fullName field.
- **[ManagedTopics](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_managedtopics.htm)**  
    Represents navigational and featured topics managed in an Experience Cloud site.
- **[MarketingAppExtension](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_marketingappextension.htm)**  
    Represents an integration with a third-party app or service that is used to work with prospects.
- **[MatchingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_matchingrule.htm)**  
    Represents a matching rule that is used to identify duplicate records.
- **[MessagingChannel](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_messagingchannel.htm)**  
    Represents the metadata associated with an Embedded Service Messaging channel.
- **[Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm)**  
    The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.
- **[MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm)**  
    MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.
- **[MfgProgramTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mfgprogramtemplate.htm)**  
    Represents a definition of a program to create a program-based business. A program-based business, also known as a Manufacturing Program, enables manufacturers to drive their business models with forecasting tools and manage the end-to-end sales process efficiently.
- **[MilestoneType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_milestonetype.htm)**  
    Represents the name and description of a milestone, which you can use in an entitlement process to track important steps in cases.
- **[MlDomain](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mldomain.htm)**  
    Represents an Einstein Intent Set.
- **[MLDataDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mldatadefinition.htm)**  
    Represents a modeling data definition, which specifies the data used to create a model. Such data can include filters, fields to include, fields to exclude, and so on. This type extends the Metadata metadata type and inherits its fullName field.
- **[MLPredictionDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mlpredictiondefinition.htm)**  
    Represents a prediction definition that specifies details about the prediction. This type extends the Metadata metadata type and inherits its fullName field.
- **[MobileApplicationDetail](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobileapplicationdetail.htm)**  
    Represents the packaging attributes for a mobile connected app. This type extends the Metadata metadata type and inherits its fullName field.
- **[MobileSecurityAssignment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobilesecurityassignment.htm)**  
    Represents the assignment of mobile app security policies to a profile. The policies apply to the Salesforce mobile app with Enhanced Mobile App Security enabled.
- **[MobileSecurityPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobilesecuritypolicy.htm)**  
    Represents a mobile app security policy on the Salesforce mobile app with Enhanced Mobile App Security enabled. For a full description of each policy, see [Enable and Configure Mobile App Security Policies](https://help.salesforce.com/s/articleView?id=xcloud.mobile_security_mam_setup_ui.htm&type=5&language=en_US).
- **[MobSecurityCertPinConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobsecuritycertpinconfig.htm)**  
    Represents the authentication server certificate pin configuration on the Salesforce mobile app with Enhanced Mobile Security.
- **[ModerationRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_moderationrule.htm)**  
    Represents a rule used in your Experience Cloud site to moderate member-generated content. Each rule specifies the member-generated content the rule applies to, the criteria to enforce the rule on, and the moderation action to take. Moderation rules help protect your site from spammers, bots, and offensive or inappropriate content. This type extends the Metadata metadata type and inherits its fullName field.
- **[MutingPermissionSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mutingpermissionset.htm)**  
    Represents a set of disabled permissions and is used in conjunction with [PermissionSetGroup](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionsetgroup.htm "Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed.").
- **[MyDomainDiscoverableLogin](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mydomaindiscoverablelogin.htm)**  
    Represents the configuration settings when the My Domain login page type is Discovery. Login Discovery provides an identity-first login experience, where the login page contains the identifier field only. Based on the identifier entered, a handler determines how to authenticate the user. This type extends the Metadata metadata type and inherits its fullName field.
- **[NamedCredential](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_namedcredential.htm)**  
    Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts.
- **[NavigationMenu](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_navigationmenu.htm)**  
    Represents the navigation menu in an Experience Builder site. A navigation menu consists of items that users can click to go to other parts of the site. This type replaces the NavigationLinkSet subtype on Network. NavigationMenu is available in API version 47.0 and later. This type extends the Metadata metadata type and inherits its fullName field.
- **[Network](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_network.htm)**  
    Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. If you want to create zones that contain Chatter Answers and Ideas, use the Community (Zone) component.
- **[NetworkBranding](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_networkbranding.htm)**  
    Represents the branding and color scheme applied to the login pages of an Experience Cloud site. (Experience Cloud sites are represented by the Network component.)
- **[NotificationTypeConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_notificationtypeconfig.htm)**  
    Represents the metadata associated with org-level notification settings for standard and custom notification types. This type extends the Metadata metadata type and inherits its fullName field.
- **[OauthCustomScope](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_oauthcustomscope.htm)**  
    Represents a permission defining the protected data that a connected app can access from an external entity when Salesforce is the OAuth authorization provider. This type extends the Metadata metadata type and inherits its fullName field.
- **[OauthTokenExchangeHandler](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_oauthtokenexchangehandler.htm)**  
    Represents a token exchange handler. The token exchange handler also consists of an Apex class. During the OAuth 2.0 token exchange flow, the token exchange handler is used to validate tokens from an external identity provider and to map users to Salesforce.
- **[OcrSampleDocument](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ocrsampledocument.htm)**  
    Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form. This type extends the Metadata metadata type and inherits its fullName field.
- **[OcrTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ocrtemplate.htm)**  
    Represents the details of the mapping between a form and a Salesforce object using Intelligent Form Reader. This type extends the Metadata metadata type and inherits its fullName field.
- **[OmniSupervisorConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_omnisupervisorconfig.htm)**  
    Represents the Omni-Channel supervisor configuration for an assigned group of supervisors.
- **[OrchestrationPlanCtxMapping](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_orchestrationplanctxmapping.htm)**  
    Represents the context mapping that Dynamic Revenue Orchestrator (DRO) uses to generate and orchestrate a plan for an object, such as a non-sales transaction for billing or another generic business process.
- **[OutboundNetworkConnection](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_outboundnetworkconnection.htm)**  
    Represents a private connection between a Salesforce org and a third-party data service. The connection is outbound because the callouts are going _out_ of Salesforce. This type extends the Metadata metadata type and inherits its fullName field.
- **[OnboardingDataObjectGroup](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_onboardingdataobjectgroup.htm)**  
    Represents a configuration that groups fields from one or more objects for a specific business purpose. For example, the Customer Contact Information onboarding data object group includes Name, Email, Phone Number, and Address.
- **[Package](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_package.htm)**  
    Specifies which metadata components to retrieve as part of a retrieve() call or defines a package of components.
- **[ParticipantRole](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/fsc_meta_participantrole.htm)**  
    Represents details, such as the name and associated default access level, for a role that a participant can have in the context of a parent record.
- **[PathAssistant](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pathassistant.htm)**  
    Represents Path records.This type extends the Metadata metadata type and inherits its fullName field.
- **[PaymentGatewayProvider](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_paymentgatewayprovider.htm)**  
    Represents the metadata associated with a payment gateway provider. This type extends the Metadata metadata type and inherits its fullName field.
- **[PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionset.htm)**  
    Represents a set of permissions that's used to grant more access to one or more users without changing their profile or reassigning profiles. You can use permission sets to grant access but not to deny access.
- **[PermissionSetGroup](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionsetgroup.htm)**  
    Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed.
- **[PermissionSetLicenseDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionsetlicensedefinition.htm)**  
    Represents the definition of a custom permission set license, which entitles specified features in a package.
- **[PersonAccountOwnerPowerUser](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_personaccountownerpoweruser.htm)**  
    Represents a user who can own more than 50,000 customer or partner portal accounts. Person account owner power users can own a large number of either customer or partner users. They can’t change their role, look up to a parent role, or reparent their role. Person account owner power user objects can't be created if deferred sharing is turned on for your org. This object is available in API version 57.0 and later.
- **[PipelineInspMetricConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pipelineinspmetricconfig.htm)**  
    Represents the settings of Pipeline Inspection forecast category metrics.
- **[PlatformCachePartition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformcachepartition.htm)**  
    Represents a partition in the Platform Cache. This type extends the Metadata metadata type and inherits its fullName field.
- **[PlatformEventChannel](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformeventchannel.htm)**  
    Represents a channel that you can subscribe to in order to receive a stream of events. In API version 46.0 and earlier, it is the default standard channel for change data capture events. In API version 47.0 and later, it is a custom channel for change data capture events.
- **[PlatformEventChannelMember](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformeventchannelmember.htm)**  
    Represents an entity selected for Change Data Capture notifications on a standard or custom channel, or a platform event selected on a custom channel.
- **[PlatformEventMigration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformeventmigration.htm)**  
    Represents configuration settings for a migration from standard volume platform events to high volume platform events.
- **[PlatformEventSubscriberConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformeventsubscriberconfig.htm)**  
    Represents configuration settings for a platform event Apex trigger, including the batch size and the trigger’s running user.
- **[Portal](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_portal.htm)**  
    The Portal metadata type represents a partner portal.
- **[PortalDelegablePermissionSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_portaldelegablepermissionset.htm)**  
    Represents the org-level permission sets that can be assigned to a particular profile for external users or shoppers in a store after enabling the Delegable Administration perm.
- **[PostTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_posttemplate.htm)**  
    Represents the metadata associated with an approval post template for Approvals in Chatter. With approval post templates, you can customize the information included in approval request posts that appear in Chatter feeds. This type extends the Metadata metadata type and inherits its fullName field.
- **[ProductAttributeSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_productattributeset.htm)**  
    Represents the ProductAttribute information being used as and attribute such as color\__c, size_\_c .
- **[PresenceDeclineReason](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_presencedeclinereason.htm)**  
    Represents an Omni-Channel decline reason that agents can select when declining work requests. This type extends the Metadata metadata type and inherits its fullName field.
- **[PresenceUserConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_presenceuserconfig.htm)**  
    Represents a configuration that determines a presence user’s settings.
- **[PricingActionParameters](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pricingactionparameters.htm)**  
    Represents the pricing action that's associated with a context definition and pricing procedure.
- **[PricingRecipe](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pricingrecipe.htm)**  
    Represents the data models or sets of objects of a particular cloud that the pricing data store consumes during design time and run time.
- **[Profile](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm)**  
    Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field.
- **[ProfileActionOverride](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profileactionoverride.htm)**  
    Represents an override of an ActionOverride by a user profile. You can use it to override an ActionOverride on a standard Home tab or object record page in Lightning Experience. When a user logs in with a profile, a matching ProfileActionOverride assignment takes precedence over existing overrides for the Home tab or record page specified in ActionOverride. In API versions 39.0 to 44.0, you can access ProfileActionOverride by accessing its encompassing [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customapplication.htm#meta_customapplication "CustomApplication represents a custom or standard application. In API version 29.0 and earlier, CustomApplication represents only a custom application. An application is a list of tab references, with a description and a logo. This type extends the Metadata metadata type and inherits its fullName field.") or [Profile](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#meta_profile "Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field.") metadata types. In API version 45.0 and later, you can access ProfileActionOverride only by accessing its encompassing [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customapplication.htm#meta_customapplication "CustomApplication represents a custom or standard application. In API version 29.0 and earlier, CustomApplication represents only a custom application. An application is a list of tab references, with a description and a logo. This type extends the Metadata metadata type and inherits its fullName field.").
- **[ProfilePasswordPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profilepasswordpolicy.htm)**  
    Represents a profile’s password policies. Profile password policies override org-wide password policies for that profile’s users. Use ProfilePasswordPolicy to retrieve password policies for a given profile. This type extends the Metadata metadata type and inherits its fullName field.
- **[ProfileSessionSetting](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profilesessionsetting.htm)**  
    Represents a profile’s session settings. Use ProfileSessionSetting to retrieve the session settings for a given profile. This type extends the Metadata metadata type and inherits its fullName field.
- **[Prompt](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_prompt.htm)**  
    Represents the metadata related to in-app guidance, which includes prompts and walkthroughs. Help users discover your products and services, adopt your processes, or learn how to use a new feature. Write the content, select the target audience, and specify where and when the in-app guidance appears.
- **[PublicKeyCertificate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_publickeycertificate.htm)**  
    Represents the public key certificate. On this entity we store a public certificate or a JSON web key, which is used to validate the customer-provided JWT.
- **[PublicKeyCertificateSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_publickeycertificateset.htm)**  
    Represents a set of public certificate keys. On this entity we store a public certificates or JSON web keys.
- **[Queue](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_queue.htm)**  
    Represents a holding area for items before they are processed.
- **[QueueRoutingConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_queueroutingconfig.htm)**  
    Represents the settings that determine how work items are routed to agents.
- **[QuickAction](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickaction.htm)**  
    Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields.
- **[RedirectWhitelistUrl](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_redirectwhitelisturl.htm)**  
    Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true. This type extends the Metadata metadata type and inherits its fullName field.
- **[RecommendationStrategy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recommendationstrategy.htm)**  
    Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations.
- **[RecordActionDeployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordactiondeployment.htm)**  
    Represents configuration settings for the Actions & Recommendations, Action Launcher, and Bulk Action Panel components. For example, you can have a deployment that specifies which types of actions to display, default actions for channels, and the actions that users can add at runtime. If the component shows Next Best Action recommendations, the deployment configures which strategies to use and how recommendations appear. This type extends the Metadata metadata type and inherits its fullName field.
- **[RecordAggregationDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordaggregationdefinition.htm)**  
    Represents a data aggregation from one object to another object to which it is connected by other objects in the data model.
- **[RecordAlertCategory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordalertcategory.htm)**  
    Represents a category to group and present record alerts.
- **[RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_registeredexternalservice.htm)**  
    Represents a registered external service, which provides an extension or integration.
- **[ReferencedDashboard](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_referenceddashboard.htm)**  
    Represents the ReferencedDashboard object in CRM Analytics. A referenced dashboard stores information about an externally referenced dashboard.
- **[RelatedRecordAssocCriteria](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_relatedrecordassoccriteria.htm)**  
    Represents criteria for automatically linking records like accounts, leads, opportunities, and cases with the branches that work with them.
- **[RelationshipGraphDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_relationshipgraphdefinition.htm)**  
    Represents a definition of a graph that you can configure in your organization to traverse object hierarchies and record details, giving you a glimpse of how your business works.
- **[RemoteSiteSetting](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_remotesitesetting.htm)**  
    Represents a remote site setting. Before any Visualforce page, Apex callout, or JavaScript code using XmlHttpRequest in an s-control or custom button can call an external site, that site must be registered in the Remote Site Settings page, or the call fails.
- **[Report](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm)**  
    Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.
- **[ReportType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_reporttype.htm)**  
    Represents the metadata associated with a custom report type. Custom report types allow you to build a framework from which users can create and customize reports.
- **[RestrictionRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_restrictionrule.htm)**  
    Represents a restriction rule or a scoping rule. A restriction rule has enforcementType set to Restrict and controls the access that specified users have to designated records. A scoping rule has enforcementType set to Scoping and controls the default records that your users see without restricting access. This type extends the Metadata metadata type and inherits its fullName field.
- **[RetrievalSummaryDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrievalsummarydefinition.htm)**  
    Represents a metadata type that stores the header information of a retrieval definition. It enables the configuration of data retrieval patterns for summarizing related records across object relationships.
- **[Role](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_role.htm)**  
    Represents a role in your organization.
- **[RoleOrTerritory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_roleorterritory.htm)**  
    Represents the common base type and valid values for role or territory.
- **[RpaRobotPoolMetadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_rparobotpoolmetadata.htm)**  
    Reserved for future use.
- **[SalesWorkQueueSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_salesworkqueuesettings.htm)**  
    Represents settings used to customize work queue options for third-party scoring. In Sales Engagement, you can add a custom number field on person accounts, contacts, or leads. Then, use the custom number field to sort the work queue. This type extends the Metadata metadata type and inherits its fullName field.
- **[SamlSsoConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_samlssoconfig.htm)**  
    Represents a SAML Single Sign-On configuration. This type extends the Metadata metadata type and inherits its fullName field. Single sign-on (SSO) is an authentication method that enables users to access multiple applications with one login and one set of credentials. For example, after users log in to your org, they can automatically access all apps from the App Launcher. You can set up your Salesforce org to trust a third-party identity provider to authenticate users. Or you can configure a third-party app to rely on your org for authentication.
- **[SchedulingObjective](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_schedulingobjective.htm)**  
    Represents a scheduling objective in Workforce Engagement. Scheduling objectives define business goals that the scheduling tools consider when identifying agents for shifts.
- **[SchedulingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_schedulingrule.htm)**  
    Represents a scheduling rule in Workforce Engagement Management. Scheduling rules determine when agents are assigned to shifts.
- **[ScndTelephPrvdOtbdDtl](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_scndtelephprvdotbddtl.htm)**  
    Represents the outbound SIP routing configuration for a secondary telephony provider in Agentforce Contact Center BYOC.
- **[Scontrol](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_scontrol.htm)**  
    Deprecated. Represents an Scontrol component, corresponding to an s-control in the Salesforce user interface.
- **[SearchCustomization](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_searchcustomization.htm)**  
    Represents the configuration of search settings created in Search Manager. The configuration includes the search channel, searchable objects and fields, and rules to filter search results.
- **[SearchOrgWideObjectConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_searchorgwideobjectconfig.htm)**  
    Represents an object in the search index. The search index contains org-wide search settings created in Search Manager. Each object in the search index includes searchable fields and fields protected by field-level security in search.
- **[SecondaryTelephonyProvider](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_secondarytelephonyprovider.htm)**  
    Represents the SIP configuration for secondary telephony providers in Agentforce Contact Center BYOC.
- **[ServiceAISetupDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_serviceAIsetupdefinition.htm)**  
    Represents settings for an Einstein for Service feature such as Einstein Article Recommendations. This type extends the Metadata metadata type and inherits its fullName field.
- **[ServiceAISetupField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_serviceAIsetupfield.htm)**  
    Represents a field on cases or knowledge articles that Einstein uses to identify relevant articles in Einstein Article Recommendations. This type extends the Metadata metadata type and inherits its fullName field.
- **[ServiceChannel](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_servicechannel.htm)**  
    Represents a channel of work items that are received from your organization—for example, cases, chats, or leads.
- **[ServicePresenceStatus](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_servicepresencestatus.htm)**  
    Represents a presence status that can be assigned to a service channel. This type extends the Metadata metadata type and inherits its fullName field.
- **[ServiceProcess](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_serviceprocess.htm)**  
    Represents a process created in Service Process Studio and its associated attributes.
- **[Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm)**  
    Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.
- **[SharedTo](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm)**  
    SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.
- **[SharingBaseRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingbaserule.htm)**  
    Represents sharing rule settings such as access level and to whom access is granted.
- **[SharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm)**  
    Represents the base container for sharing rules, which can be criteria-based, ownership-based, territory-based, or for guest user access. SharingRules enables you to share records with a set of users, using rules that specify the access level for the target user group.
- **[SharingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingset.htm)**  
    Represents a sharing set. A sharing set defines an access mapping that grants portal or community users access to objects that are associated with their accounts or contacts.
- **[SiteDotCom](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sitedotcom.htm)**  
    Represents a site for deployment.
- **[Skill](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_skills.htm)**  
    Represents the settings for a skill used for field service or to route chats to agents in Chat, such as the name of the skill and which agents the skills are assigned to.
- **[StandardValueSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_standardvalueset.htm)**  
    Represents the set of values in a standard picklist field. This type extends the Metadata metadata type and inherits its fullName field.
- **[StandardValueSetTranslation](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_standardvaluesettranslation.htm)**  
    Contains details for a standard picklist translation. It returns a translated standard value set.This type extends the Metadata metadata type and inherits its fullName field.
- **[StaticResource](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_staticresource.htm)**  
    Represents a static resource file, often a code library in a ZIP file. Static resources allow you to upload content that you can reference in a Visualforce page, including archives (such as .zip and .jar files), images, style sheets, JavaScript, and other files. Static resources can be used only within your Salesforce org, so you can’t host content here for other apps or websites.
- **[StageAssignment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_stageassignment.htm)**  
    Represents a collection of fields to automatically assign stage definitions to records based on rule criteria.
- **[StageDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_stagedefinition.htm)**  
    Represents a collection of fields to set up the states and transitions for Stage Management.
- **[SustainabilityUom](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sustainabilityuom.htm)**  
    Represents the unit of measure (UOM) values for custom fuel types in an org. Track fuel consumption and emission results with the flexibility to add custom fuel types and UOM values.
- **[SustnUomConversion](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sustnuomconversion.htm)**  
    Represents information about the unit of measure (UOM) conversion for the custom fuel types defined by a customer in an org.
- **[SvcCatalogCategory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_svccatalogcategory.htm)**  
    Represents the grouping of individual catalog items in Service Catalog.
- **[SvcCatalogFulfillmentFlow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_svccatalogfulfillmentflow.htm)**  
    Represents the flow associated with a specific catalog item in the Service Catalog.
- **[SvcCatalogItemDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_svccatalogitemdef.htm)**  
    Represents the entity associated with a specific, individual service available in the Service Catalog.
- **[SynonymDictionary](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_synonymdictionary.htm)**  
    Represents a set of synonym groups, which are groups of words or phrases that are treated as equivalent in users’ searches. You can define synonym groups to optimize search results for acronyms, variations of product names, and other terminology unique to your organization.
- **[Tag](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_tag.htm)**  
    Represents a named label that can be applied to Salesforce metadata records to categorize, describe, or classify them. Tags are organized within a TagSet, which defines the category they belong to. For example, a TagSet named DataDomain might contain Tags such as Financial, Operational, or Legal. Use Tag to define the individual classification values available in a category.
- **[TagSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_tagset.htm)**  
    Represents a category that groups related Tag records. A TagSet defines the classification category, and its associated Tag records represent the individual values within that category. For example, a TagSet named DataDomain might group Tags such as Financial, Operational, or Legal. TagSets can be organized into a hierarchy, where a parent TagSet contains one or more child TagSets. This hierarchy allows you to make progressively granular classifications.
- **[TelephonyProvider](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_telephonyprovider.htm)**  
    Represents a telephony provider configuration that an org uses with Bring Your Own Carrier (BYOC).
- **[Territory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_territory.htm)**  
    Represents a territory.
- **[Territory2](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_territory2.htm)**  
    Represents the metadata associated with a sales territory. This type extends the Metadata metadata type and inherits its fullName field. Available if Sales Territories has been enabled.
- **[Territory2Model](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_territory2model.htm)**  
    Represents the metadata associated with a territory model in Sales Territories. This type extends the Metadata metadata type and inherits its fullName field. Available if Sales Territories has been enabled.
- **[Territory2Rule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_territory2rule.htm)**  
    Represents the metadata associated with a territory assignment rule associated with an object, such as Account. Available if Sales Territories has been enabled.
- **[Territory2Type](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_territory2type.htm)**  
    Represents the metadata for a category of territories in Sales Territories. Every Territory2 must have a Territory2Type. This type extends the Metadata metadata type and inherits its fullName field. Available if Sales Territories has been enabled.
- **[TimelineObjectDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_timelineobjectdefinition.htm)**  
    Represents the container that stores the details of a timeline configuration. You can use this resource with Salesforce objects to see their records' related events in a linear time-sorted view.
- **[TimeSheetTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_timesheettemplate.htm)**  
    Represents a template for creating time sheets in Field Service. This type extends the Metadata metadata type and inherits its fullName field.
- **[TopicsForObjects](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_topicsforobjects.htm)**  
    Represents the ability to assign topics to objects or to remove topic assignments.
- **[TransactionSecurityPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_transactionsecurity.htm)**  
    Represents a transaction security policy definition. Transaction security policies give you a way to look through events in your organization and specify actions to take when certain combinations occur.
- **[Translations](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm)**  
    Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.
- **[TrustedTelephonyProvider](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_trustedtelephonyprovider.htm)**  
    Represents the trusted telephony carrier configuration for Agentforce Contact Center BYOC.
- **[UIBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_uibundle.htm)**  
    Represents the UI of a Salesforce Multi-Framework app, such as a React app.
- **[UiFormatSpecificationSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_uiformatspecificationset.htm)**  
    Represents a set of rules that define the style and visibility of conditional field formatting on Dynamic Forms-enabled Lightning page field instances.
- **[UIObjectRelationConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_uiobjectrelationconfig.htm)**  
    Represents the admin-created configuration of the object relation UI component.
- **[UiPreviewMessageTabDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_uipreviewmessagetabdef.htm)**  
    Represents the registration of a custom Marketing Cloud Preview and Test modal tab, created using custom Lightning web components. You can register and show multiple tabs in the Preview and Test experience.
- **[UiWidgetBundle (Beta)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_uiwidgetbundle.htm)**  
    Represents a widget. Use widgets to define reusable UI compositions once and deploy them across supported Salesforce applications and third-party platforms. Deploy this bundle to your Salesforce org to make the widget available.
- **[UserAccessPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_useraccesspolicy.htm)**  
    Represents a user access policy.
- **[UserAuthCertificate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_userauthcertificate.htm)**  
    Represents a PEM-encoded user certificate. These certificates are associated with a user, and externally uploaded. The uploaded certificate is used to authenticate the user.
- **[UserCriteria](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_usercriteria.htm)**  
    Represents the member criteria to use in Experience Cloud site moderation rules. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field..
- **[UserProfileSearchScope](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_userprofilesearchscope.htm)**  
    Reserved for internal use.
- **[UserProvisioningConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_userprovisioningconfig.htm)**  
    Represents information to use during a user provisioning request flow, such as the attributes for an update. This type extends the Metadata metadata type and inherits its fullName field.
- **[VirtualVisitConfig](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_virtualvisitconfig.htm)**  
    Represents an external video provider configuration, which relays events from Salesforce to the provider.
- **[WaveAnalyticAssetCollection](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_waveanalyticassetcollection.htm)**  
    Represents a collection of Analytics assets. This type extends the Metadata metadata type and inherits its fullName field.
- **[WaveApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_waveapplication.htm)**  
    Represents the Analytics application. This type extends the Metadata metadata type and inherits its fullName field.
- **[WaveComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_wavecomponent.htm)**  
    Represents the WaveComponent object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.
- **[WaveDataflow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_wavedataflow.htm)**  
    Represents the WaveDataflow object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.
- **[WaveDashboard](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_wavedashboard.htm)**  
    Represents the WaveDashboard object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.
- **[WaveDataset](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_wavedataset.htm)**  
    Represents the WaveDataset object in the Analytics application. This type extends the Metadata metadata type and inherits its fullName field.
- **[WaveLens](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_wavelens.htm)**  
    Represents the WaveLens object in the Analytics application.
- **[WaveRecipe](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_waverecipe.htm)**  
    Represents the WaveRecipe type in an Analytics application. A recipe is a saved set of steps to perform on a specific source dataset or connected data. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.
- **[WaveTemplateBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_wavetemplatebundle.htm)**  
    Represents an Analytics template bundle, which can be used to create Analytics apps. A bundle contains an Analytics template definition and all its related resources.This type extends the Metadata metadata type and inherits its fullName field.
- **[WaveXmd](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_wavexmd.htm)**  
    Represents the WaveXmd object in the Analytics application. This type extends the Metadata metadata type and inherits its fullName field.
- **[WebStoreBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_webstorebundle.htm)**  
    For internal use only.
- **[WebStoreTemplate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_webstoretemplate.htm)**  
    Represents a configuration for creating commerce stores.
- **[Workflow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_workflow.htm)**  
    Represents the metadata associated with a workflow rule. A workflow rule sets workflow actions into motion when its designated conditions are met. You can configure workflow actions to execute immediately when a record meets the conditions in your workflow rule, or set time triggers that execute the workflow actions on a specific day. Use this metadata type to create, update, or delete workflow rule definitions.
- **[WorkSkillRouting](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_workskillrouting.htm)**  
    Represents a setup object that stores a set of WorkSkillRoutingAttribute objects. These objects are used to route a work item to an agent who has the skills necessary to take the work. This type extends the Metadata metadata type and inherits its fullName field.

<!-- document id=51358561e67c4213e1337f21655a0d8241584bf1ce2fac07f9f1ceefff44490a url=/legacydeveloper/current/en-us/api_meta/meta_metadatawithcontent.md -->

# MetadataWithContent

MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.

## Version

MetadataWithContent components are available in API version 14.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d663255e67">Field Name</th>

              <th class="featureTableHeader  " id="d663255e70">Field Type</th>

              <th class="featureTableHeader  " id="d663255e73">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d663255e67" data-title="Field Name"><span class="keyword parmname" id="meta_content"><a name="meta_content"><!-- --></a>content</span></td>

              <td class="entry" headers="d663255e70" data-title="Field Type"><span class="ph" id="content_field_type"><a name="content_field_type"><!-- --></a>base64Binary</span></td>

              <td class="entry" headers="d663255e73" data-title="Description"><span class="ph" id="content_desc"><a name="content_desc"><!-- --></a>Base 64-encoded binary data. Before making an API call, client
                  applications must encode the binary attachment data as base64. Upon receiving a response,
                  client applications must decode the base64 data to binary. This conversion is handled for
                  you by a SOAP client.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d663255e67" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d663255e70" data-title="Field Type">string</td>

              <td class="entry" headers="d663255e73" data-title="Description">Required. The name of the component. The <span class="keyword parmname">fullName</span> can contain
                only underscores and alphanumeric characters. It must be unique, begin with a letter, not
                include spaces, not end with an underscore, and not contain two consecutive
                underscores.<p class="p">Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>
                  component, this field isn’t defined in the WSDL for this component. It must be specified
                  when creating, updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see an example of this field specified for a call.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.")

<!-- document id=16df98dc7df3e2130e2feb5160c25f930702b9ee25c529b22d45cd0ff11e5f05 url=/legacydeveloper/current/en-us/api_meta/meta_mfgprogramtemplate.md -->

# MfgProgramTemplate

Represents a definition of a program to create a program-based business. A program-based business, also known as a Manufacturing Program, enables manufacturers to drive their business models with forecasting tools and manage the end-to-end sales process efficiently.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

MfgProgramTemplate components have the suffix .mfgProgramTemplate and are stored in the MfgProgramTemplate folder.

## Version

MfgProgramTemplate components are available in API version 54.0 and later.

## Special Access Rules

The program-based business feature setting for Manufacturing Cloud is required to create a program template.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The description of the manufacturing program template.



 |
| programTemplateItems | 

Field Type

[MfgProgramTemplateItem\[\]](#subtype_MfgProgramTemplateItem)

Description

The list of templates associated with the manufacturing program template.



 |
| programTemplateName | 

Field Type

string

Description

Required.

The unique identifier for the manufacturing program template.



 |
| status | 

Field Type

MfgProgramTemplateStatus (enumeration of type string)

Description

Required.

The status of the manufacturing program template.

Values are:

- Active
- Draft
- Inactive

The default value is Active.



 |

## MfgProgramTemplateItem

A program template item defines each of the templates associated with a manufacturing program. A template item includes program details, such as a data transformation type and a display order. Transformation type is the method to forecast business visibility to manufacturers.

| Field Name | Description |
| --- | --- |
| advAccountForecastSet | 
Field Type

string

Description

The forecast set associated with the transformation.



 |
| contextDefinition | 

Type

string

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The context definition that defines how data is mapped and transformed to the target, such as an opportunity or account.



 |
| description | 

Field Type

string

Description

The description of the manufacturing program template item.



 |
| sourceContextMappingName | 

Type

string

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The context mapping that defines how data is mapped from a list of facts(Input Data) to create structured information.



 |
| targetContextMappingName | 

Type

string

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The context mapping that defines how the structured data is saved to the target, such as an opportunity or sales agreement.



 |
| templateItemName | 

Field Type

string

Description

Required.

The name of the manufacturing program template item.



 |
| transformationDisplayOrder | 

Field Type

int

Description

Required.

The display order of the transformation in the manufacturing program template.



 |
| transformationType | 

Field Type

MfgProgramTransformationType (enumeration of type string)

Description

Required.

Specifies the type of transformation.

Values are:

- BusinessTransformation
- ForecastSetRelation





 |

## Declarative Metadata Sample Definition

The following is an example of a MfgProgramTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<MfgProgramTemplate xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <description\>Program Template</description\>
     <programTemplateItems\>
         <templateItemName\>Template Item #1</templateItemName\>
         <transformationDisplayOrder\>1</transformationDisplayOrder\>
         <transformationType\>BusinessTransformation</transformationType\>
         <description\>Program Template Item</description\>
     </programTemplateItems\>
     <programTemplateName\>Sample Program Template</programTemplateName\>
     <status\>Draft</status\>
</MfgProgramTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
     <types\>
         <members\>\*</members\>
         <name\>MfgProgramTemplate</name\>
     </types\>
     <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=6be50950d575e1df6c8727e93f0760c5fa3ac2af40665f279a592445bd748378 url=/legacydeveloper/current/en-us/api_meta/mfg_mfgserviceconsolesettings_metadata_api.md -->

# MfgServiceConsoleSettings

Represents the settings to access the Service Console for Manufacturing.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details.

## File Suffix and Directory Location

MfgServiceConsoleSettings values are stored in the MfgServiceConsole.settings file in the settings directory.

## Version

MfgServiceConsoleSettings components are available in API version 56.0 and later.

## Special Access Rules

To use this metadata type, your Salesforce org must have the Manufacturing Cloud license.

## Fields

### enableMfgServiceConsole

- **Field Type**: boolean
- **Description**: Indicates whether Service Console for Manufacturing is enabled in your org (true) or not false).

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

By default, Service Console for Manufacturing is disabled.

## Declarative Metadata Sample Definition

The following is an example of a MfgServiceConsoleSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<MfgServiceConsoleSettings
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableMfgServiceConsole\>true</enableMfgServiceConsole\>
</MfgServiceConsoleSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>MfgServiceConsole</members\>
		<name\>Settings</name\>
	</types\>
	<version\>56.0</version\>
</Package\>

## Wildcard Support in the Manifest File

### 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=4dba55bd542ec72ca33ed19d9053e00151e7261b80fb4543b9405aa13e572a41 url=/legacydeveloper/current/en-us/api_meta/meta_milestonetype.md -->

# MilestoneType

Represents the name and description of a milestone, which you can use in an entitlement process to track important steps in cases.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

Milestone types are stored in the milestoneTypes directory of the corresponding package directory. The extension is .milestoneType.

## Version

[MilestoneType](#meta_milestonetype "Represents the name and description of a milestone, which you can use in an entitlement process to track important steps in cases.") is available in API version 27.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d664730e105">Field Name</th>

              <th class="featureTableHeader  " id="d664730e108">Field Type</th>

              <th class="featureTableHeader  " id="d664730e111">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d664730e105" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d664730e108" data-title="Field Type">string</td>

              <td class="entry" headers="d664730e111" data-title="Description">The description of the milestone.</td>

            </tr>

            <tr>
              <td class="entry" headers="d664730e105" data-title="Field Name"><span class="keyword parmname" id="recurrenceTypefieldmdapi"><a name="recurrenceTypefieldmdapi"><!-- --></a>RecurrenceType</span></td>

              <td class="entry" headers="d664730e108" data-title="Field Type">
                <samp class="codeph nolang">MilestoneTypeRecurrenceType</samp>
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)
              </td>

              <td class="entry" headers="d664730e111" data-title="Description">
                <span class="ph" id="recurrenceTypeFieldmdapiDesc"><a name="recurrenceTypeFieldmdapiDesc"><!-- --></a>The type of recurrence for
                  the milestone.</span> Available in API version 29.0 and later.
                Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">none</samp>—Specifies
                    no recurrence for the milestone. The milestone occurs only
                    one time until the entitlement process exits.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">recursIndependently</samp>—Specifies independent
                    recurrence for the milestone.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">recursChained</samp>—Specifies sequential
                    recurrence for the milestone.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s a sample milestone type.

<?xml version="1.0" encoding="UTF-8"?>
<MilestoneType xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>First Response Time</description\>
</MilestoneType\>

And, here’s the sample package.xml file that references the MilestoneType component definition:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\* or a valid name of a milestone type</members\>
        <name\>MilestoneType</name\>
    </types\>
    <version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b8d0e77d8fc85cb994c44ef11a6c17425ec40e507b9afe3061e6a8597c430ea8 url=/legacydeveloper/current/en-us/api_meta/meta_mktcalcinsightobjectdef.md -->

# MktCalcInsightObjectDef

Represents Calculated Insight definition such as expression.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

MktCalcInsightObjectDef components have the suffix mktCalcInsightObjectDef and are stored in the mktCalcInsightObjectDefs folder.

## Version

MktCalcInsightObjectDef components are available in API version 52.0 and later.

## Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d665153e107">Field Name</th>

              <th class="featureTableHeader  " id="d665153e110">Field Type</th>

              <th class="featureTableHeader  " id="d665153e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d665153e107" data-title="Field Name"><span class="keyword parmname">builderExpression</span></td>

              <td class="entry" headers="d665153e110" data-title="Field Type">string</td>

              <td class="entry" headers="d665153e113" data-title="Description">Reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665153e107" data-title="Field Name"><span class="keyword parmname">creationType</span></td>

              <td class="entry" headers="d665153e110" data-title="Field Type">CalculatedInsightCreationType(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title" target="_blank">enumeration</a> of type string)</td>

              <td class="entry" headers="d665153e113" data-title="Description">Required. Describes whether this Calculated Insight Object Definition was added
                was added by the customer. Valid values include: Custom.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665153e107" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d665153e110" data-title="Field Type">string</td>

              <td class="entry" headers="d665153e113" data-title="Description">The description for this Calculated Insight Object Definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665153e107" data-title="Field Name"><span class="keyword parmname">expression</span></td>

              <td class="entry" headers="d665153e110" data-title="Field Type">string</td>

              <td class="entry" headers="d665153e113" data-title="Description">Required when the Calculated Insight Object Definition is for internal
                insight type. This is the SQL query to generate the calculated
                insight.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665153e107" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d665153e110" data-title="Field Type">string</td>

              <td class="entry" headers="d665153e113" data-title="Description">Required. App name for this Calculated Insight Object Definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665153e107" data-title="Field Name"><span class="keyword parmname">system</span></td>

              <td class="entry" headers="d665153e110" data-title="Field Type">string</td>

              <td class="entry" headers="d665153e113" data-title="Description">
                <p dir="ltr" class="p">Required. Indicates how this calculated insight object definition was
                  added, by the customer or by the system. Valid values are: </p>

                <a name="ul_oxj_jmv_bfc"><!-- --></a>
                <ul class="ul bulletList" id="ul_oxj_jmv_bfc">
                  <li class="li">Custom </li>

                  <li class="li">System (API version 61.0 and later)</li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a MktCalcInsightObjectDef component.

<?xml version="1.0" encoding="UTF-8"?>
<MktCalcInsightObjectDef xmlns="http://soap.sforce.com/2006/04/metadata">
    <creationType\>Custom</creationType\>
    <description\>InsightName description</description\>
    <expression\>SELECT COUNT(ssot\_\_Individual\_\_dlm.ssot\_\_Id\_\_c) as count\_\_c FROM ssot\_\_Individual\_\_dlm</expression\>
</MktCalcInsightObjectDef\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=ce5cfeb6531d999f3d28bb09587c854ae9aed9fbe583a6de92f5fd94b9859aa2 url=/legacydeveloper/current/en-us/api_meta/meta_mktdatatranobject.md -->

# MktDataTranObject

An entity that is used to deliver (aka transport) information from the source to a target (target will be called a landing entity).This can be the schema of a file, API, Event, or other means of transporting data, such as SubscriberFile1.csv, or SubscriberCDCEvent.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

MktDataTranObject components have the suffix mktDataTranObject and are stored in the mktDataTranObjects folder.

## Version

MktDataTranObject components are available in API version 50.0 and later.

## Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d665779e96">Field Name</th>

              <th class="featureTableHeader  " id="d665779e99">Field Type</th>

              <th class="featureTableHeader  " id="d665779e102">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d665779e96" data-title="Field Name"><span class="keyword parmname">connector</span></td>

              <td class="entry" headers="d665779e99" data-title="Field Type">string</td>

              <td class="entry" headers="d665779e102" data-title="Description">Required. <span class="ph">Data 360</span> connector name that allows you to connect the data source
                to <span class="ph">Data 360</span>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e96" data-title="Field Name"><span class="keyword parmname">creationType</span></td>

              <td class="entry" headers="d665779e99" data-title="Field Type">DefinitionCreationType</td>

              <td class="entry" headers="d665779e102" data-title="Description">Required. Describe whether this object was added as the result of the Customer
                or as part of a Standard Taxonomy. <ul class="ul bulletList">
                  <li class="li">
                    <p class="p">Valid values available in API version 62.0 and later are: </p>

                    <a name="ul_rjt_r2n_52c"><!-- --></a>
                    <ul class="ul bulletList" id="ul_rjt_r2n_52c">
                      <li class="li"><samp class="codeph nolang">ADG</samp></li>

                      <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                      <li class="li"><samp class="codeph nolang">CG_Audience</samp></li>

                      <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                      <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                      <li class="li"><samp class="codeph nolang">External</samp></li>

                      <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                      <li class="li"><samp class="codeph nolang">Transform</samp></li>

                      <li class="li"><samp class="codeph nolang">Vector_Embedding </samp></li>

                    </ul>

                  </li>

                </ul>
                <p class="p">Valid values available in API version 67.0 and later are: </p>
                <a name="ul_mkt_67_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_mkt_67_tjc">
                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                  <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                  <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e96" data-title="Field Name"><span class="keyword parmname">dataSource</span></td>

              <td class="entry" headers="d665779e99" data-title="Field Type">string</td>

              <td class="entry" headers="d665779e102" data-title="Description">Required. Your reference to the data source from which the data originated
                (source of that data such as the name of a CRM Org. Example: MC Enterprise.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e96" data-title="Field Name"><span class="keyword parmname">dataSourceObject</span></td>

              <td class="entry" headers="d665779e99" data-title="Field Type">string</td>

              <td class="entry" headers="d665779e102" data-title="Description">Required. Represents the object name from where the data is sourced. Example:
                ecommerce-OrderItem.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e96" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d665779e99" data-title="Field Type">string</td>

              <td class="entry" headers="d665779e102" data-title="Description">Required. The UI name for the Data Transport Object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e96" data-title="Field Name"><span class="keyword parmname">objectCategory</span></td>

              <td class="entry" headers="d665779e99" data-title="Field Type">string</td>

              <td class="entry" headers="d665779e102" data-title="Description">Required. Reference to the Object Category. For Transport, these are Profile, Engagement, or Other.</td>

            </tr>

          </tbody>

        </table>

## MktDataTranField

This is a sub-type to MktDataTranObject.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d665779e296">Field Name</th>

              <th class="featureTableHeader  " id="d665779e299">Field Type</th>

              <th class="featureTableHeader  " id="d665779e302">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">creationType</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">DefinitionCreationType</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional: Was this object added as a result of the Customer, part of a Standard
                Taxonomy. <ul class="ul bulletList">
                  <li class="li">
                    <p class="p">Valid values available in API version 62.0 and later are: </p>

                    <a name="ul_kvy_v2n_52c"><!-- --></a>
                    <ul class="ul bulletList" id="ul_kvy_v2n_52c">
                      <li class="li"><samp class="codeph nolang">ADG</samp></li>

                      <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                      <li class="li"><samp class="codeph nolang">CG_Audience</samp></li>

                      <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                      <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                      <li class="li"><samp class="codeph nolang">External</samp></li>

                      <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                      <li class="li"><samp class="codeph nolang">Transform</samp></li>

                      <li class="li"><samp class="codeph nolang">Vector_Embedding </samp></li>

                    </ul>

                  </li>

                </ul>
                <p class="p">Available in API version 67.0 and later: </p>
                <a name="ul_wlb_2t3_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_wlb_2t3_tjc">
                  <li class="li">
                    <a name="ul_ypj_l4f_sjc"><!-- --></a>
                    <ul class="ul bulletList" id="ul_ypj_l4f_sjc">
                      <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                      <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                      <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                      <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                      <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                    </ul>

                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">datatype</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">string</td>

              <td class="entry" headers="d665779e302" data-title="Description">Required. Phone, currency, number, or other assigned type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">dateFormat</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">string</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional: The Date format of date, time, date/time fields in this Transport field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">externalName</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">string</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional. Name of the object in the external system (different from Developer Name).</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">isDataRequired</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">boolean</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional. If true, data is required for this field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">length</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">int</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional. Length of a string column</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">string</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional? Field label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">precision</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">int</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional. Used for currency and numeric accuracy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">primaryIndexOrder</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">int</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional. If supplied, indicates this field is part of the primary key where the number value (starting at 1) indicates the order of attributes if this happens to be a compound primary key. Missing value means this field is not part of the primary key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">scale</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">int</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional. Used for currency and numeric accuracy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d665779e296" data-title="Field Name"><span class="keyword parmname">sequence</span></td>

              <td class="entry" headers="d665779e299" data-title="Field Type">int</td>

              <td class="entry" headers="d665779e302" data-title="Description">Optional. The sequence of this source schema.</td>

            </tr>

          </tbody>

        </table>

<!-- document id=69f50f30a08eb8db35135494e05cb65d5e70b946fa9feb53ff51fa673ae7719d url=/legacydeveloper/current/en-us/api_meta/meta_mktplanningopssettings.md -->

# MktPlanningOpsSettings

Represents the settings for Marketing Planning and Operations.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details.

## File Suffix and Directory Location

MktPlanningOpsSettings values are stored in the MktPlanningOps.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

MktPlanningOpsSettings components are available in API version 68.0 and later.

## Special Access Rules

Marketing Planning and Operations must be available to access this object. See [Availability of Marketing Planning and Operations](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US).

## Fields

| Field Name | Description |
| --- | --- |
| marketingOpsEnabled | 
Field Type

boolean

Description

Indicates whether Marketing Planning and Operations is enabled (true) or disabled (false) for your org. The default value is false.



 |

## Declarative Metadata Sample Definition

The following is an example of an MktPlanningOpsSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<MktPlanningOpsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <marketingOpsEnabled\>true</marketingOpsEnabled\>
</MktPlanningOpsSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types\>
    <members\>MktPlanningOpsSettings</members\>
    <name\>Settings</name\>
  </types\>
  <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=8dddddfd298a182758c0005db27121745e29397161d2d7f8483457609493eb91 url=/legacydeveloper/current/en-us/api_meta/meta_mldatadefinition.md -->

# MLDataDefinition

Represents a modeling data definition, which specifies the data used to create a model. Such data can include filters, fields to include, fields to exclude, and so on. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

MLDataDefinition components have the suffix .mlDataDefinition and are stored in the mlDataDefinitions folder.

## Version

MLDataDefinition is available in API version 50.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d667707e83">Field Name</th>

              <th class="featureTableHeader  " id="d667707e86">Field Type</th>

              <th class="featureTableHeader  " id="d667707e89">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e89" data-title="Description">Required. Represents the name of the data definition. Can contain only underscores and
                alphanumeric characters and must be unique in your org. It must begin with a letter,
                not include spaces, not end with an underscore, and not contain two consecutive
                underscores. Only users with View DeveloperName OR View Setup and Configuration
                permission can view, group, sort, and filter this field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">entityDeveloperName</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e89" data-title="Description">Required. The developer name of the object from which the model data is retrieved.
                After the MLDataDefinition entity is created,
                <span class="keyword parmname">entityDeveloperName</span> can’t be updated.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">excludedFields</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type">string[]</td>

              <td class="entry" headers="d667707e89" data-title="Description">Fields that are excluded from the model.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">includedFields</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type">string[]</td>

              <td class="entry" headers="d667707e89" data-title="Description">Fields that are included in the model.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">joinFields</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type">
                <a class="xref" href="#MLFieldVariable">MLField</a>[]
              </td>

              <td class="entry" headers="d667707e89" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">parentDefinitionDevName</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e89" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">scoringFilter</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type"><a class="xref" href="#MLFilterVariable">MLFilter</a></td>

              <td class="entry" headers="d667707e89" data-title="Description">Specifies records to which the prediction scores are written.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">segmentFilter</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type"><a class="xref" href="#MLFilterVariable">MLFilter</a></td>

              <td class="entry" headers="d667707e89" data-title="Description">This field further filters data used in training and scoring when
                <span class="keyword parmname">segmentFilter</span> is combined with both
                <span class="keyword parmname">scoringFilter</span> and <span class="keyword parmname">trainingFilter</span>. For
                example, select all records in a specific region.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">trainingFilter</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type"><a class="xref" href="#MLFilterVariable">MLFilter</a></td>

              <td class="entry" headers="d667707e89" data-title="Description">Specifies the records that make up the training set.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e83" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d667707e86" data-title="Field Type">MLDataDefinitionType (enumeration of type string)</td>

              <td class="entry" headers="d667707e89" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Candidate</samp></li>

                  <li class="li"><samp class="codeph nolang">Interaction</samp></li>

                  <li class="li"><samp class="codeph nolang">Prediction</samp></li>

                  <li class="li"><samp class="codeph nolang">Recipient</samp></li>

                </ul>
                <p class="p">After the model is created, <span class="keyword parmname">type</span> can’t be
                  updated.</p>
              </td>

            </tr>

          </tbody>

        </table>

## MLField

Represents a single field in the data definition. Available in API version 50.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d667707e298">Field Name</th>

              <th class="featureTableHeader  " id="d667707e301">Field Type</th>

              <th class="featureTableHeader  " id="d667707e304">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d667707e298" data-title="Field Name"><span class="keyword parmname">entity</span></td>

              <td class="entry" headers="d667707e301" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e304" data-title="Description">Required. The object that contains the field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e298" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d667707e301" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e304" data-title="Description">Required. The name of the field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e298" data-title="Field Name"><span class="keyword parmname">relatedField</span></td>

              <td class="entry" headers="d667707e301" data-title="Field Type">MLField</td>

              <td class="entry" headers="d667707e304" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e298" data-title="Field Name"><span class="keyword parmname">relationType</span></td>

              <td class="entry" headers="d667707e301" data-title="Field Type">MLRelationType (enumeration of type string)</td>

              <td class="entry" headers="d667707e304" data-title="Description">Reserved for future use. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Full</samp></li>

                  <li class="li"><samp class="codeph nolang">Inner</samp></li>

                  <li class="li"><samp class="codeph nolang">Leftinner</samp></li>

                  <li class="li"><samp class="codeph nolang">Leftouter</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e298" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d667707e301" data-title="Field Type">MLFieldType (enumeration of type string)</td>

              <td class="entry" headers="d667707e304" data-title="Description">Required. How the field is used in a prediction. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Excluded</samp></li>

                  <li class="li"><samp class="codeph nolang">Expression</samp></li>

                  <li class="li"><samp class="codeph nolang">Included</samp></li>

                  <li class="li"><samp class="codeph nolang">Join</samp></li>

                  <li class="li"><samp class="codeph nolang">Prediction</samp></li>

                  <li class="li"><samp class="codeph nolang">Pushback</samp></li>

                  <li class="li"><samp class="codeph nolang">Related</samp></li>

                  <li class="li"><samp class="codeph nolang">SourceDate</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## MLFilter

Represents a data filter based on a data comparison. For each comparison, there’s a left-hand element, an operator, and a right-hand element. For each record, only one of these left-hand elements is populated: lhFilter, lhPredictionField, or lhValue. Similarly, for each record, only one of these right-hand elements is populated: rhFilter, rhPredictionField, or rhValue. Available in API version 50.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d667707e475">Field Name</th>

              <th class="featureTableHeader  " id="d667707e478">Field Type</th>

              <th class="featureTableHeader  " id="d667707e481">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">filterName</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e481" data-title="Description">Required. Name of the filter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">lhFilter</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">MLFilter</td>

              <td class="entry" headers="d667707e481" data-title="Description">Left-hand filter condition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">lhPredictionField</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e481" data-title="Description">Left-hand prediction field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">lhType</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">AIValueType (enumeration of type string)</td>

              <td class="entry" headers="d667707e481" data-title="Description">The value type if a left-hand value is specified. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Comparison</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li"><samp class="codeph nolang">Supplier</samp></li>

                  <li class="li"><samp class="codeph nolang">Varchar</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">lhUnit</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">AIFilterUnit (enumeration of type string)</td>

              <td class="entry" headers="d667707e481" data-title="Description">The unit if a left-hand filter is specified. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Milliseconds</samp></li>

                  <li class="li"><samp class="codeph nolang">Seconds</samp></li>

                  <li class="li"><samp class="codeph nolang">Minutes</samp></li>

                  <li class="li"><samp class="codeph nolang">Hours</samp></li>

                  <li class="li"><samp class="codeph nolang">Days</samp></li>

                  <li class="li"><samp class="codeph nolang">Weeks</samp></li>

                  <li class="li"><samp class="codeph nolang">Months</samp></li>

                  <li class="li"><samp class="codeph nolang">Years</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">lhValue</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e481" data-title="Description">The left-hand value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">operation</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">AIFilterOperation (enumeration of type string)</td>

              <td class="entry" headers="d667707e481" data-title="Description">Required. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">And</samp></li>

                  <li class="li"><samp class="codeph nolang">Or</samp></li>

                  <li class="li"><samp class="codeph nolang">Not</samp></li>

                  <li class="li"><samp class="codeph nolang">LessThan</samp></li>

                  <li class="li"><samp class="codeph nolang">LessThanOrEqual</samp></li>

                  <li class="li"><samp class="codeph nolang">GreaterThan</samp></li>

                  <li class="li"><samp class="codeph nolang">GreaterThanOrEqual</samp></li>

                  <li class="li"><samp class="codeph nolang">Equals</samp></li>

                  <li class="li"><samp class="codeph nolang">NotEquals</samp></li>

                  <li class="li"><samp class="codeph nolang">Add</samp></li>

                  <li class="li"><samp class="codeph nolang">Subtract</samp></li>

                  <li class="li"><samp class="codeph nolang">Multiply</samp></li>

                  <li class="li"><samp class="codeph nolang">Divide</samp></li>

                  <li class="li"><samp class="codeph nolang">IsNull</samp></li>

                  <li class="li"><samp class="codeph nolang">IsNotNull</samp></li>

                  <li class="li"><samp class="codeph nolang">StartsWith</samp></li>

                  <li class="li"><samp class="codeph nolang">EndsWith</samp></li>

                  <li class="li"><samp class="codeph nolang">Contains</samp></li>

                  <li class="li"><samp class="codeph nolang">Concat</samp></li>

                  <li class="li"><samp class="codeph nolang">DoesNotContain</samp></li>

                  <li class="li"><samp class="codeph nolang">Between</samp></li>

                  <li class="li"><samp class="codeph nolang">In</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">rhFilter</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">MLFilter</td>

              <td class="entry" headers="d667707e481" data-title="Description">Right-hand filter condition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">rhPredictionField</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e481" data-title="Description">Right-hand prediction field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">rhType</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">AIValueType (enumeration of type string)</td>

              <td class="entry" headers="d667707e481" data-title="Description">The value type if a right-hand value is specified. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Comparison</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">String</samp></li>

                  <li class="li"><samp class="codeph nolang">Supplier</samp></li>

                  <li class="li"><samp class="codeph nolang">Varchar</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">rhUnit</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">AIFilterUnit (enumeration of type string)</td>

              <td class="entry" headers="d667707e481" data-title="Description">The unit if a right-hand filter is specified. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Milliseconds</samp></li>

                  <li class="li"><samp class="codeph nolang">Seconds</samp></li>

                  <li class="li"><samp class="codeph nolang">Minutes</samp></li>

                  <li class="li"><samp class="codeph nolang">Hours</samp></li>

                  <li class="li"><samp class="codeph nolang">Days</samp></li>

                  <li class="li"><samp class="codeph nolang">Weeks</samp></li>

                  <li class="li"><samp class="codeph nolang">Months</samp></li>

                  <li class="li"><samp class="codeph nolang">Years</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">rhValue</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">string</td>

              <td class="entry" headers="d667707e481" data-title="Description">The right-hand value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d667707e475" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d667707e478" data-title="Field Type">int</td>

              <td class="entry" headers="d667707e481" data-title="Description">Specifies the order of operations for evaluating the expressions. For example, if you
                have two conditions, this field specifies which condition is evaluated
                first.</td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e9a63450c5a83b3833eba718a7c3416071d7604bd460502e72e773b8486cbee3 url=/legacydeveloper/current/en-us/api_meta/meta_mldomain.md -->

# MlDomain

Represents an Einstein Intent Set.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

MlDomain components have the suffix .mlDomain and are stored in the mlDomains folder.

## Version

MlDomain components are available in API version 43.0 and later.

## Special Access Rules

This object is available only if Chat and Einstein Bots are enabled in your org.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Einstein Intent Set description. |
| label | string | Einstein Intent Set name. |
| mlIntents | [MlIntent](#MlIntent)\[\] | List of intents under this Einstein Intent Set. |
| mlSlotClasses | [MlSlotClass](#MlSlotClass)\[\] | List of entities under this Einstein Intent Set. |

## MlIntent

An intent in an Einstein Intent Set.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d670515e205">Field Name</th>

              <th class="featureTableHeader  " id="d670515e208">Field Type</th>

              <th class="featureTableHeader  " id="d670515e211">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d670515e205" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d670515e208" data-title="Field Type">string</td>

              <td class="entry" headers="d670515e211" data-title="Description">Einstein Intent Set description.</td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e205" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d670515e208" data-title="Field Type">string</td>

              <td class="entry" headers="d670515e211" data-title="Description">Required. This unique name prevents conflicts with other Einstein Intent Sets
                associated with the same bot version. This name can contain only underscores and
                alphanumeric characters and must be unique in your org. It must begin with a letter,
                not include spaces, not end with an underscore, and not contain two consecutive
                underscores.<p class="p">Only users with View DeveloperName OR View Setup and Configuration
                  permission can view, group, sort, and filter this field.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e205" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d670515e208" data-title="Field Type">string</td>

              <td class="entry" headers="d670515e211" data-title="Description">Einstein Intent Set name.</td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e205" data-title="Field Name"><span class="keyword parmname">mlIntentUtterances</span></td>

              <td class="entry" headers="d670515e208" data-title="Field Type">
                <a class="xref" href="#MlIntentUtterance">MlIntentUtterance</a>[]
              </td>

              <td class="entry" headers="d670515e211" data-title="Description">List of customer inputs for this intent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e205" data-title="Field Name"><span class="keyword parmname">relatedMlIntents</span></td>

              <td class="entry" headers="d670515e208" data-title="Field Type">
                <a class="xref" href="#MlRelatedIntent">MlRelatedIntent</a>[]
              </td>

              <td class="entry" headers="d670515e211" data-title="Description">List of intents within an Einstein Intent Set used to expand customer inputs
                for this intent. Only intents within local Einstein Intent Sets have related
                intents.</td>

            </tr>

          </tbody>

        </table>

## MlIntentUtterance

A customer input for this intent.

| Field Name | Field Type | Description |
| --- | --- | --- |
| utterance | string | A customer input or natural language query that triggers the parent intent. |

## MlRelatedIntent

An intent in an Einstein Intent Set used to expand customer inputs for this intent. Only intents within local Einstein Intent Sets have related intents.

| Field Name | Field Type | Description |
| --- | --- | --- |
| relatedMlIntent | string | Name of the intent that is used to extend the customer inputs of the current parent intent. |

## MlSlotClass

An entity in this Einstein Intent Set.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d670515e425">Field Name</th>

              <th class="featureTableHeader  " id="d670515e428">Field Type</th>

              <th class="featureTableHeader  " id="d670515e431">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d670515e425" data-title="Field Name"><span class="keyword parmname">dataType</span></td>

              <td class="entry" headers="d670515e428" data-title="Field Type">MlSlotClassDataType (enumeration of type string)</td>

              <td class="entry" headers="d670515e431" data-title="Description">A list of the data types available for the MISlotClass. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Text</samp></li>

                  <li class="li"><samp class="codeph nolang">Number</samp></li>

                  <li class="li"><samp class="codeph nolang">Boolean</samp></li>

                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">DateTime</samp></li>

                  <li class="li"><samp class="codeph nolang">Currency</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e425" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d670515e428" data-title="Field Type">string</td>

              <td class="entry" headers="d670515e431" data-title="Description">A description of an Einstein Bot entity.</td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e425" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d670515e428" data-title="Field Type">string</td>

              <td class="entry" headers="d670515e431" data-title="Description">Required. This unique name prevents conflicts with other entities in an
                Einstein Intent Set. This name can contain only underscores and alphanumeric
                characters, and must be unique in your org. It must begin with a letter, not include
                spaces, not end with an underscore, and not contain two consecutive underscores.
                <p class="p">Only users with View DeveloperName OR View Setup and Configuration permission
                  can view, group, sort, and filter this field.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e425" data-title="Field Name"><span class="keyword parmname">extractionRegex</span></td>

              <td class="entry" headers="d670515e428" data-title="Field Type">string</td>

              <td class="entry" headers="d670515e431" data-title="Description">Regular expression used to extract an entity when the type is set to <samp class="codeph nolang">Pattern</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e425" data-title="Field Name"><span class="keyword parmname">extractionType</span></td>

              <td class="entry" headers="d670515e428" data-title="Field Type">MlSlotClassExtractionType (enumeration of type string)</td>

              <td class="entry" headers="d670515e431" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Pattern</samp></li>

                  <li class="li"><samp class="codeph nolang">Value</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e425" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d670515e428" data-title="Field Type">string</td>

              <td class="entry" headers="d670515e431" data-title="Description">Label that identifies an entity throughout the Salesforce user
                interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d670515e425" data-title="Field Name"><span class="keyword parmname">mlSlotClassValues</span></td>

              <td class="entry" headers="d670515e428" data-title="Field Type">
                <a class="xref" href="#MlSlotClassValue">MlSlotClassValue</a>[]
              </td>

              <td class="entry" headers="d670515e431" data-title="Description">List of entity values associated with an entity of type <samp class="codeph nolang">Value</samp>.</td>

            </tr>

          </tbody>

        </table>

## MlSlotClassValue

An entity value associated with an entity of type Value.

| Field Name | Field Type | Description |
| --- | --- | --- |
| synonymGroup | [SynonymGroup](#SynonymGroup) | Represents a list of terms or synonyms for the current entity value. |
| value | string | Single value used to extract an entity of type Value. |

## SynonymGroup

Represents a group of synonymous words or phrases.

| Field Name | Field Type | Description |
| --- | --- | --- |
| languages | Language (enumeration of type string) | Required. Specifies the languages the value list applies to. If value list items are specific to a single language, specify only that language. If the value list items apply to multiple languages, specify multiple languages for one value list. |
| terms | string | Required. A word or phrase synonymous with other terms in the value list. |

## Declarative Metadata Sample Definition

The following is an example of an MlDomain.

<?xml version="1.0" encoding="UTF-8"?>
<MlDomain xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>TestDomainMetadata</label\>
    <description\>This is domain 2 for metadata testing</description\>
    <mlIntents\>
        <developerName\>Test\_Intent\_New</developerName\>
        <label\>Test Intent New</label\>
        <mlIntentUtterances\>
            <utterance\>Utterance Hello</utterance\>
        </mlIntentUtterances\>
        <mlIntentUtterances\>
            <utterance\>Utterance Hi</utterance\>
        </mlIntentUtterances\>
        <mlIntentUtterances\>
            <utterance\>Utterance What</utterance\>
        </mlIntentUtterances\>
    </mlIntents\>
    <mlIntents\>
        <developerName\>Test\_Intent\_New2</developerName\>
        <label\>Test Intent New 2</label\>
    </mlIntents\>
    <mlSlotClasses\>
        <developerName\>Test\_Entity1</developerName\>
        <label\>Test Entity 1</label\>
        <extractionType\>Value</extractionType\>
        <mlSlotClassValues\>
                <value\>Choice value 1</value\>
            </mlSlotClassValues\>
            <mlSlotClassValues\>
                <value\>Choice value 2</value\>
            </mlSlotClassValues\>
    </mlSlotClasses\>
    <mlSlotClasses\>
        <developerName\>Test\_Entity2</developerName\>
        <label\>Test Entity 2</label\>
        <extractionType\>Pattern</extractionType\>
    </mlSlotClasses\>
    <mlSlotClasses\>
            <dataType\>Text</dataType\>
            <description\>Valid Email Address</description\>
            <developerName\>Email</developerName\>
            <extractionRegex\>\\b\[A-Z0-9.\_%+-\]+@\[A-Z0-9.-\]+\\.\[A-Z\]{2,}\\b</extractionRegex\>
            <extractionType\>Pattern</extractionType\>
            <label\>Email</label\>
    </mlSlotClasses\>
    <mlSlotClasses\>
        <developerName\>airport</developerName\>
        <extractionType\>Value</extractionType\>
        <label\>airport</label\>
        <mlSlotClassValues\>
            <synonymGroup\>
                <languages\>en\_US</languages\>
                <terms\>San Francisco</terms\>
                <terms\>The City</terms\>
            </synonymGroup\>
            <value\>SFO</value\>
        </mlSlotClassValues\>
        <mlSlotClassValues\>
            <synonymGroup\>
                <languages\>en\_US</languages\>
                <terms\>Oakland</terms\>
                <terms\>The Town</terms\>
            </synonymGroup\>
            <value\>OAK</value\>
        </mlSlotClassValues\>
    </mlSlotClasses\>
</MlDomain\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>TestDomainMetadata</members\>
        <name\>MlDomain</name\>
    </types\>
    <version\>43.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a1e6839bdfe43e5cf62ecef0464ce6ae5cb86865843feaf7cb10c5f1484bcac5 url=/legacydeveloper/current/en-us/api_meta/meta_mlpredictiondefinition.md -->

# MLPredictionDefinition

Represents a prediction definition that specifies details about the prediction. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

MLPredictionDefinition components have the suffix .mlPrediction and are stored in the mlPredictions folder.

## Version

MLPredictionDefinition is available in API version 50.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d672555e89">Field Name</th>

              <th class="featureTableHeader  " id="d672555e92">Field Type</th>

              <th class="featureTableHeader  " id="d672555e95">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">aiApplicationDeveloperName</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type">string</td>

              <td class="entry" headers="d672555e95" data-title="Description">Required. Represents the developer name of the parent AI application. Can
                contain only underscores and alphanumeric characters and must be unique in your org.
                It must begin with a letter, not include spaces, not end with an underscore, and not
                contain two consecutive underscores.</td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type">string</td>

              <td class="entry" headers="d672555e95" data-title="Description">Description of the prediction.</td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type">string</td>

              <td class="entry" headers="d672555e95" data-title="Description">Required. Represents the name of the prediction definition. Can contain only
                underscores and alphanumeric characters and must be unique in your org. It must
                begin with a letter, not include spaces, not end with an underscore, and not contain
                two consecutive underscores.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Only users with View DeveloperName OR View Setup
                            and Configuration permission can view, group, sort, and filter this
                            field.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type">string</td>

              <td class="entry" headers="d672555e95" data-title="Description">Label that identifies the ML prediction definition throughout the Salesforce
                user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">negativeExpression</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mldatadefinition.htm#MLFilterVariable">MLFilter</a></td>

              <td class="entry" headers="d672555e95" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">positiveExpression</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mldatadefinition.htm#MLFilterVariable">MLFilter</a></td>

              <td class="entry" headers="d672555e95" data-title="Description">Reserved for future use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">predictionField</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type">string</td>

              <td class="entry" headers="d672555e95" data-title="Description">Field that the prediction is based on.</td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">priority</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type">int</td>

              <td class="entry" headers="d672555e95" data-title="Description">Reflects the priority of the MLPD object when an AIApplication has multiple
                child MLPDs. Nillable.</td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">pushbackField</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type">string</td>

              <td class="entry" headers="d672555e95" data-title="Description">Field that the prediction writes scores to.</td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type">MLPredictionDefinitionStatus (enumeration of type string)</td>

              <td class="entry" headers="d672555e95" data-title="Description">Required. The status of the prediction. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Enabled</samp></li>

                  <li class="li"><samp class="codeph nolang">Disabled</samp></li>

                  <li class="li"><samp class="codeph nolang">Draft</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d672555e89" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d672555e92" data-title="Field Type">AIPredictionType (enumeration of type string)</td>

              <td class="entry" headers="d672555e95" data-title="Description">Required. The type of model that returns the prediction values. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">BinaryClassification</samp></li>

                  <li class="li"><samp class="codeph nolang">DeepLearningIntentClassification</samp></li>

                  <li class="li"><samp class="codeph nolang">DeepLearningNameEntityRecognition</samp></li>

                  <li class="li"><samp class="codeph nolang">GlobalDeepLearningIntentClassification</samp></li>

                  <li class="li"><samp class="codeph nolang">GlobalDeepLearningNameEntityRecognition</samp></li>

                  <li class="li"><samp class="codeph nolang">LanguageDetection</samp></li>

                  <li class="li"><samp class="codeph nolang">MulticlassClassification</samp></li>

                  <li class="li"><samp class="codeph nolang">Regression</samp></li>

                  <li class="li"><samp class="codeph nolang">ScoringSpecificOutcome</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=7f758eee0fde05638f58552594d72bac5b84d2644232a466ec58eff4557e24d2 url=/legacydeveloper/current/en-us/api_meta/meta_mobileapplicationdetail.md -->

# MobileApplicationDetail

Represents the packaging attributes for a mobile connected app. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

MobileApplicationDetail components have the suffix MobileApplicationDetail and are stored in the MobileApplicationDetails folder.

## Version

MobileApplicationDetail components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d673555e85">Field Name</th>

              <th class="featureTableHeader  " id="d673555e88">Field Type</th>

              <th class="featureTableHeader  " id="d673555e91">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">applicationBinaryFile</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">base64</td>

              <td class="entry" headers="d673555e91" data-title="Description">Base 64-encoded binary data file for the mobile app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">applicationBinaryFileName</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">string</td>

              <td class="entry" headers="d673555e91" data-title="Description">Filename for the mobile app binary data file.</td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">applicationBundleIdentifier</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">string</td>

              <td class="entry" headers="d673555e91" data-title="Description">iOS apps only: the unique application bundle identifier.</td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">applicationFileLength</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">int</td>

              <td class="entry" headers="d673555e91" data-title="Description">The length of the mobile app binary data file.</td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">applicationIconFile</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">string</td>

              <td class="entry" headers="d673555e91" data-title="Description">iOS apps only:
                the
                application icon.</td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">applicationIconFileName</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">string</td>

              <td class="entry" headers="d673555e91" data-title="Description">iOS apps only: the application icon filename.</td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">applicationInstallUrl</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">string</td>

              <td class="entry" headers="d673555e91" data-title="Description">URL to install the mobile app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">devicePlatform</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">DevicePlatformType (enumeration&nbsp;of type string)</td>

              <td class="entry" headers="d673555e91" data-title="Description">Required. Platform that supports the mobile app. The valid values are: <ul class="ul bulletList">

                  <li class="li"><samp class="codeph nolang">android</samp></li>

                  <li class="li"><samp class="codeph nolang">ios</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">deviceType</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">string</td>

              <td class="entry" headers="d673555e91" data-title="Description">Supported device type for mobile app. The valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">minitablet</samp></li>

                  <li class="li"><samp class="codeph nolang">phone</samp></li>

                  <li class="li"><samp class="codeph nolang">tablet</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">minimumOsVersion</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">string</td>

              <td class="entry" headers="d673555e91" data-title="Description">Minimum OS version required to install the mobile app.</td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">privateApp</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d673555e91" data-title="Description">Specifies whether the mobile app is private
                (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d673555e85" data-title="Field Name"><span class="keyword parmname">version</span></td>

              <td class="entry" headers="d673555e88" data-title="Field Type">string</td>

              <td class="entry" headers="d673555e91" data-title="Description">Required. Version number of the mobile app.</td>

            </tr>

          </tbody>

        </table>

## Usage

When you create a connected app in Salesforce Classic or Lightning Experience and enter mobile app settings, those settings are stored in a MobileApplicationDetail component. In this example, the metadata retrieved for a connected app includes MobileApplicationDetail metadata.

<?xml version="1.0" encoding="UTF-8"?>
<<ConnectedApp xmlns="http://soap.sforce.com/2006/04/metadata">
  <contactEmail\>paul.chen@salesforce.com</contactEmail\>
  <label\>MobileApplicationDetailConnectedApp</label\>
  <mobileAppConfig\>
    <applicationBinaryFile\></applicationBinaryFile\>
    <applicationInstallUrl\>https://appstore.apple.com/MobileApplicationDetail
        </applicationInstallUrl\>
    <devicePlatform\>ios</devicePlatform\>
    <deviceType\>phone</deviceType\>
    <privateApp\>false</privateApp\>
    <version\>0.0.0.0</version\>
  </mobileAppConfig\>
< . mobileStartUrl>https://www.salesforce.com</mobileStartUrl\>
</ConnectedApp\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=7e4f9b734f2219328f80cd479e201ac4fe06d13725f3c31820fba9e667e0a982 url=/legacydeveloper/current/en-us/api_meta/meta_mobilesecurityassignment.md -->

# MobileSecurityAssignment

Represents the assignment of mobile app security policies to a profile. The policies apply to the Salesforce mobile app with Enhanced Mobile App Security enabled.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

MobileSecurityAssignment components have the suffix .mobileSecurityAssignment and are stored in the mobileSecurityAssignments folder.

## Version

MobileSecurityAssignment components are available in API version 54.0 and later.

## Special Access Rules

The Enhanced Mobile App Security add-on subscription and the Enforce Enhanced Mobile App Security user permission are required to use this metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| connectedApplication | 
Field Type

string

Description

The name of the connected app that’s associated with the mobile security policies assignment.



 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type. The default is false.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for MobileSecurityAssignment, which is defined when the MobileSecurityAssignment component is created.





 |
| profile | 

Field Type

string

Description

The profile that the mobile security policies are assigned to.



 |

## Declarative Metadata Sample Definition

The following is an example of a MobileSecurityAssignment component.

<?xml version="1.0" encoding="UTF-8"?>
<MobileSecurityAssignment xmlns="http://soap.sforce.com/2006/04/metadata">
    <connectedApplication\>MyMobileConnectedApp</connectedApplication\>
    <isProtected\>false</isProtected\>
    <masterLabel\>MyMobileSecurityAssignment</masterLabel\>
    <profile\>admin</profile\>
</MobileSecurityAssignment\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>MobileSecurityAssignment</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=17a3df1bbc4c2c075ad9debfac680b84644fb350d4dcf98991d78909d008cf40 url=/legacydeveloper/current/en-us/api_meta/meta_mobilesecuritypolicy.md -->

# MobileSecurityPolicy

Represents a mobile app security policy on the Salesforce mobile app with Enhanced Mobile App Security enabled. For a full description of each policy, see [Enable and Configure Mobile App Security Policies](https://help.salesforce.com/s/articleView?id=xcloud.mobile_security_mam_setup_ui.htm&type=5&language=en_US).

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

MobileSecurityPolicy components have the suffix .mobileSecurityPolicy and are stored in the mobileSecurityPolicies folder.

## Version

MobileSecurityPolicy components are available in API version 53.0 and later.

## Special Access Rules

The Enhanced Mobile App Security add-on subscription and the Enforce Enhanced Mobile App Security user permission are required to use this metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| effectiveDate | 
Field Type

dateTime

Description

The date that a mobile security policy is enforced.



 |
| isEnabled | 

Field Type

boolean

Description

Required. Indicates whether the mobile security policy is enabled. The default value is false, which means that the policy is disabled.





 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. ​​A user-friendly name for MobileSecurityPolicy, which is defined when the MobileSecurityPolicy component is created.





 |
| mobilePlatform | 

Field Type

MobileSecurityMobilePlatform (enumeration of type string)

Description

The mobile operating system of the mobile security policy.

Values are:

- Android
- iOS





 |
| mobileSecurityAssignment | 

Field Type

string

Description

The name of the mobile security assignment associated with the mobile security policy. See [MobileSecurityAssignment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobilesecurityassignment.htm "Represents the assignment of mobile app security policies to a profile. The policies apply to the Salesforce mobile app with Enhanced Mobile App Security enabled.").



 |
| ruleValue | 

Field Type

string

Description

Required. The value of the mobile security policy rule.





 |
| ruleValueType | 

Field Type

MobileSecurityPolicyRuleValueType (enumeration of type string)

Description

Required. The type of mobile security policy rule.

Values are:

- Boolean
- Text
- TextList





 |
| severityLevel | 

Field Type

MobileSecurityPolicySeverityLevel (enumeration of type string)

Description

Required. The severity level of a mobile security policy.

Values are:

- Critical— Wipes app data and logs user out
- Error—Blocks access to the app until the issue is resolved, but doesn’t log user out
- Info— Blocks prohibited action or logs user action and informs user
- Warn—Notifies the user of the violation and recommends how to resolve, but user is able to continue using the app





 |
| type | 

Field Type

MobileSecurityPolicyType (enumeration of type string)

Description

Required. The type of mobile security policy.

Values are:

- AllowedDeviceList
- Block3dTouch
- BlockCalendar
- BlockCamera
- BlockContacts
- BlockCustomKeyboard
- BlockFileBackup
- BlockMicrophone
- BlockOsSharing
- BlockedDeviceList
- BrowserUriScheme
- CheckBiometric
- DevicePasscode
- DisableUrlCaching
- JailbrokenDevice
- LogCertPin
- LogEmail
- LogPhonecall
- LogPolicyResult
- LogScreenshot
- LogTextmessage
- LogoutAfterRestart
- LogoutOnBiometricChange
- MalwareDetection
- ManInMiddle
- MaxOffline
- MaximumAppVersion
- MaximumOsVersion
- MinimumAppVersion
- MinimumOsVersion
- MinimumSecurityPatchVersion
- MininumAppVersion
- PhonecallUriScheme
- Screenshot





 |

## Declarative Metadata Sample Definition

The following is an example of a MobileSecurityPolicy component.

<?xml version="1.0" encoding="UTF-8"?>
<MobileSecurityPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
    <effectiveDate\>2022-08-09T22:04:56.000Z</effectiveDate\>
    <isEnabled\>true</isEnabled\>
    <isProtected\>false</isProtected\>
    <masterLabel\>MyMobileSecurityPolicy</masterLabel\>
    <mobileSecurityAssignment\>MyMobileSecurityAssignment</mobileSecurityAssignment\>
    <ruleValue\>true</ruleValue\>
    <ruleValueType\>Boolean</ruleValueType\>
    <severityLevel\>info</severityLevel\>
    <type\>BlockCalendar</type\>
    <mobilePlatform\>Android</mobilePlatform\>
</MobileSecurityPolicy\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>MobileSecurityPolicy</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=5b5f8583932c7564fce510a0a803869c104640bd9109e494d81646dc890c00aa url=/legacydeveloper/current/en-us/api_meta/meta_mobilesettings.md -->

# MobileSettings

Represents an organization’s mobile settings. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

[MobileSettings](#meta_mobilesettings "Represents an organization’s mobile settings. This type extends the Metadata metadata type and inherits its fullName field.") is no longer available in API versions 25.0 and 26.0.

## Declarative Metadata File Suffix and Directory Location

[MobileSettings](#meta_mobilesettings "Represents an organization’s mobile settings. This type extends the Metadata metadata type and inherits its fullName field.") values are stored in a single file named Mobile.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

Mobile settings are available in API version 27.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d676436e121">Field</th>

              <th class="featureTableHeader vertical-align-top " id="d676436e124">Field Type</th>

              <th class="featureTableHeader vertical-align-top " id="d676436e127">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">chatterMobile</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type"><a class="xref" href="#ChatterMobileSettings">ChatterMobileSettings</a></td>

              <td class="entry" headers="d676436e127" data-title="Description">
                <span class="ph" id="chatterSettings_descr"><a name="chatterSettings_descr"><!-- --></a>The settings for
                  devices running Chatter mobile.</span> Removed
                in API version 46.0.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">dashboardMobile</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type"><a class="xref" href="#DashboardMobileSettings">DashboardMobileSettings</a></td>

              <td class="entry" headers="d676436e127" data-title="Description"><span class="ph" id="dashboardSettings_descr"><a name="dashboardSettings_descr"><!-- --></a>Deprecated. The settings for
                  devices running the mobile dashboards app.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">enableImportContactFromDevice</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e127" data-title="Description">Indicates whether users can import contacts
                from their mobile device (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>).<p class="p">Available in API version
                  47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">enableLightningOnMobile</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e127" data-title="Description">Indicates whether the org is enabled for the
                Salesforce mobile app. Available in API version
                47.0 only. Removed in API version 48.0. </td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">enableNewSalesforceMobileAppForTablet</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e127" data-title="Description">Indicates whether the org is enabled for the Salesforce mobile
                app tablet experience. Removed in API version 56.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">enableNewSalesforceMobileAppForTabletWideScreen</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e127" data-title="Description">Indicates whether the org is enabled for the
                Salesforce mobile app widescreen tablet
                experience. Available in API version 52.0
                through 55.0. Removed in API version 56.0.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">enableOfflineDraftsEnabled</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e127" data-title="Description">Indicates whether users can create, edit, and
                delete records while offline in the Salesforce
                mobile app (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The
                default value is <samp class="codeph nolang">true</samp>. This option isn’t available
                if <span class="keyword parmname">enableS1OfflinePref</span> is
                set to <samp class="codeph nolang">false</samp>.<p class="p">Available in API version
                  47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">enablePopulateNameManuallyInToday</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e127" data-title="Description">Indicates whether the user’s name is shown on
                the Today page in the Salesforce mobile app
                (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>.<p class="p">Available in API version
                  47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">enableS1EncryptedStoragePref2</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e127" data-title="Description">Indicates whether the Salesforce mobile web
                uses secure and persistent browser caching to
                improve performance (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The
                default value is <samp class="codeph nolang">true</samp>.<p class="p">Available in API version
                  47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">enableS1OfflinePref</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e127" data-title="Description">Indicates whether users can access records
                offline in the Salesforce mobile app (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). This option is set to <samp class="codeph nolang">true</samp> the first
                time someone in your org installs one of the
                Salesforce downloadable apps.<p class="p">Available in API
                  version 47.0 and later. However, offline
                  access isn’t supported in all versions of
                  the downloadable mobile apps. Users must
                  have version 10.0 or later of the Salesforce
                  for Android app or the Salesforce for iOS
                  app. Offline access isn’t available for the
                  Salesforce mobile web.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e121" data-title="Field"><span class="keyword parmname">touchMobile</span></td>

              <td class="entry" headers="d676436e124" data-title="Field Type"><a class="xref" href="#TouchMobileSettings">TouchMobileSettings</a></td>

              <td class="entry" headers="d676436e127" data-title="Description"> The settings for devices running Salesforce
                Touch. Removed in API version 46.0.</td>

            </tr>

          </tbody>

        </table>

## ChatterMobileSettings

These fields are removed in API version 46.0. Represents your organization's Chatter Mobile settings.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d676436e373">Field </th>

              <th class="featureTableHeader vertical-align-top " id="d676436e376">Field Type</th>

              <th class="featureTableHeader vertical-align-top " id="d676436e379">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d676436e373" data-title="Field"><span class="keyword parmname">IPadAuthorized</span></td>

              <td class="entry" headers="d676436e376" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e379" data-title="Description">Indicates whether iPad devices are enabled for Chatter Mobile
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e373" data-title="Field"><span class="keyword parmname">IPhoneAuthorized</span></td>

              <td class="entry" headers="d676436e376" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e379" data-title="Description">Indicates whether iPhone devices are enabled for Chatter Mobile
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e373" data-title="Field"><span class="keyword parmname">androidAuthorized</span></td>

              <td class="entry" headers="d676436e376" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e379" data-title="Description">Indicates whether Android devices are enabled for Chatter Mobile
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e373" data-title="Field"><span class="keyword parmname">blackBerryAuthorized</span></td>

              <td class="entry" headers="d676436e376" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e379" data-title="Description">Indicates whether Blackberry devices are enabled for Chatter
                Mobile (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e373" data-title="Field"><span class="keyword parmname">enableChatterMobile</span></td>

              <td class="entry" headers="d676436e376" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e379" data-title="Description">Indicates whether Chatter Mobile has been enabled for your
                organization (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). <p class="p">Setting this
                  field to <samp class="codeph java">true</samp> enables you to
                  set all the other ChatterMobile settings. If you change this
                  setting from <samp class="codeph java">true</samp> to <samp class="codeph java">false</samp>, and also try to change any
                  of the other ChatterMobile settings, your deployment fails with
                  an error. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e373" data-title="Field"><span class="keyword parmname">enablePushNotifications</span></td>

              <td class="entry" headers="d676436e376" data-title="Field Type">boolean</td>

              <td class="entry" headers="d676436e379" data-title="Description">Indicates whether Chatter push notifications have been enabled
                for your organization (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>)</td>

            </tr>

            <tr>
              <td class="entry" headers="d676436e373" data-title="Field"><span class="keyword parmname">sessionTimeout</span></td>

              <td class="entry" headers="d676436e376" data-title="Field Type">MobileSessionTimeout (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d676436e379" data-title="Description">
                <p class="p">The length of time after which users without activity are
                  prompted to log out or continue working. Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Never</samp></li>

                  <li class="li"><samp class="codeph nolang">OneMinute</samp></li>

                  <li class="li"><samp class="codeph nolang">FiveMinutes</samp></li>

                  <li class="li"><samp class="codeph nolang">TenMinutes</samp></li>

                  <li class="li"><samp class="codeph nolang">ThirtyMinutes</samp></li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## DashboardMobileSettings

These fields are deprecated. Represents your organization's Mobile Dashboards iPad app settings.

| Field | Field Type | Description |
| --- | --- | --- |
| enableDashboardIPadApp | boolean | Indicates whether Mobile Dashboards iPad app has been enabled for your organization (true) or not (false). |

## TouchMobileSettings

These fields are removed in API version 46.0. Salesforce Touch has been upgraded to the Salesforce mobile app.

| Field | Field Type | Description |
| --- | --- | --- |
| enableTouchBrowserIPad | boolean | Indicates whether your organization has the Salesforce Touch mobile browser app enabled (true) or not (false). |
| enableTouchAppIPad | boolean | Indicates whether your organization has the Salesforce Touch downloadable app enabled (true) or not (false) |

## Declarative Metadata Sample Definition

Here’s a sample mobile.settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>
<MobileSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableImportContactFromDevice\>true</enableImportContactFromDevice\>
    <enableOfflineDraftsEnabled\>true</enableOfflineDraftsEnabled\>
    <enableS1EncryptedStoragePref2\>true</enableS1EncryptedStoragePref2\>
    <enableS1OfflinePref\>true</enableS1OfflinePref\>
</MobileSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=95a46d008f95c00e6bcb8bfe8350a2f1af64e94de4d277fbbb2801c21306c7e5 url=/legacydeveloper/current/en-us/api_meta/meta_mobsecuritycertpinconfig.md -->

# MobSecurityCertPinConfig

Represents the authentication server certificate pin configuration on the Salesforce mobile app with Enhanced Mobile Security.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

MobSecurityCertPinConfig components have the suffix .mobSecurityCertPinConfig and are stored in the mobSecurityCertPinConfigs folder.

## Version

MobSecurityCertPinConfig components are available in API version 53.0 and later.

## Special Access Rules

The Enhanced Mobile App Security add-on subscription and the Enforce Enhanced Mobile App Security user permission are required to use this metadata type.

## Fields

| Field Name | Description |
| --- | --- |
| certificateHash | 
Field Type

string

Description

Required. The unique identifier for the certificate.





 |
| domainName | 

Field Type

string

Description

Required.

The name of the domain for the server that you want to pin the certificate to. For example, https://MyDomainName.my.salesforce.com.



 |
| isEnabled | 

Field Type

boolean

Description

Required. Indicates whether authentication server certificate pinning is enabled. The default value is false, which means that certificate pinning is disabled.





 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is false.



 |
| isSubdomainIncluded | 

Field Type

boolean

Description

Required. Indicates whether subdomains use the same certificate pinning configuration as the specified domainName. The default value is false.





 |
| masterLabel | 

Field Type

string

Description

Required. ​A user-friendly name for MobSecurityCertPinConfig, which is defined when the MobSecurityCertPinConfig component is created.





 |
| mobilePlatform | 

Field Type

MobileSecurityMobilePlatform (enumeration of type string)

Description

The mobile operating system.

Values are:

- Android
- iOS





 |
| mobileSecurityAssignment | 

Field Type

string

Description

The name of the mobile security assignment associated with the mobile security policy. See [MobileSecurityAssignment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobilesecurityassignment.htm "Represents the assignment of mobile app security policies to a profile. The policies apply to the Salesforce mobile app with Enhanced Mobile App Security enabled.").



 |
| severityLevel | 

Field Type

MobileSecurityPolicySeverityLevel (enumeration of type string)

Description

Required. The severity level of the mobile security policy.

Values are:

- Critical— Wipes app data and logs user out
- Error—Blocks access to the app until the issue is resolved, but doesn’t log user out
- Info— Blocks prohibited action or logs user action and informs user
- Warn—Notifies the user of the violation and recommends how to resolve, but user is able to continue using the app





 |
| type | 

Field Type

MobileSecurityCertPinType (enumeration of type string)

Description

Required. The type of pin.

Values are:

- AuthServer
- Resource





 |

## Declarative Metadata Sample Definition

The following is an example of a MobSecurityCertPinConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<MobileSecurityCertPinConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <certificateHash\>AaBbCcDdEeFfGg</certificateHash\>
    <domainName\>login.salesforce.com</domainName\>
    <isEnabled\>true</isEnabled\>
    <isProtected\>false</isProtected\>
    <masterLabel\>AuthenticationServerCertificatePinning</masterLabel\>
    <mobilePlatform\>Android</mobilePlatform\>
    <mobileSecurityAssignment\>MyMobileSecurityAssignment</mobileSecurityAssignment\>
    <severityLevel\>info</severityLevel\>
    <type\>AuthServer</type\>
</MobileSecurityCertPinConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>MobileSecurityCertPinConfig</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=cc438490008ad211f85ef6373f21a72f4ba5579c24d68d9821fc279d1176ef7b url=/legacydeveloper/current/en-us/api_meta/meta_moderationrule.md -->

# ModerationRule

Represents a rule used in your Experience Cloud site to moderate member-generated content. Each rule specifies the member-generated content the rule applies to, the criteria to enforce the rule on, and the moderation action to take. Moderation rules help protect your site from spammers, bots, and offensive or inappropriate content. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

Moderation rules created with the Metadata API are more powerful than moderation rules set up in the Experience Management UI. For example, in the UI you could create a rule that moderates posts and comments. In the Metadata API you could create a rule that moderates only the Link Name of a Link feed type. Use the Metadata API to express complex moderation rules.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Don’t update moderation rules you create using the Metadata API in the Experience Management UI. If you do, you overwrite relevant Metadata API fields or the fields are ignored.

Keep the following things in mind when creating moderation rules:

- Your org can have up to 30 rules. This limit is per org, not per site. This limit includes both content rules and rate rules.
- Each rule can have up to three keyword criteria.
- Rules that block content run first, followed by rules to review and approve content, then rules that replace content, and last by rules that flag content. If two or more rules perform the same action, the oldest rule runs first, based on the date the rule was created. Rules to replace content don’t run when the content also applies to a review rule—we want community managers to review the original content.

## File Suffix and Directory Location

ModerationRule components have the suffix .rule and are stored in the moderation directory of the corresponding package directory. The file name format follows site\_name.moderation\_rule\_developer\_name.rule.

## Version

ModerationRule components are available in API version 36.0 and later.

## Special Access Rules

To view, create, edit, and delete moderation rules, you need the Manage Experiences or Create and Set Up Experiences permission. As of Spring ’20 and later, only users with permission to edit moderation rules can access this object.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d679372e129">Field Name</th>

              <th class="featureTableHeader  " id="d679372e132">Field Type</th>

              <th class="featureTableHeader  " id="d679372e135">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d679372e129" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d679372e132" data-title="Field Type">ModerationRuleAction (enumeration of type string)</td>

              <td class="entry" headers="d679372e135" data-title="Description">
                <span class="ph" id="action_desc"><a name="action_desc"><!-- --></a>Required. Indicates the moderation action that you want to
                  take. The valid values are:</span><a name="moderationruleaction_values"><!-- --></a>
                <ul class="ul bulletList" id="moderationruleaction_values">
                  <li class="li"><samp class="codeph nolang">Block</samp></li>

                  <li class="li"><samp class="codeph nolang">Review</samp></li>

                  <li class="li"><samp class="codeph nolang">Replace</samp></li>

                  <li class="li"><samp class="codeph nolang">Flag</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">FreezeAndNotify</samp> (Reserved for future
                    use.)
                  </li>


                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e129" data-title="Field Name"><span class="keyword parmname">actionLimit</span></td>

              <td class="entry" headers="d679372e132" data-title="Field Type">int</td>

              <td class="entry" headers="d679372e135" data-title="Description">
                <span class="ph" id="actionLimit_desc"><a name="actionLimit_desc"><!-- --></a>Indicates the moderation action limit.</span> Available
                in API 39.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e129" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d679372e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d679372e135" data-title="Description"><span class="ph" id="active_desc"><a name="active_desc"><!-- --></a>Required. Indicates whether the moderation rule is active
                  (<samp class="ph systemoutput">true</samp>) or inactive
                  (<samp class="ph systemoutput">false</samp>).</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e129" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d679372e132" data-title="Field Type">string</td>

              <td class="entry" headers="d679372e135" data-title="Description"><span class="ph" id="description_desc"><a name="description_desc"><!-- --></a>A description of the moderation rule.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e129" data-title="Field Name"><span class="keyword parmname">entitiesAndFields</span></td>

              <td class="entry" headers="d679372e132" data-title="Field Type">ModerateEntityField[]</td>

              <td class="entry" headers="d679372e135" data-title="Description"><span class="ph" id="entitiesfields_desc"><a name="entitiesfields_desc"><!-- --></a>Indicates the types of user-generated content this
                  moderation rule applies to.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e129" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d679372e132" data-title="Field Type">string</td>

              <td class="entry" headers="d679372e135" data-title="Description"><span class="ph" id="label_desc"><a name="label_desc"><!-- --></a>Required. Label for the moderation rule.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e129" data-title="Field Name"><span class="keyword parmname">notifyLimit</span></td>

              <td class="entry" headers="d679372e132" data-title="Field Type">int</td>

              <td class="entry" headers="d679372e135" data-title="Description">
                <span class="ph" id="notifyLimit_desc"><a name="notifyLimit_desc"><!-- --></a>Indicates the notification limit of the moderation
                  rule.</span> Available in API 39.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e129" data-title="Field Name"><span class="keyword parmname">userCriteria</span></td>

              <td class="entry" headers="d679372e132" data-title="Field Type">string</td>

              <td class="entry" headers="d679372e135" data-title="Description">
                <span class="ph" id="userCriteria_desc"><a name="userCriteria_desc"><!-- --></a>Represents the member criteria to use in moderation
                  rules.</span> Available in API 39.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e129" data-title="Field Name"><span class="keyword parmname">userMessage</span></td>

              <td class="entry" headers="d679372e132" data-title="Field Type">string</td>

              <td class="entry" headers="d679372e135" data-title="Description"><span class="ph" id="usermessage_desc"><a name="usermessage_desc"><!-- --></a>The message you want your members to see when their
                  content is blocked. Use the <var class="keyword varname">%BLOCKED_KEYWORD%</var> variable to
                  display up to five blocked words in the user message. If you don’t specify a
                  message, the member sees the standard message: “You can’t use
                  <var class="keyword varname">%BLOCKED_KEYWORD%</var> or other inappropriate words in this site.
                  Review your content and try again.”</span></td>

            </tr>

          </tbody>

        </table>

## ModeratedEntityField

The fields and entities you want to moderate.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d679372e334">Field Name</th>

              <th class="featureTableHeader  " id="d679372e337">Field Type</th>

              <th class="featureTableHeader  " id="d679372e340">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d679372e334" data-title="Field Name"><span class="keyword parmname">entityName</span></td>

              <td class="entry" headers="d679372e337" data-title="Field Type">string</td>

              <td class="entry" headers="d679372e340" data-title="Description"><span class="ph" id="entityname_desc"><a name="entityname_desc"><!-- --></a>Required. Indicates the types of user-generated
                  content the moderation rule applies to. Post and comments only apply to content
                  created in groups and user profiles. All feed types, such as polls and links, are
                  supported.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e334" data-title="Field Name"><span class="keyword parmname">fieldName</span></td>

              <td class="entry" headers="d679372e337" data-title="Field Type">string</td>

              <td class="entry" headers="d679372e340" data-title="Description">
                <span class="ph" id="fieldname_desc"><a name="fieldname_desc"><!-- --></a>Indicates the field the moderation rule applies
                  to.</span>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>To moderate feed posts, use <span class="keyword parmname">entityName</span>
                            <samp class="codeph nolang">FeedItem</samp> with <span class="keyword parmname">fieldName</span>
                            <samp class="codeph nolang">RawBody</samp>. To moderate feed comments, use
                            <span class="keyword parmname">entityName</span>
                            <samp class="codeph nolang">FeedComment</samp> with
                            <span class="keyword parmname">fieldName</span>
                            <samp class="codeph nolang">RawCommentBody</samp>. The <samp class="codeph nolang">RawBody</samp> and <samp class="codeph nolang">RawCommentBody</samp> fields aren’t available in any other
                            API.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d679372e334" data-title="Field Name"><span class="keyword parmname">keywordList</span></td>

              <td class="entry" headers="d679372e337" data-title="Field Type">KeywordList string</td>

              <td class="entry" headers="d679372e340" data-title="Description"><span class="ph" id="keywordlist_desc"><a name="keywordlist_desc"><!-- --></a>Indicates the keyword list that you want to moderate
                  against.</span></td>

            </tr>

          </tbody>

        </table>

## ModerationRuleType

Required. Indicates the type of rule to run on user-generated content.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d679372e449">Field Name</th>

              <th class="featureTableHeader  " id="d679372e452">Field Type</th>

              <th class="featureTableHeader  " id="d679372e455">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d679372e449" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d679372e452" data-title="Field Type"> (enumeration of type string)</td>

              <td class="entry" headers="d679372e455" data-title="Description">
                <span class="ph" id="moderationruletype_desc"><a name="moderationruletype_desc"><!-- --></a>Required. Indicates the type of rule to run on
                  user-generated content. </span> Valid values are:<ul class="ul bulletList">
                  <li class="li">Content</li>

                  <li class="li">Rate</li>

                </ul>
                Available in API 39.0 and later.
              </td>

            </tr>

          </tbody>

        </table>

## RateLimitTimePeriod

Required. Indicates the time period that is applied to the rate limit.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d679372e513">Field Name</th>

              <th class="featureTableHeader  " id="d679372e516">Field Type</th>

              <th class="featureTableHeader  " id="d679372e519">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d679372e513" data-title="Field Name"><span class="keyword parmname">timePeriod</span></td>

              <td class="entry" headers="d679372e516" data-title="Field Type"> (enumeration of type string)</td>

              <td class="entry" headers="d679372e519" data-title="Description">
                <span class="ph" id="ratelimittimeperiod_desc"><a name="ratelimittimeperiod_desc"><!-- --></a>Required. Indicates the time period that is
                  applied to the rate limit.</span> Valid values are:<ul class="ul bulletList">
                  <li class="li">Short</li>

                  <li class="li">Medium</li>

                </ul>
                Available in API 39.0 and later.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ModerationRule component.

<?xml version="1.0" encoding="UTF-8"?>
<ModerationRule xmlns="http://soap.sforce.com/2006/04/metadata">
   <description\>Blocks Bad Word List in posts, comments, Link URLs, titles, and poll choices.</description\>
   <masterLabel\>Blocking Rule</masterLabel\>
   <action\>Block</action\>
   <active\>true</active\>
   <userMessage\>You can't use %BLOCKED\_KEYWORD% or other inappropriate words in this site. Review your content and try again.</userMessage\>
   <!-- Applies the rule to FeedComment.RawCommentBody (an internal only field), if it contains words from the keyword list specified -->
   <entitiesAndFields\>
     <entityName\>FeedComment</entityName\>
     <fieldName\>RawCommentBody</fieldName\>
     <keywordList\>site1.badword\_list</keywordList\>
   </entitiesAndFields\>
   <entitiesAndFields\>
     <entityName\>FeedItem</entityName\>
     <fieldName\>LinkUrl</fieldName\>
     <keywordList\>site1.badword\_list</keywordList\>
   </entitiesAndFields\>
   <!-- Applies the rule to FeedItem.RawBody (an internal only field), if it contains words from the keyword list specified -->
   <entitiesAndFields\>
     <entityName\>FeedItem</entityName\>
     <fieldName\>RawBody</fieldName\>
     <keywordList\>site1.badword\_list</keywordList\>
   </entitiesAndFields\>
   <entitiesAndFields\>
     <entityName\>FeedItem</entityName\>
     <fieldName\>Title</fieldName\>
     <keywordList\>site1.badword\_list</keywordList\>
   </entitiesAndFields\>
   <entitiesAndFields\>
     <entityName\>FeedPollChoice</entityName\>
     <fieldName\>ChoiceBody</fieldName\>
     <keywordList\>site1.badword\_list</keywordList\>
   </entitiesAndFields\>
</ModerationRule\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
     <name\>ModerationRule</name\>
     <members\>site1.blocking\_rule</members\>
   </types\>
   <version\>36.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=0d4bf5078e7f0b3c844035d4b22ba79a92c5af8d9e27f2eb3b8caa4878ce3e3f url=/legacydeveloper/current/en-us/api_meta/meta_use_cases_to_from_scratch_org.md -->

# Move Metadata Changes to and from a Scratch Org

Use a scratch org to develop and test changes to metadata. You can perform your development within or outside the scratch org using Salesforce CLI or Salesforce Extensions for VS Code, which leverage the power of Metadata API.

Scratch orgs are created empty so that developers can specify the exact metadata and data to include from the source control system. The lifespan of a scratch org is indicated during creation, 1–30 days. They’re ephemeral to ensure the source of truth is always the source control system, and not the org itself.

You can move metadata from the source control system or to the scratch org using Salesforce CLI. Because scratch orgs use source tracking to identify changes, the CLI is the most efficient way to move metadata between your local repository and the scratch org. Continue to iterate through this process of moving metadata between your local file system and your scratch org until development is complete.

#### See Also

- [Push Source to the Scratch Org](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_push_md_to_scratch_org.htm)
- [Pull Source from the Scratch Org to Your Project](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_pull_md_from_scratch_org.htm)

<!-- document id=391da329492b4ec11f8fe927934544490fd56eb09714aa0a5ef99211d52bd0e8 url=/legacydeveloper/current/en-us/api_meta/meta_use_cases_prod_level_changes.md -->

# Move Metadata for Production-Level Changes

Use Metadata API to move metadata during large changes, such as merging or splitting Salesforce orgs.

To split an org, first retrieve the metadata to be moved. Then, use a deploy call to push those configurations to the new org. Similarly, to merge two orgs, retrieve existing metadata from one org. Next, use a deploy call to migrate metadata from one org to another.

#### See Also

- [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.")
- [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.")

<!-- document id=d64bf139ba28092d1f2290524c3ca66823cf20b2d077974bb27811334c0816a9 url=/legacydeveloper/current/en-us/api_meta/meta_use_cases_prod_to_local.md -->

# Move Metadata from Production to Your Local File System

To make development changes without affecting your existing configurations, use Metadata API to move metadata to your local file system. Next, push metadata from your local file system to a shareable repository for development.

When you build customizations on Salesforce, you must preserve the functionality of your existing org during the development cycle. To build customizations without affecting your production org, save your production metadata in a version control system. Git integrates best with SFDX tools.

First, move the required metadata from the production org to your local file system. To move metadata to your local machine, use a retrieve call instead of a source pull. Next, push your files to a repository that is accessible to your team members with Git commands. The repository is now the original source of production metadata for your team’s development cycle.

Now that your production metadata is stored in a repository, move the necessary metadata back to your local file system to begin development work.

#### See Also

- [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.")
- [source Commands](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source)

<!-- document id=bdd9b9342ebdfc75531c07a01094baf75dddb6598ced2e1f2a2ff4e7880d3f4f url=/legacydeveloper/current/en-us/api_meta/meta_use_cases_move_to_sandbox.md -->

# Move Metadata to a Sandbox at Integration Points

During development, use Metadata API to move metadata to sandboxes for integrating changes, testing, and collaborating with your team.

After developing on your own in a scratch org or your local file system, combine work from your team at integration points in a sandbox. Sandboxes are development environments that you can use to integrate and test changes from multiple developers. Admins often create and assign sandboxes. To create a sandbox on the Salesforce UI, navigate to Setup. Next, in the Quick Find box, search for sandboxes.

You have several levels of sandboxes to choose from with differing amounts of data. The Developer sandbox and Developer Pro sandbox are development environments where you build customizations and test changes on fictional data. The Partial Copy sandbox and Full sandbox are testing environments loaded with copies of production data. Move metadata to different sandboxes with a Metadata API deploy command depending on your development and testing needs.

Outside of Metadata API, admins typically use change sets to send customizations from one sandbox to another. Unlike Metadata API calls, you must build change sets manually. To add components to a continuous integration system more easily, you can automate Metadata API calls on Salesforce CLI.

#### See Also

- [Sandbox Types and Templates](https://help.salesforce.com/s/articleView?id=platform.create_test_instance.htm&type=5&language=en_US)
- [Change Sets](https://help.salesforce.com/s/articleView?id=platform.changesets.htm&type=5&language=en_US)
- [Continuous Integration](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_ci.htm)

<!-- document id=4acc9dcce732fb10a12c2617c8350f937c2e3edc17df88284f8d5a8a11a25e60 url=/legacydeveloper/current/en-us/api_meta/meta_mutingpermissionset.md -->

# MutingPermissionSet

Represents a set of disabled permissions and is used in conjunction with [PermissionSetGroup](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionsetgroup.htm "Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed.").

This type extends the [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionset.htm "Represents a set of permissions that's used to grant more access to one or more users without changing their profile or reassigning profiles. You can use permission sets to grant access but not to deny access.") metadata type.

## Declarative Metadata File Suffix and Directory Location

Muting permission sets are stored in the mutingpermissionsets directory. The file name matches the muting permission set API name and the extension is .mutingpermissionset. For example, a mutingpermissionsets with the name Finance\_Mgmt\_MutingPermSet is stored in mutingpermissionsets/Finance\_Mgmt\_MutingPermSet.mutingpermissionset.

## Version

This object is available in API version 46.0 and later.

## Special Access Rules

As of Summer ’20 and later, only users who have one of these permissions can access this type:

- View Setup and Configuration
- Manage Session Permission Set Activations
- Assign Permission Sets
- Manage Profiles and Permission Sets

To view the following settings, assignments, and permissions for standard and custom objects in a specified muting permission set, the View Setup and Configuration permission is required.

- Client settings
- Field permissions
- Layout assignments
- Object permissions
- Permission dependencies
- Permission set tab settings
- Permission set group components
- Record types

## Fields

MutingPermissionSet has the same fields as [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionset.htm "Represents a set of permissions that's used to grant more access to one or more users without changing their profile or reassigning profiles. You can use permission sets to grant access but not to deny access."), plus a single field, label, used to name a MutingPermissionSet. Unlike PermissionSet, settings enabled by MutingPermissionSet are turned off for the permission set group that it’s a component of.

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The name of the muting permission set. |

## Declarative Metadata Sample Definition

The following example deploys a MutingPermissionSet used in a Permission Set Group intended for users submitting job applications for a custom application. The muting permission set has administrative permissions enabled to ensure that they’re muted in the Permission Set Group.

<?xml version="1.0" encoding="UTF-8"?>
<MutingPermissionSet xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>Job Apps User Muted</label\>
    <description\>Mutes any administrative tasks for the Job Apps user</description\>
    <hasActivationRequired\>false</hasActivationRequired\>
    <license\>Salesforce</license\>
    <applicationVisibilities\>
        <application\>JobApps\_\_Approval</application\>
        <visible\>true</visible\>
    </applicationVisibilities\>
    <classAccesses\>
        <apexClass\>ApprovalUtility</apexClass\>
        <enabled\>true</enabled\>
    </classAccesses\>
    <customPermissions\>
        <enabled\>true</enabled\>
        <name\>JobAppApprover</name\>
    </customPermissions\>
    <fieldPermissions\>
        <editable\>false</editable\>
        <field\>Job\_Request\_\_c.Salary\_\_c</field\>
        <readable\>true</readable\>
    </fieldPermissions\>
    <objectPermissions\>
        <allowCreate\>true</allowCreate\>
        <allowDelete\>true</allowDelete\>
        <allowEdit\>true</allowEdit\>
        <allowRead\>true</allowRead\>
        <customizeSetup\>true</customizeSetup\>
        <deleteSetup\>true</deleteSetup\>
        <modifyAllRecords\>true</modifyAllRecords\>
        <object\>Approval\_Confirmation\_\_c</object\>
        <viewAllRecords\>true</viewAllRecords\>
        <viewSetup\>true</viewSetup\>
    </objectPermissions\>
    <pageAccesses\>
        <apexPage\>Job\_Approval\_Web\_Form</apexPage\>
        <enabled\>true</enabled\>
    </pageAccesses\>
    <recordTypeVisibilities\>
        <recordType\>Approval\_Confirmation\_\_c.DevManager</recordType\>
        <visible\>true</visible\>
    </recordTypeVisibilities\>
    <tabSettings\>
        <tab\>Approval\_Confirmation\_\_c</tab\>
        <visibility\>Visible</visibility\>
    </tabSettings\>
</MutingPermissionSet\>

The following is an example package.xml manifest used to retrieve the MutingPermissionSet metadata for an organization.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Job\_Apps\_User</members\>
        <name\>PermissionSetGroup</name\>
    </types\>
    <types\>
        <members\>Job\_Apps\_User\_Muted</members\>
        <name\>MutingPermissionSet</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [PermissionSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionset.htm "Represents a set of permissions that's used to grant more access to one or more users without changing their profile or reassigning profiles. You can use permission sets to grant access but not to deny access.")

<!-- document id=aaeefd9e6c3ce17adf0fe6ed1b8ea035709322fc56681201c710d3522d70dbbc url=/legacydeveloper/current/en-us/api_meta/meta_mydomaindiscoverablelogin.md -->

# MyDomainDiscoverableLogin

Represents the configuration settings when the My Domain login page type is Discovery. Login Discovery provides an identity-first login experience, where the login page contains the identifier field only. Based on the identifier entered, a handler determines how to authenticate the user. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

MyDomainDiscoverableLogin components have the suffix .myDomainDiscoverableLogin in the myDomainDiscoverableLogins folder.

## Version

MyDomainDiscoverableLogin components are available in API version 48.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| apexHandler | string | Required. The Apex handler class that contains the Discovery authentication logic. |
| executeApexHandlerAs | string | The user who is executing the handler. Requires the Manage User permission. |
| usernameLabel | string | The login prompt when the My Domain login page type is Discovery. This label supports localization with custom labels. |

## Declarative Metadata Sample Definition

The following is an example of a MyDomainDiscoverableLogin component.

<?xml version="1.0" encoding="UTF-8"?>
<MyDomainDiscoverableLogin xmlns="http://soap.sforce.com/2006/04/metadata">
    <apexHandler\>MyDomainDiscLoginHandler</apexHandler\>
    <executeApexHandlerAs\>executeUser@example.com</executeApexHandlerAs\>
    <usernameLabel\>Enter your email</usernameLabel\>
</MyDomainDiscoverableLogin\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>MyDomainDiscoverableLogin</name\>
    </types\>
    <version\>48.0</version\>
</Package\>

## Usage

Use this type to access the My Domain Login Discovery Page. This type of login page prompts users to identity themselves with an email address, phone number, or custom identifier. My Domain Login Discovery performs an interview-based login process, where users are prompted to provide identity for authentication. For example, users receive a verification code that they enter to complete the login process.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=42fd03524941afa7d0e7b67874811c033186b6762181a3074977fcd52283d918 url=/legacydeveloper/current/en-us/api_meta/meta_mydomainsettings.md -->

# MyDomainSettings

Represents your org’s My Domain settings. With My Domain, you can include your company name in your URLs, for example, https://yourcompanyname.my.salesforce.com. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

MyDomainSettings values are stored in a single file named MyDomain.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

MyDomainSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d681709e93">Field Name</th>

              <th class="featureTableHeader  " id="d681709e96">Field Type</th>

              <th class="featureTableHeader  " id="d681709e99">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">areLegacyRedirectsMaintained</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">Salesforce checks this field when this org is upgraded to Summer ’25. If
                <span class="keyword parmname">areLegacyRedirectsMaintained</span> is <samp class="codeph nolang">false</samp>, Salesforce disables <span class="keyword parmname">enableLegacyRedirections</span>
                during the upgrade. If <samp class="codeph nolang">true</samp>, no change is made
                to <span class="keyword parmname">enableLegacyRedirections</span> during the upgrade. The default is
                <samp class="codeph nolang">false</samp>.<p class="p">This field has no impact after this
                  org is on Summer ’25.</p>
                <p class="p">Available in API version 63.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">areLgcyRdirMaintainedWntr26</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">Salesforce checks this field when this org is upgraded to Winter ’26. If
                <span class="keyword parmname">areLgcyRdirMaintainedWntr26</span> is <samp class="codeph nolang">false</samp>, Salesforce disables <span class="keyword parmname">enableLegacyRedirections</span>
                during the upgrade. If <samp class="codeph nolang">true</samp>, no change is made
                to <span class="keyword parmname">enableLegacyRedirections</span> during the upgrade. The default is
                <samp class="codeph nolang">false</samp>.<p class="p">This field has no impact after this
                  org is on Winter ’26.</p>
                <p class="p">Available in API version 64.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">canOnlyLoginWithMyDomainUrl</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <samp class="codeph nolang">true</samp>, users must use the org's My
                Domain login URL to log in. If <samp class="codeph nolang">false</samp> (default),
                users can also log in using the org’s instance Salesforce URL,
                <span class="ph filepath">https://<var class="keyword varname">InstanceName</var>.salesforce.com</span>, and
                through the login URL <span class="ph filepath">https://login.salesforce.com</span>.<p class="p">Admins
                  can log in to a sandbox via the <strong class="ph uicontrol">Log In</strong> action on the
                  Sandboxes Setup page only when <span class="keyword parmname">canOnlyLoginWithMyDomainUrl</span> is
                  <samp class="codeph nolang">false</samp> in the sandbox.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">doesApiLoginRequireOrgDomain</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <samp class="codeph nolang">true</samp>, users must use the org’s My
                Domain login URL to access the Salesforce API. If <samp class="codeph nolang">false</samp> (default), users can also access the Salesforce API using the
                generic Salesforce page,
                <span class="ph filepath">https://<var class="keyword varname">InstanceName</var>.salesforce.com</span> and
                through the login URL <span class="ph filepath">https://login.salesforce.com</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">doesWarnOnForceComRedirect</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">Indicates whether users who visit a previous *.force.com site URL for this org
                see a message with the current URL during redirections (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                is <samp class="codeph nolang">false</samp>.<p class="p">This field is applicable only
                  when</p>
                <ul class="ul bulletList">
                  <li class="li">Your org has a previous *.force.com URL associated with an Experience Cloud
                    site or Salesforce Site.</li>

                  <li class="li">
                    <span class="keyword parmname">redirectForceComSiteUrls</span> is <samp class="codeph nolang">true</samp>
                  </li>

                </ul>
                <p class="p">This field is available in API version 59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">doesWarnOnRedirect</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">Indicates whether users who visit a previous My Domain URL see a message with
                the current URL during redirections (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>.<p class="p">This field is applicable only when</p>
                <ul class="ul bulletList">
                  <li class="li">Your org has a previous My Domain. For example, after an admin deploys a
                    change to the My Domain.</li>

                  <li class="li">The previous My Domain hasn’t been removed via the Routing options on the My
                    Domain Setup page. If the previous My Domain is removed, calls to URLs
                    associated with that My Domain aren’t redirected.</li>

                  <li class="li">
                    <span class="keyword parmname"><span class="keyword parmname">redirectPriorMyDomain</span></span> is <samp class="codeph nolang">true</samp>.
                  </li>

                </ul>
                <p class="p">This field is available in API version 59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">domainPartition</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">OrgDomainShard (enumeration of type string)</td>

              <td class="entry" headers="d681709e99" data-title="Description">The partition for this org. When <samp class="codeph nolang">none</samp>,
                partitioned domains aren’t enabled. Otherwise, My Domain hostnames include the
                partition value. For example, the format of a My Domain login hostname for a
                Developer Edition org with partitioned domains is
                <span class="ph filepath"><var class="keyword varname">MyDomainName</var>.develop.my.salesforce.com</span>.<p class="p">This
                  field is read-only in the API. Possible values are: </p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">demo</samp>—Used in demo orgs. Available
                    in API version 60.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">develop</samp>—Used in Developer Edition
                    orgs. Also used in patch orgs where partitioned domains were deployed before
                    Winter ’24.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">free</samp>—Reserved for internal
                    use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">none</samp>—Indicates that this org
                    doesn’t use partitioned domains.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">patch</samp>—Used in patch orgs.
                    Available in API version 59.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sandbox</samp>—Used in sandboxes with
                    enhanced domains. These orgs are always partitioned.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">scratch</samp>—Used in scratch orgs.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sfdctest</samp>—Reserved for internal
                    use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">trailblaze</samp>—Used in Trailblazer
                    Playgrounds.
                  </li>

                </ul>
                <p class="p">Partitioned domains require enhanced domains.
                  Production
                  orgs always have a value of <samp class="codeph nolang">none</samp>, and only
                  the sandbox partition is available in Government Cloud—Defense
                  orgs.</p>
                <p class="p">Qualifying new orgs are partitioned by default and get the
                  corresponding <span class="keyword parmname">domainPartition</span> value. You can’t disable this
                  feature in those orgs.</p>
                <p class="p">Available in API version 55.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">edgeRoutingMethod</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">edgeRoutingOption (enumeration of type string)</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <span class="keyword parmname">useEdge</span> is <samp class="codeph nolang">true</samp>,
                the routing method for traffic for requests to this org. If
                <span class="keyword parmname">useEdge</span> is <samp class="codeph nolang">false</samp>, this
                field has no effect. The default is <samp class="codeph nolang">global</samp>.<p class="p">Possible values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">global</samp>—Route requests to the
                    Salesforce Edge Network location closest to the origin of the request. This
                    method provides the best performance and security.
                  </li>

                  <li class="li">
                    <p class="p"><samp class="codeph nolang">regional</samp>—Route requests to
                      Salesforce locations only in the country where your org is located. </p>

                    <p class="p">This routing method is only available in orgs on a Hyperforce instance in
                      Japan.</p>

                    <p class="p">This routing method can result in increased round-trip time for requests,
                      especially for users located outside of your country.</p>

                  </li>

                  <li class="li">
                    <samp class="codeph nolang">gsr</samp>— Route requests to the nearest
                    reliable network node while bypassing specific network locations in the Middle
                    East where your users face connectivity issues due to firewall blockages.
                  </li>

                </ul>
                <p class="p">This field is read-only in the API. Update this setting on the My Domain
                  Setup page.</p>
                <p class="p">Available in API version 65.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">enableCrossDomainPreviewCookies</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <span class="keyword parmname">isFirstPartyCookieUseRequired</span> is <samp class="codeph nolang">true</samp>, indicates whether cross-domain cookies are
                allowed on the Experience Builder preview domain (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">If
                  <span class="keyword parmname">isFirstPartyCookieUseRequired</span> is <samp class="codeph nolang">false</samp>, this field has no effect.
                </p>
                <p class="p">Available in
                  API version 62.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">enableEdgeDuringRollout</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">Indicates whether Salesforce Edge Network is enabled in this org during the
                scheduled rollout. If <samp class="codeph nolang">true</samp>, Salesforce notifies
                admins by email before Salesforce Edge Network is enabled. If <samp class="codeph nolang">false</samp>, the Edge enablement is deferred. The default
                value is <samp class="codeph nolang">true</samp>. <p class="p">If
                  <span class="keyword parmname">useEdge</span> is <samp class="codeph nolang">true</samp>, this
                  field has no effect.
                </p>
                <p class="p">Available in API version 58.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">enableExtendedRedirections</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If Salesforce configured temporary extended redirections for select legacy
                hostnames for this org, indicates whether calls to those hostnames are redirected
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. If
                extended redirections aren’t configured for this org, this field has no
                effect.<p class="p">Available in API version 62.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">enableLegacyRedirections</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <span class="keyword parmname">redirectPriorMyDomain</span> is <samp class="codeph nolang">true</samp>, indicates whether legacy hostnames for this org are redirected
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">If any of these conditions are true, this field has no
                  effect.</p>
                <ul class="ul bulletList">
                  <li class="li">No legacy (non-enhanced) hostnames exist for the org</li>

                  <li class="li">
                    <span class="keyword parmname">redirectPriorMyDomain</span> is <samp class="codeph nolang">false</samp>
                  </li>

                  <li class="li">Salesforce stopped legacy redirections for this org</li>

                </ul>
                <p class="p">For more information about the end of legacy hostname redirections, see
                  <a class="xref" href="https://help.salesforce.com/s/articleView?id=products.domain_name_redirections_non_enhanced.htm&amp;type=5&amp;language=en_US" target="_blank">Prepare for the End of Redirections for
                    Non-Enhanced Domains</a> in Salesforce Help.
                </p>
                <p class="p">Available in API version
                  62.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">enableNativeBrowserForAuthOnAndroid</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <samp class="codeph nolang">true</samp>, use the native browser for
                authentication of Android mobile apps. Default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">enableNativeBrowserForAuthOnIos</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <samp class="codeph nolang">true</samp>, use the native browser for
                authentication of iOS mobile apps. Default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">instancedUrlRedirectHandling</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">OrgDomainRedirectOption (enumeration of type string)</td>

              <td class="entry" headers="d681709e99" data-title="Description">Indicates how user visits to this org’s instanced URL are handled.<p class="p">Possible
                  values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Redirect</samp>—Redirect users to the
                    equivalent page on this org’s My Domain hostnames.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WarnOnRedirect</samp>—Display a brief
                    warning message to users as they are redirected to the equivalent page on this
                    org’s My Domain hostnames.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NoRedirect</samp>—Require users to use
                    your My Domain hostnames when they view this org’s pages. Visits to this page’s
                    instanced URL aren’t redirected.
                  </li>

                </ul>
                <p class="p">For example, when a user visits <samp class="codeph nolang">https://<var class="keyword varname">InstanceName</var>.lightning.force.com/lightning/page/home</samp>,
                  this setting determines whether they’re redirected to <samp class="codeph nolang">https://<var class="keyword varname">MyDomainName</var>.lightning.force.com/lightning/page/home</samp>.</p>
                <p class="p">The
                  value of this field has no effect on user’s ability to log in via the org’s
                  instanced URL. To control that behavior, use
                  <span class="keyword parmname">canOnlyLoginWithMyDomainUrl</span>.
                </p>
                <p class="p">Available in API version
                  59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">isFirstPartyCookieUseRequired</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">Indicates whether the <samp class="codeph nolang">SameSite=None</samp>
                attribute is removed from Salesforce cookies (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). In Salesforce
                orgs created in Summer ’24 and later, the default is <samp class="codeph nolang">true</samp>. In all other orgs, the default is <samp class="codeph nolang">false</samp>.<p class="p">Service Cloud Voice with Amazon Connect and Service Cloud Voice
                  with Partner Telephony from Amazon Connect aren’t compatible with this setting. If
                  you use those features, set <span class="keyword parmname">isFirstPartyCookieUseRequired</span> to
                  <samp class="codeph nolang">false</samp>. <a class="xref" href="https://help.salesforce.com/s/articleView?id=004333227&amp;type=1&amp;language=en_US" target="_blank"><u class="ph u">Learn more</u></a>.
                </p>
                <p class="p">Available in API
                  version 61.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">isIcorInstApiTrafficBlocked</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">This field is reserved for future use. The default is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version 64.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">logRedirections</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <samp class="codeph nolang">true</samp>, Salesforce produces a log for the
                Hostname Redirects event type when daily event logs are generated. The default is
                <samp class="codeph nolang">false</samp>. <p class="p">The Hostname Redirects event is
                  free for all customers with a 24-hour data retention period. When
                  <span class="keyword parmname">logRedirections</span> is <samp class="codeph nolang">true</samp>, this event is available in the API but not in the Event
                  Monitoring Analytics app. You can also download the latest Hostname Redirects
                  event log file through a button on the My Domain page.
                </p>
                <p class="p">Available in API
                  version 56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname" id="myDomainName"><a name="myDomainName"><!-- --></a>myDomainName</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">string</td>

              <td class="entry" headers="d681709e99" data-title="Description">The subdomain name used in My Domain URLs for this org, such as <samp class="codeph nolang"><span class="keyword parmname">MyDomainName</span>.my.salesforce.com</samp>
                and <samp class="codeph nolang"><span class="keyword parmname">MyDomainName</span>.lightning.force.com</samp>.<p class="p">This field is
                  read-only in the API. You can change your org’s My Domain name from the My Domain
                  Setup page.</p>
                <p class="p">Available in API version 51.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname" id="myDomainSuffix"><a name="myDomainSuffix"><!-- --></a>myDomainSuffix</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">OrgDomainProdSuffix (enumeration of type string)</td>

              <td class="entry" headers="d681709e99" data-title="Description">The domain suffix for this org’s My Domain login URL. This field is read-only
                in the API.<p class="p">Possible values are: </p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang" id="CloudforceSuffix"><a name="CloudforceSuffix"><!-- --></a>CloudforceLimited</samp>—<span class="ph filepath">cloudforce.com</span>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="DatabaseSuffix"><a name="DatabaseSuffix"><!-- --></a>DatabaseLimited</samp>—<span class="ph filepath">database.com</span>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MySalesforce</samp>—<span class="ph filepath">my.salesforce.com</span> with
                    enhanced domains
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="StandardSuffix"><a name="StandardSuffix"><!-- --></a>MySalesforceLimited</samp>—<span class="ph filepath">my.salesforce.com</span>
                    without enhanced domains
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OrgLevelCertificate</samp>—<span class="ph filepath">my-salesforce.com</span>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OrgLevelCertificateLimited</samp>—legacy
                    version of <span class="ph filepath">my-salesforce.com</span> that’s noncompliant with
                    browser settings that block third-party cookies
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Restricted1</samp>—Reserved for future
                    use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Restricted2</samp>—Reserved for future
                    use.
                  </li>

                </ul>
                <p class="p">Available in API version 51.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">onboardCustomerSpecificSuffix</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">This field is reserved for future use. The default is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version 63.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">redirectForceComSiteUrls</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <samp class="codeph nolang">true</samp>, calls to URLs ending in
                <span class="ph filepath">.force.com</span> that serve your Experience Cloud sites and
                Salesforce Sites are redirected to the corresponding current My Domain site URL. If
                <samp class="codeph nolang">false</samp>, these calls aren’t redirected and the
                user gets a file not found (404) error. The default is <samp class="codeph nolang">true</samp>.<p class="p">This field is only applicable when</p>
                <ul class="ul bulletList">
                  <li class="li">Enhanced domains are enabled.</li>

                  <li class="li">Your org has a previous *.force.com URL associated with an Experience Cloud
                    site or Salesforce Site.</li>

                </ul>
                <p class="p">Available in API version 55.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">redirectPriorMyDomain</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">If <samp class="codeph nolang">true</samp>, calls to URLs associated with
                your previous My Domain name are redirected to the corresponding URL associated with
                your current My Domain. If <samp class="codeph nolang">false</samp>, these calls
                aren’t redirected. When you deploy a new My Domain, this setting resets to its
                default, <samp class="codeph nolang">true</samp>.<p class="p">This field is only applicable
                  when</p>
                <ul class="ul bulletList">
                  <li class="li">Your org has a previous My Domain. For example, after an admin deploys a
                    change to the My Domain.</li>

                  <li class="li">The previous My Domain hasn’t been removed via the Routing options on the My
                    Domain Setup page. If the previous My Domain is removed, calls to URLs
                    associated with that My Domain aren’t redirected.</li>

                </ul>
                <p class="p">Available in API version 54.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">use3rdPartyCookieBlockingCompatibleHostnames</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">Indicates whether the org’s instance name is included in Visualforce URLs when
                third-party cookies are blocked (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). This field has a default value of
                <samp class="codeph nolang">true</samp>. Setting this field <samp class="codeph nolang">true</samp> prevents potential issues loading Visualforce
                pages with stabilized URLs.<p class="p">Only applicable when DatabaseLimiteduseStabilizedMyDomainHostnames<samp class="codeph nolang"> is set to
                    true</samp> and myDomainSuffix is set to </p>
                <p class="p">Available in API version
                  51.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">useEdge</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">
                <p class="p">Indicates whether this org’s qualifying My Domain URLs are routed through
                  Salesforce Edge Network (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>). This field has a default value of
                  <samp class="codeph nolang">true</samp>.
                </p>

                <p class="p">This field is read-only in the API. If your org can use Salesforce Edge Network,
                  you can enable this setting from the My Domain Setup page. After this field is set
                  to <samp class="codeph nolang">true</samp> from Setup, it can't be set to
                  <samp class="codeph nolang">false</samp>.
                </p>

                <p class="p">Available in API version 51.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">useEnhancedDomainsInSandbox</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">This field corresponds to the previous My Domain setting, Use enhanced domains
                by default in new and refreshed sandboxes, that was removed in Summer
                ’23.<p class="p">Previously, in API versions 55.0 to 57.0, if enhanced domains weren’t
                  enabled, this field indicated whether new and refreshed sandboxes created from
                  this org used enhanced domains by default (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>), and the
                  default value was <samp class="codeph nolang">true</samp>. As of API version
                  58.0, this field’s value is always <samp class="codeph nolang">true</samp>,
                  regardless of the value that you set. Changing its value has no effect on
                  Salesforce, even if it reads <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname" id="useStabilizedMyDomainHostnames"><a name="useStabilizedMyDomainHostnames"><!-- --></a>useStabilizedMyDomainHostnames</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">Indicates whether the instance name is hidden in My Domain URLs for
                Visualforce, Experience Builder, Site.com Studio, and content files (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">true</samp>. For example,
                <span class="ph filepath"><var class="keyword varname">MyDomainName</var>--<var class="keyword varname">PackageName</var>.na44.visual.force.com</span>
                becomes
                <span class="ph filepath"><var class="keyword varname">MyDomainName</var>--<var class="keyword varname">PackageName</var>.visualforce.com</span>
                when this field is set to <samp class="codeph nolang">true</samp>.<p class="p">Only
                  applicable when DatabaseLimitedmyDomainSuffix is set
                  to </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d681709e93" data-title="Field Name"><span class="keyword parmname">useStabilizedSandboxMyDomainHostnames</span></td>

              <td class="entry" headers="d681709e96" data-title="Field Type">boolean</td>

              <td class="entry" headers="d681709e99" data-title="Description">This field corresponds to the Stabilize the Hostname for My Domain URLs in
                Sandboxes release update, which was enforced in Summer ’20.<p class="p">When <samp class="codeph nolang">true</samp>, the instance name is hidden in My Domain URLs
                  for sandboxes orgs. For example,
                  <span class="ph filepath"><var class="keyword varname">MyDomainName</var>--test.cs5.my.salesforce.com</span>
                  became
                  <span class="ph filepath"><var class="keyword varname">MyDomainName</var>--test.my.salesforce.com</span>. As
                  of API version 49.0, this field's value is always <samp class="codeph nolang">true</samp>, regardless of the value that you set. Changing its value has no
                  effect on Salesforce, even if it reads <samp class="codeph nolang">false</samp>.
                </p>
                <p class="p">This change applies retroactively back to API version 47.0, when this field
                  was first introduced. Previously, in API version 47.0 to 49.0, this field
                  indicated whether the instance name was hidden in My Domain URLs for sandboxes
                  orgs (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>), and the field's default value was <samp class="codeph nolang">false</samp>. Now, in all API versions, this field's value
                  is always <samp class="codeph nolang">true</samp>, even if it reads <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a MyDomainSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<MyDomainSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <areLegacyRedirectsMaintained\>false</areLegacyRedirectsMaintained\>
    <areLgcyRdirMaintainedWntr26\>false</areLgcyRdirMaintainedWntr26\>
    <canOnlyLoginWithMyDomainUrl\>false</canOnlyLoginWithMyDomainUrl\>
    <doesApiLoginRequireOrgDomain\>false</doesApiLoginRequireOrgDomain\>
    <doesWarnOnForceComRedirect\>false</doesWarnOnForceComRedirect\>
    <doesWarnOnRedirect\>true</doesWarnOnRedirect\>
    <domainPartition\>none</domainPartition\>
    <edgeRoutingMethod\>global</edgeRoutingMethod\>
    <enableCrossDomainPreviewCookies\>true</enableCrossDomainPreviewCookies\>
    <enableEdgeDuringRollout\>true</enableEdgeDuringRollout\>
    <enableExtendedRedirections\>false</enableExtendedRedirections\>
    <enableLegacyRedirections\>false</enableLegacyRedirections\>
    <enableNativeBrowserForAuthOnAndroid\>false</enableNativeBrowserForAuthOnAndroid\>
    <enableNativeBrowserForAuthOnIos\>false</enableNativeBrowserForAuthOnIos\>
    <instancedUrlRedirectHandling\>false</instancedUrlRedirectHandling\>
    <isFirstPartyCookieUseRequired>true</isFirstPartyCookieUseRequired>
    <isIcorInstApiTrafficBlocked\>true</isIcorInstApiTrafficBlocked\>
    <logRedirections\>true</logRedirections\>
    <myDomainName\>mycompany</myDomainName\>
    <myDomainSuffix\>MySalesforce</myDomainSuffix\>
    <onboardCustomerSpecificSuffix\>false</onboardCustomerSpecificSuffix\>
    <redirectForceComSiteUrls\>true</redirectForceComSiteUrls\>
    <redirectPriorMyDomain\>true</redirectPriorMyDomain\>
    <use3rdPartyCookieBlockingCompatibleHostnames\>true</use3rdPartyCookieBlockingCompatibleHostnames\>
    <useEdge\>true</useEdge\>
    <useEnhancedDomainsInSandbox\>true</useEnhancedDomainsInSandbox\>
    <useStabilizedMyDomainHostnames\>true</useStabilizedMyDomainHostnames\>
    <useStabilizedSandboxMyDomainHostnames\>true</useStabilizedSandboxMyDomainHostnames\>
</MyDomainSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyDomain</members\>
        <name\>Settings</name\>
    </types\>
    <version\>65.0</version\>
</Package\>

<!-- document id=60313367d0bd492f334aaf5259e0eeb34640b84dd7517f38661928d81b79103d url=/legacydeveloper/current/en-us/api_meta/meta_namedcredential.md -->

# NamedCredential

Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

All credentials stored within this entity are encrypted under a framework that is consistent with other encryption frameworks on the platform. Salesforce encrypts your credentials by auto-creating org-specific keys. Credentials encrypted using the previous encryption scheme have been migrated to the new framework.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

NamedCredential components have the suffix .namedCredential and are stored in the namedCredentials folder.

## Version

NamedCredential components are available in API version 33.0 and later.

## Special Access Rules

As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this type.

## Fields

| Field Name | Description |
| --- | --- |
| allowMergeFieldsInBody | 
Field Type

boolean

Description

Specifies whether Apex code can use merge fields to populate the HTTP request body with org data when a callout is made. Corresponds to **Allow Merge Fields in HTTP Body** in the user interface. Defaults to false.

This field is available in API version 41.0 and later.





 |
| allowMergeFieldsInHeader | 

Field Type

boolean

Description

Specifies whether Apex code can use merge fields to populate the HTTP header with org data when a callout is made. Corresponds to **Allow Merge Fields in HTTP Header** in the user interface. Defaults to false.

This field is available in API version 41.0 and later.





 |
| authProvider | 

Field Type

string

Description

The authentication provider that the AuthProvider component represents.

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| authTokenEndpointUrl | 

Field Type

string

Description

The URL where JWTs are exchanged for access tokens.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| awsAccessKey | 

Field Type

string

Description

First part of the access key used to sign programmatic requests to AWS. Use when AWS Signature Version 4 is your authentication protocol.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| awsAccessSecret | 

Field Type

string

Description

The second part of the access key that's used to sign programmatic requests to AWS. Use when AWS Signature Version 4 is your authentication protocol.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| awsRegion | 

Field Type

string

Description

Specifies which AWS Region the named credential accesses.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| awsService | 

Field Type

string

Description

Specifies which AWS resource the named credential accesses.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| calloutStatus | 

Field Type

calloutStatus (enumeration of type string)

Description

Specifies whether the named credential is enabled for callouts. Valid values are:

- Disabled: The named credential is disabled for callouts.
- Enabled: The named credential is enabled for callouts.

This field is available in API version 59.0 and later.





 |
| certificate | 

Field Type

string

Description

If you specify a certificate, your Salesforce org supplies it when establishing each two-way SSL connection with the external system. The certificate is used for digital signatures, which verify that requests are coming from your Salesforce org.

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| description | 

Field Type

string

Description

A meaningful description of the named credential.



 |
| endpoint | 

Field Type

string

Description

The URL or root URL of the callout endpoint. Corresponds to **URL** in the user interface.

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| generateAuthorizationHeader | 

Field Type

boolean

Description

Specifies whether Salesforce generates an authorization header and applies it to each callout that references the named credential. Corresponds to **Generate Authorization Header** in the user interface. Defaults to true.

This field is available in API version 41.0 and later.





 |
| jwtAudience | 

Field Type

string

Description

External service or other allowed recipients for the JWT. Written as JSON, with a quoted string for a single audience and an array of quoted strings for multiple audiences. Single audience example: “aud1” Multiple audiences example: \[“aud1”, “aud2”, “aud3”\].

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| jwtFormulaSubject | 

Field Type

string

Description

Formula string calculating the Subject of the JWT. API names and constant strings, in single quotes, can be included. Allows a dynamic Subject unique per user requesting the token. For example, 'User='+$User.Id. Use this field when principalType is set to PerUser. Corresponds to Per User Subject in the user interface.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| jwtIssuer | 

Field Type

string

Description

Specify who issued the JWT using a case-sensitive string.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| jwtSigningCertificate | 

Field Type

string

Description

Certificate verifying the JWT’s authenticity to external sites.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| jwtTextSubject | 

Field Type

string

Description

Static text, without quotes, that specifies the JWT Subject. Use this field when principalType is set to NamedUser. Corresponds to Named Principal Subject in the user interface.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| jwtValidityPeriodSeconds | 

Field Type

int

Description

Specify the number of seconds that the token is valid.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 46.0, this field is deprecated in API version 56.0 and later.**





 |
| label | 

Field Type

string

Description

Required.

A user-friendly name for the named credential that appears in the Salesforce user interface, such as in list views.



 |
| namedCredentialParameters | 

Field Type

[NamedCredentialParameter\[\]](#subtype_NamedCredentialParameter)

Description

Reference to the (one or more) NamedCredentialParameter used to configure a named credential.

This field is available in API version 56.0 and later.





 |
| namedCredentialType | 

Field Type

NamedCredentialType (enumeration of type string)

Description

Specifies the type or behavior of this named credential. Valid values are:

- Legacy: The named credential is a legacy type, which means that it doesn’t use the schema introduced in the Winter ‘23 release. Used for backward compatibility.
- PrivateEndpoint: The named credential sends traffic through a private connection, bypassing the public internet. If the credential type is PrivateEndpoint, you must specify the value of OutboundNetworkConnection.
- SecuredEndpoint: The named credential is extensible and uses external credentials to control authentication and permissions.
- Standard: Reserved for internal use.

This field is available in API version 56.0 and later.





 |
| oauthRefreshToken | 

Field Type

string

Description

The OAuth refresh token. Used to obtain a new access token for an end user when a token expires.

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| oauthScope | 

Field Type

string

Description

Specifies the scope of permissions to request for the access token. Corresponds to **Scope** in the user interface.

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| oauthToken | 

Field Type

string

Description

The access token that’s issued by your authorization server.

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| outboundNetworkConnection | 

Field Type

string

Description

Specifies the outbound network connection that uses the named credential to send callouts to AWS.

This field is valid only when NamedCredentialType is set to Legacy.

**First available in API version 49.0, this field is deprecated in API version 56.0 and later.**





 |
| password | 

Field Type

string

Description

The password to be used by your org to access the external system. Ensure that the credentials have adequate privileges to access the external system. Depending on how you set up access, you might need to provide the administrator password.

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| principalType | 

Field Type

ExternalPrincipalType (enumeration of type string)

Description

Determines whether you're using one set or multiple sets of credentials to access the external system. Corresponds to **Identity Type** in the user interface. Values are:

- Anonymous
- NamedUser
- PerUser

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| protocol | 

Field Type

AuthenticationProtocol (enumeration of type string)

Description

The authentication protocol that’s required to access the external system. Valid values are:

- AwsSv4
- Jwt
- JwtExchange
- NoAuthentication
- Oauth
- Password

For connections to Amazon Web Services using Signature Version 4, use AwsSv4.

For connections using a direct token system, select Jwt. If using an intermediary authorization provider to process JWTs and return access tokens, use JwtExchange.

For Simple URL data sources, select NoAuthentication.

For cloud-based Files Connect external systems, select Oauth. For on-premises systems, select Password.

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |
| username | 

Field Type

string

Description

The username to be used by your org to access the external system. Ensure that the credentials have adequate privileges for performing callouts to the external system. Depending on how you set up access, you might need to provide the administrator username.

This field is valid only when NamedCredentialType is set to Legacy.

**This field is deprecated in API version 56.0.**





 |

## NamedCredentialParameter

Represents the parameters that configure a named credential. Named credential parameters are used to configure Named Credential callouts through a combination of the type, name, and value/lookup fields. Available in API version 56.0 and later.

These parameters are used internally to provide a flexible architecture and are exposed here for packaging reasons.

| Field Name | Description |
| --- | --- |
| certificate | 
Field Type

string

Description

If the value of the parameterType field is ClientCertificate then this field references the certificate.



 |
| description | 

Field Type

string

Description

A human-readable description of this named credential parameter.



 |
| externalCredential | 

Field Type

string

Description

If the value of the parameterType field is Authentication, then this field references an external credential that in turn references a set of authenticated user credentials.



 |
| globalNamedPrincipalCredential | 

Field Type

boolean

Description

Reserved for internal use.



 |
| managedFeatureEnabledCallout | 

Field Type

boolean

Description

Reserved for internal use.



 |
| outboundNetworkConnection | 

Field Type

string

Description

The lookup field for the OutboundNetworkConnection parameter type. Used when namedCredentialType is PrivateEndpoint.



 |
| parameterName | 

Field Type

string

Description

Required.

The name of the named credential parameter.



 |
| parameterType | 

Field Type

NamedCredentialParamType (enumeration of type string)

Description

Required.

The type of the named credential parameter. Valid values are:

- AllowedManagedPackageNamespaces: Allows managed packages identified by specified namespaces to use the named credential and make callouts through it.
- Authentication: Specifies that this parameter configures authentication using the credentials specified in the external credential, referenced by the externalCredential field.
- ClientCertificate: Specifies that this parameter configures a client certificate, referenced by the certificate field.
- ConnectionStatus: Reserved for internal use.
- CreatedByNamespace: Reserved for internal use.
- CustomParameter: Reserved for internal use.
- HttpHeader: Allows the user to specify custom headers to be added to the callout at run time. When using HttpHeader, the parameterName field must be the header name as a string, and parameterValue must be a formula of a header value that is evaluated at run time.
- ManagedByComponent: Reserved for internal use.
- ManagedByFeature: Reserved for internal use.
- ManagedByNamespace: Specifies the manageability capabilities for a packaged named credential. The parameterValue indicates whether the named credential uses subscriber-controlled or developer-controlled manageability.
- NamedCredentialOptions: Reserved for internal use.
- OutboundNetworkConnection: Specifies a lookup to an outbound network connection. When using this parameter type, the outboundNetworkConnection field is a string representing the lookup. Used when namedCredentialType is PrivateEndpoint.
- SfHttpRequestExtensionName: Reserved for internal use.
- StandardNamedCredentialType: Reserved for internal use.
- Url: Specifies that this parameter configures the URL of the endpoint. Store the actual URL in the parameterValue field.





 |
| parameterValue | 

Field Type

string

Description

If the parameterType field describes a literal value, such as Url, then the literal value is stored in this field, such as https://iam.amazonaws.com/.



 |
| readOnlyNamedCredential | 

Field Type

boolean

Description

Reserved for internal use.



 |
| sequenceNumber | 

Field Type

int

Description

Used to order HttpHeader parameters.



 |
| systemUserNamedCredential | 

Field Type

boolean

Description

Reserved for internal use.



 |

## Declarative Metadata Sample Definition

The following is an example of a NamedCredential component.

<?xml version="1.0" encoding="UTF-8"?>
<NamedCredential xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>SampleNamedCredential</label\>
    <namedCredentialType\>SecuredEndpoint</namedCredentialType\>
    <namedCredentialParameters\>
        <description\>IAM Endpoint</description\>
        <parameterName\>DefaultEndpoint</parameterName\>
        <parameterType\>Url</parameterType\>
        <parameterValue\>https://iam.amazonaws.com/</parameterValue\>
    </namedCredentialParameters\>
    <namedCredentialParameters\>
        <description\>AWS Auth</description\>
        <parameterName\>DefaultAuth</parameterName\>
        <parameterType\>Authentication</parameterType\>
        <externalCredential\>SampleExternalCredential</externalCredential\>
    </namedCredentialParameters\>
    <namedCredentialParameters\>
        <description\>Cert</description\>
        <parameterName\>DefaultCert</parameterName\>
        <parameterType\>ClientCertificate</parameterType\>
        <certificate\>MyCertificate</certificate\>
    </namedCredentialParameters\>
    <allowMergeFieldsInBody\>true</allowMergeFieldsInBody\>
    <allowMergeFieldsInHeader\>true</allowMergeFieldsInHeader\>
    <generateAuthorizationHeader\>true</generateAuthorizationHeader\>
</NamedCredential\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>NamedCredential</name>
    </types>
    <version>56.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [ExternalCredential](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalcredential.htm "Represents the details of how Salesforce authenticates to the external system.")
- [_Salesforce Help_: Named Credentials](https://help.salesforce.com/s/articleView?id=xcloud.named_credentials_about.htm&type=5&language=en_US "Salesforce Help: Named Credentials - HTML (New Window)")
- [_Named Credentials Developer Guide_: Get Started with Named Credentials](https://developer.salesforce.com/docs/platform/named-credentials/guide/get-started.html "Named Credentials Developer Guide: Get Started with
    Named Credentials - HTML (New Window)")
- [_Named Credentials Developer Guide_: Named Credential API Links](https://developer.salesforce.com/docs/platform/named-credentials/references/named-credentials-reference/nc-api-links.html "Named Credentials Developer Guide: Named Credential
    API Links - HTML (New Window)")
- [_Apex Developer Guide_: Invoking Callouts Using Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_callouts.htm " Apex Developer Guide: Invoking Callouts Using
    Apex - html (New Window)")
- [_Apex Developer Guide_: Named Credentials as Callout Endpoints](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_callouts_named_credentials.htm " Apex Developer Guide: Named Credentials as Callout
    Endpoints - HTML (New Window)")

<!-- document id=860f97e7b4e8f64174d1406edd370d89521e9d793c16085cdc81bc58c3496c08 url=/legacydeveloper/current/en-us/api_meta/namedfilter.md -->

# NamedFilter

Represents the metadata associated with a lookup filter. This metadata type is used to create, update, or delete lookup filter definitions. This component has been removed as of API version 30.0 and is only available in previous API versions. The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField component.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. You can also use this metadata type to work with customizations of lookup filters on standard fields.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The namedFilter appears as a child of the target object of the associated lookup field.

## Declarative Metadata File Suffix and Directory Location

Lookup filters are defined as part of the custom object or standard object definition. See [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.") for more information.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet components that are retrieved in the same package.

## Version

Lookup filters are available in API version 17.0 and later. However, the NamedFilter type was removed in API version 30.0. The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField type.

## Fields

Unless otherwise noted, all fields are creatable, filterable, and nillable.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1041301e109">Field Name</th>

              <th class="featureTableHeader  " id="d1041301e112">Field Type</th>

              <th class="featureTableHeader  " id="d1041301e115">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1041301e115" data-title="Description">Required. Indicates whether the lookup filter is active.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">string</td>

              <td class="entry" headers="d1041301e115" data-title="Description">Specifies advanced filter conditions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">string</td>

              <td class="entry" headers="d1041301e115" data-title="Description">A description of what this filter does.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname">errorMessage</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">string</td>

              <td class="entry" headers="d1041301e115" data-title="Description"><span class="ph" id="errormsg"><a name="errormsg"><!-- --></a>The error message that appears if the lookup
                  filter fails.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname" id="field"><a name="field"><!-- --></a>field</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">string</td>

              <td class="entry" headers="d1041301e115" data-title="Description">Required. The <span class="keyword parmname">fullName</span> of the custom or
                standard field associated with the lookup filter. You can associate
                one relationship field with each lookup filter, and vice
                versa.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>You can’t update a field associated with a lookup
                            filter.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname">filterItems</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type"><a class="xref" href="#filteritems">FilterItems[]</a></td>

              <td class="entry" headers="d1041301e115" data-title="Description">Required. The set of filter conditions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname">infoMessage</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">string</td>

              <td class="entry" headers="d1041301e115" data-title="Description"><span class="ph" id="infomsg"><a name="infomsg"><!-- --></a>The information message displayed on the page.
                  Use to describe things the user might not understand, such as
                  why certain items are excluded in the lookup
                  filter.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname" id="field_fullName"><a name="field_fullName"><!-- --></a>fullName</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">string</td>

              <td class="entry" headers="d1041301e115" data-title="Description">Inherited from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for this
                metadata type. It must be specified when creating, updating, or
                deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a>
                to see an example of this field specified for a call.<p class="p" id="no_null_para"><a name="no_null_para"><!-- --></a>This value can’t be <samp class="codeph java">null</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname">isOptional</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1041301e115" data-title="Description">Required. Indicates whether the lookup filter is
                optional.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">string</td>

              <td class="entry" headers="d1041301e115" data-title="Description"><span class="ph" id="lookupname"><a name="lookupname"><!-- --></a>Required. The name of the lookup filter. If
                  you create this field in the user interface, a name is
                  automatically assigned. If you create this field through
                  Metadata API, you must include the <span class="keyword parmname">name</span>
                  field.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d1041301e109" data-title="Field Name"><span class="keyword parmname">sourceObject</span></td>

              <td class="entry" headers="d1041301e112" data-title="Field Type">string</td>

              <td class="entry" headers="d1041301e115" data-title="Description">The object that contains the lookup field that uses this lookup
                filter. Set this field if the lookup filter references fields on the
                source object.</td>

            </tr>

          </tbody>

        </table>

Lookup filters use additional data types. For more information, see [Metadata Field Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm "These field types extend the field types described in the Salesforce Object Reference.").

## FilterItems

FilterItems contains the following properties:

| Field | Field Type | Description |
| --- | --- | --- |
| field | string | Represents the field specified in the filter. |
| operation | FilterOperation (enumeration of type string) | Represents the filter operation for this filter item. Valid values are enumerated in [FilterOperation](#filteroperation). |
| value | string | Represents the value of the filter item being operated upon, for example, if the filter is my\_number\_field\_\_c > 1, the value of value is 1. |

## FilterOperation

Here’s an enumeration of type string that lists different filter operations. Valid values are:

- equals
- notEqual
- lessThan
- greaterThan
- lessOrEqual
- greaterOrEqual
- contains
- notContain
- startsWith
- includes
- excludes

## Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
....
    <namedfilters\>
        <fullName\>nf\_Acc</fullName\>
        <active\>true</active\>
        <booleanFilter\>1 OR 2</booleanFilter\>
        <field\>Account.lk\_\_c</field\>
        <filterItems\>
            <field\>Account.Phone</field\>
            <operation\>notEqual</operation\>
            <value\>x</value\>
        </filterItems\>
        <filterItems\>
            <field\>Account.Fax</field\>
            <operation\>notEqual</operation\>
            <value\>y</value\>
        </filterItems\>
        <name\>Acc</name\>
        <sourceObject\>Account</sourceObject\>
    </namedfilters\>
....
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_marketingobject.htm "MarketingObject")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm "Picklist (Including Dependent Picklist)")

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")
- [Picklist (Including Dependent Picklist)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm "Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.")
- [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.")
- [CustomField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm "Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.")

<!-- document id=5979e5a9858e9f84bd93f0cc54d682c4d28d6e1ad91aecf2fec1aec1eb6f50f1 url=/legacydeveloper/current/en-us/api_meta/meta_namesettings.md -->

# NameSettings

Enables or disables the formal name, middle name, and suffix attributes for these person objects: Contact, Lead, Person Account, and User. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

You can’t enable local name fields programmatically via the Metadata API. For more information about enabling local fields, see [Local Name Fields](https://help.salesforce.com/s/articleView?id=xcloud.admin_local_name_fields.htm&language=en_US "HTML (New Window)") and [Enable ‘Local Name’ Fields](https://help.salesforce.com/s/articleView?id=000386837&type=1&language=en_US "HTML (New Window)").

## File Suffix and Directory Location

NameSettings values are stored in a single file named Name.settings in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

NameSettings components are available in API version 31.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableInformalName | boolean | Reserved for internal use. Available in API version 48.0 and later. |
| enableMiddleName | boolean | Indicates whether middle names are enabled (true) or disabled (false) for person objects. |
| enableNameSuffix | boolean | Indicates whether suffixes are enabled (true) or disabled (false) for person objects. |

## Declarative Metadata Sample Definition

This example shows a NameSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<NameSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableMiddleName\>true</enableMiddleName\>
    <enableNameSuffix\>false</enableNameSuffix\>
</NameSettings\>

This example package.xml manifest references the NameSettings definitions.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Name</members\>
        <name\>Settings</name\>
    </types\>
    <version\>31.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=390f8569711d1261928dbde2e3a6ec5effcec6ea92a4d192349375fe40ad5b2c url=/legacydeveloper/current/en-us/api_meta/meta_navigationmenu.md -->

# NavigationMenu

Represents the navigation menu in an Experience Builder site. A navigation menu consists of items that users can click to go to other parts of the site. This type replaces the NavigationLinkSet subtype on Network. NavigationMenu is available in API version 47.0 and later. This type extends the Metadata metadata type and inherits its fullName field.

The Help Center and LWR templates (Build Your Own and Microsites) don’t include generic record pages. So if you create an object or global action type menu item that links to a Salesforce object, make sure that you also create the corresponding object pages. If you don't create the associated object pages, end users won't see anything if they click on the menu item.

## File Suffix and Directory Location

NavigationMenu components have the suffix .navigationMenu and are stored in the navigationMenus folder.

## Version

NavigationMenu components are available in API version 47.0 and later.

## Special Access Rules

The MultipleNavigationMenu permission is required.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| container | string | The name of the navigation menu container. |
| containerType | string | The container type. The options are Network or CommunityTemplateDefinition. |
| label | string | The navigation menu label as it appears in the Experience Builder UI. |
| navigationMenuItem | [NavigationMenuItem](#navigationMenu_NavigationMenuItem)\[\] | A list of menu items in a NavigationMenu. Use this object to create, delete, or update menu items in your site’s navigation menu. |

## NavigationMenuItem

Represents a single menu item in the NavigationLinkSet subtype on Network (API version 37.0 to 46.0) or in the NavigationMenu type (API version 47.0 and later). Use this object to create, delete, or update menu items in your site’s navigation menu.

<table class="featureTable sort_table" summary="">



        <thead class="thead sorted" align="left">
          <tr>
            <th class="featureTableHeader  " id="d689383e195">Field</th>

            <th class="featureTableHeader  " id="d689383e198">Field Type</th>

            <th class="featureTableHeader  " id="d689383e201">Description</th>

          </tr>

        </thead>

        <tbody class="tbody">
          <tr>
            <td class="entry" headers="d689383e195" data-title="Field"><span class="keyword parmname">defaultListViewId</span></td>

            <td class="entry" headers="d689383e198" data-title="Field Type">string</td>

            <td class="entry" headers="d689383e201" data-title="Description">If the value of the <span class="keyword parmname">type</span> field is <samp class="codeph nolang">SalesforceObject</samp>, the value is the ID of the default
              list view for the object.</td>

          </tr>

          <tr>
            <td class="entry" headers="d689383e195" data-title="Field"><span class="keyword parmname">label</span></td>

            <td class="entry" headers="d689383e198" data-title="Field Type">string</td>

            <td class="entry" headers="d689383e201" data-title="Description">Required. The text that appears in the navigation menu for this item.</td>

          </tr>

          <tr>
            <td class="entry" headers="d689383e195" data-title="Field"><span class="keyword parmname">menuItemBranding</span></td>

            <td class="entry" headers="d689383e198" data-title="Field Type"><a class="xref" href="#NavigationMenuItemBranding">NavigationMenuItemBranding</a></td>

            <td class="entry" headers="d689383e201" data-title="Description">Branding for the navigation menu item. Available in API version 47.0 and
              later.</td>

          </tr>

          <tr>
            <td class="entry" headers="d689383e195" data-title="Field"><span class="keyword parmname">position</span></td>

            <td class="entry" headers="d689383e198" data-title="Field Type">int</td>

            <td class="entry" headers="d689383e201" data-title="Description">Required. The location of the menu item in the navigation menu.</td>

          </tr>

          <tr>
            <td class="entry" headers="d689383e195" data-title="Field"><span class="keyword parmname">publiclyAvailable</span></td>

            <td class="entry" headers="d689383e198" data-title="Field Type">boolean</td>

            <td class="entry" headers="d689383e201" data-title="Description">When set to <samp class="codeph nolang">true</samp>, gives access to guest
              users.</td>

          </tr>

          <tr>
            <td class="entry" headers="d689383e195" data-title="Field"><span class="keyword parmname">subMenu</span></td>

            <td class="entry" headers="d689383e198" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_network.htm#navigation_sub_menu">NavigationSubMenu</a></td>

            <td class="entry" headers="d689383e201" data-title="Description">A list of child menu items. This field is available in API 39.0 and
              later.</td>

          </tr>

          <tr>
            <td class="entry" headers="d689383e195" data-title="Field"><span class="keyword parmname">target</span></td>

            <td class="entry" headers="d689383e198" data-title="Field Type">string</td>

            <td class="entry" headers="d689383e201" data-title="Description">Required if <span class="keyword parmname">type</span> is <samp class="codeph nolang">ExternalLink</samp>, <samp class="codeph nolang">InternalLink</samp>, or
              <samp class="codeph nolang">SalesforceObject</samp>. If <span class="keyword parmname">type</span>
              is <samp class="codeph nolang">ExternalLink</samp> or <samp class="codeph nolang">InternalLink</samp>, the target is the URL that the link points to. For <samp class="codeph nolang">ExternalLink</samp>, your entry looks like this:
              <kbd class="ph userinput">https://salesforce.com</kbd>. For <samp class="codeph nolang">InternalLink</samp>, use a relative URL, such as
              <kbd class="ph userinput">/contactsupport</kbd>. If <span class="keyword parmname">type</span> is <samp class="codeph nolang">MenuLabel</samp> or <samp class="codeph nolang">NavigationalTopic</samp>, <span class="keyword parmname">target</span> isn’t used.
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d689383e195" data-title="Field"><span class="keyword parmname">targetPreference</span></td>

            <td class="entry" headers="d689383e198" data-title="Field Type">string</td>

            <td class="entry" headers="d689383e201" data-title="Description">Backed by a picklist that includes preferences for the target field. Valid values are:<ul class="ul bulletList">
                <li class="li"><samp class="codeph nolang">None</samp></li>

                <li class="li">
                  <samp class="codeph nolang">OpenInExternalTab</samp>—Used for external links
                  to determine whether to open in an external tab.
                </li>

              </ul>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d689383e195" data-title="Field"><span class="keyword parmname">type</span></td>

            <td class="entry" headers="d689383e198" data-title="Field Type">string</td>

            <td class="entry" headers="d689383e201" data-title="Description">Required. The type of navigation menu item. Valid values are:<ul class="ul bulletList">
                <li class="li">
                  <samp class="codeph nolang">SalesforceObject</samp>—Available objects include
                  accounts, cases, contacts, and custom objects.
                </li>

                <li class="li">
                  <samp class="codeph nolang">ExternalLink</samp>—Links to a URL outside of your
                  site. For example, <kbd class="ph userinput">https://salesforce.com</kbd>.
                </li>

                <li class="li">
                  <samp class="codeph nolang">InternalLink</samp>—Links to a relative URL inside
                  your site. For example, <kbd class="ph userinput">/contactsupport</kbd>.
                </li>

                <li class="li">
                  <samp class="codeph nolang">MenuLabel</samp>—A parent heading for your
                  navigation menu. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_network.htm#navigation_sub_menu">NavigationSubMenu</a> for how to nest items
                  underneath the menu label. This value is available in API 39.0 and later.
                </li>

                <li class="li">
                  <samp class="codeph nolang">NavigationalTopic</samp>—A dropdown list with
                  links to the navigational topics in your site.
                </li>

              </ul>
              <p class="p">You can’t nest other items of type <samp class="codeph nolang">MenuLabel</samp> or <samp class="codeph nolang">NavigationalTopic</samp>
                under <samp class="codeph nolang">MenuLabel</samp>.</p>
            </td>

          </tr>

        </tbody>

      </table>

## NavigationMenuItemBranding

Branding for a menu item.

| Field | Field Type | Description |
| --- | --- | --- |
| tileImage | string | Name of the ContentAsset to use for the navigation menu item. |

## NavigationSubMenu

A list of child menu items. Only NavigationMenuItem items of type MenuLabel can have items in a NavigationSubMenu. Available in API 39.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| navigationMenuItem | [NavigationMenuItem](#navigationMenu_NavigationMenuItem)\[\] | A list of menu items in a NavigationSubMenu. Use navigationMenuItem to create, delete, or update child items under a parent heading. |

## Declarative Metadata Sample Definition

The following is an example of a NavigationMenu component.

<?xml version="1.0" encoding="UTF-8"?>
<NavigationMenu xmlns="http://soap.sforce.com/2006/04/metadata">
    <container>Service</container>
    <containerType>Network</containerType>
    <label>Test Navigation</label>
    <navigationMenuItem>
        <label>Accounts</label>
        <position>1</position>
        <publiclyAvailable>false</publiclyAvailable>
        <target>Account</target>
        <type>SalesforceObject</type>
    </navigationMenuItem>
    <navigationMenuItem>
        <label>External Link</label>
        <menuItemBranding>
            <tileImage>google\_image</tileImage> 
        </menuItemBranding>
        <position>2</position>
        <publiclyAvailable>false</publiclyAvailable>
        <target>http://google.com</target>
        <targetPreference>OpenExternalLinkInSameTab</targetPreference>
        <type>ExternalLink</type>
    </navigationMenuItem>
    <navigationMenuItem>
        <label>All Objects</label>
        <position>3</position>
        <publiclyAvailable>false</publiclyAvailable>
        <subMenu>
            <navigationMenuItem>
                <label>Leads</label>
                <position>0</position>
                <publiclyAvailable>false</publiclyAvailable>
                <target>Account</target>
                <type>SalesforceObject</type>
            </navigationMenuItem>
        </subMenu>
        <type>MenuLabel</type>
    </navigationMenuItem>
</NavigationMenu>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types>
    <members>\*</members>
    <name>NavigationMenu</name>
  </types>
  <version>47.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=8913e771a235fd8ced4b60f4b09640c8b4230f95a3593fd83102b9680deb8158 url=/legacydeveloper/current/en-us/api_meta/meta_network.md -->

# Network

Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. If you want to create zones that contain Chatter Answers and Ideas, use the Community (Zone) component.

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

## Declarative Metadata File Suffix and Directory Location

Network components are stored in the networks directory of the corresponding package directory. The file name matches the site name, and the extension is .network.

## Version

This object is available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d690828e90">Field</th>

              <th class="featureTableHeader  " id="d690828e93">Field Type</th>

              <th class="featureTableHeader  " id="d690828e96">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">allowedExtensions</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Specifies the types of files allowed in your site. This list of
                file types lets you control what your members upload and also
                prevents spammers from polluting your site with inappropriate files.
                Available in API version 36.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">allowInternalUserLogin</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether internal users can log in with their internal
                credentials on the site login page. Available in API version 40.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="ph" id="AllowMembersToFlagField"><a name="AllowMembersToFlagField"><!-- --></a><span class="keyword parmname">allowMembersToFlag</span></span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">
                <span class="ph" id="AllowMembersToFlagDesc"><a name="AllowMembersToFlagDesc"><!-- --></a>Determines whether users in the
                  site can flag posts or comments as inappropriate. Flagged items
                  are sent to a moderator for review.</span> Available in API
                version 29.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">branding</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">Branding</td>

              <td class="entry" headers="d690828e96" data-title="Description">The color scheme, header, and footer used in the site. Deprecated
                in API version 41.0 and later. Replaced by the NetworkBranding
                type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">caseCommentEmailTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Email template used when notifying members when a case comment
                has been modified or added to a case.<p class="p">Lightning email templates
                  aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">changePasswordTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Email template used when notifying a user that their password has
                been reset.<p class="p">Lightning email templates aren’t packageable. We
                  recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">chgEmailVerNewTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Email template used to verify a user’s email address change. This
                email is sent to the new email address.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>You can't update this
                            template via Metadata API.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">chgEmailVerOldTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Email template used to verify a user’s email address change. This
                email is sent to the old email address.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>You can't update this
                            template via Metadata API.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">communityRoles</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">CommunityRoles</td>

              <td class="entry" headers="d690828e96" data-title="Description">Identifies users with Customer, Partner, or Employee roles in a
                site. Available in API version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Description of the site.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">deviceActEmailTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">The ID of the device activation email template. The template is
                used to customize the device activation email for community users.
                Available in API version 53.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">disablePvtPagesForPwdResetInLWR</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether private pages in an LWR site are available to
                users who haven’t completed setting up or resetting their password.
                Set to <samp class="codeph nolang">(true)</samp> by default for
                all LWR sites except those that use custom Visualforce
                password-management pages.<p class="p">When set to <samp class="codeph nolang">(true)</samp>, private pages are unavailable until
                  password setup or reset is complete. In LWR sites that use
                  custom Visualforce pages for password management, make these
                  pages public. Otherwise, visitors can’t access them to set up or
                  reset their password.</p>
                <p class="p">Available in API version 67.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">disableReputationRecord​Conversations</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">When reputation levels are enabled for the site, determines
                whether to exclude contributions to records when counting points
                toward reputation levels. Available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">emailDomainSubstitutionEnabled</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Indicates whether email messages sent on behalf of users with an
                unverified email domain are sent from the site’s emailSenderAddress
                (<samp class="codeph nolang">true</samp>). If
                emailDomainSubstitutionEnabled is <samp class="codeph nolang">false</samp>, email messages sent on behalf of users with an
                unverified email domain are sent from the <a class="xref" href="https://help.salesforce.com/s/articleView?id=xcloud.security_user_email_verification_substitute_domain.htm&amp;language=en_US" target="_blank">org-wide substitute email
                  address</a> if one is set. If emailDomainSubstitutionEnabled
                is <samp class="codeph nolang">false</samp> and no org-wide
                substitute email address is set, email messages from senders with an
                unverified email domain are suppressed. The default value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version
                  68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">emailFooterLogo</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">The document name of the logo that appears in the footer of
                emails. Available in API version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">emailFooterText</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">The text that appears in the footer of emails. Available in API
                version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">emailSenderAddress</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Required. Email address from which emails are sent.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>You can
                            add the sender email address via the <samp class="codeph nolang">emailSenderAddress</samp> field only when you deploy
                            Network for the first time to create a new Experience Cloud
                            site. You must verify that email address before you can use it
                            as the sender email address.
                          </p><p class="p">You can't update this field via
                            Metadata API. If you attempt to update this field via
                            Metadata API, your changes are ignored and Salesforce
                            doesn’t show an error. To update the email address in this
                            field, go to the site’s Administration workspace, select
                            <strong class="ph uicontrol">Emails</strong>, and then edit the Email
                            Address field.
                          </p>
                          <p></p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">emailSenderName</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Required. Name from which emails are sent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">embeddedLoginEnabled</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Option to place Salesforce login form directly on an external
                website. This setting enables users to log in without being
                redirected to a separate Salesforce page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableApexCDNCaching</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether public data from @wire calls to Apex methods
                is cached for guest users. This setting applies only to sites using
                Salesforce's CDN for Digital Experiences.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableCustomVFError​PageOverrides</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether to use custom Visualforce error pages instead
                of the default Visualforce error pages. Available in API version
                41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableDirectMessages</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether site users can send direct messages to start a
                private conversation with one or more members. Available in API
                version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableExperienceBundleBasedSnaOverrideEnabled</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether the Builder-based SNA page is used (<samp class="codeph apex_code"><span class="keyword">true</span></samp>) or not (<samp class="codeph apex_code"><span class="keyword">false</span></samp>) and overrides the
                existing SNA page when an experience is published. Available in API
                version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableGuestChatter</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Specifies whether guest users can access public Chatter groups in
                the site without logging in.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableGuestFileAccess</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether guest users view asset files shared with the
                site on publicly accessible pages and login pages. If public access
                is enabled in Experience Builder at the page or site level, this
                property is automatically enabled. Available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableGuestMemberVisibility</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines if unauthenticated guest users can see the
                authenticated members (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). Available in API
                version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableImageOptimizationCDN</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether to optimize cached images for guest users on
                all devices when a site uses Salesforce’s CDN for Digital
                Experiences. Available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableInvitation</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether users can invite others to the site.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableKnowledgeable</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines if members can see who’s knowledgeable on topics and
                endorse people for their knowledge on a topic. Available in API
                version 30.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableMemberVisibility</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Controls user visibility on a per-site basis. If <samp class="codeph nolang">true</samp>, the See other members of this
                site preference is enabled for the selected site. Available in API
                version 45.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname" id="enableNicknameDisplay"><a name="enableNicknameDisplay"><!-- --></a>enableNicknameDisplay</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines if user nicknames display instead of their first and
                last names in most places in the site. Set to <samp class="codeph nolang">false</samp> by default. Available in API
                version 32.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enablePrivateMessages</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines if members can send and receive private messages.
                Available in API version 30.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableReputation</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines if reputation is calculated and displayed for members.
                Available in API version 31.0 and later.<p class="p">If enabled,
                  <span class="keyword parmname">reputationLevels</span> and
                  <span class="keyword parmname">reputationPointsRules</span> are used. If no
                  <span class="keyword parmname">reputationLevels</span> or
                  <span class="keyword parmname">reputationPointsRules</span> are defined in
                  the data file, the default values are used.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableShowAllNetworkSettings</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Shows settings that are hidden by default based on how the site
                is set up. Available in API version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableSiteAsContainer</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether the site is an Experience Builder site
                (<samp class="codeph apex_code"><span class="keyword">true</span></samp>) or a Salesforce
                Tabs + Visualforce site (<samp class="codeph apex_code"><span class="keyword">false</span></samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableTalkingAboutStats</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">
                <span class="ph" id="talking_about"><a name="talking_about"><!-- --></a>Determines whether users see how many
                  people are discussing a topic. The number of people discussing
                  the topic appears as the user types the topic and the system
                  gives topic suggestions.</span> Available in API version 41.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableTopicAssignmentRules</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">
                <span class="ph" id="topic_assignment_rules"><a name="topic_assignment_rules"><!-- --></a>Enables the org to use rules to
                  automatically assign topics to articles in a site. After it’s
                  enabled, admins set up rules to map topics to Salesforce
                  Knowledge data categories.</span> This field is available in API
                version 40.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableTopicSuggestions</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">
                <span class="ph" id="topic_suggestion"><a name="topic_suggestion"><!-- --></a>Enables topic suggestions when users
                  write posts.</span> Available in API version 41.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableUpDownVote</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">
                <span class="ph" id="enableupdownvote"><a name="enableupdownvote"><!-- --></a>Replaces the option to like a question
                  or answer with the option to upvote or downvote.</span> Available
                in API version 41.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">enableExpFriendlyUrlsAsDefault</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether URL slugs are enabled by default on<ul class="ul bulletList">
                  <li class="li">Product and Category pages of LWR Commerce stores (available
                    in API version 58.0 and later)</li>

                  <li class="li">Custom object pages on enhanced LWR sites (available in API
                    version 60.0 and later)</li>

                  <li class="li">Account and contact pages on enhanced LWR sites (available
                    in API version 61.0 and later)</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">feedChannel</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Displays the feed of all channel program record or group
                interactions, including posts, questions, and attachments. This
                field is available in API version 28.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">forgotPasswordTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Required. The email template used when a user forgets their
                password.<p class="p">Lightning email templates aren’t packageable. We
                  recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">gatherCustomerSentimentData</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">
                <span class="ph" id="community360_MD_API"><a name="community360_MD_API"><!-- --></a>Gathers data when a customer looks
                  at articles and cases in sites, for use in the Community 360
                  feature.</span> This field is available in API version 40.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">lockoutTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">The email template used to communicate with users when they get
                locked out of their org because of too many failed login attempts.
                Available in API version 43.0 and later.<p class="p">Lightning email templates
                  aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">logoutUrl</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Specifies the URL that members are redirected to when they log
                out from your site. This field is available in API version 28.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">maxFileSizeKb</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">int</td>

              <td class="entry" headers="d690828e96" data-title="Description">Specifies the maximum file size (in KBs) that members can upload
                in your site. Available in API version 36.0 and later. Enter a
                number between 3072 KB and your org’s maximum file size. To use the
                default limit of 2 GB, leave this field empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">navigationLinkSet</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">NavigationLinkSet</td>

              <td class="entry" headers="d690828e96" data-title="Description">
                <span class="ph" id="navigationLinkSet_def"><a name="navigationLinkSet_def"><!-- --></a>Represents the navigation menu in
                  a site. A navigation menu consists of items that users can click
                  to go to other parts of the site. </span>This field is available
                in API versions 37.0 to 46.0. In API version 47.0 and later, use the
                NavigationMenu type instead.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">networkAuthApiSettings</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">NetworkAuthApiSettings</td>

              <td class="entry" headers="d690828e96" data-title="Description">The settings that control enablement, access, and security for
                the Headless Registration Flow, Headless Forgot Password Flow,
                Headless Passwordless Login Flow, and their associated APIs.
                Available in API version 60.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">networkMemberGroups</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">NetworkMemberGroups</td>

              <td class="entry" headers="d690828e96" data-title="Description">The profiles and permission sets that have access to the site.
                Users with these profiles or permission sets are members of the
                site.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>If a Chatter customer (from a customer group) is
                            assigned a permission set that is also associated with a site,
                            the Chatter customer isn’t added to the site.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">networkPageOverrides</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">NetworkPageOverride</td>

              <td class="entry" headers="d690828e96" data-title="Description">The settings in the Administration area (in Experience Management
                or Experience Workspaces) that control which page type Change
                Password, Forgot Password, Home, and Login each point to. Available
                in API version 40.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">newSenderAddress</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Email address that has been entered as the new value for
                <span class="keyword parmname">EmailSenderAddress</span> but hasn’t been verified
                yet. After a user has requested to change the sender email address
                and has successfully responded to the verification email, the
                <span class="keyword parmname">NewSenderAddress</span> value overwrites the value
                in <span class="keyword parmname">EmailSenderAddress</span>. This value becomes the
                email address from which emails are sent.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">pendingSecondaryEmailAddress</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">The secondary sender email address that’s pending verification.
                Salesforce doesn’t send emails from this address until it’s
                verified. Available in API version 67.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">pwdlessRegEmailTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">The email template used when a user registers without a password.
                Instead of a password,they use an identity verification method, such
                as a verification code or link, which the user completes to finalize
                the registration or login process.<p class="p">Lightning email templates
                  aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">picassoSite</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description"><span class="ph" id="picassoSite"><a name="picassoSite"><!-- --></a>Name of the site of ChatterNetworkPicasso
                  type that's linked to the Experience Cloud site.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">recommendationAudience</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">RecommendationAudience</td>

              <td class="entry" headers="d690828e96" data-title="Description">
                <span class="ph" id="rec_audience_description"><a name="rec_audience_description"><!-- --></a>Creates an audience of new
                  members, or can be used to manage customized lists of audience
                  members to organize and target recommendations.</span> Available
                in API version 41.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">recommendationDefinition</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">RecommendationDefinition</td>

              <td class="entry" headers="d690828e96" data-title="Description">Represents a custom recommendation to drive engagement. Targets a
                specific audience and uses channels to specify a location for the
                recommendation. Available in API version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">reputationLevels</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">ReputationLevelDefinitions</td>

              <td class="entry" headers="d690828e96" data-title="Description">The reputation levels assigned to members when they accrue points
                by performing certain actions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">reputationPointsRules</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">ReputationPointsRules</td>

              <td class="entry" headers="d690828e96" data-title="Description">The points members accrue when they perform certain defined
                actions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">secondaryEmailSenderEnabled</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Indicates whether email messages that contain sensitive data are
                sent from a secondary sender email address (<samp class="codeph nolang">true</samp>), instead of via email relay
                (<samp class="codeph nolang">false</samp>). The default value
                is <samp class="codeph nolang">false</samp>. Available in API
                version 67.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">selfRegMicroBatchSubErrorEmailTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">reference</td>

              <td class="entry" headers="d690828e96" data-title="Description">The email template used to communicate with users when their
                self-registration request, using micro-batching failed. Available in
                API version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="ph" id="SelfRegProfileField"><a name="SelfRegProfileField"><!-- --></a><span class="keyword parmname">selfRegProfile</span></span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">
                <span class="ph" id="SelfRegProfileDesc"><a name="SelfRegProfileDesc"><!-- --></a>The profile assigned to users who
                  self-register. This value is used only if
                  <span class="keyword parmname">selfRegistration</span> is enabled for the
                  site.</span> Available in API version 29.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">selfRegistration</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether self-registration is available for the
                site.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">sendWelcomeEmail</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e96" data-title="Description">Determines whether a welcome email is sent when a new user is
                added to the site.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">site</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">Required. The CustomSite associated with the Experience Cloud
                site.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">siteArchiveStatus</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">SitesArchiveStatus</td>

              <td class="entry" headers="d690828e96" data-title="Description">Specifies whether the site has been archived. Available values
                are: <ul class="ul bulletList">
                  <li class="li">
                    <span class="keyword parmname">NotArchived</span>—The site hasn’t been
                    archived.
                  </li>

                  <li class="li">
                    <span class="keyword parmname">TemporarilyArchived</span>—The site is
                    archived, but can be unarchived in the future.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">NetworkStatus[]</td>

              <td class="entry" headers="d690828e96" data-title="Description">Required. Status of the site. Available values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Live</samp>—The site is online
                    and members can access it.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DownForMaintenance</samp>—The
                    site was previously published but was taken offline. Members
                    with the Create and Set Up Experiences permission can still
                    access the setup for offline sites regardless of profile or
                    membership. Members aren’t able to access offline sites, but
                    they still appear in the user interface dropdown as
                    <span class="keyword parmname">SiteName (Offline)</span>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UnderConstruction</samp>—The
                    site hasn’t yet been published. Users with the Create and
                    Set Up Experiences permission can access sites in this
                    status if their profile is associated with the site.<p class="p">After
                      a site is published, it can never be in this status
                      again.</p>
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">tabs</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">NetworkTabSet</td>

              <td class="entry" headers="d690828e96" data-title="Description">Required. The tabs that are available in the site. The user that
                created the site selected these tabs.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">urlPathPrefix</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="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
                <span class="ph filepath"><var class="keyword varname">MyDomainName</var>.my.site.com/partners</span>,
                then <span class="ph filepath">partners</span> is the
                <span class="keyword parmname">urlPathPrefix</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">verificationTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">The email template used to communicate with users when they must
                verify their identity, for example, when they log in without a
                password or from a new device. Available in API version 44.0 and
                later.<p class="p">Lightning email templates aren’t packageable. We
                  recommend using a Classic email template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e90" data-title="Field"><span class="keyword parmname">welcomeTemplate</span></td>

              <td class="entry" headers="d690828e93" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e96" data-title="Description">The email template used when sending welcome emails to new
                members.<p class="p">Lightning email templates aren’t packageable. We
                  recommend using a Classic email template.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Branding

Represents the branding and color scheme applied to the Experience Cloud site. Available in API version 40.0 and earlier. Replaced by NetworkBranding in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| loginFooterText | string | The text that appears in the footer of the login page. |
| loginLogo | string | The logo that appears on the login page for external users. |
| pageFooter | string | An image that appears on the footer of the pages. Must be an .html file. |
| pageHeader | string | An image that appears on the header of the pages. Can be an .html, .gif, .jpg, or .png file. |
| primaryColor | string | The color used for the active tab. |
| primaryComplementColor | string | Font color used with primaryColor. |
| quaternaryColor | string | The background color for pages. |
| quaternaryComplementColor | string | Font color used with quaternaryColor. |
| secondaryColor | string | The color used for the top borders of lists and tables. |
| tertiaryColor | string | The background color for section headers on edit and detail pages. |
| tertiaryComplementColor | string | Font color used with tertiaryColor. |
| zeronaryColor | string | The background color for the header. |
| zeronaryComplementColor | string | Font color used with zeronaryColor. |

## CommunityRoles

The labels used to identify users with Customer, Partner, or Employee roles in an Experience Cloud site. Available in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| customerUserRole | string | The label for the Customer user role. |
| employeeUserRole | string | The label for the Employee user role. |
| partnerUserRole | string | The label for the Partner user role. |

## NavigationLinkSet

Represents the navigation menu in an Experience Cloud site. A navigation menu consists of items that users can click to go to other parts of the site. Available in API versions 37.0 to 46.0. In API version 47.0, use NavigationMenu instead.

| Field | Field Type | Description |
| --- | --- | --- |
| navigationMenuItem | NavigationMenuItem\[\] | A list of menu items in a NavigationLinkSet. Use this object to create, delete, or update menu items in your site’s navigation menu. |

## NavigationMenuItem

Represents a single menu item in the NavigationLinkSet subtype (API version 37.0 to 46.0) or in the [NavigationMenu](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_navigationmenu.htm "Represents the navigation menu in an Experience Builder site. A navigation menu consists of items that users can click to go to other parts of the site. This type replaces the NavigationLinkSet subtype on Network. NavigationMenu is available in API version 47.0 and later. This type extends the Metadata metadata type and inherits its fullName field.") type (API version 47.0 and later). Use this subtype to create, delete, or update menu items in your site’s navigation menu.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d690828e1628">Field</th>

              <th class="featureTableHeader  " id="d690828e1631">Field Type</th>

              <th class="featureTableHeader  " id="d690828e1634">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d690828e1628" data-title="Field"><span class="keyword parmname">defaultListViewId</span></td>

              <td class="entry" headers="d690828e1631" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1634" data-title="Description">If the value of the <span class="keyword parmname">type</span> field is <samp class="codeph nolang">SalesforceObject</samp>, the value is the
                ID of the default list view for the object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1628" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d690828e1631" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1634" data-title="Description">Required. The text that appears in the navigation menu for this
                item.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1628" data-title="Field"><span class="keyword parmname">menuItemBranding</span></td>

              <td class="entry" headers="d690828e1631" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_navigationmenu.htm#NavigationMenuItemBranding">NavigationMenuItemBranding</a></td>

              <td class="entry" headers="d690828e1634" data-title="Description">Branding for the navigation menu item. Available in API version
                47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1628" data-title="Field"><span class="keyword parmname">position</span></td>

              <td class="entry" headers="d690828e1631" data-title="Field Type">int</td>

              <td class="entry" headers="d690828e1634" data-title="Description">Required. The location of the menu item in the navigation
                menu.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1628" data-title="Field"><span class="keyword parmname">publiclyAvailable</span></td>

              <td class="entry" headers="d690828e1631" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1634" data-title="Description">When set to <samp class="codeph nolang">true</samp>, gives
                access to guest users.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1628" data-title="Field"><span class="keyword parmname">subMenu</span></td>

              <td class="entry" headers="d690828e1631" data-title="Field Type"><a class="xref" href="#navigation_sub_menu">NavigationSubMenu</a></td>

              <td class="entry" headers="d690828e1634" data-title="Description">A list of child menu items. This field is available in API 39.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1628" data-title="Field"><span class="keyword parmname">target</span></td>

              <td class="entry" headers="d690828e1631" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1634" data-title="Description">Required if <span class="keyword parmname">type</span> is <samp class="codeph nolang">ExternalLink</samp>, <samp class="codeph nolang">InternalLink</samp>, or <samp class="codeph nolang">SalesforceObject</samp>. If
                <span class="keyword parmname">type</span> is <samp class="codeph nolang">ExternalLink</samp> or <samp class="codeph nolang">InternalLink</samp>, the target is the URL that the link
                points to. For <samp class="codeph nolang">ExternalLink</samp>,
                your entry looks like this:
                <kbd class="ph userinput">https://salesforce.com</kbd>. For <samp class="codeph nolang">InternalLink</samp>, use a relative URL,
                such as <kbd class="ph userinput">/contactsupport</kbd>. If
                <span class="keyword parmname">type</span> is <samp class="codeph nolang">MenuLabel</samp> or <samp class="codeph nolang">NavigationalTopic</samp>, <span class="keyword parmname">target</span> isn’t
                used.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1628" data-title="Field"><span class="keyword parmname">targetPreference</span></td>

              <td class="entry" headers="d690828e1631" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1634" data-title="Description">Backed by a picklist that includes preferences for the target
                field. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">OpenInExternalTab</samp>—Used
                    for external links to determine whether to open in an
                    external tab.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1628" data-title="Field"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d690828e1631" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1634" data-title="Description">Required. The type of navigation menu item. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">SalesforceObject</samp>—Available objects include
                    accounts, cases, contacts, and custom objects.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ExternalLink</samp>—Links to a
                    URL outside of your site. For example,
                    <kbd class="ph userinput">https://salesforce.com</kbd>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">InternalLink</samp>—Links to a
                    relative URL inside your site. For example,
                    <kbd class="ph userinput">/contactsupport</kbd>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MenuLabel</samp>—A parent
                    heading for your navigation menu. See <a class="xref" href="#navigation_sub_menu">NavigationSubMenu</a> for
                    how to nest items underneath the menu label. This value is
                    available in API 39.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NavigationalTopic</samp>—A
                    dropdown list with links to the navigational topics in your
                    site.
                  </li>

                </ul>
                <p class="p">You can’t nest other items of type <samp class="codeph nolang">MenuLabel</samp> or <samp class="codeph nolang">NavigationalTopic</samp> under <samp class="codeph nolang">MenuLabel</samp>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## NavigationSubMenu

A list of child menu items. Only NavigationMenuItem items of type MenuLabel can have items in a NavigationSubMenu. Available in API 39.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| navigationMenuItem | [NavigationMenuItem](#network_navigation_menu_item)\[\] | A list of menu items in a NavigationSubMenu. Use navigationMenuItem to create, delete, or update child items under a parent heading. |

## NetworkAuthApiSettings

Represents the settings that control enablement, access, and security for the Headless Registration Flow, Headless Forgot Password Flow, Headless Passwordless Login Flow, and their associated APIs. Available in API version 60.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d690828e1965">Field</th>

              <th class="featureTableHeader  " id="d690828e1968">Field Type</th>

              <th class="featureTableHeader  " id="d690828e1971">Details</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">doesForgotPasswordRequireAuth</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether authentication is required to access Headless
                Forgot Password API when a password reset is requested. If <samp class="codeph nolang">true</samp>, an access token issued to an
                internal integration user in your initial POST request to the
                <span class="ph filepath">/services/auth/headless/forgot_password</span>
                endpoint is required. The access token must include the <samp class="codeph nolang">forgot_password</samp> scope.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">doesPasswordLoginRequireAuth</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether reCAPTCHA is required for headless
                username-password login that uses the OAuth 2.0 for First-Party
                Applications draft protocol.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">doesPwdlessLoginRequireAuth</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether authentication is required to access Headless
                Passwordless Login API when user information is submitted to
                Salesforce. If <samp class="codeph nolang">true</samp>, an access
                token issued to an internal integration user is required in your
                initial POST request to the
                <span class="ph filepath">/services/auth/headless/init/passwordless/login</span>
                endpoint. The access token must include the <samp class="codeph nolang">pwdless_login_api</samp> scope.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">doesRegistrationRequireAuth</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether authentication is required to access Headless
                Registration API when user registration information is submitted to
                Salesforce. If <samp class="codeph nolang">true</samp>, an access
                token issued to an internal integration user in your initial POST
                request to the
                <span class="ph filepath">/services/auth/headless/init/registration</span>
                endpoint is required. The access token must include the <samp class="codeph nolang">user_registration_api</samp>
                scope.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">emailTmplsAllowlist</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type"><a class="xref" href="#network_networkemailtmplallowlist">NetworkEmailTmplAllowlist[]</a></td>

              <td class="entry" headers="d690828e1971" data-title="Details">The email template allowlist for the Headless Registration Flow,
                Headless Passwordless Login Flow, and Headless Forgot Password Flow.
                The allowlist defines which email templates can be used for
                verification emails sent to end users during these flows.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">headlessDiscoveryExecutionUser</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">Id</td>

              <td class="entry" headers="d690828e1971" data-title="Details">An integration user account to run a headless user discovery Apex
                handler.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">headlessDiscoveryHandler</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1971" data-title="Details">An Apex class that implements the <samp class="codeph ">Auth.HeadlessUserDiscoveryHandler</samp> interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isFirstPartyAppsAllowed</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether the Experience Cloud site can use headless
                identity flows that use the OAuth 2.0 for First-Party Applications
                draft protocol.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isForgotPwdAllowed</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether the Headless Forgot Password Flow is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isForgotPwdEmailTemplateAllowlistingEnabled</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether email template allowlisting is enabled for the
                Headless Forgot Password Flow. If <samp class="codeph nolang">true</samp>, the <samp class="codeph nolang">emailtemplate</samp> parameter in the initial request to
                Headless Forgot Password API can include only allowlisted email
                templates.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isHeadlessUserRegistrationAllowed</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether the Headless Registration Flow is
                enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">IsPwdlessLoginAllowed</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether the Headless Passwordless Login Flow is
                enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isRecaptchaRequiredForgotPwd</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether a reCAPTCHA token is required to access
                Headless Forgot Password API when a password reset is requested. If
                <samp class="codeph nolang">true</samp>, a reCAPTCHA token is
                required in your initial POST request to the
                <span class="ph filepath">/services/auth/headless/forgot_password</span>
                endpoint.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isRecaptchaRequiredPwdlessLogin</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether a reCAPTCHA token is required to access
                Headless Passwordless Login API when user information is submitted
                to Salesforce. If <samp class="codeph nolang">true</samp>, a
                reCAPTCHA token is required in your initial POST request to the
                <span class="ph filepath">/services/auth/headless/init/passwordless/login</span>
                endpoint.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isRecaptchaRequiredRgstr</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether a reCAPTCHA token is required to access
                Headless Registration API when user registration information is
                submitted to Salesforce. If <samp class="codeph nolang">true</samp>, a reCAPTCHA token is required in your initial
                POST request to the
                <span class="ph filepath">/services/auth/headless/init/registration</span>
                endpoint.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isUniversalClientRgstrAllowed</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether self-registration and passwordless login via
                Universal Registration API are enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isUserDisambiguationAllowedForgotPwd</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether the Headless Forgot Password Flow uses the
                headless user discovery Apex handler that's specified in the
                <span class="keyword parmname">HeadlessDiscoveryHandlerId</span> field. The
                handler enables users to reset their password with an identifier
                other than their username, such as an email address, phone number,
                or order number.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">isUserDisambiguationAllowedUsernamePwd</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e1971" data-title="Details">Determines whether headless login flows use the headless user
                discovery Apex handler that's specified in the
                <span class="keyword parmname">HeadlessDiscoveryHandlerId</span> field. The
                handler enables users to log in with an identifier other than their
                username, such as an email address, phone number, or order number.
                This field applies to the Authorization Code and Credentials Flow
                and the OAuth 2.0 for First-Party Applications login flow.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">maxPasswordResetAttempts</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">int</td>

              <td class="entry" headers="d690828e1971" data-title="Details">The maximum number of password reset attempts you allow for the
                Headless Forgot Password Flow before the user must request a new
                one-time password (OTP).</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">recaptchaScoreThreshold</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">double</td>

              <td class="entry" headers="d690828e1971" data-title="Details">The lowest reCAPTCHA score that is accepted before rejecting a
                request to access Headless Identity APIs. This value must be between
                0.5 and 1. Scores closer to 0.5 are more likely to be bots, while
                scores closer to 1 are more likely to be valid users.<p class="p">You must set
                  a score threshold if
                  <span class="keyword parmname">doesForgotPasswordRequireAuth</span> or
                  <span class="keyword parmname">doesRegistrationRequireAuth</span> fields are
                  set to <samp class="codeph nolang">true</samp>. reCAPTCHA
                  settings apply to both the Headless Registration Flow and the
                  Headless Forgot Password Flow.
                </p>
                <p class="p">Google issues a reCAPTCHA
                  score only for reCAPTCHA v3 implementations. If you implement
                  reCAPTCHA v2, this field doesn’t apply.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">recaptchaSecretKey</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1971" data-title="Details">The reCAPTCHA secret key from your API key pair. You get the API
                key pair from Google when you set up reCAPTCHA. The secret key helps
                your app securely communicate with Google. You must enter a secret
                key if <span class="keyword parmname">doesForgotPasswordRequireAuth</span> or
                <span class="keyword parmname">doesRegistrationRequireAuth</span> are set to
                <samp class="codeph nolang">true</samp>. reCAPTCHA settings
                apply to all headless identity flows for which reCAPTCHA is
                enabled.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">registrationExecutionUser</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1971" data-title="Details">The user who runs your headless registration Apex
                handler.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">registrationHandler</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1971" data-title="Details">The headless registration Apex handler.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e1965" data-title="Field"><span class="keyword parmname">registrationUserDefaultProfile</span></td>

              <td class="entry" headers="d690828e1968" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e1971" data-title="Details">The default profile that gets assigned to new users when they
                register.</td>

            </tr>

          </tbody>

        </table>

## NetworkEmailTmplAllowlist

Represents the allowlist for one-time password (OTP) email templates sent to end users during the Headless Registration Flow, Headless Passwordless Login Flow, and Headless Forgot Password Flow. Available in API version 60.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| emailTemplate | string | Required. The email templates that can be sent to users during the headless authorization flows for registration, passwordless login, and forgot password. You can list multiple templates. When your app sends its initial request to Headless Registration API or Headless Passwordless Login API, the emailtemplate parameter can include only an email template ID from the allowlist. For Headless Forgot Password API, it works the same way, but only if the isForgotPwdEmailTemplateAllowlistingEnabled field on the NetworkAuthApiSettings metadata type is true. |

## NetworkMemberGroup

Represents the profiles and permission sets that are assigned to the Experience Cloud site. Users with one of the profiles or permission sets are members of the site, unless the user is a Chatter customer (from a customer group).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d690828e2475">Field</th>

              <th class="featureTableHeader  " id="d690828e2478">Field Type</th>

              <th class="featureTableHeader  " id="d690828e2481">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d690828e2475" data-title="Field"><span class="keyword parmname">permissionSet</span></td>

              <td class="entry" headers="d690828e2478" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e2481" data-title="Description">A permission set that is assigned to the site. <div class="box message info" id="permission_set_no_chatter_ext">
                  <a name="permission_set_no_chatter_ext"><!-- --></a>
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>If a Chatter customer (from a
                            customer group) is assigned a permission set that is also
                            associated with a site, the Chatter customer isn’t added to the
                            site.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e2475" data-title="Field"><span class="keyword parmname">profile</span></td>

              <td class="entry" headers="d690828e2478" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e2481" data-title="Description">A profile that is part of the site.</td>

            </tr>

          </tbody>

        </table>

## NetworkPageOverride

Represents settings in the Administration area (in Experience Management or Experience Workspaces) that control which page type the Change Password, Forgot Password, Home, and Login pages each point to.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Assigned Visualforce page overrides are specified and deployed via the corresponding CustomSite metadata field.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d690828e2545">Field</th>

              <th class="featureTableHeader  " id="d690828e2548">Field Type</th>

              <th class="featureTableHeader  " id="d690828e2551">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d690828e2545" data-title="Field"><span class="keyword parmname">changePasswordPageOverrideSetting</span></td>

              <td class="entry" headers="d690828e2548" data-title="Field Type">NetworkPageOverrideSetting (enumeration of type string)</td>

              <td class="entry" headers="d690828e2551" data-title="Description">Required. Specifies the page type that the Change Password page
                setting applies to. The valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Configurable</samp>—a
                    configurable self-registration page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Designer</samp>—an
                    Experience Builder page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Standard</samp>—the
                    default page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">VisualForce</samp>—a
                    Visualforce page
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e2545" data-title="Field"><span class="keyword parmname">forgotPasswordPageOverrideSetting</span></td>

              <td class="entry" headers="d690828e2548" data-title="Field Type">NetworkPageOverrideSetting (enumeration of type string)</td>

              <td class="entry" headers="d690828e2551" data-title="Description">Required. Specifies the page type that the Forgot Password page
                setting applies to. The valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Configurable</samp>—a
                    configurable self-registration page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Designer</samp>—an
                    Experience Builder page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Standard</samp>—the
                    default page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">VisualForce</samp>—a
                    Visualforce page
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e2545" data-title="Field"><span class="keyword parmname">homePageOverrideSetting</span></td>

              <td class="entry" headers="d690828e2548" data-title="Field Type">NetworkPageOverrideSetting (enumeration of type string)</td>

              <td class="entry" headers="d690828e2551" data-title="Description">Required. Specifies the page type that the Experience Home page
                setting applies to. The valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Configurable</samp>—a
                    configurable self-registration page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Designer</samp>—an
                    Experience Builder page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Standard</samp>—the
                    default page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">VisualForce</samp>—a
                    Visualforce page
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e2545" data-title="Field"><span class="keyword parmname">loginPageOverrideSetting</span></td>

              <td class="entry" headers="d690828e2548" data-title="Field Type">NetworkPageOverrideSetting (enumeration of type string)</td>

              <td class="entry" headers="d690828e2551" data-title="Description">Required. Specifies the page type that the Login page setting
                applies to. The valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Configurable</samp>—a
                    configurable self-registration page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Designer</samp>—an
                    Experience Builder page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Standard</samp>—the
                    default page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">VisualForce</samp>—a
                    Visualforce page
                  </li>

                </ul>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>To configure an Experience Builder page for your Home and
                            Login pages, make sure you publish your site. Unpublished pages
                            show up as Default Page from the dropdown menu in Admin
                            settings.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e2545" data-title="Field"><span class="keyword parmname">selfRegProfilePageOverrideSetting</span></td>

              <td class="entry" headers="d690828e2548" data-title="Field Type">NetworkPageOverrideSetting (enumeration of type string)</td>

              <td class="entry" headers="d690828e2551" data-title="Description">
                <span class="ph" id="self_reg_description"><a name="self_reg_description"><!-- --></a>Required. Specifies the page type
                  that the Self Registration page setting applies to. </span>The
                valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Configurable</samp>—a
                    configurable self-registration page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Designer</samp>—an
                    Experience Builder page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Standard</samp>—the
                    default page
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">VisualForce</samp>—a
                    Visualforce page
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## RecommendationAudience

Creates an audience of new Experience Cloud site members, or can be used to manage customized lists of audience members to organize and target recommendations. Available in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| recommendationAudienceDetails | [RecommendationAudienceDetail](#recommendationAudienceDetail) | The specific details of an audience for recommendations. |

## RecommendationAudienceDetail

The specific details of an audience for recommendations. Available in API version 41.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d690828e2819">Field</th>

              <th class="featureTableHeader  " id="d690828e2822">Field Type</th>

              <th class="featureTableHeader  " id="d690828e2825">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d690828e2819" data-title="Field"><span class="keyword parmname">audienceCriteriaType</span></td>

              <td class="entry" headers="d690828e2822" data-title="Field Type">AudienceCriteriaType (enumeration of type string)</td>

              <td class="entry" headers="d690828e2825" data-title="Description">The criteria for the recommendation audience type. Values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CustomList</samp></li>

                  <li class="li"><samp class="codeph nolang">MaxDaysInCommunity</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e2819" data-title="Field"><span class="keyword parmname">audienceCriteriaValue</span></td>

              <td class="entry" headers="d690828e2822" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e2825" data-title="Description">For new member criteria, the maximum number of days since a user
                became a member. Null in case of custom list criteria.</td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e2819" data-title="Field"><span class="keyword parmname">setupName</span></td>

              <td class="entry" headers="d690828e2822" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e2825" data-title="Description">Name of the recommendation audience.</td>

            </tr>

          </tbody>

        </table>

## RecommendationDefinition

Represents a list of custom recommendations to drive engagement for an Experience Cloud site. Available in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| recommendationDefinitionDetails | [RecommendationDefinitionDetail](#recommendationDefinitionDetails)\[\] | A list of custom recommendations and their details. |

## RecommendationDefinitionDetail

The specific details of a custom recommendation. Available in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| actionUrl | string | The URL for the button that lets users act on the recommendation. |
| description | string | An explanation of the recommendation that suggests what users can do. |
| linkText | string | The text label for the button. |
| scheduledRecommendations | [ScheduledRecommendation](#scheduledRecommendations) | A list of scheduled recommendations. |
| setupName | string | The name of the recommendation, which appears in Setup. |
| title | string | The title of the recommendation. |

## ReputationBranding

Branding for the reputation level.

| Field | Field Type | Description |
| --- | --- | --- |
| smallImage | string | Custom image associated with a reputation level. Use files with these extensions: .jpeg, .png, or .gif. Images are stored as documents. If not specified, the default reputation level image is used. Available in API version 32.0 and later. |

## ReputationLevelDefinitions

Represents reputation levels members can achieve by performing certain defined actions in an Experience Cloud site.

| Field | Field Type | Description |
| --- | --- | --- |
| level | [ReputationLevel](#network_reputation_level)\[\] | Represents reputation levels. |

## ReputationLevel

Represents the name and lower value of the reputation level. The application calculates the upper value.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d690828e3192">Field</th>

              <th class="featureTableHeader  " id="d690828e3195">Field Type</th>

              <th class="featureTableHeader  " id="d690828e3198">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d690828e3192" data-title="Field"><span class="keyword parmname" id="branding_repLevel"><a name="branding_repLevel"><!-- --></a>branding</span></td>

              <td class="entry" headers="d690828e3195" data-title="Field Type">
                <a class="xref" href="#network_reputation_branding">ReputationBranding</a>[]
              </td>

              <td class="entry" headers="d690828e3198" data-title="Description">Represents any branding associated with the reputation level,
                specifically, the custom image for the reputation level.<p class="p">This
                  field is optional. If not specified, the default reputation
                  level image is used. Available in API version 32.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e3192" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d690828e3195" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e3198" data-title="Description">Name of the reputation level.<p class="p">This field is optional. If not
                  specified, one of the 10 defaults is used.</p>
                <ul class="ul bulletList">
                  <li class="li">Level 1</li>

                  <li class="li">Level 2</li>

                  <li class="li">Level 3</li>

                  <li class="li">Level 4</li>

                  <li class="li">Level 5</li>

                  <li class="li">Level 6</li>

                  <li class="li">Level 7</li>

                  <li class="li">Level 8</li>

                  <li class="li">Level 9</li>

                  <li class="li">Level 10</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e3192" data-title="Field"><span class="keyword parmname">lowerThreshold</span></td>

              <td class="entry" headers="d690828e3195" data-title="Field Type">double</td>

              <td class="entry" headers="d690828e3198" data-title="Description">Required. The lower value in the range for this reputation level.
                For example, if this reputation level is for points 1–50, 1
                is the <span class="keyword parmname">lowerThreshold</span>.</td>

            </tr>

          </tbody>

        </table>

## ReputationPointsRules

Represents points rules in an Experience Cloud site’s point system.

| Field | Field Type | Description |
| --- | --- | --- |
| pointsRule | [ReputationPointsRule](#network_reputation_points_rule)\[\] | Represents events and their associated points. |

## ReputationPointsRule

Represents the event and associated point value for a points rule. When a user acts, they accrue the associated points.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d690828e3369">Field</th>

              <th class="featureTableHeader  " id="d690828e3372">Field Type</th>

              <th class="featureTableHeader  " id="d690828e3375">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d690828e3369" data-title="Field"><span class="keyword parmname">eventType</span></td>

              <td class="entry" headers="d690828e3372" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e3375" data-title="Description">Required. The type of event a member has to perform to get
                points. The available values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FeedItemWriteAPost</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemWriteAComment</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemReceiveAComment</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemLikeSomething</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemReceiveALike</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemMentionSomeone</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemSomeoneMentionsYou</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemShareAPost</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemSomeoneSharesYourPost</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemPostAQuestion</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemAnswerAQuestion</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemReceiveAnAnswer</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemMarkAnswerAsBest</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemYourAnswerMarkedBest</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemEndorseSomeoneForKnowledgeOnATopic</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedItemEndorsedForKnowledgeOnATopic</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e3369" data-title="Field"><span class="keyword parmname">points</span></td>

              <td class="entry" headers="d690828e3372" data-title="Field Type">int</td>

              <td class="entry" headers="d690828e3375" data-title="Description">Required. The number of points a member gets for performing the
                event. The default number of points per event is:<ul class="ul bulletList">
                  <li class="li">FeedItemWriteAPost +1</li>

                  <li class="li">FeedItemWriteAComment: +1</li>

                  <li class="li">FeedItemReceiveAComment: +5</li>

                  <li class="li">FeedItemLikeSomething: +1</li>

                  <li class="li">FeedItemReceiveALike: +5</li>

                  <li class="li">FeedItemMentionSomeone: +1</li>

                  <li class="li">FeedItemSomeoneMentionsYou: +5</li>

                  <li class="li">FeedItemShareAPost: +1</li>

                  <li class="li">FeedItemSomeoneSharesYourPost: +5</li>

                  <li class="li">FeedItemPostAQuestion: +1</li>

                  <li class="li">FeedItemAnswerAQuestion: +5</li>

                  <li class="li">FeedItemReceiveAnAnswer: +5</li>

                  <li class="li">FeedItemMarkAnswerAsBest: +5</li>

                  <li class="li">FeedItemYourAnswerMarkedBest: +20</li>

                  <li class="li">FeedItemEndorseSomeoneForKnowledgeOnATopic: +5</li>

                  <li class="li">FeedItemEndorsedForKnowledgeOnATopic: +20</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ScheduledRecommendation

Represents a list of scheduled recommendations. Available in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| scheduledRecommendationDetails | [ScheduledRecommendationDetail](#scheduledRecommendationsDetails)\[\] | A list of scheduled recommendations. |

## ScheduledRecommendationDetail

The specific details of a scheduled recommendation. Available in API version 41.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d690828e3610">Field</th>

              <th class="featureTableHeader  " id="d690828e3613">Field Type</th>

              <th class="featureTableHeader  " id="d690828e3616">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d690828e3610" data-title="Field"><span class="keyword parmname">channel</span></td>

              <td class="entry" headers="d690828e3613" data-title="Field Type">RecommendationChannel (enumeration of type string)</td>

              <td class="entry" headers="d690828e3616" data-title="Description">A way to group recommendations together to determine where they
                show up in the site. The valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">DefaultChannel</samp>—The default recommendation
                    channel. Recommendations in the default channel appear in
                    predefined locations, such as directly in the feed in
                    Salesforce mobile web and on the Home and Question Detail
                    pages of the Customer Service (Napili) template.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomChannel1</samp>—A
                    custom recommendation channel. Choose where you want
                    recommendations to appear by adding the Recommendations
                    Carousel component to the page in Experience Builder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomChannel2</samp>—A
                    custom recommendation channel.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomChannel3</samp>—A
                    custom recommendation channel.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomChannel4</samp>—A
                    custom recommendation channel.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomChannel5</samp>—A
                    custom recommendation channel.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e3610" data-title="Field"><span class="keyword parmname">enabled</span></td>

              <td class="entry" headers="d690828e3613" data-title="Field Type">boolean</td>

              <td class="entry" headers="d690828e3616" data-title="Description">Indicates whether scheduling is enabled. If <samp class="codeph nolang">true</samp>, the recommendation is enabled
                and appears in sites.<p class="p">If <samp class="codeph nolang">false</samp>, recommendations in feeds in Salesforce
                  mobile web aren’t removed, but no new recommendations appear. In
                  sites, disabled recommendations no longer appear.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e3610" data-title="Field"><span class="keyword parmname">rank</span></td>

              <td class="entry" headers="d690828e3613" data-title="Field Type">int</td>

              <td class="entry" headers="d690828e3616" data-title="Description">The rank of the recommendation within the channel, which
                determines the order in which it’s displayed.<p class="p">The scheduled
                  recommendation is inserted into the position specified by the
                  rank. The rank of all the scheduled recommendations after it is
                  pushed down. If the specified rank is larger than the size of
                  the list, the scheduled recommendation is put at the end of the
                  list.</p>
                <p class="p">If a rank isn’t specified, the scheduled
                  recommendation is put at the end of the list.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d690828e3610" data-title="Field"><span class="keyword parmname">recommendationAudience</span></td>

              <td class="entry" headers="d690828e3613" data-title="Field Type">string</td>

              <td class="entry" headers="d690828e3616" data-title="Description">The name of the audience for this scheduled
                recommendation.</td>

            </tr>

          </tbody>

        </table>

## NetworkTabSet

| Field | Field Type | Description |
| --- | --- | --- |
| customTab | string | Custom tab that is part of the site. |
| defaultTab | string | The Home tab for the site. When members log in, this tab is the first page they see. |
| standardTab | string | Standard tab that is part of the site. |

## Declarative Metadata Sample Definition

A sample XML definition of a network.

<?xml version="1.0" encoding="UTF-8"?>
<Network xmlns="http://soap.sforce.com/2006/04/metadata">
    <allowMembersToFlag\>true</allowMembersToFlag\>
    <changePasswordTemplate\>unfiled$public/CommunityChangePasswordEmailTemplate</changePasswordTemplate\>
    <description\>Metadata Community</description\>
    <emailSenderAddress\>admin@networkMetadata.com</emailSenderAddress\>
    <emailSenderName\>Admin User</emailSenderName\>
    <enableInvitation\>false</enableInvitation\>
    <enableKnowledgeable\>true</enableKnowledgeable\>
    <enableNicknameDisplay\>false</enableNicknameDisplay\>
    <enablePrivateMessages\>true</enablePrivateMessages\>
    <enableReputation\>true</enableReputation\>
    <enableUpDownVote\>true</enableUpDownVote\>
    <forgotPasswordTemplate\>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate\>
    <networkMemberGroups\>
        <permissionSet\>Admin</permissionSet\>
        <permissionSet\>Standard</permissionSet\>
        <permissionSet\>ReadOnly</permissionSet\>
        <profile\>Admin</profile\>
        <profile\>Standard</profile\>
        <profile\>ReadOnly</profile\>
    </networkMemberGroups\>
    <recommendationDefinition\>
        <recommendationDefinitionDetails\>
            <actionUrl\>https://www.apple.com/iphone</actionUrl\>
            <description\>Better specs and high performance for iPhones</description\>
            <linkText\>iPhone 7</linkText\>
            <scheduledRecommendations\>
                <scheduledRecommendationDetails\>
                    <channel\>DefaultChannel</channel\>
                    <enabled\>false</enabled\>
                    <rank\>1</rank\>
                    <recommendationAudience\>New Member Audience</recommendationAudience\>
                </scheduledRecommendationDetails\>
            </scheduledRecommendations\>
            <setupName\>Apple iPhone</setupName\>
            <title\>iPhone7</title\>
        </recommendationDefinitionDetails\>
        <recommendationDefinitionDetails\>
            <actionUrl\>https://www.bose.com/qc35</actionUrl\>
            <description\>New Amazing Noise cancellation Headphones</description\>
            <linkText\>Bose QC35</linkText\>
            <scheduledRecommendations\>
                <scheduledRecommendationDetails\>
                    <channel\>DefaultChannel</channel\>
                    <enabled\>true</enabled\>
                    <rank\>2</rank\>
                    <recommendationAudience\>Custom Audience</recommendationAudience\>
                </scheduledRecommendationDetails\>
            </scheduledRecommendations\>
            <setupName\>Bose Headphones</setupName\>
            <title\>Bose QC35</title\>
        </recommendationDefinitionDetails\>
    </recommendationDefinition\>
    <reputationLevels\>
        <level\>
            <branding\> 
                <smallImage\>communities\_shared \_document\_folder/replevel\_beginner.png</smallImage\>
            </branding\>
            <label\>Beginner</label\>
            <lowerThreshold\>0</lowerThreshold\>
        </level\>
        <level\>
            <branding\> 
                <smallImage\>communities\_shared \_document\_folder/replevel\_apprentice.png</smallImage\>
            </branding\>
            <label\>Apprentice</label\>
            <lowerThreshold\>51</lowerThreshold\>
        </level\>
        <level\>
            <branding\> 
                <smallImage\>communities\_shared \_document\_folder/replevel\_gettingthere.png</smallImage\>
            </branding\>
            <label\>Getting There</label\>
            <lowerThreshold\>101</lowerThreshold\>
        </level\>
        <level\>
            <branding\> 
                <smallImage\>communities\_shared \_document\_folder/replevel\_skilled.png</smallImage\>
            </branding\>
            <label\>Skilled</label\>
            <lowerThreshold\>151</lowerThreshold\>
        </level\>
        <level\>
            <branding\> 
                <smallImage\>communities\_shared \_document\_folder/replevel\_expert.png</smallImage\>
            </branding\>
            <label\>Expert</label\>
            <lowerThreshold\>201</lowerThreshold\>
        </level\>
        <level\>
            <branding\> 
                <smallImage\>communities\_shared \_document\_folder/replevel\_mentor.png</smallImage\>
            </branding\>
            <label\>Mentor</label\>
            <lowerThreshold\>251</lowerThreshold\>
        </level\>
        <level\>
            <branding\> 
                <smallImage\>communities\_shared \_document\_folder/replevel\_guru.png</smallImage\>
            </branding\>
            <label\>Guru</label\>
            <lowerThreshold\>301</lowerThreshold\>
        </level\>
    </reputationLevels\>
    <reputationPointsRules\>
        <pointsRule\>
            <eventType\>FeedItemWriteAPost</eventType\>
            <points\>5</points\>
        </pointsRule\>
        <pointsRule\>
            <eventType\>FeedItemWriteAComment</eventType\>
            <points\>3</points\>
        </pointsRule\>
        <pointsRule\>
            <eventType\>FeedItemReceiveAComment</eventType\>
            <points\>10</points\>
        </pointsRule\>
        <pointsRule\>
            <eventType\>FeedItemLikeSomething</eventType\>
            <points\>3</points\>
        </pointsRule\>
        <pointsRule\>
            <eventType\>FeedItemReceiveALike</eventType\>
            <points\>5</points\>
        </pointsRule\>
        <pointsRule\>
            <eventType\>FeedItemMentionSomeone</eventType\>
            <points\>5</points\>
        </pointsRule\>
        <pointsRule\>
            <eventType\>FeedItemSomeoneMentionsYou</eventType\>
            <points\>10</points\>
        </pointsRule\>
        <pointsRule\>
            <eventType\>FeedItemShareAPost</eventType\>
            <points\>5</points\>
        </pointsRule\>
        <pointsRule\>
            <eventType\>FeedItemSomeoneSharesYourPost</eventType\>
            <points\>10</points\>
        </pointsRule\>
    </reputationPointsRules\>
    <selfRegistration\>false</selfRegistration\>
    <sendWelcomeEmail\>true</sendWelcomeEmail\>
    <site\>Network\_11</site\>
    <status\>UnderConstruction</status\>
    <tabs\>
        <defaultTab\>Chatter</defaultTab\>
        <standardTab\>Chatter</standardTab\>
        <standardTab\>Account</standardTab\>
        <standardTab\>Campaign</standardTab\>
        <standardTab\>Case</standardTab\>
        <standardTab\>Console</standardTab\>
        <standardTab\>Contact</standardTab\>
        <standardTab\>Contract</standardTab\>
        <standardTab\>Dashboard</standardTab\>
        <standardTab\>JigsawSearch</standardTab\>
        <standardTab\>File</standardTab\>
        <standardTab\>CollaborationGroup</standardTab\>
        <standardTab\>home</standardTab\>
        <standardTab\>Idea</standardTab\>
        <standardTab\>Lead</standardTab\>
        <standardTab\>Opportunity</standardTab\>
        <standardTab\>Product2</standardTab\>
        <standardTab\>UserProfile</standardTab\>
        <standardTab\>report</standardTab\>
        <standardTab\>Solution</standardTab\>
    </tabs\>
    <urlPathPrefix\>network1</urlPathPrefix\>
    <welcomeTemplate\>unfiled$public/CommunityWelcomeEmailTemplate</welcomeTemplate\>
</Network\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Community (Zone)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_community.htm "Represents a zone that contains Ideas or Chatter Answers objects. Zones are shared by the Ideas, Answers, and Chatter Answers features, allowing you to view and create zones from those locations.This type extends the Metadata metadata type and inherits its fullName field.")

<!-- document id=7b05c00676f7438d91111f9c00d12fb70dea763752c5eb41fc5fbb2f39f50d7a url=/legacydeveloper/current/en-us/api_meta/meta_networkbranding.md -->

# NetworkBranding

Represents the branding and color scheme applied to the login pages of an Experience Cloud site. (Experience Cloud sites are represented by the Network component.)

This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm#meta_metadatawithcontent "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") type and inherits its content and fullName fields.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

For branding properties that apply to Experience Builder sites, see [BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm "Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.").

## Declarative Metadata File Suffix and Directory Location

NetworkBranding components have the suffix .networkBranding and are stored in the networkBranding folder.

## Version

This object is available in API version 41.0 and later. It replaces the Branding subtype in the Network component.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| loginBackgroundImageUrl | string | The path to the image URL that appears as the background on the Experience Cloud site’s login page. This URL can be fixed, dynamic, or an uploaded image. A dynamic URL contains the experience ID parameter, {expid}, and is resolved dynamically at runtime. |
| loginFooterText | string | The text that appears in the footer of the Experience Cloud site login page. |
| loginLogo | string | The logo that appears on the Experience Cloud site login page for external users. |
| loginLogoName | string | The name of the logo that appears on the Experience Cloud site login page for external users. |
| loginPrimaryColor | string | The background color of the Login button. Available in API version 42.0 and later. |
| loginQuaternaryColor | string | The background color for the Experience Cloud site’s login page. |
| loginRightFrameUrl | string | The path to the content of the right frame of the Experience Cloud site login page. This URL can be either fixed or dynamic. A dynamic URL contains the experience ID parameter, {expid}. If the URL contains {expid}, the URL is resolved dynamically at runtime depending on the parameter's value. |
| network | string | The name of the Experience Cloud site associated with the branding. |
| pageFooter | string | An image that appears on the footer of the Experience Cloud site pages. Must be an .html file. |
| pageHeader | string | An image that appears on the header of the Experience Cloud site pages. Can be an .html, .gif, .jpg, or .png file. |
| primaryColor | string | Required. The color used for the active tab. |
| primaryComplementColor | string | Required. Font color used with primaryColor. |
| quaternaryColor | string | Required. The background color for pages in the Experience Cloud site. |
| quaternaryComplementColor | string | Required. Font color used with quaternaryColor. |
| secondaryColor | string | Required. The color used for the top borders of lists and tables. |
| staticLogoImageUrl | string | The path to the logo that appears on the Experience Cloud site’s login page. This URL can be fixed, dynamic, or an uploaded image. A dynamic URL contains the experience ID parameter, {expid}. If the URL contains {expid}, the URL is resolved dynamically at runtime depending on the parameter's value. |
| tertiaryColor | string | Required. The background color for section headers on edit and detail pages. |
| tertiaryComplementColor | string | Required. Font color used with tertiaryColor. |
| zeronaryColor | string | Required. The background color for the header. |
| zeronaryComplementColor | string | Required. Font color used with zeronaryColor. |

## Declarative Metadata Sample Definition

A sample XML definition of network branding.

<?xml version="1.0" encoding="UTF-8"?>
<NetworkBranding xmlns="http://soap.sforce.com/2006/04/metadata">
    <loginFooterText\>salesforce.com</loginFooterText\>
    <loginLogo\>Communities\_Shared\_Document\_Folder/header2\_png.png</loginLogo\>
    <loginLogoName\>header2.png</loginLogoName\>
    <loginBackgroundImageUrl\>http://identitycms.herokuapp.com/promo-background.jpg</loginBackgroundImageUrl\>
    <loginQuaternaryColor\>#B1BAC1</loginQuaternaryColor\>
    <loginRightFrameUrl\>https://www.example.com/test</loginRightFrameUrl\>
    <network\>Network 1</network\>
    <pageFooter\>Branding/footer\_html.html</pageFooter\>
    <pageHeader\>Branding/header\_Image.jpg</pageHeader\>
    <primaryColor\>#AF5800</primaryColor\>
    <primaryComplementColor\>#FFFFFF</primaryComplementColor\>
    <quaternaryColor\>#286FB8</quaternaryColor\>
    <quaternaryComplementColor\>#FFFFFF</quaternaryComplementColor\>
    <secondaryColor\>#000000</secondaryColor\>
    <tertiaryColor\>#FFFFFF</tertiaryColor\>
    <tertiaryComplementColor\>#222222</tertiaryComplementColor\>
    <zeronaryColor\>#0A3764</zeronaryColor\>
    <zeronaryComplementColor\>#FFFFFF</zeronaryComplementColor\>
</NetworkBranding\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=3ff5ebd73127892dd1f0c2259a84595339fb363c0116e488b3414507b2d7e233 url=/legacydeveloper/current/en-us/api_meta/meta_notificationssettings.md -->

# NotificationsSettings

Represents an organization’s mobile settings.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## Declarative Metadata File Suffix and Directory Location

NotificationsSettings values are stored in a single file named Notifications.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

Mobile settings are available in API version 46.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| enableActvityReminderBrowserNotifs | boolean | Reserved for internal use. |
| enableMobileAppPushNotifications | boolean | Indicates whether mobile push notifications are enabled. |
| enableNotifications | boolean | Indicates whether notifications are enabled. |

## Declarative Metadata Sample Definition

This is a sample notifications.settings metadata file.

<NotificationsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableMobileAppPushNotifications\>true</enableMobileAppPushNotifications\>
    <enableNotifications\>true</enableNotifications\>
</NotificationsSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b4c543c382ead0c83ee218d095759e97233c550d250d831ff47d2f9a19addb3c url=/legacydeveloper/current/en-us/api_meta/meta_notificationtypeconfig.md -->

# NotificationTypeConfig

Represents the metadata associated with org-level notification settings for standard and custom notification types. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

NotificationTypeConfig components have the suffix .config and are stored in the notificationTypeConfig folder.

## Version

NotificationTypeConfig components are available in API version 48.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| notificationTypeSettings | [NotificationTypeSettings](#notificationTypeSettings)\[\] | An array of delivery settings for an org’s notification types. |

## NotificationTypeSettings

Represents the delivery settings for a standard or custom notification type.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d704442e141">Field Name</th>

              <th class="featureTableHeader  " id="d704442e144">Field Type</th>

              <th class="featureTableHeader  " id="d704442e147">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d704442e141" data-title="Field Name"><span class="keyword parmname">notificationType</span></td>

              <td class="entry" headers="d704442e144" data-title="Field Type">string</td>

              <td class="entry" headers="d704442e147" data-title="Description">
                <p class="p">Required. Specifies a notification type’s API name.</p>

                <p class="p">For standard notification types, this is the predefined API name
                  of the standard notification type. For custom notification
                  types, this is the API name of the custom notification type. If
                  a custom notification type was installed with a managed package,
                  it includes the namespace prefix.</p>

                <p class="p">Retrieve NotificationTypeConfig to see the API names of the
                  notification types available in your org.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d704442e141" data-title="Field Name"><span class="keyword parmname">appSettings</span></td>

              <td class="entry" headers="d704442e144" data-title="Field Type">
                <a class="xref" href="#appSettings">AppSettings</a>[]
              </td>

              <td class="entry" headers="d704442e147" data-title="Description">An array of settings for the connected apps supported for a
                notification type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d704442e141" data-title="Field Name"><span class="keyword parmname">notificationChannels</span></td>

              <td class="entry" headers="d704442e144" data-title="Field Type"><a class="xref" href="#notificationChannels">NotificationChannels</a></td>

              <td class="entry" headers="d704442e147" data-title="Description">Defines the delivery channels for a notification type.</td>

            </tr>

          </tbody>

        </table>

## AppSettings

Represents the settings for the connected apps supported for a notification type.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d704442e234">Field Name</th>

              <th class="featureTableHeader  " id="d704442e237">Field Type</th>

              <th class="featureTableHeader  " id="d704442e240">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d704442e234" data-title="Field Name"><span class="keyword parmname">connectedAppName</span></td>

              <td class="entry" headers="d704442e237" data-title="Field Type">string</td>

              <td class="entry" headers="d704442e240" data-title="Description">Required. Specifies the API name of a connected app. If a
                connected app is installed with a managed package, it includes the
                namespace prefix.<p class="p">Retrieve NotificationTypeConfig to see the API
                  names of the connected apps supported for a notification
                  type.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d704442e234" data-title="Field Name"><span class="keyword parmname">enabled</span></td>

              <td class="entry" headers="d704442e237" data-title="Field Type">boolean</td>

              <td class="entry" headers="d704442e240" data-title="Description">Indicates whether a connected app is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) for the notification
                type.</td>

            </tr>

          </tbody>

        </table>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If an Enhanced Connected App (ECA) and a Connected App (CA) share the same name, or if the CA has been migrated to an ECA, only the ECA is returned when you retrieve NotificationTypeConfig.

- The CA settings aren't applied when you deploy the retrieved settings to a new org and the CA and ECA share the same name.
- In existing orgs, app settings for CAs that share a name with an ECA or have been migrated to an ECA can't be changed via the Metadata API. To change these app settings, use the UI.

## NotificationChannels

Represents the settings for the delivery channels for a notification type.

| Field Name | Field Type | Description |
| --- | --- | --- |
| desktopEnabled | boolean | Indicates whether desktop notifications are enabled (true) or not (false). |
| mobileEnabled | boolean | Indicates whether mobile notifications are enabled (true) or not (false). |
| slackEnabled | boolean | Indicates whether Slack notifications are enabled (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example of a NotificationTypeConfig component.

<NotificationTypeConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <notificationTypeSettings>
        <notificationType>chatter\_mention</notificationType>
        <notificationChannels>
            <desktopEnabled>false</desktopEnabled>
            <mobileEnabled>true</mobileEnabled>
        </notificationChannels>
        <appSettings>
            <connectedAppName>Datawatch</connectedAppName>
            <enabled>false</enabled>
        </appSettings>
            <appSettings>
            <connectedAppName>package2\_\_ConnectedApp2</connectedAppName>
            <enabled>true</enabled>
        </appSettings>
    </notificationTypeSettings>
   <notificationTypeSettings>
        <notificationType>namespace\_\_Custom\_Notification</notificationType>
        <notificationChannels>
            <desktopEnabled>true</desktopEnabled>
            <mobileEnabled>true</mobileEnabled>
        </notificationChannels>
        <appSettings>
            <connectedAppName>namespace\_\_Connected\_App</connectedAppName>
            <enabled>false</enabled>
        </appSettings>
        <appSettings>
            <connectedAppName>namespace2\_\_ConnectedApp2</connectedAppName>
            <enabled>true</enabled>
        </appSettings>
    </notificationTypeSettings>
</NotificationTypeConfig>

The following is an example of a package manifest used to retrieve all the available notification settings for an organization, by using a wildcard:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>NotificationTypeConfig</name>
    </types>
    <version>48.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=8fa613b9799c1bd36ef8abe7762b4eea3737f1c99df7cf86cbd60e8b2f6fb1a3 url=/legacydeveloper/current/en-us/api_meta/meta_oauthcustomscope.md -->

# OauthCustomScope

Represents a permission defining the protected data that a connected app can access from an external entity when Salesforce is the OAuth authorization provider. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

OauthCustomScope components have the suffix .oauthcustomscope and are stored in the oauthcustomscopes directory.

## Version

OAuth custom scopes are available in API version 46.0 and later.

## Special Access Rules

You must have the “Manage Connected Apps” permission to access this object.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d705456e100">Field Name</th>

              <th class="featureTableHeader  " id="d705456e103">Field Type</th>

              <th class="featureTableHeader  " id="d705456e106">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d705456e100" data-title="Field Name"><span class="keyword parmname">assignedTo</span></td>

              <td class="entry" headers="d705456e103" data-title="Field Type">
                <span class="ph" id="OauthCustomScopeApp_title"><a name="OauthCustomScopeApp_title"><!-- --></a>OauthCustomScopeApp</span> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d705456e106" data-title="Description">Represents the name of the connected app to which the custom scope is assigned.
                Available in API version 49.0 and later.<p class="p">If the connected app is part of a
                  package, include the package’s namespace prefix with the connected app’s name. Use
                  the following format: <samp class="codeph nolang"><var class="keyword varname">&lt;namespace_prefix&gt;</var>__<var class="keyword varname">&lt;connected_app&gt;</var></samp>.
                  Use two underscores (_) between the namespace prefix and connected app’s
                  name.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d705456e100" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d705456e103" data-title="Field Type">string</td>

              <td class="entry" headers="d705456e106" data-title="Description">Required. The description of the permission provided to the connected app by
                the scope. The custom scope’s description must be unique, can only include
                alphanumeric characters, and can be up to 60 characters long.<div class="p">You can enter a
                  custom label in place of a description. An advantage of using a custom label is
                  that you can maintain reusable text in a single location and translate the text
                  into multiple languages. See <a class="xref" href="https://help.salesforce.com/articleView?id=cl_about.htm&amp;language=en_US" target="_blank">Custom Labels</a>.<div class="box message info">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p>The description formatting
                              requirements that apply to custom scopes also apply to custom
                              labels.</p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d705456e100" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d705456e103" data-title="Field Type">string</td>

              <td class="entry" headers="d705456e106" data-title="Description">Required. Use when referring to the OAuth custom scope from a program.</td>

            </tr>

            <tr>
              <td class="entry" headers="d705456e100" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d705456e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d705456e106" data-title="Description">Required. Indicates whether this component is protected () or not (<samp class="codeph nolang">false</samp>).
                Protected components cannot be linked to or referenced by components created in the
                installing org.</td>

            </tr>

            <tr>
              <td class="entry" headers="d705456e100" data-title="Field Name"><span class="keyword parmname">isPublic</span></td>

              <td class="entry" headers="d705456e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d705456e106" data-title="Description">Indicates whether the object is included in the connected app’s OpenID Connect
                discovery endpoint. The default setting is <samp class="codeph nolang">false</samp>. For more information, see <a class="xref" href="https://help.salesforce.com/articleView?id=remoteaccess_using_openid_discovery_endpoint.htm&amp;language=en_US" target="_blank">OpenID Connect Discovery Endpoint</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d705456e100" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d705456e103" data-title="Field Type">string</td>

              <td class="entry" headers="d705456e106" data-title="Description">Required. The primary label for the custom scope record. This label must be
                unique and begin with a letter. It can include only alphanumeric characters and
                underscores. It can’t contain spaces.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an OAuthCustomScope component. In this example, basicScope is the name of custom scope entity being retrieved.

<?xml version="1.0" encoding="UTF-8"?>
<OauthCustomScope xmlns="http://soap.sforce.com/2006/04/metadata">
    <assignedTo\>
        <connectedApp\>MyOrgNamespace\_\_TestApp</connectedApp\>
    </assignedTo\>
    <description\>Example of a basic custom scope</description\>
    <developerName\>basicScope</developerName\>
    <masterLabel\>basicScope</masterLabel\>
    <isProtected\>false</isProtected\>
    <isPublic\>true</isPublic\>
</OauthCustomScope\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>basicScope</members\>
<name\>OauthCustomScope</name\>
</types\>
<version\>49.0</version\>
</Package\>

## Usage

An OAuth custom scope tells an external entity about a connected app’s permissions to access protected data. The OAuth custom scope you create in your Salesforce org corresponds to the same custom scope defined in your external entity and assigned to the resource.

For example, you define an Order Status custom scope in your external entity that allows access to customer order status data in your order system’s API. In Salesforce, you create an OAuth custom scope that you also name Order Status. You assign this custom scope to the connected app requesting access to the order status API. When the external entity receives the connected app’s request to access a customer’s order status, it validates the connected app’s access token and Order Status scope. With a successful validation, the app can access the customer order status information in the order system’s API.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=5fbf675bd09251061955046c12bb0a9a2ad99b4fee4091795b9d9cf3481d84b3 url=/legacydeveloper/current/en-us/api_meta/meta_oauthoidcsettings.md -->

# OauthOidcSettings

Represents org settings for disabling OAuth OpenID Connect authorization flows.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details.

## File Suffix and Directory Location

OauthOidcSettings values are stored in the OauthOidc.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

OauthOidcSettings is available in API version 56.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| agentAuthLinking | 
Field Type

boolean

Description

For internal use only.



 |
| blockOAuthUnPwFlow | 

Field Type

boolean

Description

Indicates whether the username-password flow is blocked (true) or not blocked (false). The default value is false.



 |
| blockOAuthUsrAgtFlow | 

Field Type

boolean

Description

Indicates whether the user-agent flow is blocked (true) or not blocked (false). The default value is false.



 |
| enableHdlessFgtPswFlow | 

Field Type

boolean

Description

For internal use only.



 |
| isPkceRequired | 

Field Type

boolean

Description

Indicates whether the OAuth 2.0 Proof Key for Code Exchange (PKCE) security extension is required for variations of the OAuth authorization code flow that access this org (true) or not (false). This setting requires PKCE for all supported variations of the authorization code flow, including the web server flow, the Authorization Code and Credentials Flow, and their derivatives. The default value is false. This field is available in API version 59.0 and later.



 |
| oAuthCdCrdtFlowEnable | 

Field Type

boolean

Description

Indicates whether the Authorization Code and Credentials Flow is enabled (true) or blocked (false). The default value is false.



 |

## Declarative Metadata Sample Definition

The following is an example of the OauthOidcSettings file.

<?xml version=“1.0” encoding=“UTF-8"?>
<OauthOidcSettings xmlns=“http://soap.sforce.com/2006/04/metadata”>
    <blockOAuthUnPwFlow\>true</blockOAuthUnPwFlow\>
    <blockOAuthUsrAgtFlow\>true</blockOAuthUsrAgtFlow\>
    <oAuthCdCrdtFlowEnable\>false</oAuthCdCrdtFlowEnable\>
</OauthOidcSettings\>

## Example Package Manifest

The following is an example package.xml that references the previous definition.

<?xml version=“1.0" encoding=“UTF-8”?>
<Package xmlns=“http://soap.sforce.com/2006/04/metadata”>
  <types\>
    <members\>OauthOidc</members\>
    <name\>Settings</name\>
  </types\>
  <version\>56.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6e135cfb5604fc5acf83a2145871164862beccd215b52c0dde26650549f2280f url=/legacydeveloper/current/en-us/api_meta/meta_oauthtokenexchangehandler.md -->

# OauthTokenExchangeHandler

Represents a token exchange handler. The token exchange handler also consists of an Apex class. During the OAuth 2.0 token exchange flow, the token exchange handler is used to validate tokens from an external identity provider and to map users to Salesforce.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

OauthTokenExchangeHandler components have the suffix .oauthtokenexchangehandler and are stored in the oauthtokenexchangehandlers folder.

## Version

OauthTokenExchangeHandler components are available in API version 60.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Required. A description for your token exchange handler.



 |
| developerName | 

Field Type

string

Description

Required. The API name for the handler.



 |
| enablements | 

Field Type

[OauthTokenExchHandlerApp\[\]](#OauthTokenExchHandlerApp)

Description

The enablement settings for the token exchange handler, including the execution user who runs the Apex class, the connected apps or external client apps for which it’s enabled, and whether or not it’s the default handler.



 |
| isAccessTokenSupported | 

Field Type

boolean

Description

Required. Indicates whether the handler supports OAuth 2.0 access tokens from the identity provider, including opaque access tokens and JSON Web Token (JWT)-based access tokens.



 |
| isContactCreationAllowed | 

Field Type

boolean

Description

For internal use only.



 |
| isEnabled | 

Field Type

boolean

Description

Required. Indicates whether the handler is enabled. To complete enablement, add an enablements field that specifies the enablement settings.



 |
| isIdTokenSupported | 

Field Type

boolean

Description

Required. Indicates whether the handler supports OpenID Connect ID tokens from the identity provider.



 |
| isJwtSupported | 

Field Type

boolean

Description

Required. Indicates whether the handler supports tokens from the identity provider that are in JWT format, such as JWT-based access tokens.



 |
| isProtected | 

Field Type

boolean

Description

Indicates whether the handler can be linked to or referenced by components created in a subscriber org. See [Protected Components in Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/packaging_protected_components.htm).



 |
| isRefreshTokenSupported | 

Field Type

boolean

Description

Required. Indicates whether the handler supports OAuth 2.0 refresh tokens from the identity provider.





 |
| isSaml2Supported | 

Field Type

boolean

Description

Required. Indicates whether the handler supports SAML 2.0 assertions from the identity provider.





 |
| isUserCreationAllowed | 

Field Type

boolean

Description

Required. Indicates whether the handler can set up new users. During the token exchange flow, the Apex handler maps users from the identity provider to Salesforce. If the isUserCreationAllowed field is true, the canCreateUser boolean in the getUserForTokenSubject method is true, and the user doesn’t exist in Salesforce, the handler sets up a new User object, which Salesforce automatically inserts to finish creating the user.





 |
| masterLabel | 

Field Type

string

Description

Required. The label of the token exchange handler record.





 |
| tokenHandlerApex | 

Field Type

string

Description

Required. The Apex class associated with the token exchange handler. The class contains methods to validate the token and map users to Salesforce. It must extend the Oauth2TokenExchangeHandler Apex class.





 |

## OauthTokenExchHandlerApp

Represents the settings for a specific Salesforce connected app or external client app that’s enabled for the token exchange handler. A handler can be enabled for multiple apps.

| Field Name | Description |
| --- | --- |
| apexExecutionUser | 
Field Type

string

Description

Required. A user who runs the Apex token exchange handler. We recommend that you use an integration user.





 |
| connectedApp | 

Field Type

string

Description

The API name of the connected app that’s being used to integrate with Salesforce.



 |
| externalClientApp | 

Field Type

string

Description

The API name of the external client app that’s being used to integrate with Salesforce.



 |
| isDefault | 

Field Type

boolean

Description

Required. Indicates whether the token exchange handler is the default handler for this app. During the token exchange flow, in the token request, you can optionally include a token\_handler parameter with the name of a specific handler’s Apex class. If you don’t include this parameter, Salesforce defaults to the default handler.





 |

## Declarative Metadata Sample Definition

The following is an example of an OauthTokenExchangeHandler component.

<?xml version="1.0" encoding="UTF-8"?>
<OauthTokenExchangeHandler xmlns="http://soap.sforce.com/2006/04/metadata">
    <developerName\>MyTokenExchangeHandler</developerName\>
    <description\>My token exchange handler</description\>
    <isAccessTokenSupported\>true</isAccessTokenSupported\>
    <isEnabled\>true</isEnabled\>
    <isIdTokenSupported\>false</isIdTokenSupported\>
    <isJwtSupported\>true</isJwtSupported\>
    <isProtected\>false</isProtected\>
    <isRefreshTokenSupported\>false</isRefreshTokenSupported\>
    <isSaml2Supported\>false</isSaml2Supported\>
    <isUserCreationAllowed\>true</isUserCreationAllowed\>
    <masterLabel\>MyTokenExchangeHandler</masterLabel\>
    <tokenHandlerApex\>MyOauthTokenExchangeHandler</tokenHandlerApex\>
    <enablements\>
        <apexExecutionUser\>integrationuser@mycompany.com</apexExecutionUser\>
        <connectedApp\>TokenExchangeApp1</conectedApp\>
        <isDefault\>true</isDefault\>
    </enablements\>
</OauthTokenExchangeHandler\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>OauthTokenExchangeHandler</name\>
    </types\>
    <version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=a76a92da99473a6bd7498d445137d6aaa6b9eed766bdae32b239a69bd20a0d0a url=/legacydeveloper/current/en-us/api_meta/mfg_objecthierarchyrelationshipsettings_metadata_api.md -->

# ObjectHierarchyRelationship

Represents an organization’s custom field mappings for sales agreement conversion. Fields can be mapped from Opportunity and Quotes to SalesAgreement and SalesAgreementProduct.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

ObjectHierarchyRelationship components have the suffix ObjectHierarchyRelationship.settings and are stored in the ObjectHierarchyRelationship folder.

## Version

ObjectHierarchyRelationship components are available in API version 51.0 and later.

## Fields

### childObjectMapping

- **Field Type**: [ObjectMapping](#mfg_objecthierarchyrelationshipsettings_metadata_api_objectmapping)
- **Description**: Set of inputObject, mappingFields, and outputObject entries. For example, fields from the input object of OpportunityLineItem maps to fields of the output object of SalesAgreementProduct.

### childObjectMappingId

- **Field Type**: String
- **Description**: The ID of the child object mapping record. This field is available in API version 56.0 and later.

### inputObjRecordsGrpFieldName

- **Field Type**: string
- **Description**: The field name in the input object used to group the records. This field is available in API version 55.0 and later.

### mappingType

- **Field Type**: ObjHierarchyMappingType (enumeration of type string)
- **Description**: Specifies the type of relationship between two objects. This field is available in API version 55.0 and later.
- **Possible values**:
    - ChildToChild
    - ParentToChild
    - ParentToParent
    - Support

### masterLabel

- **Field Type**: string
- **Description**: Label name of the mapping definition.

### outputPntRelationshipFieldName

- **Field Type**: string
- **Description**: The field name that defines the relationship between a parent and child for the output object. This field is available in API version 55.0 and later.

### parentObjectMapping

- **Field Type**: [ObjectMapping](#mfg_objecthierarchyrelationshipsettings_metadata_api_objectmapping)
- **Description**: Required.
    
    Set of inputObject, mappingFields, and outputObject entries. For example, fields from the input object of Opportunity maps to fields of the output object of SalesAgreement.

### parentObjectMappingId

- **Field Type**: string
- **Description**: The ID of the parent object mapping record. This field is available in API version 56.0 and later.

### parentRecord

- **Field Type**: string
- **Description**: The parent record for this object hierarchy relationship. This field is available in API version 55.0 and later.

### parentRelationshipFieldName

- **Field Type**: string
- **Description**: Name of the field that defines the relationship between the parent and child.

### sourceReferenceRelaFieldName

- **Field Type**: string
- **Description**: The field name in an object that's used to define the relationship between a source and reference object. This field is available in API version 56.0 and later.

### usageType

- **Field Type**: MappingUsageType (enumeration of type string)
- **Description**: Required. Name of the usage type of an object hierarchy relationship.
- **Possible values**:
    - ConvertToSalesAgreement
    - CLMFieldMapping
    - EligibleProgramRebateType
    - MapJournalToMemberAggregate
    - TransformationMapping

## ObjectMapping

Represents a set of inputObject, mappingFields, and outputObject entries.

### inputObject

- **Field Type**: string
- **Description**: Required. Name of the input object type containing the source fields for mapping. For example, Opportunity or OpportunityLineItem.

### mappingFields

- **Field Type**: [ObjectMappingField](#mfg_objecthierarchyrelationshipsettings_metadata_api_objectmappingfield)
- **Description**: Mapping of source object input fields to target object for SalesAgreement and SalesAgreementProduct.

### outputObject

- **Field Type**: string
- **Description**: Required. Name of the output object type receiving data conversion. For example, SalesAgreement or SalesAgreementProduct.

## ObjectMappingField

Represents a set of inputField and outputField entries.

### inputField

- **Field Type**: string
- **Description**: Required. Field in the object specified by the inputObject field in [ObjectMapping](#mfg_objecthierarchyrelationshipsettings_metadata_api_objectmapping). This field is mapped to the field in outputField, which is a field in the object specified by the outputObject field in [ObjectMapping](#mfg_objecthierarchyrelationshipsettings_metadata_api_objectmapping).

### outputField

- **Field Type**: string
- **Description**: Required. Field in the object specified by the outputObject field in [ObjectMapping](#mfg_objecthierarchyrelationshipsettings_metadata_api_objectmapping). This field is mapped to the field name in inputField, which is a field in the object specified by the inputObject field in [ObjectMapping](#mfg_objecthierarchyrelationshipsettings_metadata_api_objectmapping).

## Declarative Metadata Sample Definition

The following is an example of a ObjectHierarchyRelationship component.

<?xml version="1.0" encoding="UTF-8"?>
<ObjectHierarchyRelationship xmlns="http://soap.sforce.com/2006/04/metadata">

  <parentObjectMapping\>
    <inputObject\>Opportunity</inputObject\>
    <mappingFields\>
      <inputField\>Name</inputField\>
      <outputField\>Name</outputField\>
    </mappingFields\>
    <mappingFields\>
      <inputField\>CloseDate</inputField\>
      <outputField\>StartDate</outputField\>
    </mappingFields\>
    <mappingFields\>
      <inputField\>Account</inputField\>
      <outputField\>Account</outputField\>
    </mappingFields\>
    <mappingFields\>
      <inputField\>Pricebook2</inputField\>
      <outputField\>Pricebook</outputField\>
    </mappingFields\>
    <outputObject\>SalesAgreement</outputObject\>
  </parentObjectMapping\>

  <childObjectMapping\>
    <inputObject\>OpportunityLineItem</inputObject\>
    <mappingFields\>
      <inputField\>Id</inputField\>
      <outputField\>Name</outputField\>
    </mappingFields\>
    <mappingFields\>
      <inputField\>UnitPrice</inputField\>
      <outputField\>SalesPrice</outputField\>
    </mappingFields\>
    <mappingFields\>
      <inputField\>PricebookEntry</inputField\>
      <outputField\>PricebookEntry</outputField\>
    </mappingFields\>
    <mappingFields\>
      <inputField\>Quantity</inputField\>
      <outputField\>InitialPlannedQuantity</outputField\>
    </mappingFields\>
    <outputObject\>SalesAgreementProduct</outputObject\>
  </childObjectMapping\>

  <masterLabel\>ObjectHierarchyRelationship</masterLabel\>
  <usageType\>ConvertToSalesAgreement</usageType\>
  <parentRelationshipFieldName\>Opportunity</parentRelationshipFieldName\>
  <outputPntRelationshipFieldName\>SalesAgreement</outputPntRelationshipFieldName\>
  <parentRecord\></parentRecord\>
  <inputObjRecordsGrpFieldName\>Account</inputObjRecordsGrpFieldName\>
  <mappingType\>ParentToParent</mappingType\>

</ObjectHierarchyRelationship\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
      <members\>\*</members\>
      <name\>ObjectHierarchyRelationship</name\>
    </types\>
    <version\>51.0</version\>
</Package\>

## Usage

Use the deploy() call to deploy metadata with a .zip file. Every .zip file contains a project manifest, a file that’s named package.xml, and a set of directories that contain the components. The manifest file defines the components that you’re trying to retrieve or deploy in the .zip file. The manifest also defines the API version that’s used for the deployment or retrieval. For more information on the .zip file, deploying, and retrieving metadata, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)"). You can also deploy and retrieve the metadata API using Postman.

Ensure you map all the required fields for sales agreement conversion.

## Wildcard Support in the Manifest File

### 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b283520f26f49be43eff56b6984b9fc4bbaf25f1e7ab57fc3fd5b9fa7949d22d url=/legacydeveloper/current/en-us/api_meta/meta_objectlinkingsettings.md -->

# ObjectLinkingSettings (Beta)

Represents the channel-object linking settings for an org. This type extends the Metadata metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

As a beta feature, Channel-Object Linking is a preview and isn’t part of the “Services” under your Main Services Agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature. For information on enabling this feature, contact Salesforce.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

ObjectLinkingSettings values are stored in the ObjectLinking.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ObjectLinkingSettings components are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableObjectLinking | boolean | Indicates whether Channel-Object Linking is enabled, allowing you to link channel interactions to objects such as Contacts. The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of an ObjectLinkingSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ObjectLinkingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableObjectLinking\>true</enableObjectLinking\>
</ObjectLinkingSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ObjectLinking</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</Package\>

<!-- document id=769178fe3e490eee67ea681ccec6d56453946f0bce3a034fd8fa8863f599c8d1 url=/legacydeveloper/current/en-us/api_meta/meta_objectsourcetargetmap.md -->

# ObjectSourceTargetMap

Contains the object-level mappings between the source and the target objects. The source and target objects can be an MktDataLakeObject or an MktDataModelObject. For example, an Email source object can be mapped to the ContactPointEmail object.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ObjectSourceTargetMap components have the suffix .objectSourceTargetMap and are stored in the objectSourceTargetMaps folder.

## Version

ObjectSourceTargetMap components are available in API version 51.0 and later.

## Special Access Rules

To access this metadata type, you must have the Customize Application user permission.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d709013e112">Field Name</th>

              <th class="featureTableHeader  " id="d709013e115">Field Type</th>

              <th class="featureTableHeader  " id="d709013e118">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d709013e112" data-title="Field Name"><span class="keyword parmname">creationType</span></td>

              <td class="entry" headers="d709013e115" data-title="Field Type">DefinitionCreationType (enumeration of type string)</td>

              <td class="entry" headers="d709013e118" data-title="Description">Describes whether this object was added by the user or as part of a standard taxonomy.
                Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ADG</samp></li>

                  <li class="li"><samp class="codeph nolang">Activation_Audience</samp></li>

                  <li class="li"><samp class="codeph nolang">Bridge</samp></li>

                  <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">CG_Audience</samp> (Available in API version
                    62.0 and later)
                  </li>

                  <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                  <li class="li"><samp class="codeph nolang">Curated</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom</samp></li>

                  <li class="li"><samp class="codeph nolang">Derived</samp></li>

                  <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                  <li class="li"><samp class="codeph nolang">External</samp></li>

                  <li class="li"><samp class="codeph nolang">Ml_Prediction</samp></li>

                  <li class="li"><samp class="codeph nolang">Segment_Membership</samp></li>

                  <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                  <li class="li"><samp class="codeph nolang">Standard</samp></li>

                  <li class="li"><samp class="codeph nolang">System</samp></li>

                  <li class="li"><samp class="codeph nolang">Transform</samp></li>

                  <li class="li"><samp class="codeph nolang">Vector_Embedding</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e112" data-title="Field Name"><span class="keyword parmname">fieldSourceTargetMaps</span></td>

              <td class="entry" headers="d709013e115" data-title="Field Type">FieldSourceTargetMap[]</td>

              <td class="entry" headers="d709013e118" data-title="Description">Contains the field-level mappings associated with this object mapping.</td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e112" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d709013e115" data-title="Field Type">string</td>

              <td class="entry" headers="d709013e118" data-title="Description">Required. The UI name for the target map.</td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e112" data-title="Field Name"><span class="keyword parmname">sequenceNbr</span></td>

              <td class="entry" headers="d709013e115" data-title="Field Type">int</td>

              <td class="entry" headers="d709013e118" data-title="Description">Use this field to display multiple mappings between the same two objects, for a
                consistent customer experience when presenting the mappings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e112" data-title="Field Name"><span class="keyword parmname">sourceObjectName</span></td>

              <td class="entry" headers="d709013e115" data-title="Field Type">string</td>

              <td class="entry" headers="d709013e118" data-title="Description">Required. Name of the source object that’s mapped, such as Email, or
                SfmcEnt1_Subscriber.</td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e112" data-title="Field Name"><span class="keyword parmname">targetObjectName</span></td>

              <td class="entry" headers="d709013e115" data-title="Field Type">string</td>

              <td class="entry" headers="d709013e118" data-title="Description">Required. Name of the target object that’s mapped, such as ContactPointEmail or
                Individual.</td>

            </tr>

          </tbody>

        </table>

## FieldSourceTargetMap

Contains the field-level mappings between the source and the target objects.

The source and target can be MktDataLakeField or MktDataModelField.

For example, you can map a Person source object’s field called emailAddress to an Individual target object's field called emailAddress.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d709013e317">Field Name</th>

              <th class="featureTableHeader  " id="d709013e320">Field Type</th>

              <th class="featureTableHeader  " id="d709013e323">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d709013e317" data-title="Field Name"><span class="keyword parmname">creationType</span></td>

              <td class="entry" headers="d709013e320" data-title="Field Type">DefinitionCreationType (enumeration of type string)</td>

              <td class="entry" headers="d709013e323" data-title="Description">Describes whether this object was added by the user or as part of a standard taxonomy.
                <p class="p">Values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ADG</samp></li>

                  <li class="li"><samp class="codeph nolang">Activation_Audience</samp></li>

                  <li class="li"><samp class="codeph nolang">Bridge</samp></li>

                  <li class="li"><samp class="codeph nolang">Calculated_Insight</samp></li>

                  <li class="li"><samp class="codeph nolang">Chunk</samp></li>

                  <li class="li"><samp class="codeph nolang">Curated</samp></li>

                  <li class="li"><samp class="codeph nolang">Custom</samp></li>

                  <li class="li"><samp class="codeph nolang">Derived</samp></li>

                  <li class="li"><samp class="codeph nolang">Directory_Table</samp></li>

                  <li class="li"><samp class="codeph nolang">External</samp></li>

                  <li class="li"><samp class="codeph nolang">Ml_Prediction</samp></li>

                  <li class="li"><samp class="codeph nolang">Segment_Membership</samp></li>

                  <li class="li"><samp class="codeph nolang">Semantic</samp></li>

                  <li class="li"><samp class="codeph nolang">Standard</samp></li>

                  <li class="li"><samp class="codeph nolang">System</samp></li>

                  <li class="li"><samp class="codeph nolang">Transform</samp></li>

                  <li class="li"><samp class="codeph nolang">Vector_Embedding</samp></li>

                </ul>
                <p class="p">Valid values available in API version 67.0 and later are: </p>
                <a name="ul_bpt_ft3_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_bpt_ft3_tjc">
                  <li class="li"><samp class="codeph nolang">Ad_Audience_Insights</samp></li>

                  <li class="li"><samp class="codeph nolang">Auxiliary</samp></li>

                  <li class="li"><samp class="codeph nolang">Clean_Room</samp></li>

                  <li class="li"><samp class="codeph nolang">Deletion_Records</samp></li>

                  <li class="li"><samp class="codeph nolang">Problem_Records</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e317" data-title="Field Name"><span class="keyword parmname">filterApplied</span></td>

              <td class="entry" headers="d709013e320" data-title="Field Type">boolean</td>

              <td class="entry" headers="d709013e323" data-title="Description">Specifies whether the field-level mapping is an event type filter (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e317" data-title="Field Name"><span class="keyword parmname">filterOperationType</span></td>

              <td class="entry" headers="d709013e320" data-title="Field Type">string</td>

              <td class="entry" headers="d709013e323" data-title="Description">If the field-level mapping is an event type filter, specifies the filtering
                operator.<p class="p">Value is:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Equal</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e317" data-title="Field Name"><span class="keyword parmname">filterValue</span></td>

              <td class="entry" headers="d709013e320" data-title="Field Type">string</td>

              <td class="entry" headers="d709013e323" data-title="Description">If the field-level mapping is an event type filter, specifies the object that contains
                the event type field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e317" data-title="Field Name"><span class="keyword parmname">isSourceFormula</span></td>

              <td class="entry" headers="d709013e320" data-title="Field Type">boolean</td>

              <td class="entry" headers="d709013e323" data-title="Description">Specifies whether the source field is a formula (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If <samp class="codeph nolang">true</samp>, you must include the sourceFormula value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e317" data-title="Field Name"><span class="keyword parmname">sourceField</span></td>

              <td class="entry" headers="d709013e320" data-title="Field Type">string</td>

              <td class="entry" headers="d709013e323" data-title="Description">Required. The source object field that’s mapped, such as
                <span class="keyword parmname">EmailAddr</span> or <span class="keyword parmname">SfmcEnt1_Subscriber.FName</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e317" data-title="Field Name"><span class="keyword parmname">sourceFormula</span></td>

              <td class="entry" headers="d709013e320" data-title="Field Type">string</td>

              <td class="entry" headers="d709013e323" data-title="Description">A formula, such as concatenation, date function, or constant value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d709013e317" data-title="Field Name"><span class="keyword parmname">targetField</span></td>

              <td class="entry" headers="d709013e320" data-title="Field Type">string</td>

              <td class="entry" headers="d709013e323" data-title="Description">Required. The target object field that’s mapped, such as
                <span class="keyword parmname">SfmcEnt1_Email.EmailAddr</span> or
                <span class="keyword parmname">Individual.FirstName</span>.
              </td>

            </tr>

          </tbody>

        </table>

<!-- document id=e0ea48c5b8a296000cb51b8b8c9ca58e535cbeacd4ccba0416772d210e901872 url=/legacydeveloper/current/en-us/api_meta/meta_ocrsampledocument.md -->

# OcrSampleDocument

Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

The OcrSampleDocument type doesn’t need to represent a real sample document. It can also be an abstract document that represents all documents of the same DocumentType. In such cases, the contentAsset and documentHeight fields are null.

## File Suffix and Directory Location

OcrSampleDocument components have the suffix .ocrSampleDocument and are stored in the ocrSampleDocuments folder.

## Version

OcrTemplate components are available in API version 52.0 and later.

## Special Access Rules

To use this metadata type, your Salesforce org must have the AWSTextract1000LimitAddOn license.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d710578e112">Field Name</th>

              <th class="featureTableHeader  " id="d710578e115">Field Type</th>

              <th class="featureTableHeader  " id="d710578e118">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d710578e112" data-title="Field Name"><span class="keyword parmname">applicationType</span></td>

              <td class="entry" headers="d710578e115" data-title="Field Type">OcrApplicationType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d710578e118" data-title="Description">The type of application using the OCR sample document.
                <p class="p">Possible values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">EinsteinDocumentReader</samp></li>

                  <li class="li"><samp class="codeph nolang">Industries</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e112" data-title="Field Name"><span class="keyword parmname">contentAsset</span></td>

              <td class="entry" headers="d710578e115" data-title="Field Type">string</td>

              <td class="entry" headers="d710578e118" data-title="Description">The ID of the OCR sample document asset.
                <p class="p">This field is null if the OcrSampleDocument is an abstract
                  document representing the DocumentType.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e112" data-title="Field Name"><span class="keyword parmname">documentHeight</span></td>

              <td class="entry" headers="d710578e115" data-title="Field Type">double</td>

              <td class="entry" headers="d710578e118" data-title="Description">The normalized height of the OCR sample document page.
                <p class="p">This field is null if the OcrSampleDocument is an
                  abstract document representing the DocumentType.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e112" data-title="Field Name"><span class="keyword parmname">documentType</span></td>

              <td class="entry" headers="d710578e115" data-title="Field Type">string</td>

              <td class="entry" headers="d710578e118" data-title="Description">Required. The type of the OCR sample document.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e112" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d710578e115" data-title="Field Type">string</td>

              <td class="entry" headers="d710578e118" data-title="Description">Required. The label for the OCR sample document.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e112" data-title="Field Name"><span class="keyword parmname">ocrSampleDocumentFields</span></td>

              <td class="entry" headers="d710578e115" data-title="Field Type">
                <a class="xref" href="#OcrSampleDocFields">OcrSampleDocumentField</a>[]
              </td>

              <td class="entry" headers="d710578e118" data-title="Description">The details of the field in a form whose value is extracted and mapped to a
                Salesforce object field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e112" data-title="Field Name"><span class="keyword parmname">ocrSampleDocumentPages</span></td>

              <td class="entry" headers="d710578e115" data-title="Field Type">
                <a class="xref" href="#OcrSampleDocPages">OcrSampleDocumentPage</a>[]
              </td>

              <td class="entry" headers="d710578e118" data-title="Description"><span class="ph" id="ocrsampledocpage"><a name="ocrsampledocpage"><!-- --></a>A collection of fields that define a page in the OCR
                  sample document.</span></td>

            </tr>

          </tbody>

        </table>

## OcrSampleDocumentField

Represents the details of the field in a form whose value is extracted and mapped to a Salesforce object field.

<table class="featureTable sort_table" summary="">
          <caption><span class="tablecap">Table 1. Fields</span></caption>



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d710578e275">Field Name</th>

              <th class="featureTableHeader  " id="d710578e278">Field Type</th>

              <th class="featureTableHeader  " id="d710578e281">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">cellColumnNumber</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">int</td>

              <td class="entry" headers="d710578e281" data-title="Description">The column number in the item with the cell storing this field’s value.
                Available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">cellColumnSpanValue</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">int</td>

              <td class="entry" headers="d710578e281" data-title="Description">The number of columns that span the cell storing this field’s value. Available
                in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">cellRowNumber</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">int</td>

              <td class="entry" headers="d710578e281" data-title="Description">The row number in the item with the cell storing this field’s value. Available
                in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">cellRowSpanValue</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">int</td>

              <td class="entry" headers="d710578e281" data-title="Description">The number of rows that span the cell storing this field’s value. Available in
                API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">fieldLabelMaxX</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">double</td>

              <td class="entry" headers="d710578e281" data-title="Description">A normalized coordinate representing the right edge of the bounding box of the
                key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">fieldLabelMaxY</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">double</td>

              <td class="entry" headers="d710578e281" data-title="Description">A normalized coordinate representing the bottom edge of the bounding box of the
                key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">fieldLabelMinX</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">double</td>

              <td class="entry" headers="d710578e281" data-title="Description">A normalized coordinate representing the left edge of the bounding box of the
                key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">fieldLabelMinY</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">double</td>

              <td class="entry" headers="d710578e281" data-title="Description">A normalized coordinate representing the top edge of the bounding box of the
                key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">fieldValueName</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">string</td>

              <td class="entry" headers="d710578e281" data-title="Description">Name of the referred field value. Available in API version 56.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">isAutoExtractedValue</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">boolean</td>

              <td class="entry" headers="d710578e281" data-title="Description">Indicates whether the key is automatically extracted (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 57.0 and later.
                <p class="p">This field helps to distinguish auto-extracted keys from manual ones.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">keyContent</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">string</td>

              <td class="entry" headers="d710578e281" data-title="Description">The content in a particular area of the form, representing the field that is
                extracted by OCR.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">ocrSampleDocument</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">string</td>

              <td class="entry" headers="d710578e281" data-title="Description">Required. The associated OCR sample document used as a reference while
                extracting and mapping information from a customer form.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">ocrSampleDocumentPage</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type">string</td>

              <td class="entry" headers="d710578e281" data-title="Description">A reference to a page of the OCR sample document that contains the
                key.
                <p class="p">This field is null if the OcrSampleDocument is an abstract document
                  representing the DocumentType.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e275" data-title="Field Name"><span class="keyword parmname">ocrSampleDocumentPageItem</span></td>

              <td class="entry" headers="d710578e278" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ocrtemplate.htm" title="Represents the details of the mapping between a form and a Salesforce object using Intelligent Form Reader. This type extends the Metadata metadata type and inherits its fullName field.">OcrTemplate</a></td>

              <td class="entry" headers="d710578e281" data-title="Description">A reference to the item on the sample document page containing this field's
                value. Available in API version 56.0 and later.</td>

            </tr>

          </tbody>

        </table>

## OcrSampleDocumentPage

Represents a collection of fields that define a page in the OCR sample document. This type exists only if the OcrSampleDocument is a real sample document and not an abstract document representing the DocumentType.

Table 2. Fields
| Field Name | Field Type | Description |
| --- | --- | --- |
| ocrSampleDocument | string | Required. The associated OCR sample document used as a reference while extracting and mapping information from a customer form. |
| ocr​Sample​Document​Page​Items | [OcrSampleDocument](# "Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form. This type extends the Metadata metadata type and inherits its fullName field.") | The collection of page items with the associated OCR sample document page. Available in API version 56.0 and later. |
| pageHeight | double | The normalized height of the OCR sample document page. |
| pageNumber | integer | Required. The page number of the page in the associated OCR sample document. |

## OcrSampleDocumentPageItem

Represents a foreign key reference to the item on the sample document page containing a value for the page item.

<table class="featureTable sort_table" summary="">
          <caption><span class="tablecap">Table 3. Fields</span></caption>



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d710578e626">Field Name</th>

              <th class="featureTableHeader  " id="d710578e629">Field Type</th>

              <th class="featureTableHeader  " id="d710578e632">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d710578e626" data-title="Field Name"><span class="keyword parmname">hasHeader</span></td>

              <td class="entry" headers="d710578e629" data-title="Field Type">boolean</td>

              <td class="entry" headers="d710578e632" data-title="Description">Indicates whether the OCR sample document page item has a header (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e626" data-title="Field Name"><span class="keyword parmname">sequenceNumber</span></td>

              <td class="entry" headers="d710578e629" data-title="Field Type">int</td>

              <td class="entry" headers="d710578e632" data-title="Description">Required. The sequence number of the item on an OCR sample document page with
                multiple items. Available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e626" data-title="Field Name"><span class="keyword parmname">title</span></td>

              <td class="entry" headers="d710578e629" data-title="Field Type">string</td>

              <td class="entry" headers="d710578e632" data-title="Description">The title of the OCR sample document page item. Available in API version 56.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d710578e626" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d710578e629" data-title="Field Type">ItemType (enumeration of type string)</td>

              <td class="entry" headers="d710578e632" data-title="Description">Required. Specifies the type of OCR sample document page item. Available in API
                version 56.0 and later.<p class="p">Valid value is <samp class="codeph nolang">TABLE</samp>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a OcrSampleDocument component.

<?xml version="1.0" encoding="UTF-8"?>
<OcrSampleDocument xmlns="http://soap.sforce.com/2006/04/metadata">
   <contentAsset\>asset\_01jpeg</contentAsset\>
   <documentHeight\>1.24</documentHeight\>
   <documentType\>Form</documentType\>
   <masterLabel\>Form</masterLabel\>
   <ocrSampleDocumentFields\>
   ...<cellColumnNumber\>1</cellColumnNumber\>
      <cellColumnSpanValue\>1</cellColumnSpanValue\>
      <cellRowNumber\>1</cellRowNumber\>
      <cellRowSpanValue\>1</cellRowSpanValue\>
      <fieldLabelMaxX\>0.5975854</fieldLabelMaxX\>
      <fieldLabelMaxY\>0.46625894</fieldLabelMaxY\>
      <fieldLabelMinX\>0.5065626</fieldLabelMinX\>
      <fieldLabelMinY\>0.39605626</fieldLabelMinY\>
      <keyContent\>Last Name</keyContent\>
     <ocrSampleDocument\>image240</ocrSampleDocument\>
     <ocrSampleDocumentPage\>1</ocrSampleDocumentPage\>
     <ocrSampleDocumentPageItem\>
         <hasHeader\>false</hasHeader\>
         <sequenceNumber\>1</sequenceNumber\>
         <title\>Table1</title\>
         <type\>TABLE</type\>
     </ocrSampleDocumentPageItem\>
   </ocrSampleDocumentFields\>
   <ocrSampleDocumentPages\>
      <ocrSampleDocument\>Form</ocrSampleDocument\>
      <pageHeight\>1.0</pageHeight\>
      <pageNumber\>1</pageNumber\>
   </ocrSampleDocumentPages\>
   <ocrSampleDocumentPages\>
      <ocrSampleDocument\>Form</ocrSampleDocument\>
      <pageNumber\>2</pageNumber\>
   </ocrSampleDocumentPages\>
</OcrSampleDocument\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>DocumentType</name\>
   </types\>
   <types\>
      <members\>\*</members\>
      <name\>ContentAsset</name\>
   </types\>
   <types\>
      <members\>\*</members\>
      <name\>OcrSampleDocument</name\>
   </types\>
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=26bb04d66dbeae5140d44d181b7eb7444955eddedb7f2653061192820d7d534c url=/legacydeveloper/current/en-us/api_meta/meta_ocrtemplate.md -->

# OcrTemplate

Represents the details of the mapping between a form and a Salesforce object using Intelligent Form Reader. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

OcrTemplate components have the suffix .ocrTemplate and are stored in the ocrTemplates folder.

## Version

OcrTemplate components are available in API version 52.0 and later.

## Special Access Rules

To use this metadata type, your Salesforce org must have the AWSTextract1000LimitAddOn license.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| active | boolean | Indicates whether the OCR template is active (true) or not (false). |
| description | string | The description of the OCR template. |
| documentType | string | Required. The document type for which this template defines mappings. |
| masterLabel | string | Required. The label for the OCR template. |
| ocrTargetObjects | [OcrTargetObject](#OcrTargettObj)\[\] | Represents the details of the object to which information from a form is extracted and mapped. |
| ocrTemplateSampleDocuments | [OcrTemplateSampleDocument](#OcrTemplateSampleDoc)\[\] | Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form. |
| pageCount | integer | The number of pages in the form from which information is extracted. |
| templateName | string | Required. The name of the OCR template. |

## OcrTargetObject

Represents the details of the object to which information from a form is extracted and mapped.

Table 1. Fields
| Field Name | Field Type | Description |
| --- | --- | --- |
| ocrTargetObjFieldMappings | [OcrTargetObjFieldMapping](#OcrTgtObjFieldMap)\[\] | Represents the details of how information from a form field is mapped to fields in an object. |
| targetObject | string | Required. The object to which information from a form is mapped. |
| targetObjectRecordType | string | The developer name of the record type of the target object. Available in API version 56.0 and later. |

## OcrTargetObjFieldMapping

Represents the details of how information from a form field is mapped to fields in an object.

<table class="featureTable sort_table" summary="">
          <caption><span class="tablecap">Table 2. Fields</span></caption>



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d712885e346">Field Name</th>

              <th class="featureTableHeader  " id="d712885e349">Field Type</th>

              <th class="featureTableHeader  " id="d712885e352">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d712885e346" data-title="Field Name"><span class="keyword parmname">ocrSampleDocField</span></td>

              <td class="entry" headers="d712885e349" data-title="Field Type">
                <a class="xref" href="#OcrSampleDocField">OcrSampleDocumentField</a>[]
              </td>

              <td class="entry" headers="d712885e352" data-title="Description">The details of the field in a form whose value is extracted and mapped to a
                Salesforce object field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e346" data-title="Field Name"><span class="keyword parmname">targetField</span></td>

              <td class="entry" headers="d712885e349" data-title="Field Type">string</td>

              <td class="entry" headers="d712885e352" data-title="Description">Required. The field to which information is mapped.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e346" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d712885e349" data-title="Field Type">OcrMappingType (enumeration of type string)</td>

              <td class="entry" headers="d712885e352" data-title="Description">Required. Specifies the type of mapping. Available in API version 56.0 and
                later.<p class="p">Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FormField</samp></li>

                  <li class="li"><samp class="codeph nolang">TableColumn</samp></li>

                </ul>
                The default value is <samp class="codeph nolang">FormField</samp>.
              </td>

            </tr>

          </tbody>

        </table>

## OcrSampleDocumentField

Represents the details of the field in a form whose value is extracted and mapped to a Salesforce object field.

<table class="featureTable sort_table" summary="">
          <caption><span class="tablecap">Table 3. Fields</span></caption>



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d712885e447">Field Name</th>

              <th class="featureTableHeader  " id="d712885e450">Field Type</th>

              <th class="featureTableHeader  " id="d712885e453">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">cellColumnNumber</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">int</td>

              <td class="entry" headers="d712885e453" data-title="Description">The column number in the item with the cell storing this field’s value.
                Available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">cellColumnSpanValue</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">int</td>

              <td class="entry" headers="d712885e453" data-title="Description">The number of columns that span the cell storing this field’s value. Available
                in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">cellRowNumber</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">int</td>

              <td class="entry" headers="d712885e453" data-title="Description">The row number in the item with the cell storing this field’s value. Available
                in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">cellRowSpanValue</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">int</td>

              <td class="entry" headers="d712885e453" data-title="Description">The number of rows that span the cell storing this field’s value. Available in
                API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">fieldLabelMaxX</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">double</td>

              <td class="entry" headers="d712885e453" data-title="Description">A normalized coordinate representing the right edge of the bounding box of the
                key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">fieldLabelMaxY</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">double</td>

              <td class="entry" headers="d712885e453" data-title="Description">A normalized coordinate representing the bottom edge of the bounding box of the
                key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">fieldLabelMinX</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">double</td>

              <td class="entry" headers="d712885e453" data-title="Description">A normalized coordinate representing the left edge of the bounding box of the
                key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">fieldLabelMinY</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">double</td>

              <td class="entry" headers="d712885e453" data-title="Description">A normalized coordinate representing the top edge of the bounding box of the
                key.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">fieldValueName</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">string</td>

              <td class="entry" headers="d712885e453" data-title="Description">The name of the referred field value. Available in API version 56.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">isAutoExtractedValue</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">boolean</td>

              <td class="entry" headers="d712885e453" data-title="Description">Indicates whether the key is automatically extracted (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 57.0 and later.<p class="p">This field helps to
                  distinguish auto-extracted keys from manual ones.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">keyContent</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">string</td>

              <td class="entry" headers="d712885e453" data-title="Description"> The content in a particular area of the form, representing the field that is
                extracted by OCR.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">ocrSampleDocument</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">string</td>

              <td class="entry" headers="d712885e453" data-title="Description">Required. The associated OCR sample document is used as a reference while
                extracting and mapping information from a customer form.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">ocrSampleDocumentPage</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type">string</td>

              <td class="entry" headers="d712885e453" data-title="Description">A collection of fields that define a page in the OCR sample document.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e447" data-title="Field Name"><span class="keyword parmname">ocrSampleDocumentPageItem</span></td>

              <td class="entry" headers="d712885e450" data-title="Field Type"><a class="xref" href="#" title="Represents the details of the mapping between a form and a Salesforce object using Intelligent Form Reader. This type extends the Metadata metadata type and inherits its fullName field.">OcrSampleDocumentPageItem</a></td>

              <td class="entry" headers="d712885e453" data-title="Description">A reference to the item on the sample document page containing this field's
                value. Available in API version 56.0 and later.</td>

            </tr>

          </tbody>

        </table>

## OcrSampleDocumentPageItem

Represents a foreign key reference to the item on the sample document page containing a value for the page item.

<table class="featureTable sort_table" summary="">
          <caption><span class="tablecap">Table 4. Fields</span></caption>



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d712885e692">Field Name</th>

              <th class="featureTableHeader  " id="d712885e695">Field Type</th>

              <th class="featureTableHeader  " id="d712885e698">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d712885e692" data-title="Field Name"><span class="keyword parmname">hasHeader</span></td>

              <td class="entry" headers="d712885e695" data-title="Field Type">boolean</td>

              <td class="entry" headers="d712885e698" data-title="Description">Indicates whether the OCR sample document page item has a header (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e692" data-title="Field Name"><span class="keyword parmname">sequenceNumber</span></td>

              <td class="entry" headers="d712885e695" data-title="Field Type">int</td>

              <td class="entry" headers="d712885e698" data-title="Description">Required. The sequence number of the item on an OCR sample document page with
                multiple items. Available in API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e692" data-title="Field Name"><span class="keyword parmname">title</span></td>

              <td class="entry" headers="d712885e695" data-title="Field Type">string</td>

              <td class="entry" headers="d712885e698" data-title="Description">The title of the OCR sample document page item. Available in API version 56.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d712885e692" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d712885e695" data-title="Field Type">ItemType (enumeration of type string)</td>

              <td class="entry" headers="d712885e698" data-title="Description">Required. Specifies the type of OCR sample document page item. <p class="p">Valid value
                  is <samp class="codeph nolang">TABLE</samp>.</p>
                Available in API version 56.0
                and later.</td>

            </tr>

          </tbody>

        </table>

## OcrTemplateSampleDocument

Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form.

Table 5. Fields
| Field Name | Field Type | Description |
| --- | --- | --- |
| ocrSampleDocument | string | The associated OCR sample document is used as a reference while extracting and mapping information from a customer form. |

## Declarative Metadata Sample Definition

The following is an example of a OcrTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<OcrTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
   <active\>false</active\>
   <documentType\>Form</documentType\>
   <masterLabel\>Form Test 222</masterLabel\>
   <ocrTargetObjects\>
      <ocrTargetObjFieldMappings\>
         <ocrSampleDocField\>
            <cellColumnNumber\>1</cellColumnNumber\>
            <cellColumnSpanValue\>1</cellColumnSpanValue\>
            <cellRowNumber\>1</cellRowNumber\>
            <cellRowSpanValue\>1</cellRowSpanValue\>
             <fieldLabelMaxX\>0.5975854</fieldLabelMaxX\>
             <fieldLabelMaxY\>0.46625894</fieldLabelMaxY\>
             <fieldLabelMinX\>0.5065626</fieldLabelMinX\>
             <fieldLabelMinY\>0.39605626</fieldLabelMinY\>
             <keyContent\>Last Name</keyContent\>
             <ocrSampleDocument\>image240</ocrSampleDocument\>
             <ocrSampleDocumentPage\>1</ocrSampleDocumentPage\>
             <ocrSampleDocumentPageItem\>
                <hasHeader\>false</hasHeader\>
                <sequenceNumber\>1</sequenceNumber\>
                <title\>Table1</title\>
                <type\>TABLE</type\>
            </ocrSampleDocumentPageItem\>
        </ocrSampleDocField\>
      <targetField\>Account.Name</targetField\>
      <type\>TableColumn</type\>
      </ocrTargetObjFieldMappings\>
      <targetObject\>Account</targetObject\>
      <targetObjectRecordType\>Account.X240</targetObjectRecordType\>
   </ocrTargetObjects\>
   <ocrTemplateSampleDocuments\>
      <ocrSampleDocument\>Form</ocrSampleDocument\>
   </ocrTemplateSampleDocuments\>
   <pageCount\>10</pageCount\>
   <templateName\>Form Test</templateName\>
</OcrTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>OcrTemplate</name\>
   </types\>
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ff080521670cb42c391a4eb3aaa00daa6ac39729194178a0ba46cfabc92961a6 url=/legacydeveloper/current/en-us/api_meta/meta_omnichannelsettings.md -->

# OmniChannelSettings

Represents the Omni-Channel settings for an org.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details.

## File Suffix and Directory Location

OmniChannelSettings values are stored in the OmniChannel.settings file in the settings folder.

## Version

OmniChannelSettings components are available in API version 44.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d715517e103">Field Name</th>

              <th class="featureTableHeader  " id="d715517e106">Field Type</th>

              <th class="featureTableHeader  " id="d715517e109">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniAutoLoginPrompt</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="Description">
                <p class="p">Indicates whether to display a login confirmation upon loading a console with
                  Omni-Channel. The default value is <samp class="codeph java">false</samp>.</p>

                <p class="p">When <samp class="codeph nolang">true</samp>, the console displays a prompt
                  before logging into Omni-Channel when an agent opens another Omni-Channel console
                  in a different tab or window or refreshes the current tab. The agent is logged out
                  of Omni-Channel on other consoles and any ongoing conversations are ended.
                  Available in API version 47.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniChannel</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="Description">Indicates whether Omni-Channel is enabled, giving you access to the objects
                required to set up the feature in your org. The default value is <samp class="codeph java">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniSecondaryRoutingPriority</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="Description">Indicates whether Secondary Routing Priority is enabled in your org. The
                default value is <samp class="codeph java">false</samp>. Available in API version
                47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniSkillsRouting</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="Description">Indicates whether skills-based routing is enabled in your org. The default
                value is <samp class="codeph java">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniStatusCapModel</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="Description">Indicates whether the status based capacity model for rep work is enabled or
                not. The default value is <samp class="codeph java">false</samp>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a OmniChannelSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<OmniChannelSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableOmniChannel\>true</enableOmniChannel\>
    <enableOmniAutoLoginPrompt\>true</enableOmniAutoLoginPrompt\>
    <enableOmniSecondaryRoutingPriority\>true</enableOmniSecondaryRoutingPriority\>
    <enableOmniSkillsRouting\>true</enableOmniSkillsRouting\>
</OmniChannelSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>OmniChannel</members\>
        <name\>Settings</name\>
    </types\>
    <version\>44.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)"). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=a0799e1f76d91133c8610fbe0ea6c639c58840d71d0a5b5463274f5abf9d0210 url=/legacydeveloper/current/en-us/api_meta/meta_omnisupervisorconfig.md -->

# OmniSupervisorConfig

Represents the Omni-Channel supervisor configuration for an assigned group of supervisors.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

OmniSupervisorConfig components have the suffix .omniSupervisorConfig and are stored in the omniSupervisorConfigs folder.

## Version

OmniSupervisorConfig components are available in API version 57.0 and later.

## Special Access Rules

To access this type, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&language=en_US) must be enabled.

## Fields

| Field Name | Description |
| --- | --- |
| isTimelineHidden | 
Field Type

boolean

Description

Required. If set to true, hides the agent timeline from the supervisors assigned to this supervisor configuration. The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. A unique label for the supervisor configuration. The name must begin with a letter and can contain alphanumeric characters and underscores. It can’t contain spaces, two consecutive underscores, or end with an underscore. The name appears as Omni Supervisor Configuration Name in the UI.



 |
| omniSpvsrConfigAIAgent | 

Field Type

[OmniSpvsrConfigAIAgent\[\]](#omniSpvsrConfigAIAgentID)

Description

Represents AI agent bots that are visible to supervisors in this configuration. This field is available in API version 64.0 and later.



 |
| omniSupervisorConfigAction | 

Field Type

[OmniSupervisorConfigAction\[\]](#omniSupervisorConfigActionID)

Description

Represents the actions available to the supervisors of this Omni-Channel supervisor configuration.



 |
| omniSupervisorConfigGroup | 

Field Type

[OmniSupervisorConfigGroup\[\]](#omniSupervisorConfigGroupID)

Description

Represents the group of agents who are visible to the supervisors of an Omni-Channel supervisor configuration. The group, if visible, appears in the Agents tab of Omni Supervisor.



 |
| omniSupervisorConfigProfile | 

Field Type

[OmniSupervisorConfigProfile\[\]](#omniSupervisorConfigProfileID)

Description

Represents the supervisor profiles to which an Omni-Channel supervisor configuration applies. User-level configurations override profile-level configurations.



 |
| omniSupervisorConfigQueue | 

Field Type

[OmniSupervisorConfigQueue\[\]](#omniSupervisorConfigQueueID)

Description

Represents the queues that are visible to the supervisors of an Omni-Channel supervisor configuration. The queue, if visible, appears in the Queues Backlog and Assigned Work tabs of Omni Supervisor.



 |
| omniSupervisorConfigSkill | 

Field Type

[OmniSupervisorConfigSkill\[\]](#omniSupervisorConfigSkillID)

Description

Represents the skills that are visible to the supervisors of an Omni-Channel supervisor configuration. These skills, if visible, appear in the Skills Backlog tab of Omni Supervisor.



 |
| omniSupervisorConfigTab | 

Field Type

[OmniSupervisorConfigTab\[\]](#omniSupervisorConfigTabID)

Description

Represents the visible tabs specified in an Omni Supervisor configuration. This object is available in API version 60.0 and later.



 |
| omniSupervisorConfigUser | 

Field Type

[OmniSupervisorConfigUser\[\]](#section_ocv_424_1fc)

Description

Represents the supervisor to which the Omni-Channel supervisor configuration applies. User-level configurations override profile-level configurations. This object is available in API version 64.0 and later.



 |
| skillVisibility | 

Field Type

OmniSuperSkillVisibilityType (enumeration of type string)

Description

Determines which work items based on skills are visible to the supervisors assigned to this supervisor configuration. Values are:

- AllSkills
- AnySkill





 |

## OmniSpvsrConfigAIAgent

Represents AI agent bot definitions that are visible to supervisors in this configuration. This object is available in API version 64.0 and later.

| Field Name | Description |
| --- | --- |
| botDefinition | 
Field Type

string

Description

Required. The name of the bot definition that is visible to supervisors in this configuration.



 |

## OmniSupervisorConfigAction

Represents an action and associated tab, custom flow, and display order for supervisor actions in this configuration.

| Field Name | Description |
| --- | --- |
| actionName | 
Field Type

OmniSupervisorActionName (enumeration of type string)

Description

Required. An action that a supervisor can perform. Values are:

- AWSDashboard
- AssignLearning
- ChangeGroups
- ChangeQueues
- ChangeSkills
- CustomAction
- ManageQueues





 |
| actionTab | 

Field Type

OmniSupervisorActionTab (enumeration of type string)

Description

Required. The tab where the action appears. Values are:

- AgentDetails
- AllAgents
- AssignedWork
- AssignedWorkDetails
- QueueDetails
- QueuesBacklog
- SkillDetails
- SkillsBacklog





 |
| customActionFlow | 

Field Type

string

Description

A flow that performs a custom action.



 |
| displayOrder | 

Field Type

int

Description

Required. The order in which the action is displayed.





 |

## OmniSupervisorConfigGroup

Represents the group of agents for the supervisors in this configuration.

| Field Name | Description |
| --- | --- |
| group | 
Field Type

string

Description

Required. The name of the group of agents.



 |

## OmniSupervisorConfigProfile

Represents a profile for the supervisors in this configuration.

| Field Name | Description |
| --- | --- |
| profile | 
Field Type

string

Description

Required. The profile name.



 |

## OmniSupervisorConfigQueue

Represents a queue that’s visible to the supervisors in this configuration.

| Field Name | Description |
| --- | --- |
| queue | 
Field Type

string

Description

Required. The queue name.



 |

## OmniSupervisorConfigSkill

Represents a skill that’s visible to supervisors in this configuration.

| Field Name | Description |
| --- | --- |
| skill | 
Field Type

string

Description

Required. The skill name.



 |

## OmniSupervisorConfigTab

Represents the visible tabs specified in an Omni Supervisor configuration. This object is available in API version 60.0 and later.

| Field | Details |
| --- | --- |
| displayOrder | 
Type

int

Properties

Create, Filter, Group, Nillable, Sort

Description

The order in which tabs are displayed in Omni Supervisor.



 |
| flexipage | 

Type

string

Description

The name of the [FlexiPage](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_flexipage.htm "html (New Window)") added as a customized tab. Required when tabTypeis set to FlexipageType.



 |
| tabType | 

Type

OmniSupervisorTabType (enumeration of type string)

Properties

Create, Filter, Group, Nillable, Restricted picklist, Sort

Description

Required. Tabs shown on the Omni Supervisor page. Possible values are:

- Agents — the Agents tab
- AssignedWork — the Assigned Work tab
- FlexipageType — A custom tab created using Lightning App Builder, with the omniSupervisorPageType value of the FlexiPage Type field
- QueuesBacklog — the Queues Backlog tab
- SkillsBacklog — the Skills Backlog tab
- Wallboard — the Wallboard tab





 |

## OmniSupervisorConfigUser

Represents the supervisor to which the Omni-Channel supervisor configuration applies. User-level configurations override profile-level configurations. This object is available in API version 64.0 and later.

| Field | Details |
| --- | --- |
| user | 
Type

string

Description

Required. Represents the supervisor to which the Omni-Channel supervisor configuration applies.



 |

## Declarative Metadata Sample Definition

The following is an example of a OmniSupervisorConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<OmniSupervisorConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <isTimelineHidden>true</isTimelineHidden>
    <masterLabel>Supervisor Config</masterLabel>
    <skillVisibility>AllSkills</skillVisibility>
    <omniSupervisorConfigAction>
        <actionName>ChangeQueues</actionName>
        <actionTab>AllAgents</actionTab>
        <displayOrder>0</displayOrder>
    </omniSupervisorConfigAction>
    <omniSupervisorConfigGroup>
        <group>Agent\_Group</group>
    </omniSupervisorConfigGroup>
    <omniSupervisorConfigProfile>
        <profile>contractmanager</profile>
    </omniSupervisorConfigProfile>
    <omniSupervisorConfigQueue>
        <queue>CaseQueue</queue>
    </omniSupervisorConfigQueue>
    <omniSupervisorConfigSkill>
        <skill>English</skill>
    </omniSupervisorConfigSkill>
</OmniSupervisorConfig>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>OmniSupervisorConfig</name>
    </types>
    <version>57.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a7e9ee94156c40636b14c04753e6779de9628fd4911b7183c7113ef354a41f17 url=/legacydeveloper/current/en-us/api_meta/meta_onboardingdataobjectgroup.md -->

# OnboardingDataObjectGroup

Represents a configuration that groups fields from one or more objects for a specific business purpose. For example, the Customer Contact Information onboarding data object group includes Name, Email, Phone Number, and Address.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

OnboardingDataObjectGroup components have the suffix .onboardingDataObjectGroup and are stored in the onboardingDataObjectGroups folder.

## Version

OnboardingDataObjectGroup components are available in API version 66.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Description of the onboarding data object group.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for OnboardingDataObjectGroup, which is defined when the OnboardingDataObjectGroup is created.





 |
| usageType | 

Field Type

OnboardingDataObjGrpUsageType (enumeration of type string)

Description

Required. Specifies the purpose of the onboarding data object group. Valid values are:

- DocumentValidation
- ValidityPeriod





 |
| versionDetail | 

Field Type

[OnboardingDataObjGrpVer\[\]](#OnboardingDataObjGrpVer)

Description

Versions of the onboarding data object group, which define the computation settings and related data objects.



 |

## OnboardingDataObjGrpVer

Represents a version of an onboarding data object group, containing computation settings and the related data objects.

| Field Name | Description |
| --- | --- |
| computationSource | 
string

Description

Unique name of the component that contains the computation logic to determine the group's validity, such as a Flow ID or ExpressionSet ID.



 |
| computationType | 

Field Type

OnboardingDataObjGrpCompType (enumeration of type string)

Description

Specifies the type of computation that's used for validity calculations of the onboarding data object group version. Valid values are:

- Formula
- StandardMinimumValidity





 |
| objectDetail | 

Field Type

[OnboardingDataObject\[\]](#onboardingdataobject)

Description

Details of the data objects within this version.



 |
| onbrdDataObjGrpDocCatgMap | 

Field Type

[OnbrdDataObjGrpDocCatgMap\[\]](#OnbrdDataObjGrpDocCatgMap)

Description

Junction object that maps onboarding data category version, document type, and document category.



 |
| status | 

Field Type

OnboardingDataObjVerGrpStatus (enumeration of type string)

Description

Required. Status of the onboarding data object group version. Valid values are:

- Active
- Inactive





 |

## OnbrdDataObjGrpDocCatgMap

Represents a configuration that maps a document type and a document category to a specific onboarding data object group version.

| Field Name | Description |
| --- | --- |
| documentCategory | 
Field Type

[DocumentCategory\[\]](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_documentcategory.htm "HTML (New Window)")

Description

Required. Category that's used to group the document checklist items.



 |
| documentType | 

Field Type

[DocumentType\[\]](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_documenttype.htm "HTML (New Window)")

Description

Type of file that's uploaded or attached in the document checklist item.



 |

## OnboardingDataObject

Represents a data object within an onboarding data object group, specifying the target object and its field configurations. For example, Party Profile and Party Profile Address are objects within the Customer Information onboarding object data group.

| Field Name | Description |
| --- | --- |
| businessContext | 
Field Type

OnboardingDataObjBusContext (enumeration of type string)

Description

Required. Specifies the business context or scenario in which this validity configuration is applicable. Valid values are:

- KYC\_VALIDITY
- DVC





 |
| fieldDetail | 

Field Type

[OnboardingDataObjectField\[\]](#onboardingdataobjectfield)

Description

Details of the fields within the data object.



 |
| name | 

Field Type

OnboardingDataObjGrpTgtObject (enumeration of type string)

Description

Required. Target sObject type for this data object. Valid values are:

- Account
- Applicant
- ApplicationForm
- ApplicationFormProduct
- ApplicationFormSellerItem
- Contact
- IdentityDocument
- Opportunity
- PartyCreditProfile
- PartyExpense
- PartyFinancialAsset
- PartyFinancialAssetLien
- PartyFinancialLiability
- PartyFinclAssetAddlOwner
- PartyFinclLiabAddlBrwr
- PartyIdentityVerification
- PartyIdentityVerificationStep
- PartyIncome
- PartyProfile
- PartyProfileAddress
- PartyProfileRisk
- PartyScreeningSummary
- PersonEmployment





 |
| partyProfileDataObjectValidityDefinition | 

Field Type

string

Description

Reference to the [PartyProfileDataObjectValidityDefinition](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_partyprofiledataobjectvaliditydefinition.htm "HTML (New Window)") metadata type that defines validity settings for this data object.



 |
| pathToRoot | 

Field Type

string

Description

Relationship of the path from this data object to the root object in the hierarchy.



 |
| relatedObjectRole | 

Field Type

RelatedOnboardingDataObjRole (enumeration of type string)

Description

Specifies the type of relationship between this record and related onboarding data object record. Valid values are Parent and Child.



 |
| relatedOnboardingDataObjRecord | 

Field Type

string

Description

Reference to a related onboarding data object record.



 |
| targetObjectRelationshipField | 

Field Type

string

Description

API name of the target object's field that links this record to the related onboarding data object record.



 |

## OnboardingDataObjectField

Represents a field within an onboarding data object group. For example, Email Address of Party Profile is a field in the Customer Information group.

| Field Name | Description |
| --- | --- |
| name | 
string

Description

Required. API name of the field on the target object.



 |

## Declarative Metadata Sample Definition

The following is an example of an OnboardingDataObjectGroup component where usageType is ValidityPeriod.

<?xml version="1.0" encoding="UTF-8"?>
<OnboardingDataObjectGroup xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>description text</description\>
    <masterLabel\>Field Group Valid Configuration</masterLabel\>
    <usageType\>ValidityPeriod</usageType\>
    <versionDetail\>
        <computationType\>StandardMinimumValidity</computationType\>
        <objectDetail\>
            <businessContext\>KYC\_VALIDITY</businessContext\>
            <fieldDetail\>
                <name\>Status</name\>
            </fieldDetail\>
            <name\>PartyFinancialAssetLien</name\>
            <pathToRoot\>PartyFinancialAsset.PartyProfile.Id</pathToRoot\>
            <relatedObjectRole\>Parent</relatedObjectRole\>
            <targetObjectRelationshipField\>PartyFinancialAsset</targetObjectRelationshipField\>
        </objectDetail\>
        <objectDetail\>
            <businessContext\>KYC\_VALIDITY</businessContext\>
            <fieldDetail\>
                <name\>ValuationAmount</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>VerificationStatus</name\>
            </fieldDetail\>
            <name\>PartyFinancialAsset</name\>
            <pathToRoot\>PartyProfile.Id</pathToRoot\>
            <relatedObjectRole\>Parent</relatedObjectRole\>
            <targetObjectRelationshipField\>PartyProfile</targetObjectRelationshipField\>
        </objectDetail\>
        <objectDetail\>
            <businessContext\>KYC\_VALIDITY</businessContext\>
            <fieldDetail\>
                <name\>IncomeAmount</name\>
            </fieldDetail\>
            <name\>PartyIncome</name\>
            <pathToRoot\>Party.Id</pathToRoot\>
            <relatedObjectRole\>Parent</relatedObjectRole\>
            <targetObjectRelationshipField\>Party</targetObjectRelationshipField\>
        </objectDetail\>
        <objectDetail\>
            <businessContext\>KYC\_VALIDITY</businessContext\>
            <fieldDetail\>
                <name\>CreditScore</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>EmploymentType</name\>
            </fieldDetail\>
            <name\>PartyProfile</name\>
            <pathToRoot\>Id</pathToRoot\>
        </objectDetail\>
        <status\>Inactive</status\>
    </versionDetail\>
</OnboardingDataObjectGroup\>

This is an example of an OnboardingDataObjectGroup component where usageType is DocumentValidation.

<?xml version="1.0" encoding="UTF-8"?>
<OnboardingDataObjectGroup xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>description text</description\>
     <masterLabel\>Application Form DVC Orig</masterLabel\>
    <usageType\>DocumentValidation</usageType\>
    <versionDetail\>
        <objectDetail\>
            <businessContext\>DVC</businessContext\>
            <fieldDetail\>
                <name\>BureauReportedFirstName</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>Name</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>Id</name\>
            </fieldDetail\>
            <name\>PartyCreditProfile</name\>
            <pathToRoot\>ReferenceObject.ApplicationForm.Id</pathToRoot\>
            <relatedObjectRole\>Parent</relatedObjectRole\>
            <targetObjectRelationshipField\>ReferenceObject</targetObjectRelationshipField\>
        </objectDetail\>
        <objectDetail\>
            <businessContext\>DVC</businessContext\>
            <fieldDetail\>
                <name\>ApplicantId</name\>
            </fieldDetail\>
            <name\>PartyFinancialAsset</name\>
            <pathToRoot\>Applicant.ApplicationForm.Id</pathToRoot\>
            <relatedObjectRole\>Parent</relatedObjectRole\>
            <targetObjectRelationshipField\>Applicant</targetObjectRelationshipField\>
        </objectDetail\>
        <objectDetail\>
            <businessContext\>DVC</businessContext\>
            <fieldDetail\>
                <name\>Name</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>ProductId</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>RequestedAmount</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>RequestedMonthlyPayment</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>RequestedTerm</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>Stage</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>SystemModstamp</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>TotalBrandOwnedItemAmt</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>TotalVendorOwnedItemAmt</name\>
            </fieldDetail\>
            <name\>ApplicationFormProduct</name\>
            <pathToRoot\>ApplicationForm.Id</pathToRoot\>
            <relatedObjectRole\>Parent</relatedObjectRole\>
            <targetObjectRelationshipField\>ApplicationForm</targetObjectRelationshipField\>
        </objectDetail\>
        <objectDetail\>
            <businessContext\>DVC</businessContext\>
            <fieldDetail\>
                <name\>Name</name\>
            </fieldDetail\>
            <name\>ApplicationForm</name\>
            <pathToRoot\>Id</pathToRoot\>
        </objectDetail\>
        <objectDetail\>
            <businessContext\>DVC</businessContext\>
            <fieldDetail\>
                <name\>FirstName</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>LastName</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>Name</name\>
            </fieldDetail\>
            <name\>Applicant</name\>
            <pathToRoot\>ApplicationForm.Id</pathToRoot\>
            <relatedObjectRole\>Parent</relatedObjectRole\>
            <targetObjectRelationshipField\>ApplicationForm</targetObjectRelationshipField\>
        </objectDetail\>
        <objectDetail\>
            <businessContext\>DVC</businessContext\>
            <fieldDetail\>
                <name\>AccountId</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>ApplicantId</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>ApplicationFormId</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>InterestRate</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>LastReferencedDate</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>LastViewedDate</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>Lender</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>Name</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>ShareType</name\>
            </fieldDetail\>
            <fieldDetail\>
                <name\>SourceSystemIdentifier</name\>
            </fieldDetail\>
            <name\>PartyFinancialLiability</name\>
            <pathToRoot\>ApplicationForm.Id</pathToRoot\>
            <relatedObjectRole\>Parent</relatedObjectRole\>
            <targetObjectRelationshipField\>ApplicationForm</targetObjectRelationshipField\>
        </objectDetail\>
        <onbrdDataObjGrpDocCatgMap\>
            <documentCategory\>Id\_Proof</documentCategory\>
            <documentType\>Aadhaar</documentType\>
        </onbrdDataObjGrpDocCatgMap\>
        <onbrdDataObjGrpDocCatgMap\>
            <documentCategory\>Address\_Proof</documentCategory\>
            <documentType\>Passport</documentType\>
        </onbrdDataObjGrpDocCatgMap\>
        <onbrdDataObjGrpDocCatgMap\>
            <documentCategory\>Id\_Proof</documentCategory\>
            <documentType\>Passport</documentType\>
        </onbrdDataObjGrpDocCatgMap\>
        <onbrdDataObjGrpDocCatgMap\>
            <documentCategory\>Id\_Proof</documentCategory\>
            <documentType\>Pan\_Card</documentType\>
        </onbrdDataObjGrpDocCatgMap\>
        <status\>Inactive</status\>
    </versionDetail\>
</OnboardingDataObjectGroup\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>OnboardingDataObjectGroup</name\>
    </types\>
    <version\>66.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=1926cf6f659b42bc62b20c5478866e585ed754b0b68626b94abf27c2dddc3655 url=/legacydeveloper/current/en-us/api_meta/meta_opportunityinsightssettings.md -->

# OpportunityInsightsSettings

Represents an org’s Einstein Opportunity Insights settings. This setting controls features that give you relevant updates about your opportunities.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This metadata type has been deprecated as of API version 59.0.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

OpportunityInsightsSettings values are stored in the OpportunityInsights.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

OpportunityInsightsSettings is available in API versions 48.0 to 58.0.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableOpportunityInsights | boolean | Indicates whether Einstein Opportunity Insights is enabled (true) or not (false). The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of the OpportunityInsights.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<OpportunityInsightsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableOpportunityInsights\>true</enableOpportunityInsights\>
</OpportunityInsightsSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the OpportunityInsights settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>OpportunityInsights</members\>
		<name\>Settings</name\>
	</types\>
	<version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=4e6f1af403ae5e9d4ad17cf5dc770fadd1b981b876d591f8a949eadd059ec155 url=/legacydeveloper/current/en-us/api_meta/meta_opportunityscoresettings.md -->

# OpportunityScoreSettings

Represents an org’s Einstein Opportunity Scoring settings, such as whether or not Einstein Opportunity Scoring is enabled. Einstein Opportunity Scoring helps determine the likelihood of an opportunity being won. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

OpportunityScoreSettings values are stored in the OpportunityScore.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

OpportunityScoreSettings is available in API versions 49.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableOpportunityScoring | boolean | Indicates whether Einstein Opportunity Scoring is enabled (true) or not (false). The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of the OpportunityScore.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<OpportunityScoreSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableOpportunityScoring\>true</enableOpportunityScoring\>
</OpportunityScoreSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the OpportunityScore settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>OpportunityScore</members\>
		<name\>Settings</name\>
	</types\>
	<version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=70be535a3a4fbdd7e07a9fe67c41c25949e9138586f7827277ca579a27e1e56c url=/legacydeveloper/current/en-us/api_meta/meta_opportunityssettings.md -->

# OpportunitySettings

Represents org preferences for features such as automatic opportunity updates and similar-opportunity filters.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

Use opportunity settings to control the actions that users can perform on their opportunities.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

Opportunities values are stored in a single file named Opportunity.settings in the settings directory of the corresponding package directory.

## Version

OpportunitySettings is available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d721353e114">Field Name</th>

              <th class="featureTableHeader  " id="d721353e117">Field Type</th>

              <th class="featureTableHeader  " id="d721353e120">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">autoActivateNewReminders</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Automatically uses scheduled updates for new
                opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">customizableProductSchedulesEnabled</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets Salesforce admins customize product schedules by using
                custom fields, validation rules, and Apex
                triggers on the LineItemSchedule object. This field is available in
                API version 46.0 and later. <p class="p">If customizable product schedules are
                  enabled, you can use custom fields in default schedules and
                  customize their layout, but Apex triggers or validation rules
                  that you apply to default schedules are bypassed.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">doesEnforceStandardOpportunitySaveLogic</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Enforces standard validation and triggers for opportunity
                products and opportunity product schedules. Default value is <samp class="codeph nolang">true</samp>. Can't be set to <samp class="codeph nolang">false</samp>. <p class="p">Available in API version
                  47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableExpandedPipelineInspectionSetup</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type"></td>

              <td class="entry" headers="d721353e120" data-title="Description">Displays a Pipeline Inspection setup page to Salesforce admins
                with all setup steps for enabling and configuring the feature. The
                set up also includes historical trending. The default value is
                false.<p class="p">Available in API version 52.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableFindSimilarOpportunities</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users see related or similar existing opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableForecastCategoryMetrics</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users see single and cumulative forecast category rollups
                over a selected period. Applies to the following categories: Best
                Case, Closed Lost, Closed Won, Commit, Most Likely, Open Pipeline,
                and Total. <p class="p">Default value is <samp class="codeph nolang">true</samp>. Available in API version 57.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableOpportunityFieldHistoryTracking</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Enables history tracking for the opportunity field. For more
                information, see “Field History Tracking” in Salesforce Help.
                Default value is <samp class="codeph nolang">true</samp>.
                <p class="p">Available in API version 47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableOpportunityInsightsInMobile</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Deprecated in API version 59.0 and later because the feature is
                no longer available. Indicates whether a user can see Einstein
                Opportunity Insights on their mobile device <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Einstein Opportunity
                Insights includes predictions about which deals are likely to be
                won, reminders to follow up, and notifications when key moments in a
                deal take place. <p class="p">Available in API version 47.0 to
                  58.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableOpportunityTeam</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users associate team members with opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enablePipelineChangesMetrics</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users see net change to the pipeline (positive or negative)
                contributed by each deal within a selected timeframe. Applies to the
                following categories: Open Pipeline, New, Won, Increased, Moved In,
                Moved Out, Decreased, Lost, and Overdue. <p class="p">Default value is <samp class="codeph nolang">true</samp>. Available in API version
                  57.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enablePipelineInspection</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Enables the Pipeline Inspection feature in the Opportunity tab.
                Also enables historical trending for opportunities, if the org has
                the historical trending org perm. Pipeline Inspection is a
                consolidated view of pipeline metrics, corresponding opportunities,
                and highlights of recent opportunity changes and insights. The
                default value is false.<p class="p">Also enables historical trending for
                  opportunities, if historical trending isn’t already enabled. To
                  use Pipeline Inspection, additional configuration in Setup is
                  required.</p>
                <p class="p">Available in API version 52.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enablePipelineInspectionFlow</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Enables the Pipeline Inspection Flow Chart in the Opportunity
                tab. This chart shows Pipeline Inspection users the changes to
                opportunities in different forecast categories over time. Users can
                filter results to see the data that’s most useful to them.<p class="p">To use
                  this feature, access to Revenue Insights is
                  required.</p>
                <p class="p">Available in API version 54.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enablePipelineInspectionSingleCategoryRollup</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates that Pipeline Inspection metrics display as single
                forecast categories <samp class="codeph nolang">(true)</samp>, or
                multiple categories rolled up <samp class="codeph nolang">(false)</samp>. The default value is <samp class="codeph nolang">(false)</samp>.<p class="p">To use this feature,
                  Pipeline Inspection configuration in Setup is
                  required.</p>
                <p class="p">Available in API version 55.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableRevenueInsights</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Sets up Revenue Insights dashboards and installs the related CRM
                Analytics app. The dashboards give users access to sales
                performance, pipeline, and forecasting reports and
                analytics.<p class="p">Revenue Insights is part of Revenue Intelligence,
                  which is available for an additional cost.</p>
                <p class="p">Available in
                  API version 54.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableServiceCaseInsights</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether insights based on service cases are enabled
                <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp> in Pipeline Inspection. The
                default value is <samp class="codeph nolang">(false)</samp>.<p class="p">Available in API version 55.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableUpdateReminders</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users enable automatic, scheduled updates on
                opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">findSimilarOppFilter</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type"><a class="xref" href="#FindSimilarOppFilter">FindSimilarOppFilter</a></td>

              <td class="entry" headers="d721353e120" data-title="Description">Defines parameters for similar opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">oppAmountDealMotionEnabled</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether deal change highlights are enabled for
                opportunity amounts <samp class="codeph nolang">(true)</samp> or
                not <samp class="codeph nolang">(false)</samp>. The default value
                is <samp class="codeph nolang">(true)</samp>.<p class="p">Available in API
                  version 50.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">oppCloseDateDealMotionEnabled</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether deal change highlights are enabled for
                opportunity close dates <samp class="codeph nolang">(true)</samp>
                or not <samp class="codeph nolang">(false)</samp>. The default
                value is <samp class="codeph nolang">(true)</samp>.<p class="p">Available in
                  API version 50.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">promptToAddProducts</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Prompts users to add related products to an opportunity.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">pushCountEnabled</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether the Push Count field is visible to users in
                opportunity list views and Pipeline Inspection views <samp class="codeph nolang">(true)</samp> or not (<samp class="codeph nolang">false</samp>). The default value is
                (<samp class="codeph nolang">true</samp>).<p class="p">Available in API
                  version 56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">simpleOppCreateFromContact</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether you can create an opportunity with prefilled
                information (such as the contact’s account) from the Global Actions
                menu while viewing a contact <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Available in API version 54.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">simpleOppCreateFromEvent</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether you can create an opportunity with prefilled
                information (such as the event’s account) from the Global Actions
                menu while viewing an event <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Available in API version 54.0 and
                later.</td>

            </tr>

          </tbody>

        </table>

## FindSimilarOppFilter

Defines whether to match by entire columns or fields.

| Field | Field Type | Description |
| --- | --- | --- |
| similarOpportunitiesDisplayColumns | string | The columns to compare. |
| similarOpportunitiesMatchFields | string | The fields to compare. |

## Declarative Metadata Sample Definition

The following is an example of the package file.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Opportunity</members\>
        <name\>Settings</name\>
    </types\>
    <version\>28.0</version\>
</Package\>

The package file references the following Opportunity.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<OpportunitySettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <autoActivateNewReminders\>true</autoActivateNewReminders\>
  <customizableProductSchedulesEnabled\>false</customizableProductSchedulesEnabled\>
  <doesEnforceStandardOpportunitySaveLogic\>true</doesEnforceStandardOpportunitySaveLogic\>
  <enableFindSimilarOpportunities\>true</enableFindSimilarOpportunities\>
  <enableForecastCategoryMetrics\>true</enableForecastCategoryMetrics\>
  <enablePipelineChangesMetrics\>true</enablePipelineChangesMetrics\>
  <findSimilarOppFilter\>
    <similarOpportunitiesMatchFields\>OPPORTUNITY.Account</similarOpportunitiesMatchFields\>
    <similarOpportunitiesMatchFields\>OPPORTUNITY.OpportunityCompetitors</similarOpportunitiesMatchFields\>
    <similarOpportunitiesMatchFields\>CustomField\_\_c</similarOpportunitiesMatchFields\>
    <similarOpportunitiesDisplayColumns\>CustomField\_\_c</similarOpportunitiesDisplayColumns\>
  </findSimilarOppFilter\>
  <enableOpportunityFieldHistoryTracking\>true</enableOpportunityFieldHistoryTracking\>
  <enableOpportunityInsightsInMobile\>false</enableOpportunityInsightsInMobile\>
  <enableOpportunityTeam\>true</enableOpportunityTeam\>
  <enableUpdateReminders\>true</enableUpdateReminders\>
  <promptToAddProducts\>true</promptToAddProducts\>
..<oppAmountDealMotionEnabled\>true</oppAmountDealMotionEnabled\>
..<oppCloseDateDealMotionEnabled\>true</oppCloseDateDealMotionEnabled\>
</OpportunitySettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=045ec3459c7e132d35f4562340f3e77b9a2ea5e4e8067b53f1f4367c77e8bbf5 url=/legacydeveloper/current/en-us/api_meta/meta_orchestrationplanctxmapping.md -->

# OrchestrationPlanCtxMapping

Represents the context mapping that Dynamic Revenue Orchestrator (DRO) uses to generate and orchestrate a plan for an object, such as a non-sales transaction for billing or another generic business process.

## Parent Type

[Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") fullName

## File Suffix and Directory Location

OrchestrationPlanCtxMapping components have the suffix .orchestrationPlanCtxMapping and are stored in the orchestrationPlanCtxMappings folder.

## Version

OrchestrationPlanCtxMapping components are available in API version 67.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| context​Definition | string | Required. [ContextDefinition](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_contextdefinition.htm) that the orchestration use case is based on. |
| contextItem​Node | string | Name of the item-level node in the context definition. The item node represents the line items or child records of the root node, such as the items in an order. |
| contextMapping | string | Required. Name of the context mapping that maps the source object fields to the nodes in the context definition. |
| context​RootNode | string | Required. Name of the root node in the context definition. The root node represents the parent record that the orchestration plan is generated for, such as an order. |
| label | string | Required. UI label for the orchestration plan context mapping. |
| objectName | string | Required. API name of the object that the orchestration plan is generated for. The combination of objectName and orchestrationType must be unique. |
| orchestration​Type | PlanUsageType (enumeration of type string) | Required. Type of orchestration plan that this context mapping applies to. Valid values are Billing, Fulfillment, Generic, IntegrationOrchestrator, InsuranceRuleAction, OrderFulfillment, or StageManagement. |

## Declarative Metadata Sample Definition

This sample shows the definition of an OrchestrationPlanCtxMapping component for a fulfillment plan that orchestrates an order.

<?xml version="1.0" encoding="UTF-8"?>
<OrchestrationPlanCtxMapping xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>Order Fulfillment Context Mapping</label\>
    <orchestrationType\>Fulfillment</orchestrationType\>
    <contextDefinition\>SalesTransactionContext\_\_stdctx</contextDefinition\>
    <objectName\>Order</objectName\>
    <contextMapping\>OrderEntitiesMapping</contextMapping\>
    <contextRootNode\>SalesTransaction</contextRootNode\>
    <contextItemNode\>SalesTransactionItem</contextItemNode\>
</OrchestrationPlanCtxMapping\>

This sample package.xml references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>OrchestrationPlanCtxMapping</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based.htm "HTML (New Window)").

<!-- document id=da776c35883f3bef146110189fa2e3a7562c53b2b4e0ed30421e86b9d018f7e5 url=/legacydeveloper/current/en-us/api_meta/meta_ordermanagementsettings.md -->

# OrderManagementSettings

Represents options for the Salesforce Order Management product. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

OrderManagementSettings values are stored in the OrderManagement.settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

## Version

Order Management settings are available in API version 48 and later.

## Special Access Rules

This metadata type is only accessible by developers and customers using Salesforce Order Management.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| deliveryEstimationEnabled | boolean | Specifies whether delivery estimation is active (true) or not (false). The default value is false. Available in API version 62.0 and later. |
| enableB2CIntegration | boolean | Indicates whether Order Management is allowed to accept order data from B2C Commerce (true) or not (false). The default value is false. |
| enableDuplicateManagement | boolean | Indicates whether the Order Management B2C Commerce Integration applies the Salesforce org’s duplicate and matching rules for Accounts, Contacts, and Person Accounts to shopper records (true) or not (false). The default value is false. The Setup toggle label is **B2C Integration Data Matching Rules**. Available in API version 53.0 and later. |
| enableHighScaleOrders | boolean | Indicates whether the Order Management B2C Commerce Integration uses the High Scale Orders feature (true) or the original order ingestion system (false). The default value is false. Available in API version 56.0 and later. |
| enableOrderManagement | boolean | Indicates whether Order Management features are enabled (true) or not (false). The default value is false. |
| enablePersonAccountsForShoppers | boolean | Indicates whether Order Management represents each shopper with a Person Account (true) or a normal Account and a Contact (false). The default value is false. Available in API version 49.0 and later. |

## Declarative Metadata Sample Definition

The following is an example of an OrderManagementSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<OrderManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <enableOrderManagement\>true</enableOrderManagement\>
    <deliveryEstimationEnabled\>false</deliveryEstimationEnabled\>
    <enableB2CIntegration\>true</enableB2CIntegration\>
    <enableDuplicateManagement\>true</enableB2CIntegration\>
    <enableHighScaleOrders\>false</enableB2CSelfService\>
    <enablePersonAccountsForShoppers\>true</enablePersonAccountsForShoppers\>
    </OrderManagementSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>OrderManagement</members\>
        <name\>Settings</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=5e84e9abc035d49aad94cef31b52eb6d82664ad859dad38707a72ca2806c5801 url=/legacydeveloper/current/en-us/api_meta/meta_ordersettings.md -->

# OrderSettings

Represents order settings.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

There is one OrderSettings component in a file named Order.settings in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

OrderSettings components are available in API version 30.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d724146e111">Field Name</th>

              <th class="featureTableHeader  " id="d724146e114">Field Type</th>

              <th class="featureTableHeader  " id="d724146e117">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableEnhancedCommerceOrders</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether enhanced commerce orders are enabled for the
                org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This preference is
                available only in orgs with the Salesforce Order Management license.
                Default value is <samp class="codeph nolang">false.</samp>
                Available in API versions 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableNegativeQuantity</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether users in the org can add order products with
                quantities of less than zero (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">To enable this preference,
                  <span class="keyword parmname">enableOrders</span> must be set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableOptionalPricebook</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether users in the org can create orders without
                price books (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). For more
                information, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=sales.customize_order_enable_without_pricebooks.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Enable
                  Orders Without Price Books</a> in Salesforce Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableOrderEvents</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether order events are enabled for the org (<samp class="codeph nolang">true</samp>) or not <samp class="codeph nolang">(false)</samp>. For more information, see
                OrderStatusChangedEvent in the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_intro.htm" target="_blank" title="HTML (New Window)">Platform
                  Events Developer Guide</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableOrders</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether orders are enabled for the org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>


            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableOrderWithMultiplePriceBooks</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether users in the org can create orders containing
                order items that refer to multiple price books (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version
                60.0 and later.<p class="p">To enable this preference,
                  <span class="keyword parmname">enableOrders</span> and
                  <span class="keyword parmname">enableEnhancedCommerceOrders</span> must be
                  set to <samp class="codeph nolang">true</samp>.
                </p>
                <p class="p">This
                  field helps to offer different pricing structures for various
                  customer segments, regions, or promotional periods.</p>
              </td>

            </tr>


            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableReductionOrders</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether reduction orders are enabled for the org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). For more information, see
                <a class="xref" href="https://help.salesforce.com/s/articleView?id=sales.orderreduction_overview.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Reduction
                  Orders</a> in Salesforce Help.<p class="p">To enable this preference,
                  <span class="keyword parmname">enableOrders</span> must be set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableZeroQuantity</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether users in the org can add order products with
                quantities of zero (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). Default value is
                <samp class="codeph nolang">false</samp>.<p class="p">To enable this
                  preference, <span class="keyword parmname">enableOrders</span> must be set to
                  <samp class="codeph nolang">true</samp>.
                </p>
                <p class="p">Available
                  in API version 42.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This is a sample OrderSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<OrderSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableNegativeQuantity\>false</enableNegativeQuantity\>
    <enableZeroQuantity\>false</enableZeroQuantity\>
    <enableOrders\>true</enableOrders\>
    <enableReductionOrders\>true</enableReductionOrders\>
    <enableEnhancedCommerceOrders\>true</enableEnhancedCommerceOrders\>
    <enableOptionalPricebook\>false</enableOptionalPricebook\>
    <enableOrderEvents\>false</enableOrderEvents\>
    <enableOrderWithMultiplePriceBooks\>false</enableOrderWithMultiplePriceBooks\>
</OrderSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Order</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=5d671c12bcd83a550f0211d274472ce437f3fa90fe8331bf93e7b2e7f30e9688 url=/legacydeveloper/current/en-us/api_meta/meta_orgpreferencesettings.md -->

# OrgPreferenceSettings

Removed in API version 48.0. Represents the unique org preference settings in a Salesforce org.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

OrgPreferenceSettings values are stored in the OrgPreference.settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

## Version

OrgPreferenceSettings components are available in API versions 37.0 to 47.0.

OrgPreferenceSettings is deprecated in API version 47.0 and removed in API version 48.0. In API version 47.0, most of the settings supported in the preferences field were made available in the form of Boolean fields on other Settings types. For example, in API version 47.0 and later, you can enable and disable the CompileOnDeploy preference by using the enableCompileOnDeploy field on the ApexSettings type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d725110e111">Field Name</th>

              <th class="featureTableHeader  " id="d725110e114">Field Type</th>

              <th class="featureTableHeader  " id="d725110e117">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d725110e111" data-title="Field Name"><span class="keyword parmname">preferences</span></td>

              <td class="entry" headers="d725110e114" data-title="Field Type">
                <a class="xref" href="#organizationsettingsdetail">OrganizationSettingsDetail</a>[]
              </td>

              <td class="entry" headers="d725110e117" data-title="Description">The preferences associated with the org settings. In the
                following list of preferences, click hyperlinked preference names to
                go to the topic for the Settings type that contains that preference.
                If there is no link, the preference hasn’t been moved to another
                Settings type.<ul class="ul bulletList">
                  <li class="li">
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_analyticssettings.htm" title="Represents Analytics settings in Salesforce. CRM Analytics lets you explore all your data quickly and easily by providing AI-powered advanced Analytics right inside Salesforce. Manage your datasets, query data with Salesforce Analytics Query Language (SAQL), and customize dashboards. You can use these settings to configure which Analytics features are available to users in your organization."><samp class="codeph nolang">AnalyticsSharingEnable</samp></a> (available
                    in API version 40.0 and later)
                  </li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsettings.htm#ops_apexlockunlock">ApexApprovalLockUnlock</a></samp></li>

                  <li class="li">
                    <samp class="codeph nolang">AsyncSaveEnabled</samp>
                    (available in API versions 40.0 to 46.0)
                  </li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_chattersettings.htm#ops_chatter">ChatterEnabled</a></samp></li>

                  <li class="li">
                    <samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsettings.htm#ops_compileondeploy">CompileOnDeploy</a></samp>
                    (available in API version 43.0 and later)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_partydatamodelsettings.htm" title="Represents an organization’s party data model settings, including options around the Individual object and consent enablement. This type extends the Metadata metadata type and inherits its fullName field.">ConsentManagementEnabled</a></samp>
                    (available
                    in API version 45.0 and later)
                  </li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailadministrationsettings.htm#ops_enhancedemail">EnhancedEmailEnabled</a></samp></li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eventsettings.htm#ops_eventlogwave">EventLogWaveIntegEnabled</a></samp></li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eventsettings.htm#ops_loginforensics">LoginForensicsEnabled</a></samp></li>

                  <li class="li">
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_communitiessettings.htm" title="Represents community settings for an org. Enable digital experiences and workspaces. Manage moderation, guest user and partner settings, and more. This type extends the Metadata metadata type and inherits its fullName field."><samp class="codeph nolang">NetworksEnabled</samp></a> (available in API
                    version 40.0 and later)
                  </li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_enhancednotessettings.htm" title="Represents an org’s enhanced note settings, such as enabling enhanced notes and enabling tasks in enhanced notes.This type extends the Metadata metadata type and inherits its fullName field."><samp class="codeph nolang">NotesReservedPref01</samp></a></li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobilesettings.htm#ops_offlinedrafts">OfflineDraftsEnabled</a></samp></li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pathassistantsettings.htm#ops_pathassistant">PathAssistantsEnabled</a></samp></li>

                  <li class="li">
                    <samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningexperiencesettings.htm#ops_lightningexp">S1DesktopEnabled</a></samp>
                    <div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p>After it is enabled, <samp class="codeph nolang">S1DesktopEnabled</samp> can’t be disabled in any
                                version of the API.</p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                  </li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobilesettings.htm#ops_encryptedstoragepref2">S1EncryptedStoragePref2</a></samp></li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobilesettings.htm#ops_s1offlinepref">S1OfflinePref</a></samp></li>

                  <li class="li">
                    <samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_devhubsettings.htm#ops_scratchorgmanagementpref">ScratchOrgManagementPref</a></samp> (available
                    in API version 41.0 and later)
                  </li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailadministrationsettings.htm#ops_sendviagmail">SendThroughGmailPref</a></samp></li>

                  <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_socialprofilesettings.htm#ops_socialprofiles">SocialProfilesEnable</a></samp></li>

                  <li class="li">
                    <samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_languagesettings.htm" title="Represents an organization’s language settings. Language settings control end-user language selection, locale formats, and translation options. This type extends the Metadata metadata type and inherits its fullName field.">Translation</a></samp> (available in API
                    version 40.0 and later)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">VoiceEnabled</samp>
                    <div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p>The
                                <samp class="codeph nolang">VoiceEnabled</samp>
                                preference isn’t being moved to another metadata type.
                                If you want to use it in a scratch org in API version
                                48.0 and later, you can enable it as a scratch org
                                feature.
                              </p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## OrganizationSettingsDetail

| Field Name | Field Type | Description |
| --- | --- | --- |
| settingName | string | The name of the setting. For example, “S1EncryptedStoragePref2.” |
| settingValue | boolean | Indicates whether the setting is enabled (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example of a OrgPreferenceSettings component. The example shows only the preferences values that are supported but not yet available as fields on another Settings type in API version 47.0.

<?xml version="1.0" encoding="UTF-8"?>
<OrgPreferenceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <preferences\>
        <settingName\>AnalyticsSharingEnable</settingName\>
        <settingValue\>true</settingValue\>
    </preferences\>
    <preferences\>
        <settingName\>NetworksEnabled</settingName\>
        <settingValue\>true</settingValue\>
    </preferences\>
    <preferences\>
        <settingName\>NotesReservedPref01</settingName\>
        <settingValue\>false</settingValue\>
    </preferences\>
    <preferences\>
        <settingName\>ScratchOrgManagementPref</settingName\>
        <settingValue\>true</settingValue\>
    </preferences\>
    <preferences\>
        <settingName\>VoiceEnabled</settingName\>
        <settingValue\>false</settingValue\>
    </preferences\>
</OrgPreferenceSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=14e51101b648efff9e56d9cc1d188809198d865b6fd84847b8d508c6f06e994d url=/legacydeveloper/current/en-us/api_meta/meta_orgsettings.md -->

# OrgSettings

Represents the settings for org-wide functionality that isn’t associated with any specific feature.This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

An OrgSettings component file has the suffix .settings and is stored in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

OrgSettings components are available in API version 46.0 and later.

Before API version 51.0, the fields enableExtendedMailMerge and saveMailMergeDocsAsSalesforceDocs were found within OrgSettings components. In API version 51.0 and later, those fields are found within [MailMergeSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mailmergesettings.htm "Represents the settings for Extended Mail Merge functionality.").

## Fields

| Field Name | Field Type | Descriptions |
| --- | --- | --- |
|  |  |  |
| enableCustomerSuccessPortal | boolean | Indicates whether Customer Portal is enabled (true) or not (false). |
| enableManageSelfServiceUsers | boolean | Indicates whether mass management of self-service users is enabled through the Self-Service Portal (true) or not (false). |
| enableOrgFeedSentimentAnalysis | boolean | Indicates whether feed sentiment analysis is enabled for the org (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example of a OrgSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<OrgSettings xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <enableCustomerSuccessPortal\>false</enableCustomerSuccessPortal\>
    <enableMakeDeploymentsMandatory\>true</enableMakeDeploymentsMandatory\>
    <enableManageSelfServiceUsers\>false</enableManageSelfServiceUsers\>
    <enableOrgFeedSentimentAnalysis\>false</enableOrgFeedSentimentAnalysis\>
    <enableRADeploymentAttributeOnly\>true</enableRADeploymentAttributeOnly\>
</OrgSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the org settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Org</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ab50276529ba30cb725fc73484fa2969ede5035ed193c0c2824936df466c3ce3 url=/legacydeveloper/current/en-us/api_meta/meta_outboundnetworkconnection.md -->

# OutboundNetworkConnection

Represents a private connection between a Salesforce org and a third-party data service. The connection is outbound because the callouts are going _out_ of Salesforce. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

OutboundNetworkConnection components have the suffix .outboundNetworkConnection and are stored in the outboundNetworkConnections folder.

## Version

OutboundNetworkConnection components are available in API version 49.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d726698e87">Field Name</th>

              <th class="featureTableHeader  " id="d726698e90">Field Type</th>

              <th class="featureTableHeader  " id="d726698e93">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">connectionType</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">ExternalConnectionType (enumeration of type string)</td>

              <td class="entry" headers="d726698e93" data-title="Description">Required. Specifies the cloud provider of the connection. <a name="ul_hly_52w_sdc"><!-- --></a>
                <ul class="ul bulletList" id="ul_hly_52w_sdc">
                  <li class="li"><samp class="codeph nolang">AwsPrivateLink</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">DataCloudPrivateConnection</samp> (Reserved for
                    internal use)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">string</td>

              <td class="entry" headers="d726698e93" data-title="Description">A description of the connection. Maximum of 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">boolean</td>

              <td class="entry" headers="d726698e93" data-title="Description">Required. Specifies whether the connection is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">string</td>

              <td class="entry" headers="d726698e93" data-title="Description">Required. A user-friendly label for the connection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">outboundNetworkConnProperties</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">
                <a class="xref" href="#meta_outboundnetworkconnproperty">OutboundNetworkConnProperty</a>[]
              </td>

              <td class="entry" headers="d726698e93" data-title="Description">Name-value pairs that describe the properties of an outbound network
                connection. Specify a name-value pair for each of the properties.</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">ExternalConnectionStatus​(enumeration of type string)</td>

              <td class="entry" headers="d726698e93" data-title="Description">Required. Connection status. The connection is initially Unprovisioned and
                moves through the other statuses automatically after an admin performs a Provision,
                Sync, or Teardown action. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Unprovisioned</samp></li>

                  <li class="li"><samp class="codeph nolang">Allocation</samp></li>

                  <li class="li"><samp class="codeph nolang">PendingAcceptance</samp></li>

                  <li class="li"><samp class="codeph nolang">PendingActivation</samp></li>

                  <li class="li"><samp class="codeph nolang">RejectedRemotely</samp></li>

                  <li class="li"><samp class="codeph nolang">DeletedRemotely</samp></li>

                  <li class="li"><samp class="codeph nolang">TeardownInProgress</samp></li>

                  <li class="li"><samp class="codeph nolang">Ready</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## OutboundNetworkConnProperty

Represents a name-value pair that describes the properties of an outbound network connection.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d726698e260">Field Name</th>

              <th class="featureTableHeader  " id="d726698e263">Field Type</th>

              <th class="featureTableHeader  " id="d726698e266">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d726698e260" data-title="Field Name"><span class="keyword parmname">propertyName</span></td>

              <td class="entry" headers="d726698e263" data-title="Field Type">OutboundConnPropertyName​(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d726698e266" data-title="Description">Required. The name of a property used to establish to an
                OutboundNetworkConnection. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AwsVpcEndpointId</samp>—The unique endpoint ID
                    provided by Salesforce after an outbound AwsPrivateLink is created. The value is
                    read-only when the <span class="keyword parmname">status</span> is <samp class="codeph nolang">Ready</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AwsVpcEndpointServiceName</samp>—The name of the
                    customer’s endpoint service running in an AWS VPC that’s used for private
                    connections with Salesforce.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Region</samp>—The region in which the VPC is
                    hosted.
                  </li>

                </ul>
                Enumerated values <samp class="codeph nolang">DataCloudPrivateNetwork*</samp> are reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e260" data-title="Field Name"><span class="keyword parmname">propertyValue</span></td>

              <td class="entry" headers="d726698e263" data-title="Field Type"><samp class="codeph nolang">string</samp></td>

              <td class="entry" headers="d726698e266" data-title="Description">Required. The value of OutboundConnPropertyName. For example, the
                <span class="keyword parmname">propertyValue</span> of <samp class="codeph nolang">Region</samp>
                can be <samp class="codeph nolang">us-west-2.</samp>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following sample definition has the suffix .outboundNetworkConnection.

<?xml version="1.0" encoding="UTF-8"?>
<OutboundNetworkConnection xmlns="http://soap.sforce.com/2006/04/metadata">
    <connectionType\>AwsPrivateLink</connectionType\>
    <description\>Outbound Connection to make a callout to a Service deployed in AWS VPC</description\>
    <isActive\>true</isActive\>
    <label\>MyOutboundConnection</label\>
    <outboundNetworkConnProperties\>
        <propertyName\>Region</propertyName\>
        <propertyValue\>us-west-2</propertyValue\>
    </outboundNetworkConnProperties\>
    <outboundNetworkConnProperties\>
        <propertyName\>AwsVpcEndpointServiceName</propertyName\>
        <propertyValue\>com.amazonaws.vpce.us-west-2.vpce-svc-00d7bd6285c123b4c</propertyValue\>
    </outboundNetworkConnProperties\>
    <status\>Unprovisioned</status\>
</OutboundNetworkConnection\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>sampleOutboundConnection</fullName\>
    <types\>
        <members\>MyOutboundConnection</members\>
        <name\>OutboundNetworkConnection</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=30cc4ea9ed8ccbd7baaf122ede981d00c61939a47b159a7ee8b23b2429d035b1 url=/legacydeveloper/current/en-us/api_meta/meta_ownersharingrule.md -->

# OwnerSharingRule

Represents an ownership-based sharing rule. OwnerSharingRule enables you to share records owned by a set of users with another set, using rules that specify the access level of the target user group. This component is removed as of API version 33.0 and is available in earlier versions only.

OwnerSharingRule extends the [BaseSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_basesharingrule.htm "This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingBaseRule instead. Represents the base container for criteria-based and owner-based sharing rules.") metadata type and inherits its SharedTo field. For more information, see “Sharing Rules” in the Salesforce online help.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can’t create a OwnerSharingRule component directly. Use the child components instead.

## Declarative Metadata File Suffix and Directory Location

OwnerSharingRules components are stored within the SharingRules component in the ownerRules field.

## Version

OwnerSharingRules components are available in API version 24.0 and later.

## Special Access Rules

As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object, and only users with the Manage Sharing permission can edit this object.

## Fields

The following information assumes that you are familiar with implementing sharing rules for standard objects and custom objects. For more information on these fields, see “Sharing Settings” in the Salesforce online help.

| Field | Field Type | Description |
| --- | --- | --- |
| sharedFrom | [SharedTo](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.") | Required. Specifies the record owners. |
| sharedTo | [SharedTo](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.") | Required. Specifies who the record should be shared with. |
| fullName | string | The unique identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") component. |

## AccountOwnerSharingRule

Represents a sharing rule for an account with users other than the owner. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom, and sharedTo fields.

AccountOwnerSharingRule is used by the ownerRules field in [AccountSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#AccountSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d727668e229">Field</th>

              <th class="featureTableHeader  " id="d727668e232">Field Type</th>

              <th class="featureTableHeader  " id="d727668e235">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d727668e229" data-title="Field"><span class="keyword parmname">accountAccessLevel</span></td>

              <td class="entry" headers="d727668e232" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoNone</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d727668e235" data-title="Description">Required. A value that represents the level of access that a group or role has
                to the account. The possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">All</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e229" data-title="Field"><span class="keyword parmname">caseAccessLevel</span></td>

              <td class="entry" headers="d727668e232" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoAll</samp> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d727668e235" data-title="Description">Required. A value that represents the level of access that a group or role has
                to cases associated with the account. The possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e229" data-title="Field"><span class="keyword parmname">contactAccessLevel</span></td>

              <td class="entry" headers="d727668e232" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoAll</samp> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d727668e235" data-title="Description">Required. A value that represents the level of access that a group or role has
                to contacts associated with the account. The possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e229" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d727668e232" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e235" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.This
                field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e229" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d727668e232" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e235" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e229" data-title="Field"><span class="keyword parmname">opportunityAccessLevel</span></td>

              <td class="entry" headers="d727668e232" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoAll</samp> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d727668e235" data-title="Description">Required. A value that represents the level of access that a group or role is
                granted for any associated opportunity. The possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## CampaignOwnerSharingRule

Represents a sharing rule for a campaign with users other than the owner. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom, and sharedTo fields.

CampaignOwnerSharingRule is used by the ownerRules field in [CampaignSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#CampaignSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d727668e433">Field</th>

              <th class="featureTableHeader  " id="d727668e436">Field Type</th>

              <th class="featureTableHeader  " id="d727668e439">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d727668e433" data-title="Field"><span class="keyword parmname">campaignAccessLevel</span></td>

              <td class="entry" headers="d727668e436" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoNone</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d727668e439" data-title="Description">A value that represents the level of access that a group or role is granted for
                a campaign. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">All</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e433" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d727668e436" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e439" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.This
                field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e433" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d727668e436" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e439" data-title="Description">Name for the sharing rule. Corresponds to <strong class="ph uicontrol">Label</strong> in the
                user interface.</td>

            </tr>

          </tbody>

        </table>

## CaseOwnerSharingRule

Represents a sharing rule for a case with users other than the owner. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom, and sharedTo fields.

CaseOwnerSharingRule is used by the ownerRules field in [CaseSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#CaseSharingRules). All the following fields are required.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d727668e549">Field</th>

              <th class="featureTableHeader  " id="d727668e552">Field Type</th>

              <th class="featureTableHeader  " id="d727668e555">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d727668e549" data-title="Field"><span class="keyword parmname">caseAccessLevel</span></td>

              <td class="entry" headers="d727668e552" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d727668e555" data-title="Description">Required. A value that represents the level of access that a group or role is
                granted for a case. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e549" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d727668e552" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e555" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.This
                field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e549" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d727668e552" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e555" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

          </tbody>

        </table>

## ContactOwnerSharingRule

Represents a sharing rule for a contact with users other than the owner. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom, and sharedTo fields.

ContactOwnerSharingRule is used by the ownerRules field in [ContactSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#ContactSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d727668e661">Field</th>

              <th class="featureTableHeader  " id="d727668e664">Field Type</th>

              <th class="featureTableHeader  " id="d727668e667">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d727668e661" data-title="Field"><span class="keyword parmname">contactAccessLevel</span></td>

              <td class="entry" headers="d727668e664" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d727668e667" data-title="Description">Required. A value that represents the level of access that a group or role is
                granted for a contact. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e661" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d727668e664" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e667" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.This
                field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e661" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d727668e664" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e667" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

          </tbody>

        </table>

## LeadOwnerSharingRule

Represents a sharing rule for a lead with users other than the owner. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom, and sharedTo fields.

LeadOwnerSharingRule is used by the ownerRules field in [LeadSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#LeadSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d727668e770">Field</th>

              <th class="featureTableHeader  " id="d727668e773">Field Type</th>

              <th class="featureTableHeader  " id="d727668e776">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d727668e770" data-title="Field"><span class="keyword parmname">leadAccessLevel</span></td>

              <td class="entry" headers="d727668e773" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d727668e776" data-title="Description">Required. A value that represents the level of access that a group or role is
                granted for a lead. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e770" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d727668e773" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e776" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.This
                field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e770" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d727668e773" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e776" data-title="Description">Required. Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

          </tbody>

        </table>

## OpportunityOwnerSharingRule

Represents a sharing rule for an opportunity with users other than the owner. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom, and sharedTo fields.

OpportunityOwnerSharingRule is used by the ownerRules field in [OpportunitySharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#OpportunitySharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d727668e882">Field</th>

              <th class="featureTableHeader  " id="d727668e885">Field Type</th>

              <th class="featureTableHeader  " id="d727668e888">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d727668e882" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d727668e885" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e888" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e882" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d727668e885" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e888" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.This
                field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e882" data-title="Field"><span class="keyword parmname">opportunityAccessLevel</span></td>

              <td class="entry" headers="d727668e885" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d727668e888" data-title="Description">Required. A value that represents the level of access that a group or role is
                granted for an opportunity. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## AccountTerritorySharingRule

Represents a rule for sharing an account within a territory. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom, and sharedTo fields.

AccountTerritorySharingRule is used by the ownerRules field in [AccountTerritorySharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#AccountTerritorySharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d727668e995">Field</th>

              <th class="featureTableHeader  " id="d727668e998">Field Type</th>

              <th class="featureTableHeader  " id="d727668e1001">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d727668e995" data-title="Field"><span class="keyword parmname">accountAccessLevel</span></td>

              <td class="entry" headers="d727668e998" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoNone</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d727668e1001" data-title="Description">Required. A value that represents the level of access that a Territory or
                TerritoryAndSubordinates group is granted for an account territory. The possible
                values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">All</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e995" data-title="Field"><span class="keyword parmname">caseAccessLevel</span></td>

              <td class="entry" headers="d727668e998" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoAll</samp> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d727668e1001" data-title="Description">Required. A value that represents the level of access that a Territory or
                TerritoryAndSubordinates group is granted for all child cases to an account. The
                possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e995" data-title="Field"><span class="keyword parmname">contactAccessLevel</span></td>

              <td class="entry" headers="d727668e998" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoAll</samp> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d727668e1001" data-title="Description">Required. A value that represents the level of access that a Territory or
                TerritoryAndSubordinates group is granted for all related contacts on an account.
                The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e995" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d727668e998" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e1001" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.This
                field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e995" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d727668e998" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e1001" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e995" data-title="Field"><span class="keyword parmname">opportunityAccessLevel</span></td>

              <td class="entry" headers="d727668e998" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelNoAll</samp> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d727668e1001" data-title="Description">Required. A value that represents the level of access that a Territory or
                TerritoryAndSubordinates group is granted for all opportunities associated with an
                account. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## CustomObjectOwnerSharingRule

Represents a sharing rule for custom objects. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom, and sharedTo fields.

CustomObjectOwnerSharingRule is used by the ownerRules field in [CustomObjectSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#CustomObjectSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d727668e1201">Field</th>

              <th class="featureTableHeader  " id="d727668e1204">Field Type</th>

              <th class="featureTableHeader  " id="d727668e1207">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d727668e1201" data-title="Field"><span class="keyword parmname">accessLevel</span></td>

              <td class="entry" headers="d727668e1204" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e1207" data-title="Description">Required. A value that represents the level of access that a group or role is
                granted to a custom object. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">All</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e1201" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d727668e1204" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e1207" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.<p class="p" id="sharerule_descAPI"><a name="sharerule_descAPI"><!-- --></a>This field is available in API version 29.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e1201" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d727668e1204" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e1207" data-title="Description">Required. <span class="ph" id="sharingrule_name"><a name="sharingrule_name"><!-- --></a>Name for the sharing rule.</span> Corresponds
                to <strong class="ph uicontrol">Label</strong> in the user interface.</td>

            </tr>

          </tbody>

        </table>

## UserMembershipSharingRule

Represents a sharing rule to share members of a group with another group of users. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom, and sharedTo fields.

UserMembershipSharingRule is used by the ownerRules field in [UserSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#UserSharingRules).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d727668e1320">Field</th>

              <th class="featureTableHeader  " id="d727668e1323">Field Type</th>

              <th class="featureTableHeader  " id="d727668e1326">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d727668e1320" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d727668e1323" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e1326" data-title="Description">Represents the description of the sharing rule. Maximum of 1000 characters.This
                field is available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e1320" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d727668e1323" data-title="Field Type">string</td>

              <td class="entry" headers="d727668e1326" data-title="Description">Required. Name for the sharing rule. Corresponds to
                <strong class="ph uicontrol">Label</strong> in the user interface.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d727668e1320" data-title="Field"><span class="keyword parmname">userAccessLevel</span></td>

              <td class="entry" headers="d727668e1323" data-title="Field Type">
                <samp class="codeph nolang">ShareAccessLevelReadEdit</samp> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d727668e1326" data-title="Description">Required. A value that represents the level of access that a group or role is
                granted for a user. The possible values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm "CriteriaBasedSharingRule")

<!-- document id=cc5d5743c2f1e9b608ceae067a19ef777f59217b0b5fbb264d11626a288506cd url=/legacydeveloper/current/en-us/api_meta/meta_package.md -->

# Package

Specifies which metadata components to retrieve as part of a retrieve() call or defines a package of components.

<table class="featureTable sort_table" summary="">



        <thead class="thead sorted" align="left">
          <tr>
            <th class="featureTableHeader  " id="d731507e54">Name</th>

            <th class="featureTableHeader  " id="d731507e57">Type</th>

            <th class="featureTableHeader  " id="d731507e60">Description</th>

          </tr>

        </thead>

        <tbody class="tbody">
          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">apiAccessLevel</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">APIAccessLevel (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
              string)</td>

            <td class="entry" headers="d731507e60" data-title="Description">Package components have access via dynamic Apex and the API to standard and
              custom objects in the organization where they’re installed. Administrators who install
              packages can restrict this access after installation for improved security. The valid
              values are:<ul class="ul bulletList">
                <li class="li">Unrestricted—Package components have the same API access to standard objects as
                  the user who is logged in when the component sends a request to the API.</li>

                <li class="li">Restricted—The administrator can select which standard objects the components
                  can access. Further, the components in restricted packages can only access custom
                  objects in the current package if the user's permissions allow access to
                  them.</li>

              </ul>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">description</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">string</td>

            <td class="entry" headers="d731507e60" data-title="Description"><span class="ph" id="field_description"><a name="field_description"><!-- --></a>A short description of the package.</span></td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">fullName</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">string</td>

            <td class="entry" headers="d731507e60" data-title="Description">The package name used as a unique identifier for API access. The
              <span class="keyword parmname">fullName</span> can contain only underscores and alphanumeric
              characters. It must be unique, begin with a letter, not include spaces, not end with
              an underscore, and not contain two consecutive underscores. This field is inherited
              from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>
              component.
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">namespacePrefix</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">string</td>

            <td class="entry" headers="d731507e60" data-title="Description"><span class="ph" id="field_namespaceprefix"><a name="field_namespaceprefix"><!-- --></a>The namespace of the developer organization where
                the package was created.</span></td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">objectPermissions</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">
              <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profileobjectpermissions_title">ProfileObjectPermissions</a>[]
            </td>

            <td class="entry" headers="d731507e60" data-title="Description"><span class="ph" id="field_objectPermissions_desc"><a name="field_objectPermissions_desc"><!-- --></a>Indicates which objects are accessible to
                the package, and the kind of access available (create, read, update,
                delete).</span></td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">packageType</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">string</td>

            <td class="entry" headers="d731507e60" data-title="Description">Reserved for future use.</td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">postInstallClass</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">string</td>

            <td class="entry" headers="d731507e60" data-title="Description">The name of the Apex class that specifies the actions to execute after the
              package has been installed or upgraded. The Apex class must be a member of the package
              and must implement the Apex <samp class="codeph apex_code">InstallHandler</samp>
              interface. In patch upgrades, you can't change the class name in this field but you
              can change the contents of the Apex class. The class name can be changed in major
              upgrades.<p class="p">This field is available in API version 24.0 and later.</p>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">setupWeblink</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">string</td>

            <td class="entry" headers="d731507e60" data-title="Description"><span class="ph" id="field_setupWeblink"><a name="field_setupWeblink"><!-- --></a>The weblink used to describe package
                installation.</span></td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">types</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">
              <a class="xref" href="#packagetypemembers">PackageTypeMembers</a>[]
            </td>

            <td class="entry" headers="d731507e60" data-title="Description">The type of component being retrieved.</td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">uninstallClass</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">string</td>

            <td class="entry" headers="d731507e60" data-title="Description">The name of the Apex class that specifies the actions to execute after the
              package has been uninstalled. The Apex class must be a member of the package and must
              implement the Apex <samp class="codeph apex_code">UninstallHandler</samp> interface.
              In patch upgrades, you can't change the class name in this field but you can change
              the contents of the Apex class. The class name can be changed in major
              upgrades.<p class="p">This field is available in API version 25.0 and later.</p>
            </td>

          </tr>

          <tr>
            <td class="entry" headers="d731507e54" data-title="Name"><span class="keyword parmname">version</span></td>

            <td class="entry" headers="d731507e57" data-title="Type">string</td>

            <td class="entry" headers="d731507e60" data-title="Description">Required. The version of the component type.</td>

          </tr>

        </tbody>

      </table>

## PackageTypeMembers

Use to specify the name and type of components to be retrieved in a package.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d731507e279">Name</th>

              <th class="featureTableHeader  " id="d731507e282">Type</th>

              <th class="featureTableHeader  " id="d731507e285">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d731507e279" data-title="Name"><span class="keyword parmname">members</span></td>

              <td class="entry" headers="d731507e282" data-title="Type">string</td>

              <td class="entry" headers="d731507e285" data-title="Description">
                <p class="p">One or more named components, or the wildcard character (<samp class="codeph java">*</samp>) to retrieve all metadata components of the type
                  specified in the <samp class="codeph xml"><span class="tag">&lt;name</span>&gt;</samp> element. To retrieve
                  a standard object, specify it by name. For example, <samp class="codeph xml"><span class="tag">&lt;members</span>&gt;Account<span class="tag">&lt;/members</span>&gt;</samp> retrieves the standard Account
                  object.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d731507e279" data-title="Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d731507e282" data-title="Type">string</td>

              <td class="entry" headers="d731507e285" data-title="Description">
                <p class="p">The type of metadata component to be retrieved. For example, <samp class="codeph xml"><span class="tag">&lt;name</span>&gt;CustomObject<span class="tag">&lt;/name</span>&gt;</samp> retrieves one or more
                  custom objects as specified in the <samp class="codeph xml"><span class="tag">&lt;members</span>&gt;</samp>
                  element.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Sample package.xml Manifest Files](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/manifest_samples.htm "This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if you want to work with all the metadata in one batch.")

<!-- document id=acc596dcc8c5bffed662bd888e54ab5829e4a10b4f687f98f13e85837270dadd url=/legacydeveloper/current/en-us/api_meta/meta_pardoteinsteinsettings.md -->

# PardotEinsteinSettings

Represents PardotEinsteinSettings. Use these settings to learn what factors drive your campaign performance, and get the best possible engagement score for your prospects. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

PardotEinsteinSettings values are stored in the PardotEinstein.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

PardotEinsteinSettings is available in API versions 48.0 and later.

Fields

<table class="featureTable sort_table" summary="">



            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d733516e99">Field Name</th>

                <th class="featureTableHeader  " id="d733516e102">Field Type</th>

                <th class="featureTableHeader  " id="d733516e105">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d733516e99" data-title="Field Name"><span class="keyword parmname">enableCampaignInsight</span></td>

                <td class="entry" headers="d733516e102" data-title="Field Type">boolean</td>

                <td class="entry" headers="d733516e105" data-title="Description">Indicates whether Einstein Campaign Insights is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Einstein Campaign Insights helps you
                  understand what factors drive campaign performance.<p class="p">The default
                    value is <samp class="codeph nolang">false</samp>.</p>
                </td>

              </tr>

              <tr>
                <td class="entry" headers="d733516e99" data-title="Field Name"><span class="keyword parmname">enableEngagementScore</span></td>

                <td class="entry" headers="d733516e102" data-title="Field Type">boolean</td>

                <td class="entry" headers="d733516e105" data-title="Description">Indicates whether Einstein Behavior Scoring is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Einstein Behavior Scoring identifies prospects
                  whose behavior suggests that they are ready to buy, and scores them
                  based on Einstein’s engagement model.<p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

                </td>

              </tr>


            </tbody>

          </table>

## Declarative Metadata Sample Definition

The following is an example of the PardotEinstein.settings file:

<?xml version="1.0" encoding="UTF-8"?>
<PardotEinsteinSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableCampaignInsight\>true</enableCampaignInsight\>
	<enableEngagementScore\>true</enableEngagementScore\>
</PardotEinsteinSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the PardotEinstein settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>PardotEinstein</members\>
		<name\>Settings</name\>
	</types\>
	<version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=fac7770b11d1e5681610502e837af25d9f084abe6ae8d79e842227780060f464 url=/legacydeveloper/current/en-us/api_meta/meta_pardotsettings.md -->

# PardotSettings

Represents Marketing Cloud Account Engagement settings in your Salesforce org. Account Engagement, formerly known as Pardot, is a B2B marketing automation solution that helps you create meaningful connections, generate more pipeline, and close more deals. Use these settings to configure how Account Engagement collects and displays data.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

This object is stored in a file named Pardot.Settings in the settings folder 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

PardotSettings is available in API version 47.0 and later.

## Special Access Rules

This metadata type is available only to orgs with Account Engagement.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d733930e117">Field Name</th>

              <th class="featureTableHeader  " id="d733930e120">Field Type</th>

              <th class="featureTableHeader  " id="d733930e123">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">cdpEnablementStatus</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">string</td>

              <td class="entry" headers="d733930e123" data-title="Description">The
                status of the enablement in <span class="ph">Data 360</span> for the account engagement business
                unit.</td>

            </tr>


            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">enableAeDataConnector</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Enable the Account Engagement <span class="ph">Data 360</span> Connector for creating Account
                Engagement Data Streams.</td>

            </tr>


            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">enableAIOptimizedSendTime</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Enable Einstein Send Time Optimization for sending Account Engagement
                emails.</td>

            </tr>

            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">enableB2bmaAppEnabled</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Deprecated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">enableEngagementHistoryDashboards</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Enable the Engagement History Dashboard and allow related Account Engagement
                data to be shared to campaign records in Salesforce by setting this value to <samp class="codeph nolang">true</samp>. The default value is <samp class="codeph nolang">false</samp>. If
                <span class="keyword parmname">enableEnagementHistoryDashboards</span> is disabled after being
                enabled, the Engagement History Dashboard is removed, but engagement data continues
                to be retained and updated.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">enableEnhancedProspectCustomFieldsSync</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Enable Object Sync to enhance with B2B Marketing Analytics or B2B Marketing
                Analytics Plus by setting this property to <samp class="codeph nolang">true</samp>. The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">enablePardotAppV1Enabled</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Enable the Account Engagement Lightning App by setting this property to <samp class="codeph nolang">true</samp>. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">enablePardotEnabled</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Deprecated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">enablePardotObjectSync</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Deprecated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">enableProspectActivityDataset</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Enable the Prospect and Activity Dataset for B2B Marketing Automation apps by
                setting this property to <samp class="codeph nolang">true</samp>. When
                <span class="keyword parmname">enableProspectActivityDataset</span> is <samp class="codeph nolang">true</samp>, the datasets take some time to populate. Depending on how much
                data and the type of licenses you have, enabling this preference can impact the
                account’s row limit for Analytics.<p class="p">If
                  <span class="keyword parmname">enableProspectActivityDataset</span> is disabled after being
                  enabled:
                </p>
                <ul class="ul bulletList">
                  <li class="li">The data that makes up the datasets is deleted.</li>

                  <li class="li">The Prospect and Activity Dataset in existing B2B Marketing Automation apps
                    stops getting updates.</li>

                  <li class="li">The dataset isn’t available to add to new apps.</li>

                  <li class="li">When apps are reconfigured, the dataset is deleted.</li>

                </ul>
                Requires that <span class="keyword parmname">enableEnagementHistoryDashboards</span> is set to
                <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d733930e117" data-title="Field Name"><span class="keyword parmname">PardotEngageFreqSetting</span></td>

              <td class="entry" headers="d733930e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d733930e123" data-title="Description">Enable Einstein Engagement Frequency for sending Account Engagement
                emails.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a PardotSettings component.

1 <?xml version="1.0" encoding="UTF-8"?>
2 <PardotSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3     <enablePardotEnabled\>true</enablePardotEnabled\>
4     <enablePardotAppV1Enabled\>true</enablePardotAppV1Enabled\>
5     <enableB2bmaAppEnabled\>true</enableB2bmaAppEnabled\>
6     <enableEngagementHistoryDashboards\>true</enableEngagementHistoryDashboards\>
7     <enableEnhancedProspectCustomFieldsSync\>true</enableEnhancedProspectCustomFieldsSync\>
8     <enablePardotObjectSync\>true</enablePardotObjectSync\>
9     <enableProspectActivityDataset\>true</enableProspectActivityDataset\>
10     <enableAIOptimizedSendTime\>true</enableAIOptimizedSendTime\>
11 </PardotSettings\>

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\>Pardot</members\>
5         <name\>Settings</name\>
6     </types\>
7     <version\>47</version\>
8 </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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=700327f8491483fbcb8bff3678f978c1c0c332a47e051e313528b0a95461fe4c url=/legacydeveloper/current/en-us/api_meta/fsc_meta_participantrole.md -->

# ParticipantRole

Represents details, such as the name and associated default access level, for a role that a participant can have in the context of a parent record.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ParticipantRole components have the suffix .participantRole and are stored in the participantRoles folder.

## Version

ParticipantRole components are available in API version 50.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| defaultAccessLevel | 
Field Type

picklist

Description

Required. The default sharing access granted to the participant role.

Valid values are:

- Edit—Read/Write
- None
- Read—Read Only





 |
| isActive | 

Field Type

boolean

Description

Indicates whether the participant role is activated.



 |
| masterLabel | 

Field Type

string

Description

Required. The name for the participant role.



 |
| parentObject | 

Field Type

string

Description

Required. The parent object for the participant role.

Valid values are:

- Account
- Budget
    
    Available in API version 59.0 and later.
- IndividualApplication
    
    Available in API version 59.0 and later.
- Interaction
    
    Available in API version 52.0 and later.
- InteractionSummary
    
    Available in API version 51.0 and later.
- FinancialDeal
    
    Available in API version 52.0 and later.
- FundingAward
    
    Available in API version 59.0 and later.
- FundingOpportunity
- Opportunity
- Team
    
    Available in API version 58.0 and later.
- Custom objects





 |

## Declarative Metadata Sample Definition

The following is an example of a ParticipantRole component.

<?xml version="1.0" encoding="UTF-8"?>
<ParticipantRole xmlns="http://soap.sforce.com/2006/04/metadata">
    <defaultAccessLevel\>Read</defaultAccessLevel\>
    <isActive\>true</isActive\>
    <masterLabel\>Advisor</masterLabel\>
    <parentObject\>Account</parentObject\>
</ParticipantRole\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ParticipantRole</name\>
    </types\>
    <version\>50.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=5b2e607d13cf334a1daa387a3be3a025042510c67f99c3f41ddd549b58bae8cf url=/legacydeveloper/current/en-us/api_meta/meta_partydatamodelsettings.md -->

# PartyDataModelSettings

Represents an organization’s party data model settings, including options around the Individual object and consent enablement. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

PartyDataModelSettingsPartyDataModel.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

PartyDataModelSettings

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d734975e102">Field Name</th>

              <th class="featureTableHeader  " id="d734975e105">Field Type</th>

              <th class="featureTableHeader  " id="d734975e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d734975e102" data-title="Field Name"><span class="keyword parmname">enableAutoSelectIndividualOnMerge</span></td>

              <td class="entry" headers="d734975e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d734975e108" data-title="Description">Indicates whether the most recently modified data privacy record for the
                Individual is retained when merging lead, contact, and person accounts (<samp class="codeph nolang">true</samp>) or users must manually determine which data
                privacy record to retain during the merge process (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d734975e102" data-title="Field Name"><span class="keyword parmname">enableConsentManagement</span></td>

              <td class="entry" headers="d734975e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d734975e108" data-title="Description">Indicates whether data protection details are available in records (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This has a default value of <samp class="codeph nolang">true</samp>. <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Setting this field to <samp class="codeph nolang">false</samp> purges all data protection details, such as privacy preferences
                            and stored consent forms.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d734975e102" data-title="Field Name"><span class="keyword parmname">enableIndividualAutoCreate</span></td>

              <td class="entry" headers="d734975e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d734975e108" data-title="Description">Deprecated in API version 48.0 and removed in API version 49.0 and
                later.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a PartyDataModelSettings

<?xml version="1.0" encoding="UTF-8"?>
<PartyDataModelSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAutoSelectIndividualOnMerge\>true</enableAutoSelectIndividualOnMerge\>
    <enableConsentManagementEnabled\>true</enableConsentManagementEnabled\>
</PartyDataModelSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>PartyDataModel</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=91f464eb1ed46468a9391cd0a745ae9af991656f6e473c42d59cbe4a8fee1636 url=/legacydeveloper/current/en-us/api_meta/meta_pathassistant.md -->

# PathAssistant

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

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

Note the following when working with PathAssistant:

- Only one path can be created per record type for each object, including \_\_Master\_\_ record type.
- Rich text guidance information cannot be retrieved or deployed from or to translation workbench.
- The preference does not need to be on to retrieve or deploy PathAssistant.

## File Suffix and Directory Location

PathAssistant components have the suffix .pathAssistant and are stored in the pathAssistants folder.

## Version

PathAssistant components are available in API version 34.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| active | boolean | Indicates whether the path is active (true) or not (false). |
| entityName | string | Required. The entity name. This is hard coded for Opportunity, Lead, and Quote. For a custom object, this field must be specified and should be the name of the custom object. This field is not updateable. |
| fieldName | string | Required. The field name. This is hard coded for StageName and Status. For a custom object, this field must be specified and should be the name of the picklist field that determines the steps in the path. This field is not updateable. |
| masterLabel | string | Required. The label of the path. |
| pathAssistantSteps | [PathAssistantStep](#SubTypeID) | List of all the steps that have been configured with fields and guidance information. Note that a missing step in the .xml file means it has not been configured, not that it doesn’t exist. |
| recordTypeName | string | Required. The name of the record type associated with the path. This field is not updateable. |

## PathAssistantStep

Represents the steps or stages in a Path.

| Field Name | Field Type | Description |
| --- | --- | --- |
| fieldNames | string | All the fields in entityName that will display in this step. |
| info | string | The guidance information displayed in this step. |
| picklistValueName | string | Required. The picklist value associated with the step. |

## Declarative Metadata Sample Definition

The following is an example of a PathAssistant component.

<?xml version="1.0" encoding="UTF-8"?>
<PathAssistant xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <entityName\>Opportunity</entityName\>
    <fieldName\>StageName</fieldName\>
    <masterLabel\>Test Path</masterLabel\>
    <pathAssistantSteps\>
        <fieldNames\>Amount</fieldNames\>
        <fieldNames\>CloseDate</fieldNames\>
        <info\>Some Text</info\>
        <picklistValueName\>Id. Decision Makers</picklistValueName\>
    </pathAssistantSteps\>
    <pathAssistantSteps\>
        <fieldNames\>Amount</fieldNames\>
        <fieldNames\>CloseDate</fieldNames\>
        <info\>Some Text</info\>
        <picklistValueName\>Proposal/Price Quote</picklistValueName\>
    </pathAssistantSteps\>
    <recordTypeName\>Test\_Record\_Type</recordTypeName\>
</PathAssistant\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types\>
        <members\>Opportunity.Test\_Busines\_Process</members\>
        <name\>BusinessProcess</name\>
    </types\>
    <types\>
        <members\>Opportunity.StageName</members\>
        <members\>Lead.LeadSource</members\>
        <members\>Opportunity.Type</members\>
        <name\>CustomField</name\>
    </types\>
    <types\>
        <members\>Test\_Path</members\>
        <name\>PathAssistant</name\>
    </types\>
    <types\>
        <members\>Opportunity.Test\_Record\_Type</members\>
        <name\>RecordType</name\>
    </types\>
    <types\>
        <members\>PathAssistant</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=752b6a2cf8317337b9b2b2610f29452803674bc64f4c8f8c62c50e689768219e url=/legacydeveloper/current/en-us/api_meta/meta_pathassistantsettings.md -->

# PathAssistantSettings

Represents the Path preference setting. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

PathAssistantSettings components have the suffix .settings and are stored in the settings folder.

## Version

PathAssistantSettings components are available in API version 34.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d736334e99">Field Name</th>

              <th class="featureTableHeader  " id="d736334e102">Field Type</th>

              <th class="featureTableHeader  " id="d736334e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d736334e99" data-title="Field Name"><span class="keyword parmname">canOverrideAutoPathCollapseWithUserPref</span></td>

              <td class="entry" headers="d736334e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d736334e105" data-title="Description">Keeps a user's path expanded to show guidance and key fields on
                all their records. A user's path stays expanded until the user
                collapses it. To use this preference, Path must be enabled.
                <p class="p">Default value is <samp class="codeph nolang">false</samp>
                  for all editions. When set to <samp class="codeph nolang">false</samp>, the user’s path is collapsed when the page
                  loads. </p>
                <p class="p">Available in API version 47.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d736334e99" data-title="Field Name"><span class="keyword parmname">pathAssistantEnabled</span></td>

              <td class="entry" headers="d736334e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d736334e105" data-title="Description">Determines whether the preference is enabled for Path. Default
                value is <samp class="codeph nolang">true</samp> for Enterprise
                Edition and <samp class="codeph nolang">false</samp> for other
                editions. Available in API version 35.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d736334e99" data-title="Field Name"><span class="keyword parmname">pathAssistantForOpportunityEnabled</span></td>

              <td class="entry" headers="d736334e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d736334e105" data-title="Description">Determines whether the preference is enabled for Path in
                Opportunity or not. <p class="p">Available in API version 34.0 and
                  earlier.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d736334e99" data-title="Field Name"></td>

              <td class="entry" headers="d736334e102" data-title="Field Type"></td>

              <td class="entry" headers="d736334e105" data-title="Description"></td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a PathAssistantSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<PathAssistantSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <pathAssistantEnabled\>true</pathAssistantEnabled\>
    <canOverrideAutoPathCollapseWithUserPref\>true</canOverrideAutoPathCollapseWithUserPref\>
</PathAssistantSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>PathAssistant</members\>
        <name\>Settings</name\>
    </types\>
    <version\>API</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ac04f7b61334660544cdb17cecf965bd7213e3bdeec570fe834706d4c1ff7fa3 url=/legacydeveloper/current/en-us/api_meta/meta_paymentgatewayprovider.md -->

# PaymentGatewayProvider

Represents the metadata associated with a payment gateway provider. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

PaymentGatewayProvider components have the suffix paymentGatewayProvider and are stored in the paymentGatewayProviders folder.

## Version

PaymentGatewayProvider components are available in API version 48.0 and later.

## Special Access Rules

To access PaymentGatewayProvider, you must have a Salesforce Order Management license with the PaymentPlatform org permission activated.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d736851e99">Field Name</th>

              <th class="featureTableHeader  " id="d736851e102">Field Type</th>

              <th class="featureTableHeader  " id="d736851e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">apexAdapter</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">string</td>

              <td class="entry" headers="d736851e105" data-title="Description">The Apex adapter class name for your payment gateway. This field is unique
                within your organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">comments</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">string</td>

              <td class="entry" headers="d736851e105" data-title="Description">Users can add comments to provide additional details about a record. Maximum of
                1000 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">gatewayType</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">GatewayType (enumeration of type String)</td>

              <td class="entry" headers="d736851e105" data-title="Description">Defines the payment gateway type.<a name="ul_p4n_yln_p3c"><!-- --></a>
                <ul class="ul bulletList" id="ul_p4n_yln_p3c">
                  <li class="li"><samp class="codeph nolang">Adyen</samp></li>

                  <li class="li"><samp class="codeph nolang">Braintree</samp></li>

                  <li class="li"><samp class="codeph nolang">CyberSource</samp></li>

                  <li class="li"><samp class="codeph nolang">Paypal</samp></li>

                  <li class="li"><samp class="codeph nolang">Stripe</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">idempotencySupported</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">IdempotencySupportStatus (enumeration of type String)</td>

              <td class="entry" headers="d736851e105" data-title="Description">Required. Defines whether the payment gateway ignores duplicate payment gateway
                calls (<samp class="codeph nolang">Yes</samp>) or whether it processes duplicate
                gateway calls (<samp class="codeph nolang">No</samp>).<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Yes</samp></li>

                  <li class="li"><samp class="codeph nolang">No</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">string</td>

              <td class="entry" headers="d736851e105" data-title="Description">Required. The label of this payment gateway provider record.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a PaymentGatewayProvider component.

<PaymentGatewayProvider xmlns="http://soap.sforce.com/2006/04/metadata">
    <apexAdapter\>SalesforceAdapter</apexAdapter\>
    <comments\>Comments</comments\>
    <gatewayType\>Stripe</gatewayType\>
    <idempotencySupported\>Yes</idempotencySupported\>
    <masterLabel\>SalesforceAdapter</masterLabel\>
</PaymentGatewayProvider\>

The following is an example package.xml that references the previous definition.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PaymentGatewayProvider</name\>
    </types\>
    <version\>48.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b5a9a7a669d41c4c3851928e82447b49a8307f6176b6e2e4c990fa9be4e3cfdb url=/legacydeveloper/current/en-us/api_meta/meta_paymentssettings.md -->

# PaymentsSettings

Represents the Salesforce Payments settings when this feature is enabled for the org.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

PaymentsSettings values are stored in the Payments.settings file in the settings folder.

The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

PaymentsSettings is available in API version 57.0 and later.

## Special Access Rules

This metadata type is only accessible by developers and customers using Salesforce Payments.

## Fields

| Field Name | Description |
| --- | --- |
| enablePayments | 
Field Type

boolean

Description

Indicates whether Salesforce Payments is enabled (true) or not (false) for an org. The default is false.



 |

## Declarative Metadata Sample Definition

The following is a sample payments.settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>
   <PaymentsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
     <enablePayments\>true</enablePayments\>
   </PaymentsSettings\>

The following is an example package.xml that references the previous definition.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Payments</members\>
        <name\>Settings</name\>
    </types\>
    <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e533765b0cd5a3d05e2a4a13434cdc5628a37aedf88e1c5aa19885001e56e765 url=/legacydeveloper/current/en-us/api_meta/meta_permissionset.md -->

# PermissionSet

Represents a set of permissions that's used to grant more access to one or more users without changing their profile or reassigning profiles. You can use permission sets to grant access but not to deny access.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In API version 40.0 and later, when you retrieve permission set metadata, all content exposed in Metadata API for the permission sets is included. The metadata includes Apex associated with the permission set, CRUD, and so on. Likewise, when you deploy a permission set, you must include all of its metadata to avoid accidentally overwriting the permission set’s contents.

In API version 39.0 and earlier, retrieving or deploying permission set metadata returns only app and system permissions assigned to the permission set. Junction metadata (such as Apex, CRUD) are included only if the metadata for the related component is also included in the package definition.

In API version 29.0 and later, you can retrieve and deploy access settings for these managed components in profiles and permission sets:

For more information, see the Managed Component Access section of [Sample package.xml Manifest Files](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/manifest_samples.htm) in the Metadata API Developer Guide.

## Declarative Metadata File Suffix and Directory Location

Permission sets are stored in the permissionsets directory. The file name matches the permission set API name and the extension is .permissionset. For example, a permission set with the name _User\_Management\_Perms_ is stored in permissionsets/User\_Management\_Perms.permissionset.

## Version

Permission sets are available in API version 22.0 and later.

## Special Access Rules

As of Summer ’20 and later, only users who have one of these permissions can access this type:

- View Setup and Configuration
- Manage Session Permission Set Activations
- Assign Permission Sets
- Manage Profiles and Permission Sets

To view the following settings, assignments, and permissions for standard and custom objects in a specified permission set, the View Setup and Configuration permission is required.

- Client settings
- Field permissions
- Layout assignments
- Object permissions
- Permission dependencies
- Permission set tab settings
- Permission set group components
- Record types

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| agentAccesses | [PermissionSetAgentAccess](#permissionset_agentaccess)\[\] | Indicates which agents are visible to users assigned to this permission set. Available in API version 63.0 and later. |
| applicationVisibilities | [PermissionSetApplicationVisibility](#PermissionSetApplicationVisibility_title)\[\] | Indicates which apps are visible to users assigned to this permission set. Available in API version 29.0 and later. In API version 29.0, this field supports custom apps only. In API version 30.0 and later, this field supports both standard and custom apps. |
| classAccesses | [PermissionSetApexClassAccess](#PermissionSetApexClassAccess_title)\[\] | Indicates which top-level Apex classes have methods that users assigned to this permission set can execute. Available in API version 23.0 and later. |
| customMetadataTypeAccesses | [PermissionSetCustomMetadataTypeAccess](#PermissionSetCustomMetadataTypeAccess_title)\[\] | Indicates the custom metadata types that are read-accessible to a user assigned to this permission set. Available in API version 47.0 and later. |
| customPermissions | [PermissionSetCustomPermissions](#PermissionSetCustomPermissions_title)\[\] | Indicates which custom permissions are available to users assigned to this permission set. Available in API version 31.0 and later. |
| customSettingAccesses | [PermissionSetCustomSettingAccesses](#PermissionSetCustomSettingAccesses_title)\[\] | Indicates the custom settings that are read-accessible to a user assigned to this permission set. Available in API version 47.0 and later. |
| description | string | The permission set description. Limit: 255 characters. |
| emailRoutingAddressAccesses | [PermissionSetEmailRoutingAddressAccess](#PermissionSetEmailRoutingAddressAccess_title)\[\] | Indicates the Email Routing Address permissions that are available to users assigned to a permission set. Available in API version 62.0 and later. |
| externalCredentialPrincipalAccesses | [PermissionSetExternalCredentialPrincipalAccess](#PermissionSetExternalCredentialPrincipalAccess_title)\[\] | Indicates which external credential principals are available to users assigned to this permission set. Available in API version 59.0 and later. |
| externalDataSourceAccesses | [PermissionSetExternal DataSourceAccess](#PermissionSetExternalDataSourceAccess_title)\[\] | Indicates which data sources with identity type of Per User are available to users assigned to this permission set. Available in API version 27.0 and later. |
| fieldPermissions | [PermissionSetFieldPermissions](#PermissionSetFieldPermissions_title)\[\] | Indicates which fields are accessible to a user assigned to this permission set, and the kind of access available (readable or editable). Available in API version 23.0 and later. |
| flowAccesses | [PermissionSetFlowAccess](#PermissionSetFlowAccess_title)\[\] | Indicates which flows can be accessed by a user assigned to this permission set. Available in API version 47.0 and later. |
| hasActivationRequired | boolean | Indicates whether the permission set requires an associated active session (true) or not (false). Available in API version 37.0 and later. |
| label | string | Required. The permission set label. Limit: 80 characters. |
| license | string | Either the related permission set license or the user license associated with this permission set. Available in API version 38.0 and later. Use this field instead of userLicense, which is deprecated and only available up to API Version 37.0. |
| genComputingSummaryDefAccesses | [PermissionSetGenComputingSummaryDefAccess](#PermissionSetGenComputingSummaryDefAccess)\[\] | Indicates the enhanced summary access configuration for users assigned through a permission set. Available in API version 66.0 and later. |
| objectPermissions | [PermissionSetObjectPermissions](#permissionSetObjectPermissions_title)\[\] | Indicates the objects that are accessible to a user assigned to this permission set, and the kind of access available (create, read, edit, delete, and so on). Available in API version 23.0 and later. |
| pageAccesses | [PermissionSetApexPageAccess](#PermissionSetApexPageAccess_title)\[\] | Indicates which Visualforce pages that users assigned to this permission set can execute. Available in API version 23.0 and later. |
| recordTypeVisibilities | [PermissionSetRecordTypeVisibility](#PermissionSetRecordTypeVisibility_title)\[\] | Indicates which record types are visible to users assigned to this permission set. Available in API version 29.0 and later. This field is never retrieved or deployed for inactive record types. |
| ServicePresenceStatusAccesses | [PermissionSetServicePresenceStatusAccess\[\]](#section_w4v_tg4_1fc) | Indicates which Service presence statuses that the user assigned to this profile can execute. Available in API version 64.0 and later. |
| tabSettings | [PermissionSetTabVisibility](#PermissionSetTabVisibility_title)\[\] | Indicates the tab visibility settings for this permission set. Available in API version 26.0 and later. |
| userLicense | string | Deprecated. The user license for the permission set. A user license determines the baseline of features that the user can access. Every user must have exactly one user license. Available up to API version 37.0. In API version 38.0 and later, use license. |
| userPermissions | [PermissionSetUserPermissions](#permissionSetUserPermissions_title)\[\] | Specifies an app or system permission (such as “API Enabled”) and whether it's enabled for this permission set. In API version 28.0 and earlier, this field retrieves all user permissions, enabled or disabled. In API version 29.0 and later, this field retrieves only enabled user permissions. In API Version 40.0 and later, if a permission isn’t specified for a deployment, it’s disabled. |

## PermissionSetAgentAccess

PermissionSetAgentAccess represents the agent access configuration for users assigned through a permission set.

| Field Name | Field Type | Description |
| --- | --- | --- |
| agentName | string | Required. The name of the employee agent. |
| enabled | boolean | Required. Indicates whether users assigned to this permission set can use the Agentforce Employee Agent (true) or not (false). |

## PermissionSetGenComputingSummaryDefAccess

PermissionSetGenComputingSummaryDefAccess represents the enhanced summary access configuration for users assigned through a permission set. Available in API version 66.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| configName | string | Required. Indicates whether the users assigned to this profile can access the enhanced summary configuration (true) or not (false). |
| enabled | boolean | Required. Indicates whether the access configuration is enabled (true) or not (false). |

## PermissionSetApplicationVisibility

[PermissionSetApplicationVisibility](#PermissionSetApplicationVisibility_title) determines whether an app is visible to a user assigned to this permission set.

| Field Name | Field Type | Description |
| --- | --- | --- |
| application | string | Required. The app name. |
| visible | boolean | Required. Indicates whether this app is visible to users assigned to this permission set (true) or not (false). |

## PermissionSetApexClassAccess

[PermissionSetApexClassAccess](#PermissionSetApexClassAccess_title) represents the Apex class access for users assigned to a permission set.

| Field | Field Type | Description |
| --- | --- | --- |
| apexClass | string | Required. The Apex class name. |
| enabled | boolean | Required. Indicates whether users assigned to this permission set can execute methods in the top-level class (true) or not (false). |

## PermissionSetCustomMetadataTypeAccess

[PermissionSetCustomMetadataTypeAccess](#PermissionSetCustomMetadataTypeAccess_title) represents the custom metadata type access for users assigned to a permission set. Available in API version 47.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the records for this custom metadata type are readable (true) or not (false). |
| name | string | Required. The custom metadata type name. |

## PermissionSetCustomPermissions

PermissionSetCustomPermissions represents the custom permissions access for users assigned to a permission set. Only enabled custom permissions are retrieved.

| Field Name | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the custom permission is enabled (true) or not (false). |
| name | string | Required. The custom permission name. |

## PermissionSetCustomSettingAccesses

PermissionSetCustomSettingAccesses represents the custom setting access for users assigned to a permission set. Available in API version 47.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the records for this custom setting are readable (true) or not (false). |
| name | string | Required. The custom setting name. |

## PermissionSetEmailRoutingAddressAccess

PermissionSetEmailRoutingAddressAccess represents the Email Routing Address access for users assigned to a permission set. Only enabled email routing addresses are retrieved.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the custom permission is enabled (true) or not (false). |
| name | string | Required. Represents an organization's Email-to-Case routing address. |

## PermissionSetExternalCredentialPrincipalAccess

[PermissionSetExternalCredentialPrincipalAccess](#PermissionSetExternalCredentialPrincipalAccess_title) represents the access to the external credential’s principals. Users assigned to the permission set can make callouts using a named credential that references the external credential. Available in API version 59.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d737840e1165">Field</th>

              <th class="featureTableHeader  " id="d737840e1168">Field Type</th>

              <th class="featureTableHeader  " id="d737840e1171">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d737840e1165" data-title="Field"><span class="keyword parmname">enabled</span></td>

              <td class="entry" headers="d737840e1168" data-title="Field Type">boolean</td>

              <td class="entry" headers="d737840e1171" data-title="Description">Required. Indicates whether external credential principal access
                is enabled on the permission set (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d737840e1165" data-title="Field"><span class="keyword parmname">externalCredentialPrincipal</span></td>

              <td class="entry" headers="d737840e1168" data-title="Field Type">string</td>

              <td class="entry" headers="d737840e1171" data-title="Description">Required. The name of the external credential and principal,
                separated by a dash. For example, <samp class="codeph nolang">myExternalCredential-myPrincipal</samp>.<p class="p">If the external
                  credential and principal are part of a package, include the
                  package’s namespace prefix with the principal’s name using this
                  format: <samp class="codeph nolang">namespacePrefix__<var class="keyword varname">myExternalCredential-myPrincipal</var></samp>.
                  Use two underscores (__) between the namespace prefix and the
                  external credential principal’s name.</p>

              </td>

            </tr>

          </tbody>

        </table>

## PermissionSetExternalDataSourceAccess

[PermissionSetExternalDataSourceAccess](#PermissionSetExternalDataSourceAccess_title) represents the data source access for users with identity type of Per User. Available in API version 27.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the data source is enabled (true) or not (false). |
| externalDataSource | string | The name of the external data source. |

## PermissionSetFieldPermissions

[PermissionSetFieldPermissions](#PermissionSetFieldPermissions_title) represents the field permissions for users assigned to a permission set. In API version 30.0 and later, permissions for required fields can’t be retrieved or deployed. In API version 54.0 and later, only field permissions enabled in the permission set are returned in queries.

As of API version 38.0, you can change field permissions to make a field editable using the Metadata API for fields that you can't change through the user interface. For example, you can deploy Asset.ProductCode as an editable field even though you can't through the user interface.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If the View All Fields object permission is enabled for an object in the permission set, the individual fields aren't returned under fieldPermissions. However, if you later disable the View All Fields object permission, the fields are returned under fieldPermissions and you can remove access to the fields manually.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d737840e1341">Field</th>

              <th class="featureTableHeader  " id="d737840e1344">Field Type</th>

              <th class="featureTableHeader  " id="d737840e1347">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d737840e1341" data-title="Field"><span class="keyword parmname">editable</span></td>

              <td class="entry" headers="d737840e1344" data-title="Field Type">boolean</td>

              <td class="entry" headers="d737840e1347" data-title="Description">Required. Indicates whether the field can be edited by the users
                assigned to this permission set (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d737840e1341" data-title="Field"><span class="keyword parmname" id="permSetFieldPerms_field"><a name="permSetFieldPerms_field"><!-- --></a>field</span></td>

              <td class="entry" headers="d737840e1344" data-title="Field Type">string</td>

              <td class="entry" headers="d737840e1347" data-title="Description">Required. The API name of the field (such as <samp class="codeph nolang">Warehouse__c.Description__c</samp>).<p class="p">When referencing
                  shared Activity fields, specify Event or Task. For example,
                  <samp class="codeph nolang">Event.Meeting__c</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d737840e1341" data-title="Field"><span class="keyword parmname">readable</span></td>

              <td class="entry" headers="d737840e1344" data-title="Field Type">boolean</td>

              <td class="entry" headers="d737840e1347" data-title="Description">Indicates whether the field can be read by the users assigned to
                this permission set (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>).</td>

            </tr>

          </tbody>

        </table>

## PermissionSetFlowAccess

[PermissionSetFlowAccess](#PermissionSetFlowAccess_title) represents which flows a permission set grants access to. Available in API version 47.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether users assigned this permission set can access the flow (true) or not (false) The default value is false. |
| flow | string | Required. The name of the flow to which access is granted. |

## PermissionSetObjectPermissions

[PermissionSetObjectPermissions](#permissionSetObjectPermissions_title) represents the object permissions for a permission set. Use one of these elements for each permission.

| Field | Field Type | Description |
| --- | --- | --- |
| allowCreate | boolean | Required. Indicates whether the object referenced by the [object](#permSetObjectPerms_object) field can be created by the users assigned to this permission set (true) or not (false). |
| allowDelete | boolean | Required. Indicates whether the object referenced by the [object](#permSetObjectPerms_object) field can be deleted by the users assigned to this permission set (true) or not (false). |
| allowEdit | boolean | Required. Indicates whether the object referenced by the [object](#permSetObjectPerms_object) field can be edited by the users assigned to this permission set (true) or not (false). |
| allowRead | boolean | Required. Indicates whether the object referenced by the [object](#permSetObjectPerms_object) field can be viewed by the users assigned to this permission set (true) or not (false). |
| modifyAllRecords | boolean | Required. Indicates whether all records for the object referenced by the [object](#permSetObjectPerms_object) field can be viewed, edited, or deleted by the users assigned to this permission set (true) or not (false), regardless of the sharing settings for the object. Includes private records (records with no parent object). Similar to the Modify All Data user permission, but limited to the individual object level. |
| object | string | Required. The API name of the object (such as Warehouse\_\_c). |
| viewAllFields | string | Indicates whether all fields and field data for the object referenced by the [object](#permSetObjectPerms_object) field can be viewed by the users assigned to this permission set (true) or not (false). Available in API version 63.0 and later. |
| viewAllRecords | boolean | Required. Indicates whether all records for the object referenced by the [object](#permSetObjectPerms_object) field can be viewed by the users assigned to this permission set (true) or not (false), regardless of the sharing settings for the object. This setting includes private records (records with no parent object). The viewAllRecords field is similar to the View All Data user permission but limited to the individual object level. |

## PermissionSetApexPageAccess

[PermissionSetApexPageAccess](#PermissionSetApexPageAccess_title) represents the Visualforce page access for users assigned to a permission set.

| Field | Field Type | Description |
| --- | --- | --- |
| apexPage | string | Required. The Visualforce page name. |
| enabled | boolean | Required. Indicates whether users assigned to this permission set can execute the Visualforce page (true) or not (false). |

## PermissionSetRecordTypeVisibility

[PermissionSetRecordTypeVisibility](#PermissionSetRecordTypeVisibility_title) represents the visibility of record types for this permission set.

| Field | Field Type | Description |
| --- | --- | --- |
| recordType | string | Required. The record type name, for example Account.MyRecordType. |
| visible | boolean | Required. Indicates whether the record type is visible to users assigned to this permission set (true) or not (false). |

## PermissionSetTabSetting

[PermissionSetTabSetting](#PermissionSetTabVisibility_title) represents the tab settings for a permission set.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d737840e1894">Field</th>

              <th class="featureTableHeader  " id="d737840e1897">Field Type</th>

              <th class="featureTableHeader  " id="d737840e1900">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d737840e1894" data-title="Field"><span class="keyword parmname">tab</span></td>

              <td class="entry" headers="d737840e1897" data-title="Field Type">string</td>

              <td class="entry" headers="d737840e1900" data-title="Description">Required. The tab name.</td>

            </tr>

            <tr>
              <td class="entry" headers="d737840e1894" data-title="Field"><span class="keyword parmname">visibility</span></td>

              <td class="entry" headers="d737840e1897" data-title="Field Type">PermissionSetTabVisibility (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d737840e1900" data-title="Description">Required. Indicates the visibility settings for the tab. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph java">Available</samp>—The tab
                    is available on the All Tabs page. Individual users can
                    customize their display to make the tab visible in any
                    app.
                  </li>

                  <li class="li">
                    <samp class="codeph java">None</samp>—The tab isn’t
                    available on the All Tabs page or visible in any apps.
                  </li>

                  <li class="li">
                    <samp class="codeph java">Visible</samp>—The tab is
                    available on the All Tabs page and appears in the visible
                    tabs for its associated app. Individual users can customize
                    their display to hide the tab or make it visible in other
                    apps.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## PermissionSetUserPermission

In API version 28.0 and earlier, [PermissionSetUserPermission](#permissionSetUserPermissions_title) represents an app or system permission for a permission set. In API version 29.0 and later, this field retrieves only enabled user permissions. Use one of these elements for each permission.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the permission is enabled (true) or disabled (false). |
| name | string | Required. The name of the permission. |

## PermissionSetServicePresenceStatusAccess

Represents the presence statuses that reps assigned to this profile have access. Available in API version 64.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| servicePresenceStatus | string | Required. The name of Service Presence Status. |
| enabled | boolean | Required. Indicates whether the rep assigned to this profile has access to the presence status (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example of a PermissionSet component.

<?xml version="1.0" encoding="UTF-8"?>
<PermissionSet xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Grants all rights needed for an HR administrator to manage employees.</description\>
    <label\>HR Administration</label\>
    <userLicense\>Salesforce</userLicense\>
    <applicationVisibilities\>
        <application\>JobApps\_\_Recruiting</application\>
        <visible\>true</visible\>
    </applicationVisibilities\>
    <userPermissions\>
        <enabled\>true</enabled\>
        <name\>ApiEnabled</name\>
    </userPermissions\>
    <objectPermissions\>
        <allowCreate\>true</allowCreate\>
        <allowDelete\>true</allowDelete\>
        <allowEdit\>true</allowEdit\>
        <allowRead\>true</allowRead\>
        <viewAllRecords\>true</viewAllRecords\>
        <modifyAllRecords\>true</modifyAllRecords\>
        <viewAllFields\>true</viewAllFields\>
        <object\>Job\_Request\_\_c</object\>
    </objectPermissions\>
    <fieldPermissions\>
        <editable\>true</editable\>
        <field\>Job\_Request\_\_c.Salary\_\_c</field\>
        <readable\>true</readable\>
    </fieldPermissions\>
    <pageAccesses\>
        <apexPage\>Job\_Request\_Web\_Form</apexPage\>
        <enabled\>true</enabled\>
    </pageAccesses\>
    <classAccesses\>
      <apexClass\>Send\_Email\_Confirmation</apexClass\>
      <enabled\>true</enabled\>
    </classAccesses\>
    <tabSettings\>
        <tab\>Job\_Request\_\_c</tab\>
        <visibility\>Available</visibility\>
    </tabSettings\>
    <recordTypeVisibilities\>
        <recordType\>Recruiting.DevManager</recordType\>
        <visible\>true</visible\>
    </recordTypeVisibilities\>
</PermissionSet\>

The following is an example package.xml manifest used to retrieve the PermissionSet metadata for an organization. When you retrieve permission sets, also retrieve the related components with assigned permissions. For example, to retrieve objectPermissions and fieldPermissions for a custom object, you must also retrieve the CustomObject component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Job\_Request\_\_c</members\>
        <name\>CustomTab</name\>
    </types\>
    <types\>
        <members\>Job\_Request\_\_c</members\>
        <name\>CustomObject</name\>
    </types\>
    <types\>
        <members\>JobApps\_\_Recruiting</members\>
        <name\>CustomApplication</name\>
    </types\>
    <types\>
        <members\>Recruiting.DevManager</members\>
        <name\>RecordType</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>PermissionSet</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=1d475f5f4975f1c7a83e9121ecc1f7655f04bcbd10ecb0f1ec94b0f079abf2fc url=/legacydeveloper/current/en-us/api_meta/meta_permissionsetgroup.md -->

# PermissionSetGroup

Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Declarative Metadata File Suffix and Directory Location

Permission set groups are stored in the permissionsetgroups directory. The file name matches the permission set API name and the extension is .permissionsetgroup. For example, a permission set group with the name Finance\_Mgmt\_PermSetGroup is stored in permissionsetgroups/Finance\_Mgmt\_PermSetGroup.permissionsetgroup.

## Version

Permission set groups are available in API version 45.0 and later.

## Special Access Rules

As of Summer ’20 and later, to view this type, users must have one of these permissions:

- View Setup and Configuration
- Manage Session Permission Set Activations
- Assign Permission Sets

To edit this type, users must have the Manage Profiles and Permission Sets permission.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d743952e131">Field</th>

              <th class="featureTableHeader  " id="d743952e134">Field Type</th>

              <th class="featureTableHeader  " id="d743952e137">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d743952e131" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d743952e134" data-title="Field Type">string</td>

              <td class="entry" headers="d743952e137" data-title="Description">The permission set group description provided by the permission
                set group creator.</td>

            </tr>

            <tr>
              <td class="entry" headers="d743952e131" data-title="Field"><span class="keyword parmname">hasActivationRequired</span></td>

              <td class="entry" headers="d743952e134" data-title="Field Type">boolean</td>

              <td class="entry" headers="d743952e137" data-title="Description">Indicates whether the permission set group requires an associated
                active session (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value
                is <samp class="codeph nolang">false</samp>. This field is
                available in API version 53.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d743952e131" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d743952e134" data-title="Field Type">string</td>

              <td class="entry" headers="d743952e137" data-title="Description">Required. The permission set group label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d743952e131" data-title="Field"><span class="keyword parmname">mutingPermissionSets</span></td>

              <td class="entry" headers="d743952e134" data-title="Field Type">string</td>

              <td class="entry" headers="d743952e137" data-title="Description">A permission set containing permissions to disable in the
                permission set group. This field is available in API version 46.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d743952e131" data-title="Field"><span class="keyword parmname">permissionSets</span></td>

              <td class="entry" headers="d743952e134" data-title="Field Type">string</td>

              <td class="entry" headers="d743952e137" data-title="Description">A permission set or permission sets included in the permission
                set group.</td>

            </tr>

            <tr>
              <td class="entry" headers="d743952e131" data-title="Field"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d743952e134" data-title="Field Type">string</td>

              <td class="entry" headers="d743952e137" data-title="Description">Indicates permission set group recalculation status. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Updated</samp>—The
                    group is current.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Outdated</samp>—The
                    group requires recalculation.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Updating</samp>—The
                    group is in recalculation mode.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Failed</samp>—The group
                    recalculation failed.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

When adding a permission set group, you can do something like this. Individual permissions are included in the permission set referenced, not in the permission set group.

<?xml version="1.0" encoding="UTF-8"?>
<PermissionSetGroup xmlns="http://soap.sforce.com/2006/04/metadata">
     <fullName\>Finance\_Mgmt\_PermSetGroup</fullName\>
     <description\>Finance\_Mgmt\_PermSetGroup desc</description\>
     <label\>Finance\_Mgmt\_PermSetGroup</label\>
     <permissionSets\>Billing\_PS</permissionSets\>
</PermissionSetGroup\>

The permission set Billing\_PS contains the individual permissions included in Finance\_Mgmt\_PermSetGroup.

<?xml version="1.0" encoding="UTF-8"?>
<PermissionSet xmlns="http://soap.sforce.com/2006/04/metadata">
     <fullName\>Billing\_PS</fullName\>
     <description\>Billing\_PS</description\>
     <label\>Billing\_PS</label\>
     <hasActivationRequired\>false</hasActivationRequired\>
     <license\>Salesforce</license\>
     <userPermissions\>
          <enabled\>true</enabled\>
          <name\>ViewSetup</name\>
     </userPermissions\>
     <userPermissions\>
          <enabled\>true</enabled\>
          <name\>ViewRoles</name\>
     </userPermissions\>
     <userPermissions\>
          <enabled\>true</enabled\>
          <name\>EditBillingInfo</name\>
    </userPermissions\>
</PermissionSet\>

This example package.xml manifest retrieves the PermissionSetGroup metadata for an org. When you retrieve permission set groups, also retrieve the related components. For example, to retrieve PermissionSetGroup, you must also retrieve PermissionSet.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
     <types\>
          <members\>Finance\_Mgmt\_PermSetGroup</members\>
          <name\>PermissionSetGroup</name\>
     </types\>
     <types\>
          <members\>Billing\_PS</members\>
          <name\>PermissionSet</name\>
     </types\>
     <version\>45.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=27f57ddea32acae030dbd2d76f6693bd720c4a64218e457c6f4c513ff9af17f8 url=/legacydeveloper/current/en-us/api_meta/meta_permissionsetlicensedefinition.md -->

# PermissionSetLicenseDefinition

Represents the definition of a custom permission set license, which entitles specified features in a package.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

PermissionSetLicenseDefinition components have the suffix .permissionSetLicenseDefinition and are stored in the permissionSetLicenseDefinitions folder.

## Version

PermissionSetLicenseDefinition components are available in API version 66.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d744684e98">Field Name</th>

              <th class="featureTableHeader  " id="d744684e101">Field Type</th>

              <th class="featureTableHeader  " id="d744684e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d744684e98" data-title="Field Name"><span class="keyword parmname">componentAccess</span></td>

              <td class="entry" headers="d744684e101" data-title="Field Type">enum</td>

              <td class="entry" headers="d744684e104" data-title="Description">Required. How licensed components are accessed. Valid values are: <a name="ul_fyn_5md_tjc"><!-- --></a>
                <ul class="ul bulletList" id="ul_fyn_5md_tjc">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Namespace</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d744684e98" data-title="Field Name"><span class="keyword parmname">customObjects</span></td>

              <td class="entry" headers="d744684e101" data-title="Field Type"><a class="xref" href="#PermissionSetLicenseDefinitionCustomObject">PermissionSetLicenseDefinitionCustomObject</a></td>

              <td class="entry" headers="d744684e104" data-title="Description">A licensed custom object with CRUD access included in the permission set
                license definition. </td>

            </tr>

            <tr>
              <td class="entry" headers="d744684e98" data-title="Field Name"><span class="keyword parmname">customPermissions</span></td>

              <td class="entry" headers="d744684e101" data-title="Field Type"><a class="xref" href="#PermissionSetLicenseDefinitionCustomPermission">PermissionSetLicenseDefinitionCustomPermission</a></td>

              <td class="entry" headers="d744684e104" data-title="Description">An array of licensed custom permissions included in the permission set license
                definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d744684e98" data-title="Field Name"><span class="keyword parmname">defaultTrialLengthInDays</span></td>

              <td class="entry" headers="d744684e101" data-title="Field Type">int</td>

              <td class="entry" headers="d744684e104" data-title="Description">Required. Default trial length in days.</td>

            </tr>

            <tr>
              <td class="entry" headers="d744684e98" data-title="Field Name"><span class="keyword parmname">defaultTrialLicenseCount</span></td>

              <td class="entry" headers="d744684e101" data-title="Field Type">int</td>

              <td class="entry" headers="d744684e104" data-title="Description">Required. Default number of trial licenses provisioned for a trial.</td>

            </tr>

            <tr>
              <td class="entry" headers="d744684e98" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d744684e101" data-title="Field Type">string</td>

              <td class="entry" headers="d744684e104" data-title="Description">Required. The name of the permission set license definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d744684e98" data-title="Field Name"><span class="keyword parmname">licenseExpirationPolicy</span></td>

              <td class="entry" headers="d744684e101" data-title="Field Type">LicenseExpirationPolicy (enumeration of type string)</td>

              <td class="entry" headers="d744684e104" data-title="Description">The license expiration policy of the custom permission set license. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">BlockNamespaceAccess</samp>—Package
                    access is blocked for existing users when all custom permission set licenses
                    expire. This is the default value.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AllowNamespaceAccess</samp>—Package
                    access isn’t blocked for existing users when all custom permission set licenses
                    expire.
                  </li>

                </ul>
                This field is available in API version 55.0 through 64.0. Removed in API
                version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d744684e98" data-title="Field Name"><span class="keyword parmname">userLicenseRestrictions</span></td>

              <td class="entry" headers="d744684e101" data-title="Field Type">string</td>

              <td class="entry" headers="d744684e104" data-title="Description">The user license categories that can be assigned the custom permission set
                license. If no user license categories are specified, all users can be assigned the
                license. Possible values include:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">${communities}</samp></li>

                  <li class="li"><samp class="codeph nolang">${communitiesLogin}</samp></li>

                  <li class="li"><samp class="codeph nolang">${customerCommunities}</samp></li>

                  <li class="li"><samp class="codeph nolang">${customerCommunitiesLogin}</samp></li>

                  <li class="li"><samp class="codeph nolang">${internal}</samp></li>

                  <li class="li"><samp class="codeph nolang">${partnerCommunity}</samp></li>

                  <li class="li"><samp class="codeph nolang">${partnerCommunityLogin}</samp></li>

                  <li class="li"><samp class="codeph nolang">${platform}</samp></li>

                </ul>
                <p class="p">For more information, see <a class="xref" href="https://developer.salesforce.com/docs/platform/isvforce/guide/gtm-app-psl-understand.html" target="_blank">Understand Permission Set
                    Licenses</a></p>
              </td>

            </tr>

          </tbody>

        </table>

## PermissionSetLicenseDefinitionCustomObject

Represents one licensed custom object and the CRUD permissions the license grants.

| Field Name | Field Type | Description |
| --- | --- | --- |
| allowCreate | boolean | Allows created access. |
| allowDelete | boolean | Allows delete access. |
| allowRead | boolean | Allows read access. |
| allowUpdate | boolean | Allows update access. |
| name | string | Required. The label of the licenced custom object. Must include the \_\_c suffix in the metadata. For example: Widget\_\_c. The value is stored internally without the suffix, with the value added on retrieve. |

## PermissionSetLicenseDefinitionCustomPermission

Represents a licensed custom permission included in the permission set license definition.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Label of the licensed custom permission. This field must be a reference to a [CustomPermission](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_custompermission.htm "Represents a permission that grants access to a custom feature. This type extends the Metadata metadata type and inherits its fullName field.") that has the isLicensed field set to true. |

## Declarative Metadata Sample Definition

The following is an example of a PermissionSetLicenseDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<PermissionSetLicenseDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <componentAccess\>Namespace</componentAccess\>
    <customObjects\>
        <allowCreate\>false</allowCreate\>
        <allowDelete\>false</allowDelete\>
        <allowRead\>true</allowRead\>
        <allowUpdate\>false</allowUpdate\>
        <name\>Widget\_\_c</name\>
    </customObjects\>
    <defaultTrialLengthInDays\>30</defaultTrialLengthInDays\>
    <defaultTrialLicenseCount\>10</defaultTrialLicenseCount\>
    <label\>Base</label\>
    <userLicenseRestrictions\>${internal}</userLicenseRestrictions\>
</PermissionSetLicenseDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PermissionSetLicenseDefinition</name\>
    </types\>
    <version\>66.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=8fa860b6b364e5bf380bf81410a1c0f64f927c4b43d5aebad2e31b2a16959413 url=/legacydeveloper/current/en-us/api_meta/meta_personaccountownerpoweruser.md -->

# PersonAccountOwnerPowerUser

Represents a user who can own more than 50,000 customer or partner portal accounts. Person account owner power users can own a large number of either customer or partner users. They can’t change their role, look up to a parent role, or reparent their role. Person account owner power user objects can't be created if deferred sharing is turned on for your org. This object is available in API version 57.0 and later.

## Version

PersonAccountOwnerPowerUser components are available in API version 57.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| developerName | 
Field Type

string

Description

Required. The unique name of the object in the API.



 |
| masterLabel | 

Field Type

string

Description

Required. The label entered when the person account owner power user is created.



 |
| portalType | 

Field Type

string

Description

Required. The type of portal user account that the person account owner power user can own.

Possible values are:

- CustomerPortal—Customer Portal
- Partner—Partner Portal





 |
| user | 

Field Type

string

Description

Required. The unique ID associated with the person account owner power user.



 |

<!-- document id=3495d156eb3da863528ae4d4f74bfdf7cc4eeb38b231fc0e16051e81fa605591 url=/legacydeveloper/current/en-us/api_meta/meta_picklist.md -->

# Picklist (Including Dependent Picklist)

Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.

## Version

Use this type in API version 37.0 and earlier only. Picklists for custom fields in custom objects are available in API version 12.0 and later. Picklists for custom or standard fields in standard objects, such as accounts, are available in API version 16.0 and later.

In API version 38.0 and later, Picklist is replaced by [ValueSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm#valueSet) on the CustomField type.

## Declarative Metadata File Suffix and Directory Location

Picklist definitions are included in the custom object and field with which they’re associated.

## Fields

Picklist contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d746444e87">Field Name</th>

              <th class="featureTableHeader  " id="d746444e90">Field Type</th>

              <th class="featureTableHeader  " id="d746444e93">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d746444e87" data-title="Field Name"><span class="keyword parmname">controllingField</span></td>

              <td class="entry" headers="d746444e90" data-title="Field Type">string</td>

              <td class="entry" headers="d746444e93" data-title="Description">The <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#field_fullName"><span class="keyword parmname">fullName</span></a> of the
                controlling field if <span class="keyword parmname">controllingField</span> is a
                dependent picklist. A dependent picklist works in conjunction with a
                controlling picklist or checkbox to filter the available options.
                The value chosen in the controlling field affects the values
                available in the dependent field. This field is available in API
                version 14.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d746444e87" data-title="Field Name"><span class="keyword parmname">picklistValues</span></td>

              <td class="entry" headers="d746444e90" data-title="Field Type">PicklistValue[]</td>

              <td class="entry" headers="d746444e93" data-title="Description">
                <p class="p">Required. Represents a set of values for a picklist.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d746444e87" data-title="Field Name"><span class="keyword parmname">restrictedPicklist</span></td>

              <td class="entry" headers="d746444e90" data-title="Field Type">boolean</td>

              <td class="entry" headers="d746444e93" data-title="Description">
                <span class="ph" id="Picklist_restrictedPicklist_descr"><a name="Picklist_restrictedPicklist_descr"><!-- --></a>Indicates whether the
                  picklist’s value list is restricted. With a restricted picklist,
                  only an admin can add or change values; users can’t load or
                  remove values through the API. By default this value is <samp class="codeph nolang">false</samp>.</span>
                <p class="p">This field is
                  available in API version 37.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d746444e87" data-title="Field Name"><span class="keyword parmname">sorted</span></td>

              <td class="entry" headers="d746444e90" data-title="Field Type">boolean</td>

              <td class="entry" headers="d746444e93" data-title="Description">
                <p class="p">Indicates whether values are sorted (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>). By default this value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Java Sample

The following sample uses a picklist. For a complete sample of using a picklist with record types and profiles, see [Profile](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm "Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field.").

public void setPicklistValues() {
  // Create a picklist
  Picklist expenseStatus = new Picklist();
  PicklistValue unsubmitted = new PicklistValue();
  unsubmitted.setFullName("Unsubmitted");
  PicklistValue submitted = new PicklistValue();
  submitted.setFullName("Submitted");
  PicklistValue approved = new PicklistValue();
  approved.setFullName("Approved");
  PicklistValue rejected = new PicklistValue();
  rejected.setFullName("Rejected");
  expenseStatus.setPicklistValues(new PicklistValue\[\]
      {unsubmitted, submitted, approved, rejected});
  
  CustomField expenseStatusField = new CustomField();
  expenseStatusField.setFullName(
      "ExpenseReport\_\_c.ExpenseStatus\_\_c");
  expenseStatusField.setLabel("Expense Report Status");
  expenseStatusField.setType(FieldType.Picklist);
  expenseStatusField.setPicklist(expenseStatus);
  try {
    AsyncResult\[\] ars =
    metadataConnection.create(new Metadata\[\] {expenseStatusField});
  } catch (ConnectionException ce) {
    ce.printStackTrace();
  }
}

## Declarative Metadata Sample Definition

The following sample shows usage for picklists, including dependent picklists, in a custom object. The isAmerican\_\_c checkbox controls the list of manufacturers shown in the manufacturer\_\_c picklist. The manufacturer\_\_c checkbox in turn controls the list of models shown in the model\_\_c picklist.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <deploymentStatus\>Deployed</deploymentStatus\>
    <enableActivities\>true</enableActivities\>
    <fields\>
        <fullName\>isAmerican\_\_c</fullName\>
        <defaultValue\>false</defaultValue\>
        <label\>American Only</label\>
        <type\>Checkbox</type\>
    </fields\>
    <fields\>
        <fullName\>manufacturer\_\_c</fullName\>
        <label\>Manufacturer</label\>
        <picklist\>
            <controllingField\>isAmerican\_\_c</controllingField\>
            <picklistValues\>
                <fullName\>Chrysler</fullName\>
                <controllingFieldValues\>checked</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Ford</fullName\>
                <controllingFieldValues\>checked</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Honda</fullName\>
                <controllingFieldValues\>unchecked</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Toyota</fullName\>
                <controllingFieldValues\>unchecked</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <sorted\>false</sorted\>
        </picklist\>
        <type\>Picklist</type\>
    </fields\>
    <fields\>
        <fullName\>model\_\_c</fullName\>
        <label\>Model</label\>
        <picklist\>
            <controllingField\>manufacturer\_\_c</controllingField\>
            <picklistValues\>
                <fullName\>Mustang</fullName\>
                <controllingFieldValues\>Ford</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Taurus</fullName\>
                <controllingFieldValues\>Ford</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>PT Cruiser</fullName\>
                <controllingFieldValues\>Chrysler</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Pacifica</fullName\>
                <controllingFieldValues\>Chrysler</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Accord</fullName\>
                <controllingFieldValues\>Honda</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Civic</fullName\>
                <controllingFieldValues\>Honda</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Prius</fullName\>
                <controllingFieldValues\>Toyota</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Camry</fullName\>
                <controllingFieldValues\>Toyota</controllingFieldValues\>
                <default\>false</default\>
            </picklistValues\>
            <sorted\>false</sorted\>
        </picklist\>
        <type\>Picklist</type\>
    </fields\>
....
</CustomObject\>

The following sample shows usage for the standard Stage field in opportunities.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <fields\>
        <fullName\>StageName</fullName\>
        <picklist\>
            <picklistValues\>
                <fullName\>Prospecting</fullName\>
                <default\>false</default\>
                <forecastCategory\>Pipeline</forecastCategory\>
                <probability\>10</probability\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Qualification</fullName\>
                <default\>false</default\>
                <forecastCategory\>Pipeline</forecastCategory\>
                <probability\>10</probability\>
            </picklistValues\>
            <picklistValues\>
                <fullName\>Needs Analysis</fullName\>
                <default\>false</default\>
                <forecastCategory\>Pipeline</forecastCategory\>
                <probability\>20</probability\>
            </picklistValues\>
            ...
        </picklist\>
    </fields\>
<CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/namedfilter.htm "NamedFilter")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profilesearchlayouts.htm "ProfileSearchLayouts")

<!-- document id=132b457822dcc4cd491874c9d1b47275414e9103a14d29fd8997799e85e844ea url=/legacydeveloper/current/en-us/api_meta/meta_picklistsettings.md -->

# PicklistSettings

Represents an org’s picklist settings. These settings control the behavior of a picklist. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

PicklistSettings values are stored in a single file named Picklist.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

Picklist settings are available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| isPicklistApiNameEditDisabled | boolean | While true, users, including admins with Customize Application permission, can’t change the API name of a picklist field. Formulas reference a picklist’s API name so that the formula continues to work even if the displayed name value changes. Prevent changes to the API name to protect the references to fields in formulas or during integrations, such as during a data import. The default is false. |

## Declarative Metadata Sample Definition

The following is a sample picklist.settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>
<PicklistSettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <isPicklistApiNameEditDisabled\>true</isPicklistApiNameEditDisabled\>
</PicklistSettings\>

The following is an example package.xml manifest that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>Picklist</members\>
		<name\>Settings</name\>
	</types\>
	<version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6008b40d6e7b39ccccdfdefa9e3a17e24078c902b9204584b3aeae2788af5381 url=/legacydeveloper/current/en-us/api_meta/meta_pipelineinspmetricconfig.md -->

# PipelineInspMetricConfig

Represents the settings of Pipeline Inspection forecast category metrics.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

PipelineInspMetricConfig components have the suffix .pipelineInspMetricConfig and are stored in the pipelineInspMetricConfigs folder.

## Version

PipelineInspMetricConfig components are available in API version 57.0 and later.

## Special Access Rules

Only users with the Customize Application or Modify All Data permission can access this type.

## Fields

| Field Name | Description |
| --- | --- |
| isCumulative | 
Field Type

boolean

Description

Required. Read only. Indicates whether the metric is cumulative (true) or not (false). The default value is true.





 |
| isProtected | 

Field Type

boolean

Description

Indicates whether the component is protected (true) or not (false). The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. Customized label of the Pipeline Inspection metric. Limit: 50 characters.





 |
| metric | 

Field Type

PipelineInspectionMetric (enumeration of type string)

Description

Required. The Pipeline Inspection metric. Possible values are:

- BestCase (available in API version 58.0 and later)
- ClosedLost (available in API version 58.0 and later)
- ClosedWon (available in API version 58.0 and later)
- Commit (available in API version 58.0 and later)
- MostLikely (available in API version 58.0 and later)
- OpenPipeline (available in API version 58.0 and later)
- TotalPipeline (available in API version 58.0 and later)





 |

## Declarative Metadata Sample Definition

The following is an example of a PipelineInspMetricConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<PipelineInspMetricConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <isCumulative\>true</isCumulative\>
    <isProtected\>false</isProtected\>
    <masterLabel\>Lost the opportunity</masterLabel\>
    <metric\>ClosedLost</metric\>

</PipelineInspMetricConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PipelineInspMetricConfig</name\>
    </types\>
    <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=abe4b2442f41b628db89e3a29e9c501ee588a67d430e86dbd4a86d864be057d6 url=/legacydeveloper/current/en-us/api_meta/meta_platformcachepartition.md -->

# PlatformCachePartition

Represents a partition in the Platform Cache. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

PlatformCachePartition components have the suffix .cachePartition and are stored in the cachePartitions folder.

## Version

PlatformCachePartition components are available in API version 35.0 and later.

## Special Access Rules

The “Author Apex” permission is required to deploy and retrieve PlatformCachePartition components.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Describes the cache partition. |
| isDefaultPartition | boolean | Required. Indicates whether this cache partition is the default partition in your organization (true) or not (false). |
| masterLabel | string | Required. The label of the cache partition that appears in the Salesforce user interface. |
| platformCachePartitionTypes | [PlatformCachePartitionType](#PlatformCachePartitionType)\[\] | An array of cache types that the partition can store. |

## PlatformCachePartitionType

Contains information about a partition type, including its minimum and allocated capacity.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d748003e199">Field Name</th>

              <th class="featureTableHeader  " id="d748003e202">Field Type</th>

              <th class="featureTableHeader  " id="d748003e205">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d748003e199" data-title="Field Name"><span class="keyword parmname" id="meta_pc_allocated"><a name="meta_pc_allocated"><!-- --></a>allocatedCapacity</span></td>

              <td class="entry" headers="d748003e202" data-title="Field Type">int</td>

              <td class="entry" headers="d748003e205" data-title="Description">Required. The total storage capacity, in megabytes (MB), that is allocated for
                the cache type, including free, purchased, and trial cache. Purchased capacity
                includes organization-wide cache, which can be used in any partition, and
                namespace-specific cache, which can be used only in partitions associated with a
                namespace.</td>

            </tr>

            <tr>
              <td class="entry" headers="d748003e199" data-title="Field Name"><span class="keyword parmname" id="meta_pc_allocated_partner"><a name="meta_pc_allocated_partner"><!-- --></a>allocatedPartnerCapacity</span></td>

              <td class="entry" headers="d748003e202" data-title="Field Type">int</td>

              <td class="entry" headers="d748003e205" data-title="Description">Required. Free capacity, in megabytes (MB). allocated to Developer Edition orgs
                for the cache type. Use this capacity with security-reviewed managed packages.
                Available in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d748003e199" data-title="Field Name"><span class="keyword parmname" id="meta_pc_allocated_purchased"><a name="meta_pc_allocated_purchased"><!-- --></a>allocatedPurchasedCapacity</span></td>

              <td class="entry" headers="d748003e202" data-title="Field Type">int</td>

              <td class="entry" headers="d748003e205" data-title="Description">Required. <span class="ph" id="meta_pc_allocated_purchased_desc"><a name="meta_pc_allocated_purchased_desc"><!-- --></a>The amount of
                  namespace-specific purchased storage capacity, in MB, that is allocated for the
                  cache type.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d748003e199" data-title="Field Name"><span class="keyword parmname" id="meta_pc_allocated_trial"><a name="meta_pc_allocated_trial"><!-- --></a>allocatedTrialCapacity</span></td>

              <td class="entry" headers="d748003e202" data-title="Field Type">int</td>

              <td class="entry" headers="d748003e205" data-title="Description">Required. <span class="ph" id="meta_pc_allocated_trial_desc"><a name="meta_pc_allocated_trial_desc"><!-- --></a>The amount of trial cache
                  space, in MB, that is allocated for the cache type.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d748003e199" data-title="Field Name"><span class="keyword parmname">cacheType</span></td>

              <td class="entry" headers="d748003e202" data-title="Field Type">PlatformCacheType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d748003e205" data-title="Description">The type of cache. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Session</samp>—Session cache
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Organization</samp>—Org cache
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a PlatformCachePartition component.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformCachePartition xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Custom partition and marked as default.</description\>
    <isDefaultPartition\>true</isDefaultPartition\>
    <masterLabel\>myPartition</masterLabel\>
    <platformCachePartitionTypes\>
   ​​     <​allocatedCapacity>10</​allocatedCapacity>
​​        <​​allo​ca​tedPurchasedCapacity>5</​​allo​ca​tedPurchasedCapacity>
        <cacheType\>Session</cacheType\>
    </platformCachePartitionTypes\>
    <platformCachePartitionTypes\>
    ​​    <​allocatedCapacity>5</​allocatedCapacity>
​​        <​​allo​ca​tedPurchasedCapacity>5</​​allo​ca​tedPurchasedCapacity>
        <cacheType\>Organization</cacheType\>
    </platformCachePartitionTypes\>​
</PlatformCachePartition\> 

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>myPartition</members\>
        <name\>PlatformCachePartition</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

If a namespace is defined in your organization, add the namespace prefix to your partition name. For example:

<members\>Namespace.myPartition</members\>

To retrieve all cache partitions from your organization, use the wildcard character (\*) as follows.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PlatformCachePartition</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ca74cfd0712ac122722ef671f9420007cc86485366d8e84c400bdf60f2832b67 url=/legacydeveloper/current/en-us/api_meta/meta_platformencryptionsettings.md -->

# PlatformEncryptionSettings

Represents an org’s Platform Encryption settings, such as settings for available encryption schemes, permissions, encryption policy access, and which fields can be encrypted. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

PlatformEncryptionSettings values are stored in the PlatformEncryption.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

PlatformEncryptionSettings is available in API versions 47.0 and later.

## Special Access Rules

To enable and disable PlatformEncryptionSettings attributes, you need the Customize Application permission. Attributes that allow key management tasks require the Manage Encryption Keys permission. For a complete list of required permissions, read [Which User Permissions Does Shield Platform Encryption Require?](https://developer.salesforce.com/docs/atlas.en-us.264.0.securityImplGuide.meta/securityImplGuide/security_pe_permissions.htm#! "HTML (New Window)").

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| canEncryptManagedPackageFields | boolean | Indicates whether users can enable encryption on custom fields in installed managed packages (true) or not (false). |
| isUseHighAssuranceKeysRequired | boolean | This field is for internal use. |
| isMEKForEncryptionRequired | boolean | Indicates whether encryption policy tasks, such as enabling encryption on fields, also require the Manage Encryption Keys permission (true) or not (false), in addition to those tasks’ baseline permissions. |
| enableDeterministicEncryption | boolean | Indicates whether customers apply the deterministic encryption scheme to supported fields (true) or not (false). The deterministic encryption scheme lets customers filter on encrypted data. |
| enableEncryptFieldHistory | boolean | Indicates whether the background encryption process applies the customer's active key material to field history and feed tracking values (true) or not (false). The default value is false. If false, background encryption processes apply active key material to all encrypted data except duplicates of that data stored in field history or feed tracking. |
| enableEventBusEncryption | boolean | This field is for internal use. |

## Declarative Metadata Sample Definition

The following is an example of the PlatformEncryption.settings file:

<?xml version="1.0" encoding="UTF-8"  standalone="yes"?>
<PlatformEncryptionSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <canEncryptManagedPackageFields\>true</canEncryptManagedPackageFields\>
    <isUseHighAssuranceKeysRequired\>true</isUseHighAssuranceKeysRequired\>
    <isMEKForEncryptionRequired\>true</isMEKForEncryptionRequired\>
    <enableDeterministicEncryption\>true</enableDeterministicEncryption\>
    <enableEncryptFieldHistory\>true</enableEncryptFieldHistory\></PlatformEncryptionSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Platform Encryption settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>PlatformEncryption</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=f443c7b1c0c21d94c1f6934eed2248f9f109d1d841b1792fc2d43e006eb33331 url=/legacydeveloper/current/en-us/api_meta/meta_platformeventchannel.md -->

# PlatformEventChannel

Represents a channel that you can subscribe to in order to receive a stream of events. In API version 46.0 and earlier, it is the default standard channel for change data capture events. In API version 47.0 and later, it is a custom channel for change data capture events.

The default standard channel corresponds to the entity selection in the Change Data Capture page in Setup. A custom channel is a channel that you define using this metadata type. Starting in API version 47.0, the channel doesn’t contain the selected entities, which are represented each by PlatformEventChannelMember. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

PlatformEventChannel components have the suffix .platformEventChannel and are stored in the platformEventChannels folder.

## Version

PlatformEventChannel components are available in API version 45.0 and later.

## Special Access Rules

You must have the Customize Application permission to deploy and retrieve this type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d749625e105">Field Name</th>

              <th class="featureTableHeader  " id="d749625e108">Field Type</th>

              <th class="featureTableHeader  " id="d749625e111">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d749625e105" data-title="Field Name"><span class="keyword parmname">channelMembers</span></td>

              <td class="entry" headers="d749625e108" data-title="Field Type">
                <a class="xref" href="#PlatformEventChannelSelectedEntity">PlatformEventChannel​SelectedEntity</a>[]
              </td>

              <td class="entry" headers="d749625e111" data-title="Description">Removed. A list of event names of entities, including standard
                and custom objects, selected for Change Data Capture
                notifications.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>This field is removed in API version 47.0
                            and later and is available only in API versions 45.0 and 46.0.
                            In API version 47.0 and later, the channel members are each
                            defined in a PlatformEventChannelMember
                            component.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d749625e105" data-title="Field Name"><span class="keyword parmname">channelType</span></td>

              <td class="entry" headers="d749625e108" data-title="Field Type">PlatformEventChannel​Type (enumeration of type
                string)</td>

              <td class="entry" headers="d749625e111" data-title="Description">Required. The channel type. Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">data</samp>—Change Data
                    Capture channel corresponding to the selected entities.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">event</samp>—A channel
                    that contains platform events.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d749625e105" data-title="Field Name"><span class="keyword parmname">eventType</span></td>

              <td class="entry" headers="d749625e108" data-title="Field Type">PlatformEventChannel​EventType (enumeration of type
                string)</td>

              <td class="entry" headers="d749625e111" data-title="Description">The type of events that the channel can hold. A channel can hold
                only one type of events. Use this field to optionally specify a
                specific type of events for a channel in combination with the
                <span class="keyword parmname">channelType</span> field. Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">custom</samp>—The
                    channel contains custom platform events. This value is valid
                    with the <span class="keyword parmname">channelType</span> of <samp class="codeph nolang">event</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">data</samp>—The channel
                    contains change data capture events. This value is valid
                    with the <span class="keyword parmname">channelType</span> of <samp class="codeph nolang">data</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">monitoring</samp>—The
                    channel contains Real-Time Event Monitoring events. This
                    value is valid with the <span class="keyword parmname">channelType</span> of
                    <samp class="codeph nolang">event</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">standard</samp>—Reserved for internal use.
                  </li>

                </ul>
                <p class="p">Available in API version 61.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d749625e105" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d749625e108" data-title="Field Type">string</td>

              <td class="entry" headers="d749625e111" data-title="Description">Required. The channel label.</td>

            </tr>

          </tbody>

        </table>

## PlatformEventChannelSelectedEntity

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field type is removed in API version 47.0 and later and is available only in API versions 45.0 and 46.0.

| Field Name | Field Type | Description |
| --- | --- | --- |
| selectedEntity | string | Required. The event name of an entity selected for Change Data Capture notifications. For example, for the Account standard object, the name is AccountChangeEvent, or for a custom object MyObject\_\_c, the name is MyObject\_\_ChangeEvent. |

## Usage

The [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") and [deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm "Deletes one or more metadata components from your organization synchronously.") calls aren’t supported with the PlatformEventChannel metadata type.

In API version 47.0 and later, you can’t deploy or retrieve the ChangeEvents standard channel.

You can't delete the ChangeEvents standard channel with destructiveChanges.xml, but you can delete channel members using the PlatformEventChannelMember type with destructiveChanges.xml.

You can delete a custom channel with destructiveChanges.xml. If you delete a custom channel, all its member PlatformEventChannelMember components are also deleted.

You can update only the fullName field and the label field of a PlatformEventChannel component.

## Declarative Metadata Sample Definition for a Custom Channel

The PlatformEventChannel component contains the label of the custom channel and the channel type.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventChannel xmlns="http://soap.sforce.com/2006/04/metadata">
    <channelType\>data</channelType\>
    <label\>Custom Channel for Sales Events</label\>
</PlatformEventChannel\>

This package.xml references the previous definition. The custom channel name is SalesEvents\_\_chn.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>SalesEvents\_\_chn</members\>
        <name\>PlatformEventChannel</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

## Wildcard Support in the Manifest File

To deploy or retrieve all custom channels, specify the wildcard character \* (asterisk) in the <members> field.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PlatformEventChannel</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

## Upgrading to Version 47.0 or Later From an Earlier Version

The channelMembers field of the PlatformEventChannel type is removed in API version 47.0 and later. As a result, PlatformEventChannel components created in prior versions can’t be deployed using a later API version but you can deploy them in the same API version they were created with.

To deploy a custom channel component using API version 47.0 and later, upgrade the PlatformEventChannel definition by removing the <channelMembers> fields. For the ChangeEvents standard channel, it can’t be deployed or retrieved, so delete the PlatformEventChannel definition file.

For example, if you had custom channel called SalesEvents\_\_chn, this could be your custom channel definition in API version 46.0.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventChannel xmlns="http://soap.sforce.com/2006/04/metadata">
    <channelMembers\>
        <selectedEntity\>AccountChangeEvent</selectedEntity\>
    </channelMembers\>
    <channelMembers\>
        <selectedEntity\>ContactChangeEvent</selectedEntity\>
    </channelMembers\>
    <channelType\>data</channelType\>
    <label\>Sales Events</label\>
</PlatformEventChannel\>

To upgrade to version 47.0 or later, you would replace the custom channel definition with this definition, which doesn’t contain any channel members.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventChannel xmlns="http://soap.sforce.com/2006/04/metadata">
    <channelType\>data</channelType\>
    <label\>SalesEvents\_\_chn</label\>
</PlatformEventChannel\>

For each channel member that is part of either a custom or the standard ChangeEvents channel, add a PlatformEventChannelMember metadata component. Also, in the package.xml file, reference both the PlatformEventChannel and PlatformEventChannelMember components.

For example, this PlatformEventChannelMember component is for the AccountChangeEvent member.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
    <eventChannel\>SalesEvents\_\_chn</eventChannel\>
    <selectedEntity\>AccountChangeEvent</selectedEntity\>
</PlatformEventChannelMember\>

For more information, see [PlatformEventChannelMember](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformeventchannelmember.htm "Represents an entity selected for Change Data Capture notifications on a standard or custom channel, or a platform event selected on a custom channel.").

For an example of a custom channel that holds custom platform events and Real-Time Event Monitoring events, see [Group Platform Events into One Stream with a Custom Channel](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_subscribe_custom_channels.htm) in the Platform Events Developer Guide.

#### See Also

- [_Change Data Capture Developer Guide_: Subscription Channels](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_subscribe_channels.htm "Change Data Capture Developer Guide: Subscription
    Channels - HTML (New Window)")
- [_Change Data Capture Developer Guide_: Compose Streams of Change Data Capture Notifications with Custom Channels](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_custom_channel.htm "Change Data Capture Developer Guide: Compose
    Streams of Change Data Capture Notifications with Custom
    Channels - HTML (New Window)")
- [PlatformEventChannelMember](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformeventchannelmember.htm "Represents an entity selected for Change Data Capture notifications on a standard or custom channel, or a platform event selected on a custom channel.")

<!-- document id=f0ed2d882507412bd7e15dbb62aa6b2e0464340158e49b12bf10df9af2fe1b80 url=/legacydeveloper/current/en-us/api_meta/meta_platformeventchannelmember.md -->

# PlatformEventChannelMember

Represents an entity selected for Change Data Capture notifications on a standard or custom channel, or a platform event selected on a custom channel.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

PlatformEventChannelMember components have the suffix .platformEventChannelMember and are stored in the platformEventChannelMembers folder.

## Version

PlatformEventChannelMember components are available in API version 47.0 and later.

## Special Access Rules

You must have the Customize Application permission to deploy and retrieve this type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d750621e105">Field Name</th>

              <th class="featureTableHeader  " id="d750621e108">Field Type</th>

              <th class="featureTableHeader  " id="d750621e111">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d750621e105" data-title="Field Name"><span class="keyword parmname">enrichedFields</span></td>

              <td class="entry" headers="d750621e108" data-title="Field Type">
                <a class="xref" href="#EnrichedField">EnrichedField</a>[]
              </td>

              <td class="entry" headers="d750621e111" data-title="Description">One or more fields selected for Change Data Capture Enrichment. A non-empty
                enriched field is added to an update or delete change event even when not changed.
                For more information, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_enrich_intro.htm" target="_blank" title="HTML (New Window)">Enrich Change Events with
                  Extra Fields When Subscribed with CometD</a> in the <cite class="cite">Change Data Capture
                  Developer Guide</cite>. Available in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d750621e105" data-title="Field Name"><span class="keyword parmname">eventChannel</span></td>

              <td class="entry" headers="d750621e108" data-title="Field Type">string</td>

              <td class="entry" headers="d750621e111" data-title="Description">Required. The name of a channel. For the standard channel, the name is <samp class="codeph nolang">ChangeEvents</samp>. For a custom channel, the name is in
                this format: <samp class="codeph nolang"><var class="keyword varname">MyChannel</var>__chn</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d750621e105" data-title="Field Name"><span class="keyword parmname">filterExpression</span></td>

              <td class="entry" headers="d750621e108" data-title="Field Type">string</td>

              <td class="entry" headers="d750621e111" data-title="Description">
                <p class="p">An expression that is used to filter the stream of events and deliver only the
                  events that match specific criteria. The filter expression can contain one or more
                  field-value expressions. The filter expression format is based on SOQL and
                  supports a subset of SOQL operators and field types.</p>

                <p class="p">For example, this filter expression delivers only events that contain the City__c
                  field with a value of 'San Francisco'. <samp class="codeph nolang">City__c = 'San
                    Francisco'</samp></p>

                <p class="p">For more information, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_filter_section.htm" target="_blank" title="HTML (New Window)">Filter Your Stream of
                    Platform Events with Custom Channels </a> in the <cite class="cite">Platform Events
                    Developer Guide</cite> and <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/cdc_filter_section.htm" target="_blank" title="HTML (New Window)">Filter
                    Your Stream of Change Events with Channels</a> in the <cite class="cite">Change Data
                    Capture Developer Guide</cite>. Available in API version 56.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d750621e105" data-title="Field Name"><span class="keyword parmname">selectedEntity</span></td>

              <td class="entry" headers="d750621e108" data-title="Field Type">string</td>

              <td class="entry" headers="d750621e111" data-title="Description">Required. The change event name of an entity selected for Change Data Capture
                notifications. For example, for the Account standard object, the name is <samp class="codeph nolang">AccountChangeEvent</samp>, or for a custom object
                MyObject__c, the name is <samp class="codeph nolang">MyObject__ChangeEvent</samp>.</td>

            </tr>

          </tbody>

        </table>

## EnrichedField

A field selected on PlatformEventChannelMember for Change Data Capture Enrichment. A non-empty enriched field is added to an update or delete change event even when not changed.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | The name of a field selected to enrich change events with. |

## Usage

The [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") and [deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm "Deletes one or more metadata components from your organization synchronously.") calls aren’t supported with the PlatformEventChannelMember metadata type.

To delete a channel member from a channel, deploy destructiveChanges.xml for this type and specify the full name of the member.

## Declarative Metadata Sample Definition

This PlatformEventChannelMember component represents the selection of the Lead change event as part of the Change Data Capture selections (the standard ChangeEvents channel).

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
    <eventChannel\>ChangeEvents</eventChannel\>
    <selectedEntity\>LeadChangeEvent</selectedEntity\>
</PlatformEventChannelMember\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The file name of the example component is ChangeEvents\_LeadChangeEvent.platformEventChannelMember. The file name, without the extension, corresponds to the component full name (ChangeEvents\_LeadChangeEvent).

If the channel has more than one selected entity, each entity is represented separately by a PlatformEventChannelMember component. For example, this component is a second member of the standard ChangeEvents channel and represents the Contact change event.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
    <eventChannel\>ChangeEvents</eventChannel\>
    <selectedEntity\>ContactChangeEvent</selectedEntity\>
</PlatformEventChannelMember\>

This example is a selected entity on the SalesEvents\_\_chn custom channel.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
    <eventChannel\>SalesEvents\_\_chn</eventChannel\>
    <selectedEntity\>ContactChangeEvent</selectedEntity\>
</PlatformEventChannelMember\>

This example shows one enriched field, Phone, for a selected entity on the SalesEvents\_\_chn custom channel. Enriched fields are supported in API version 51.0 and later.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
    <enrichedFields\>
        <name\>Phone</name\>
    </enrichedFields\>
    <eventChannel\>SalesEvents\_\_chn</eventChannel\>
    <selectedEntity\>ContactChangeEvent</selectedEntity\>
</PlatformEventChannelMember\>

This example shows a filter expression for a ContactChangeEvent selected entity on the SalesEvents\_\_chn custom channel.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
    <eventChannel\>SalesEvents\_\_chn</eventChannel\>
    <filterExpression><!\[CDATA\[(Region\_\_c='AMER')\]\]></filterExpression\>
    <selectedEntity\>ContactChangeEvent</selectedEntity\>
</PlatformEventChannelMember\>

## Underscores in Channel Member Full Names

Two consecutive underscores in full names designate either a component name suffix or a namespace prefix. In all other cases, two consecutive underscores aren’t supported in full names. If your channel member name contains a custom channel name to make it unique, ensure to replace the double underscores in the name with one underscore. For example, the member name would be SalesEvents\_chn\_AccountChangeEvent and not SalesEvents\_\_chn\_AccountChangeEvent.

## Referencing Channel Members and Channels in Package.xml

This manifest file references the example definitions on the ChangeEvents standard channel. It lists each member in the <members> field of PlatformEventChannelMember. The <members> field contains the channel member full name in this format: ChannelName\_EventName.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ChangeEvents\_LeadChangeEvent</members\>
        <members\>ChangeEvents\_ContactChangeEvent</members\>
        <name\>PlatformEventChannelMember</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

This manifest file references members of the SalesEvents\_\_chn custom channel.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>SalesEvents\_chn\_AccountChangeEvent</members\>
        <members\>SalesEvents\_chn\_ContactChangeEvent</members\>
        <members\>SalesEvents\_chn\_MyCustomObj\_ChangeEvent</members\>
        <name\>PlatformEventChannelMember</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

To retrieve a custom channel and channel members, you can reference them in the same package.xml file, as this example shows.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>SalesEvents\_\_chn</members\>
        <name\>PlatformEventChannel</name\>
    </types\>
    <types\>
        <members\>SalesEvents\_chn\_AccountChangeEvent</members\>
        <members\>SalesEvents\_chn\_ContactChangeEvent</members\>
        <members\>SalesEvents\_chn\_MyCustomObj\_ChangeEvent</members\>
        <name\>PlatformEventChannelMember</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

#### See Also

- [_Change Data Capture Developer Guide_: Example Diagrams for Channels and Channel Members](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_channel_examples.htm "Change Data Capture Developer Guide: Example
    Diagrams for Channels and Channel Members - HTML (New Window)")
- [_Change Data Capture Developer Guide_: Filter Your Stream of Change Events with Channels](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_filter_section.htm "Change Data Capture Developer Guide: Filter Your Stream of Change Events with Channels - HTML (New Window)")
- [_Platform Events Developer Guide_: Filter Your Stream of Platform Events with Channels](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_filter_section.htm "Platform Events Developer Guide: Filter Your Stream of
    Platform Events with Channels - HTML (New Window)")
- [PlatformEventChannel](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformeventchannel.htm "Represents a channel that you can subscribe to in order to receive a stream of events. In API version 46.0 and earlier, it is the default standard channel for change data capture events. In API version 47.0 and later, it is a custom channel for change data capture events.")

<!-- document id=f20a4cee75023c5f57fd2959d9fdd117ed22740a9d6ae3d39a6e348a7c41e215 url=/legacydeveloper/current/en-us/api_meta/meta_platformeventmigration.md -->

# PlatformEventMigration

Represents configuration settings for a migration from standard volume platform events to high volume platform events.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

PlatformEventMigration components have the suffix .platformEventMigration and are stored in the PlatformEventMigrations folder.

## Version

PlatformEventMigration components are available in API version 67.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| endDate | 
Field Type

datetime

Description

Read-only. The date and time when the platform event migration finished.



 |
| eventObject | 

Field Type

string

Description

Required. The API name of the standard volume platform event that needs to be migrated to a high volume platform event.



 |
| highVolumePosition | 

Field Type

int

Description

Read-only. The replay ID that marks where subscribers can begin reading events on the high-volume event stream after the migration finishes.



 |
| masterLabel | 

Field Type

string

Description

Required. The label for the PlatformEventMigration component.



 |
| migrationStatus | 

Field Type

picklist

Description

Read-only. Indicates where the migration is in its lifecycle. Options are Migrating to indicate the event is currently being migrated, or Completed to indicate the migration has finished.



 |
| startDate | 

Field Type

datetime

Description

Read-only. The date and time when the platform event migration started.



 |

## Declarative Metadata Sample Definition

The following is an example of a PlatformEventMigration component.

        <?xml version="1.0" encoding="UTF-8"?>
        <PlatformEventMigration xmlns="http://soap.sforce.com/2006/04/metadata">
          <masterLabel\>My Event Migration</masterLabel\>
          <eventObject\>MyEvent\_\_e</eventObject\>
        </PlatformEventMigration\>
      

The following is an example package.xml that references the previous definition.

        <?xml version="1.0" encoding="UTF-8"?>
        <Package xmlns="http://soap.sforce.com/2006/04/metadata">
          <types\>
            <members\>MyEventMigration</members\>
            <name\>PlatformEventMigration</name\>
          </types\>
          <version\>67.0</version\>
        </Package\>
      

## Usage

To use the Metadata API to start a migration of a standard volume platform event to a high volume platform event, follow these steps.

1. Before starting a migration, ensure all publish activity has stopped and all subscribers, including triggers and flows, are done processing.
2. Next, create a .zip file containing the configuration data. Create a working directory on your desktop: ~/Desktop/MyMigrationConfig Inside this directory, create another directory ~/Desktop/MyMigrationConfig/platformEventMigrations. Inside of that directory, create the file ~/Desktop/MyMigrationConfig/platformEventMigrations/MyEventMigration.platformEventMigration Next and paste this XML as the body of that file and modify the eventObject element to match your standard volume platform event’s API name.
    
                <?xml version="1.0" encoding="UTF-8"?>
                <PlatformEventMigration xmlns="http://soap.sforce.com/2006/04/metadata">
                  <masterLabel\>My Event Migration</masterLabel\>
                  <eventObject\>MyEvent\_\_e</eventObject\>
                </PlatformEventMigration\>
              
    
    masterLabel can be any string. eventObject must be the API name of the standard volume platform event that you want to migrate to a high volume platform event.
3. Create the file ~/Desktop/MyMigrationConfig/package.xml and paste this XML as the body of that file.
    
                <?xml version="1.0" encoding="UTF-8"?>
                <Package xmlns="http://soap.sforce.com/2006/04/metadata">
                  <types\>
                    <members\>MyEventMigration</members\>
                    <name\>PlatformEventMigration</name\>
                  </types\>
                  <version\>67.0</version\>
                </Package\>
              
    
    members should contain the name of the previously created file without the .platformEventMigration extension. version must be 67.0 or higher.
4. Create a .zip file out of your configuration files. On Windows:
    
    1. Select both the platformEventMigrations folder and package.xml file
    2. Right-click → Send to → Compressed (zipped) folder
    3. Name it migration-config.zip
    
    On Mac:
    
    1. Open Terminal (Applications → Utilities → Terminal)
    2. Navigate to your Desktop
        
        cd ~/Desktop
    3. Create a clean ZIP without hidden files
        
        zip -r migration-config.zip MyMigrationConfig -x "\*.DS\_Store" -x "\_\_MACOSX"
    
    On Linux:
    1. Open a terminal
    2. Navigate to the MyMigrationConfig folder
        
        cd ~/Desktop/MyMigrationConfig
    3. Create the .zip file
        
        zip -r migration-config.zip platformEventMigrations package.xml
5. Using the Salesforce CLI, log in to your org.
    
    sf org login web --instance-url $URL --alias my-org
6. Using the Salesforce CLI, upload your .zip file.
    
    sf project deploy start --metadata-dir migration-config.zip --target-org my-org
7. Using the Salesforce CLI, get info about your deployment.
    
    sf project deploy report --use-most-recent
8. To check the status of the migration, in Salesforce click the gear icon → Developer Console. Click "Query Editor" tab. Check "Use Tooling API" checkbox. Run this query after replacing the value for DeveloperName with the value you used:
    
                SELECT Id, DeveloperName, MasterLabel, EventObject, MigrationStatus, StartDate, EndDate, HighVolumePosition
                FROM PlatformEventMigration
                WHERE DeveloperName = 'MyEventMigration'
              
    
    You should see your configuration record with: Your MasterLabel, EventObject = Your Platform Event, MigrationStatus = 'MIGRATING' (initially). MigrationStatus will change to COMPLETED when the migration is complete. You’ll also receive an email when the migration is complete. While the migration is running, publishes won’t work and you’ll be unable to create new triggers or flows until the migration finishes.

<!-- document id=22448f006750520b833bfc8b0e6b2ebcae79f837ac61d732febefdc8692512e5 url=/legacydeveloper/current/en-us/api_meta/meta_platformeventsettings.md -->

# PlatformEventSettings

Represents settings for platform events and change data capture events.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

PlatformEventSettings values are stored in the PlatformEvent.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

PlatformEventSettings components are available in API version 58.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| enableEnhancedUsageMetrics | 
Field Type

boolean

Description

Enables enhanced usage metrics for queries run against PlatformEventUsageMetric. Enhanced usage metrics provide additional fields for the queries and granular time segments. For more information, see [Enhanced Usage Metrics](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_monitor_enhanced_usage.htm) in the Platform Events Developer Guide. Default value is false.



 |

## Declarative Metadata Sample Definition

The following is an example of a PlatformEventSettings component that enables the enhanced usage metrics feature.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableEnhancedUsageMetrics\>true</enableEnhancedUsageMetrics\>
</PlatformEventSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>PlatformEvent</members\>
        <name\>Settings</name\>
    </types\>
    <version\>58.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=dab25f417c7bfea50e4a3a7748ca2c42656448f1346f0dded2ff11a9276635ea url=/legacydeveloper/current/en-us/api_meta/meta_platformeventsubscriberconfig.md -->

# PlatformEventSubscriberConfig

Represents configuration settings for a platform event Apex trigger, including the batch size and the trigger’s running user.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

PlatformEventSubscriberConfig components have the suffix .platformEventSubscriberConfig and are stored in the PlatformEventSubscriberConfigs folder.

## Version

PlatformEventSubscriberConfig components are available in API version 51.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d752785e102">Field Name</th>

              <th class="featureTableHeader  " id="d752785e105">Field Type</th>

              <th class="featureTableHeader  " id="d752785e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d752785e102" data-title="Field Name"><span class="keyword parmname">batchSize</span></td>

              <td class="entry" headers="d752785e105" data-title="Field Type">int</td>

              <td class="entry" headers="d752785e108" data-title="Description">A custom batch size, from 1 through 2,000, for the platform event Apex trigger.
                The batch size corresponds to the maximum number of event messages that can be sent
                to a trigger in one execution. The default batch size is 2,000 for platform event
                triggers. <p class="p">We don't recommend setting the batch size to 1 to process one event at
                  a time. Small batch sizes can slow down the processing of event
                  messages.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d752785e102" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d752785e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d752785e108" data-title="Description">(Inherited
                field.) Indicates whether this component is protected (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Protected
                components can’t be linked to or referenced by components created in a subscriber
                org. A developer can delete a protected component in a future release without
                worrying about failing installations. However, once a component is marked as
                unprotected and is released globally, the developer can’t delete it.</td>

            </tr>

            <tr>
              <td class="entry" headers="d752785e102" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d752785e105" data-title="Field Type">string</td>

              <td class="entry" headers="d752785e108" data-title="Description">Required. The label for the PlatformEventSubscriberConfig component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d752785e102" data-title="Field Name"><span class="keyword parmname">numPartitions</span></td>

              <td class="entry" headers="d752785e105" data-title="Field Type">int</td>

              <td class="entry" headers="d752785e108" data-title="Description">Specifies the number of parallel subscriptions, or partitions, that are created
                internally for an Apex trigger. Use this field to set up parallel subscriptions for
                the platform event Apex trigger. It can be an integer from 1 through 10. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_ps.htm" target="_blank">Platform Event Processing at
                  Scale with Parallel Subscriptions for Apex Triggers</a> in the <cite class="cite">Platform
                  Events Developer Guide</cite>.<p class="p">The default value is 1. This field is available
                  in API version 62.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d752785e102" data-title="Field Name"><span class="keyword parmname">partitionKey</span></td>

              <td class="entry" headers="d752785e105" data-title="Field Type">string</td>

              <td class="entry" headers="d752785e108" data-title="Description">Can be the standard <samp class="codeph nolang">EventUuid</samp> field or a
                required custom field of the custom platform event that the Apex trigger subscribes
                to. For the standard <span class="keyword parmname">EventUuid</span> field, the partition key format
                is the field name without the event name: <samp class="codeph nolang">EventUuid</samp>. For a custom field, the partition key includes the event
                name as a prefix in this format: <samp class="codeph nolang"><var class="keyword varname">EventName__e</var>.<var class="keyword varname">FieldName__c</var></samp>. Based
                on the field’s generated hash value, the system determines which partition to send
                the event to. Use this field to specify the platform event field that is used as a
                partition key for parallel subscriptions. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_ps.htm" target="_blank">Platform Event Processing at Scale with Parallel
                  Subscriptions for Apex Triggers</a> in the <cite class="cite">Platform Events Developer
                  Guide</cite>.<p class="p">The default value is <samp class="codeph nolang">EventUuid</samp>. This field is available in API version 62.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d752785e102" data-title="Field Name"><span class="keyword parmname">platformEventConsumer</span></td>

              <td class="entry" headers="d752785e105" data-title="Field Type">string</td>

              <td class="entry" headers="d752785e108" data-title="Description">Required. The full name of the platform event Apex trigger to
                configure.</td>

            </tr>

            <tr>
              <td class="entry" headers="d752785e102" data-title="Field Name"><span class="keyword parmname">user</span></td>

              <td class="entry" headers="d752785e105" data-title="Field Type">string</td>

              <td class="entry" headers="d752785e108" data-title="Description">The username of the user that the platform event Apex trigger runs as. By
                default, the platform event trigger runs as the Automated Process entity. Setting
                the running user to a specific user has these benefits:<ul class="ul bulletList">
                  <li class="li">Records are created or modified as this user.</li>

                  <li class="li">Records with <span class="keyword parmname">OwnerId</span> fields have their
                    <span class="keyword parmname">OwnerId</span> fields populated to this user when created or
                    modified.
                  </li>

                  <li class="li">Debug logs for the trigger execution are created by this user.</li>

                  <li class="li">You can send email from the trigger, which isn’t supported with the default
                    Automated Process user.</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This PlatformEventSubscriberConfig component has the label OrderEventTriggerConfig. It contains the configuration of a platform event trigger, OrderEventTrigger, and specifies the batch size and user.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventSubscriberConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <platformEventConsumer\>OrderEventTrigger</platformEventConsumer\>
    <batchSize\>200</batchSize\>
    <masterLabel\>OrderEventTriggerConfig</masterLabel\>
    <user\>user@example.com</user\>
    <isProtected\>false</isProtected\>
</PlatformEventSubscriberConfig\>

PlatformEventSubscriberConfig references an Apex trigger, which depends on a platform event. If the referenced items exist in the Salesforce org, you can deploy the PlatformEventSubscriberConfig component. This package.xml specifies the PlatformEventSubscriberConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <name\>PlatformEventSubscriberConfig</name\>
        <members\>OrderEventTriggerConfig</members\>
    </types\>
    <version\>68.0</version\>
</Package\>

If the referenced trigger and platform event don’t exist in the org, include their definitions in the package. Otherwise, the deployment fails. This example package.xml includes all the referenced components.

- CustomObject represents the platform event.
- CustomField represents a custom field defined on the platform event.
- ApexTrigger represents the platform event trigger.
- PlatformEventSubscriberConfig represents the configuration options for the platform event trigger.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <name\>CustomObject</name\>
        <members\>PlatformEvent\_\_e</members\>
    </types\>
    <types\>
        <name\>CustomField</name\>
        <members\>PlatformEvent\_\_e.Message\_\_c</members\>
    </types\>
    <types\>
        <name\>ApexTrigger</name\>
        <members\>OrderEventTrigger</members\>
    </types\>
    <types\>
        <name\>PlatformEventSubscriberConfig</name\>
        <members\>OrderEventTriggerConfig</members\>
    </types\>
    <version\>68.0</version\>
</Package\>

To specify all PlatformEventSubscriberConfig components, use the wildcard character, as shown in this example.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <name\>PlatformEventSubscriberConfig</name\>
        <members\>\*</members\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=2ea4d3ec9a3142d6666ae5bb82ea6d3a12f0f29e51542940a1b61aa0ecef11e2 url=/legacydeveloper/current/en-us/api_meta/meta_portal.md -->

# Portal

The Portal metadata type represents a partner portal.

It extends [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") and inherits its fullName field. To use this metadata type, you must have a partner portal or Customer Portal enabled for your organization. For more information, see Partner Portal Overview in Salesforce Help.

## Declarative Metadata File Suffix and Directory Location

Lightning Platform Portal components are stored in the portals directory of the corresponding package directory. The file name matches the portal name, and the extension is .portal.

## Version

Lightning Platform Portal components are available in API version 15.0 and later.

## Special Access Rules

All users, including unauthenticated guest users, can view portals via the API.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d753658e107">Field</th>

              <th class="featureTableHeader  " id="d753658e110">Field Type</th>

              <th class="featureTableHeader  " id="d753658e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d753658e113" data-title="Description">Required. Denotes whether this portal is active.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">admin</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The full name of the user designated to administer the
                portal.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">defaultLanguage</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The default language for HTML messages for the portal. Use the
                abbreviation for the language, for example, en_US for United States
                English.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The portal description.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">emailSenderAddress</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">Required. <span class="ph" id="field_emailSenderAddress_desc"><a name="field_emailSenderAddress_desc"><!-- --></a>The email
                  address used when sending emails using templates configured from
                  the portal (for example, for resetting the
                  password).</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">emailSenderName</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">Required. The name to display when sending emails using templates
                configured from the portal (for example, for resetting the
                password).</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">enableSelfCloseCase</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d753658e113" data-title="Description">For the Customer Portal, allows portal users to close their own
                cases.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">footerDocument</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The file to be used as the footer for this portal.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">forgotPassTemplate</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The email template to use when a user clicks the
                <strong class="ph uicontrol">Forgot Password</strong> link.<p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">Required. The name of the portal.<p class="p">Inherited from Metadata ,
                  this field is defined in the WSDL for this metadata type. It
                  must be specified when creating, updating, or deleting. See
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a> to
                  see an example of this field specified for a call.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">headerDocument</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The file to be used as the header for this portal.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">isSelfRegistrationActivated</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d753658e113" data-title="Description">Determines whether self-registration is active or not for this
                portal.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">loginHeaderDocument</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The file to be used as the header for this portal's login
                page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">logoDocument</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The file to be used as the logo for this portal.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">logoutUrl</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The URL that the user is redirected to on logout.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">newCommentTemplate</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The email template to be used for auto-notifications on new case
                comments.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">newPassTemplate</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The email template to be used for auto-notifications on password
                reset.<p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">newUserTemplate</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The email template to be used for auto-notifications on new user
                creation.<p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">ownerNotifyTemplate</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The email template to be used for auto-notifications on owner
                change.<p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">selfRegNewUserUrl</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The URL of the self-registration page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">selfRegUserDefaultProfile</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The default profile for self-registered users.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">selfRegUserDefaultRole</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">PortalRoles (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d753658e113" data-title="Description">The default role for self-registered users. The valid values are:<ul class="ul bulletList">
                  <li class="li">Executive</li>

                  <li class="li">Manager</li>

                  <li class="li">User</li>

                  <li class="li">PersonAccount</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">selfRegUserTemplate</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The email template to be used for auto-notifications on
                self-registration.<p class="p">Lightning email templates aren’t packageable. We recommend using a Classic email
                  template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">showActionConfirmation</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d753658e113" data-title="Description">Determines whether confirmation messages are displayed for
                actions in the portal.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">stylesheetDocument</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">string</td>

              <td class="entry" headers="d753658e113" data-title="Description">The Document object to be used as the CSS style sheet for this
                portal.</td>

            </tr>

            <tr>
              <td class="entry" headers="d753658e107" data-title="Field"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d753658e110" data-title="Field Type">PortalType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d753658e113" data-title="Description">Required. The type for this portal. The valid values are:<ul class="ul bulletList">
                  <li class="li">CustomerSuccess</li>

                  <li class="li">Partner</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s a sample XML definition of a portal.

<?xml version="1.0" encoding="UTF-8"?>
<Portal xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <description\>Customer Portal</description\>
    <emailSenderName\>rguest@albany.com</emailSenderName\>
    <enableSelfCloseCase\>false</enableSelfCloseCase\>
    <forgotPassTemplate\>unfiled$public/ChangePwdEmail</forgotPassTemplate\>
    <isSelfRegistrationActivated\>false</isSelfRegistrationActivated\>
    <newPassTemplate\>unfiled$public/ChangePwdEmail</newPassTemplate\>
    <newUserTemplate\>unfiled$public/NewUserEmail</newUserTemplate\>
    <selfRegUserTemplate\>unfiled$public/SelfRegUserEmail</selfRegUserTemplate\>
    <showActionConfirmation\>false</showActionConfirmation\>
    <type\>CustomerSuccess</type\>
</Portal\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [CustomSite](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sites.htm "Represents a Salesforce site. Create public websites and applications that are directly integrated with your Salesforce organization, but don't require users to log in with a username and password.")

<!-- document id=0e988795238d71875371cec75b120f45a12603a5a34e57c31a94d38515c13661 url=/legacydeveloper/current/en-us/api_meta/meta_portaldelegablepermissionset.md -->

# PortalDelegablePermissionSet

Represents the org-level permission sets that can be assigned to a particular profile for external users or shoppers in a store after enabling the Delegable Administration perm.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

PortalDelegablePermissionSet components have the suffix .portaldelegablepermissionset and are stored in the portaldelegablepermissionsets folder.

## Version

PortalDelegablePermissionSet components are available in API version 56.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| isProtected | 
Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type.



 |
| masterLabel | 

Field Type

string

Description

Required. The label for the service that appears to users.



 |
| permissionSet | 

Field Type

string

Description

Required. Foreign key to the [permissionSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_permissionset.htm "Represents a set of permissions that's used to grant more access to one or more users without changing their profile or reassigning profiles. You can use permission sets to grant access but not to deny access.") entity.



 |
| profile | 

Field Type

string

Description

Required. Foreign key to the [profile](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm "Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field.") entity.



 |

## Declarative Metadata Sample Definition

The following is the definition of the PortalDelegablePermissionSet entity.

<xsd:complexType name="PortalDelegablePermissionSet">
    <xsd:complexContent\>
     <xsd:extension base="tns:Metadata">
      <xsd:sequence\>
       <xsd:element name="isProtected" minOccurs="0" type="xsd:boolean"/>
       <xsd:element name="masterLabel" type="xsd:string"/>
       <xsd:element name="permissionSet" type="xsd:string"/>
       <xsd:element name="profile" type="xsd:string"/>
      </xsd:sequence\>
     </xsd:extension\>
    </xsd:complexContent\>
   </xsd:complexType\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PortalDelegablePermissionSet</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>Profile</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>PermissionSet</name\>
    </types\>
<version\>56.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=bef278db543fd1280f5621ad6f3bdf98c56582d65ccba913bb0b8da40234fa13 url=/legacydeveloper/current/en-us/api_meta/meta_posttemplate.md -->

# PostTemplate

Represents the metadata associated with an approval post template for Approvals in Chatter. With approval post templates, you can customize the information included in approval request posts that appear in Chatter feeds. This type extends the Metadata metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Review Chatter Post Templates for Approval Requests in the Salesforce Help before you create a post template.

## File Suffix and Directory Location

PostTemplate components have the suffix .postTemplate and are stored in the postTemplates folder.

## Version

PostTemplate components are available in API version 29.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d756093e91">Field Name</th>

              <th class="featureTableHeader  " id="d756093e94">Field Type</th>

              <th class="featureTableHeader  " id="d756093e97">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d756093e91" data-title="Field Name"><span class="keyword parmname">default</span></td>

              <td class="entry" headers="d756093e94" data-title="Field Type">boolean</td>

              <td class="entry" headers="d756093e97" data-title="Description">Required. Specifies whether this is the default post template for
                the given object.<p class="p">When set to <samp class="codeph nolang">true</samp>, this post template is used by approval
                  processes that are associated with the same object and
                  don’t specify a post template.</p>
                <p class="p">When an object has
                  no default post template, each of its approval processes uses
                  the system default post template, unless the approval process
                  specifies its own post template.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d756093e91" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d756093e94" data-title="Field Type">string</td>

              <td class="entry" headers="d756093e97" data-title="Description">Optional description of the post template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d756093e91" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d756093e94" data-title="Field Type">string[]</td>

              <td class="entry" headers="d756093e97" data-title="Description">Required. An array of up to four fields to include in approval
                request posts.<p class="p">If the approval object is a detail object in a
                  master-detail relationship, <span class="keyword parmname">Owner</span> isn’t
                  available for approval page layouts or approval post
                  templates.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d756093e91" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d756093e94" data-title="Field Type">string</td>

              <td class="entry" headers="d756093e97" data-title="Description">Required. Name of the post template. This non-unique label is
                different from the unique name of the post template.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a PostTemplate component:

<PostTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <default\>false</default\>
    <fields\>NumberOfEmployees</fields\>
    <fields\>NumberofLocations\_\_c</fields\>
    <fields\>PartnerAccount</fields\>
    <fields\>LeadCustomFieldNumber\_\_c</fields\>
    <label\>My Lead Post Template</label\>
</PostTemplate\>

The following is an example package manifest that references the previous PostTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Lead.leadtemplate</members\>
        <name\>PostTemplate</name\>
    </types\>
    <version\>29.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=1a00cd6be4d413bb95adef5e94465ffd4430e4badfd7f002015368b1117a52ba url=/legacydeveloper/current/en-us/api_meta/meta_predictionbuildersettings.md -->

# PredictionBuilderSettings

Represents the settings that determine how a user can interact with Einstein Prediction Builder. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

PredictionBuilderSettings values are stored in the PredictionBuilder.settings file in the settings directory. The .settings files are different from other named components in that each settings component has only one settings file.

## Version

PredictionBuilderSettings components are available in API version 47.0 and later.

## Special Access Rules

This type is available only if the CRM Analytics Plus or Einstein Predictions license is enabled in your org.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enablePredictionBuilder | boolean | Indicates whether Einstein Prediction Builder is enabled (true) or not (false). |
| isPredictionBuilderStarted | boolean | Indicates whether to display the predictions list view to the user (true) or not (false). |

## Declarative Metadata Sample Definition

This is a sample Prediction Builder settings file.

<?xml version="1.0" encoding="UTF-8"?>
<PredictionBuilderSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <isPredictionBuilderStarted>false</isPredictionBuilderStarted>
    <enablePredictionBuilder>false</enablePredictionBuilder>
</PredictionBuilderSettings>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=8bc4dcecd2d880ed6ee54a5cdb6d3c2508f278a0fdbc1628250ae940537e2303 url=/legacydeveloper/current/en-us/api_meta/meta_quickstart_prereqs.md -->

# Prerequisites to Build Client Applications

Make sure that you complete these prerequisites before you start using Metadata API.

- Create a development environment.
    
    We strongly recommend that you use a sandbox, which is an exact replica of your production organization. Enterprise, Unlimited, and Performance Editions come with free developer sandboxes. For more information, see [http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jsp](http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jsp).
    
    Alternatively, you can use a Developer Edition (DE) org. A DE org provides access to all features that are available with Enterprise Edition, but is limited by the number of users and the amount of storage space. A DE org isn’t a copy of your production org/ It provides an environment where you can build and test your solutions without affecting your organization’s data. Developer Edition accounts are available for free at [https://developer.salesforce.com/signup](https://developer.salesforce.com/signup).
- Identify a user that has the API Enabled permission and the Modify Metadata Through Metadata API Functions permission or Modify All Data permission. These permissions are required to access Metadata API calls.
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.
- Install a SOAP client. Metadata API works with current SOAP development environments, including, but not limited to, Visual Studio® .NET and the Web Service Connector (WSC).
    
    In this document, we provide Java examples based on WSC and JDK 6 (Java Platform Standard Edition Development Kit 6). To run the samples, first download the latest force-wsc JAR file and its dependencies from [mvnrepository.com/artifact/com.force.api/force-wsc/](http://mvnrepository.com/artifact/com.force.api/force-wsc/ "HTML (New Window)"). Dependencies are listed on the page when you select a version.
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    Development platforms vary in their SOAP implementations. Implementation differences in certain development platforms can prevent access to some or all features in Metadata API.

<!-- document id=40e6074aa5f01b0ed8b7d5b4714b21ba09738616ca813ce55999a289bdd5a6cf url=/legacydeveloper/current/en-us/api_meta/meta_mcp_server_eca.md -->

# Prerequisites: Set Up Salesforce Hosted MCP Servers

The Salesforce API Context MCP server is one of many Salesforce Hosted MCP Servers. To use the Salesforce API Context MCP server, you must first set up the Salesforce Hosted MCP Server.

## Activate the MCP Server

Activate the API Context MCP Server in your org.

1. From Setup, in the Quick Find box, enter MCP Servers, and then select **MCP Servers**.
2. Click **salesforce-api-context** and click **Activate**.

## Create an External Client App

External client apps enable third-party applications to integrate with Salesforce using APIs and security protocols. You need an external client app if you’re using these tools with any MCP client other than Agentforce Vibes. Skip this step if you’re using the API Context tools in Agentforce Vibes.

In this Quick Start, we provide the steps to use Cursor as your MCP client. Cursor is an AI-driven coding editor that supports MCP. To use Cursor as your MCP client, you must install Node.js. After installing Node.js, confirm that your installation was successful by running the commands node -v and npm -v from the command line.

1. From Setup, in the Quick Find box, enter external client, and then select **External Client App Manager**.
2. Click **New External Client App**.
3. Fill out the Basic Information section.
4. Expand the section labeled **API (Enable OAuth Settings)** and click the **Enable OAuth** checkbox.
5. In Callback URL, enter [http://localhost:8080/oauth/callback](http://localhost:8080/oauth/callback).
    
    For other clients, consult the provider’s documentation for the callback URL.
6. In OAuth Scopes, add the **Manage user data via APIs (api)**, **Access the Salesforce API Platform (sfap\_api)** and **Perform requests at any time (refresh\_token, offline\_access)** scopes. If you’re using prompt templates, add the **Access Einstein GPT services (einstein\_gpt\_api)** scope.
7. Under Security:
    1. Select **Issue JSON Web Token (JWT)-based access tokens for named users**.
    2. Select **Require Proof Key for Code Exchange (PKCE) extension for Supported Authorization Flows**.
    3. Deselect all other options.
8. Click **Create**.
9. Click **Settings**, then click **Consumer Key and Secret** under OAuth Settings to get the consumer key.
    
    Store the consumer key for later use.

## Log Into Your Target Org

When you configure your MCP client and initiate its authentication, it opens a web browser to authenticate into your org via OAuth. To prepare for this, additional steps are sometimes needed for the authentication to succeed. Since the MCP spec doesn't have special provisions for systems like Salesforce with multiple tenants, we recommend the following steps:

1. Log out of all other Salesforce orgs.
2. Using your default browser, log into the org that you want to access from your MCP client.
    
    This should be the org in which you created the External Client App in the previous section.
3. Keep the browser open, since the MCP client will open a new tab in that browser window in a later step.

<!-- document id=c8ddd9d5ac4b73b01ca3adf15121fc5c5624cf388bb3da1ac2018fcfcda45388 url=/legacydeveloper/current/en-us/api_meta/meta_presencedeclinereason.md -->

# PresenceDeclineReason

Represents an Omni-Channel decline reason that agents can select when declining work requests. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

PresenceDeclineReason components have the suffix .presenceDeclineReason and are stored in the presenceDeclineReasons folder.

## Version

PresenceDeclineReason components are available in API version 44.0 and later.

## Special Access Rules

This type is available only if Omni-Channel is enabled in your org.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| label | string | The label for the decline reason. |

## Declarative Metadata Sample Definition

The following is an example of a PresenceDeclineReason component.

<?xml version="1.0" encoding="UTF-8"?>
<PresenceDeclineReason xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>Incorrect queue</label\>
</PresenceDeclineReason\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PresenceDeclineReason</name\>
    </types\>
    <version\>44.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6a8a72f2f5e46cd6d1c875583576b9e6a15b9e1bea00fb36badd29573b51f00b url=/legacydeveloper/current/en-us/api_meta/meta_presenceuserconfig.md -->

# PresenceUserConfig

Represents a configuration that determines a presence user’s settings.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

PresenceUserConfig components have the suffix .presenceUserConfig and are stored in the presenceUserConfigs folder.

## Version

PresenceUserConfig components are available in API version 44.0 and later.

## Special Access Rules

This type is available only if Omni-Channel is enabled in your org.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| acwExtensionDuration | int | The maximum length of time, measured in seconds, an agent can spend on After Conversation Work (ACW) each time they extend the timer. You must set this field if hasAcwExtensionEnabled is set to true. Specify a value from 10 through 3600. Available in API version 65.0 and later. |
| afterConvoWorkMaxTime | int | The maximum length of time, measured in seconds, an agent has to complete After Conversation Work (ACW). You must set this field if hasAfterConvoWorkTimer is set to true. Specify a value from 10 through 3600. Available in API version 65.0 and later. |
| assignments | [PresenceConfigAssignments](#PresenceConfigAssignments) | Specifies how presence configurations are assigned to Omni-Channel users. Presence configurations can be assigned to sets of users or to sets of profiles. |
| capacity | int | Required. The maximum number of work units an agent can be assigned at one time. |
| declineReasons | string | Specifies the list of decline reasons that an agent can select when they decline a work. |
| enableAutoAccept | boolean | Indicates whether work items that are routed to agents are automatically accepted (true) or not (false). Available only if enableDecline is set to false. |
| enableDecline | boolean | Indicates whether agents can decline work items that are routed to them (true) or not (false). Available only if enableAutoAccept is set to false. |
| enableDeclineReason | boolean | Indicates whether agents can select a reason for declining work requests (true) or not (false). This can be selected only if decline reasons are enabled. |
| enableDisconnectSound | boolean | Indicates whether a sound is played when agents are disconnected from Omni-Channel (true) or not (false). |
| enableRequestSound | boolean | Indicates whether a sound plays with incoming work requests (true) or not (false). Set to true by default. |
| hasAcwExtensionEnabled | boolean | If set to true, agents can extend their After Conversation Work (ACW) time. Available only if hasAfterConvoWorkTimer is set to true. If set to true, you must also set the acwExtensionDuration and maxExtensions fields. The default value is falseAvailable in API version 65.0 and later.. |
| hasAfterConvoWorkTimer | boolean | If set to true, After Conversation Work (ACW) time can be configured for the user. If set to true, you must also set the afterConvoWorkMaxTime field. The default value is falseAvailable in API version 65.0 and later.. |
| interruptibleCapacity | int | Indicates the maximum number of work units using interruptible capacity that can be pushed to an agent at a time. An empty value defaults this field to the value set in the capacity field. Available in API version 57.0 and later when the Interruptible Capacity feature is enabled. |
|  |  |  |
| label | string | The label of the presence configuration. |
| maxExtensions | string | The maximum number of times an agent can extend their After Work Conversation (ACW) time. Specify a value from 1 through 10. You must set this field if hasAcwExtensionEnabled is set to true. Available in API version 65.0 and later. |
| presenceStatusOnDecline | string | The presence status that’s automatically assigned to the agent when the agent declines a work item. Available only if enableDecline is set to true. |
| presenceStatusOnPushTimeout | string | The presence status that’s automatically assigned to the agent when the agent doesn’t respond to a work item before push timeout occurs. |

## PresenceConfigAssignments

Represents the assignments of an org’s profiles and users to a Presence configuration.

| Field Name | Field Type | Description |
| --- | --- | --- |
| profiles | [PresenceConfigProfileAssignments](#PresenceConfigProfileAssignments) | Specifies the profiles that are associated with a specific presence configuration. |
| users | [PresenceConfigUserAssignments](#PresenceConfigUserAssignments) | Specifies the users that are associated with a specific presence configuration. |

## PresenceConfigProfileAssignments

Represents the profiles associated with a specific presence configuration.

| Field Name | Field Type | Description |
| --- | --- | --- |
| profile | string | Specifies the name of the profile associated with a specific presence configuration. |

## PresenceConfigUserAssignments

Represents the users associated with a specific presence configuration.

| Field Name | Field Type | Description |
| --- | --- | --- |
| user | string | Specifies the username of the user associated with a specific presence configuration. |

## Declarative Metadata Sample Definition

The following is an example of a PresenceUserConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<PresenceUserConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <assignments\>
        <profiles\>
            <profile\>standard</profile\>
        </profiles\>
        <users\>
            <user\>jdoe@example.com</user\>
        </users\>
    </assignments\>
    <capacity\>5</capacity\>
    <declineReasons\>Incorrect\_queue</declineReasons\>
    <enableAutoAccept\>false</enableAutoAccept\>
    <enableDecline\>true</enableDecline\>
    <enableDeclineReason\>true</enableDeclineReason\>
    <enableDisconnectSound\>true</enableDisconnectSound\>
    <enableRequestSound\>true</enableRequestSound\>
    <label\>My presence configuration</label\>
    <presenceStatusOnDecline\>Away</presenceStatusOnDecline\>
    <presenceStatusOnPushTimeout\>Break</presenceStatusOnPushTimeout\>
</PresenceUserConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PresenceUserConfig</name\>
    </types\>
    <version\>44.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=2bd4fa35ab2ba6e0d5af920daa48466c62e47af766adc28f5dd3b8ae6754ac34 url=/legacydeveloper/current/en-us/api_meta/meta_pricingactionparameters.md -->

# PricingActionParameters

Represents the pricing action that's associated with a context definition and pricing procedure.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

PricingActionParameters components have the suffix .pricingActionParameters and are stored in the pricingActionParameters folder.

## Version

PricingActionParameters components are available in API version 60.0 and later.

## Special Access Rules

This metadata type is available with Salesforce Pricing.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| contextDefinition | string | Required. Context definition record that's associated with the pricing action. |
| contextMapping | string | Required. Context mapping record that's associated with the pricing action. |
| developerName | string | Required. Unique name of the pricing action parameter record. The name must begin with a letter and use only alphanumeric characters and underscores. The name must not include spaces, end with an underscore, or have two consecutive underscores. |
| effectiveFrom | dateTime | Required. Date and time from when the pricing action becomes effective. |
| effectiveTo | dateTime | Date and time till when the pricing action is in effect. |
| masterLabel | string | Required. Master label of the pricing action parameter. |
| objectName | string | Name of the object that's associated with the pricing action. Valid values are Case, Contract, Opportunity, Order, Quote, SalesAgreement, or WorkOrder. |
| pricingProcedure | string | Pricing procedure record that's associated with this pricing action. |

## Declarative Metadata Sample Definition

The following is an example of a PricingActionParameters component.

<PricingActionParameters xmlns="http://soap.sforce.com/2006/04/metadata">
    <developerName\>CMEDefaultActionParameters</developerName\>
    <objectName\>ORDER</objectName\>
    <pricingProcedure\>PP</pricingProcedure\>
    <effectiveFrom\>2024-04-08T07:32:00.000Z</effectiveFrom\>
    <effectiveTo\>2024-04-11T07:32:00.000Z</effectiveTo\>
    <contextDefinition\>SalesTransactionContext\_\_stdctx</contextDefinition\>
    <contextMapping\>SalesAgreementEntitiesMapping</contextMapping\>
    <masterLabel\>PAP\_test</masterLabel\>
</PricingActionParameters\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PricingActionParameters</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=ab8d76e383f0ffac739ac866403e53b436e66b8d8db2ed086f5cc236c2a6390c url=/legacydeveloper/current/en-us/api_meta/meta_pricingrecipe.md -->

# PricingRecipe

Represents the data models or sets of objects of a particular cloud that the pricing data store consumes during design time and run time.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

PricingRecipe components have the suffix .pricingRecipe and are stored in the pricingRecipe folder.

## Version

PricingRecipe components are available in API version 60.0 and later.

## Special Access Rules

This metadata type is available with Salesforce Pricing.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| defaultPricingProcedure | [ExpressionSetDefinition](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/meta_expressionsetdefinition.htm "HTML (New Window)") | Expression set definition that's associated with this pricing recipe setting. |
| defaultPricingProcedureDeveloperName | string | For internal use only. |
| defaultPricingProcedureId | string | ID of the pricing procedure of the pricing recipe. |
| developerName | string | Required. API name of the pricing recipe. |
| isActive | boolean | Indicates whether the pricing recipe is active (true) or not (false). The default value is false. |
| isInternal | boolean | Indicates whether the price recipe record is created internally by the Salesforce platform (true) or not (false). The default value is false. |
| masterLabel | string | Required. Name for pricing recipe that's defined when the pricing recipe is created. |
| pricingRecipeTableMapping | [PricingRecipeTableMapping\[\]](#PricingRecipeTableMapping) | Mapping of the pricing components of a lookup table with the chosen pricing recipe. |

## PricingRecipeTableMapping

Represents the mapping of the lookup table with the chosen pricing recipe.

| Field Name | Field Type | Description |
| --- | --- | --- |
| isInternal | boolean | Indicates whether the price recipe field mapping record is created internally by the platform (true) or not (false). The default value is false. |
| lookupTable | [DecisionTable](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/meta_decisiontable.htm "HTML (New Window)") or [DecisionMatrixDefinition](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/meta_decisionmatrixdefinition.htm "HTML (New Window)") | Lookup table that's associated with either a decision matrix or decision table. |
| lookupTableDeveloperName | string | For internal use only. |
| pricingComponentType | string | Pricing component field data that the decision table is built on. Valid values are AttributeDiscount; BundleDiscount; DerivedPricing; ListPrice; PriceAdjustmentMatrix; PromotionsDiscount; VolumeDiscount; VolumeTierDiscount; DiscountDistributionService. This value is available in API version 60.0 and later; or MinimumPrice. Available in API version 62.0 and later. |
| pricingProcedureOutputMapList | [PricingProcedureOutputMap\[\]](#PricingProcedureOutputMap) | List of the mappings of the outputs of the pricing procedures to the associated lookup tables. Available in API version 60.0 and later. |
| pricingRecipe | string | Required. Pricing data store that's associated with this pricing recipe field mapping. |

## PricingProcedureOutputMap

Represents the mapping of the outputs of the pricing procedures to the associated lookup tables. Each record specifies the output mapping of the associated lookup table based on the pricing component type specified in the PricingRecipeTableMapping object.

| Field Name | Field Type | Description |
| --- | --- | --- |
| fieldName | string | For internal use only. |
| isPricingRecipeActive | boolean | Indicates whether the associated pricing recipe is active (true) or not (false). The default value is false. |
| outputFieldName | string | Field name that contains the output type that's generated from the pricing element. |
| outputFieldNameString | string | Derived field that references a specific column in a decision table or decision matrix. |
| outputType | string | Output type that's generated from a pricing element. Valid values are AdjustmentType, AdjustmentValue, CustomOutput, HashOutput, or UnitPrice. |
| pricingElementType | PricingElementType (enumeration of type string) | Type of pricing element, which is a derived field from PricingRecipeTableMapping.PricingComponentType. Valid values are AssetDiscovery, AttributeDiscount, BundleDiscount, DerivedPricing, DiscountDistributionService, ListPrice, MinimumPrice, PriceAdjustmentMatrix, PriceRevision, PromotionsDiscount, RuleFetch, VolumeDiscount, or VolumeTierDiscount. |

## Declarative Metadata Sample Definition

The following is an example of a PricingRecipe component.

<PricingRecipe xmlns="http://soap.sforce.com/2006/04/metadata">
    <defaultPricingProcedureId\> </defaultPricingProcedureId\>
    <developerName\>CMEDefaultRecipe</developerName\>
    <isActive\>false</isActive\>
    <isInternal\>false</isInternal\>
    <masterLabel\>CMEDefaultRecipe</masterLabel\>
    <pricingRecipeTableMapping\>
        <isInternal\>false</isInternal\>
        <lookupTableDeveloperName\>Bundle\_Based\_Adjustment\_Decision\_Table</lookupTableDeveloperName\>
        <pricingComponentType\>CUSTOMDISCOUNT</pricingComponentType\>
        <fileBasedDecisionTableName\>Bundle Based Adjustment Entries</fileBasedDecisionTableName\>
        <pricingProcedureOutputMapList\>
            <fieldName\>AdjustmentValue</fieldName\>
            <isPricingRecipeActive\>false</isPricingRecipeActive\>
            <outputFieldName\>0lPxx000000000f</outputFieldName\>
            <outputFieldNameString\>false</outputFieldNameString\>
            <outputType\>AdjustmentValue</outputType\>
	     <pricingElementType\>BundleDiscount</pricingElementType\>
        </pricingProcedureOutputMapList\>
        <pricingProcedureOutputMapList\>
            <fieldName\>AdjustmentType</fieldName\>
            <isPricingRecipeActive\>false</isPricingRecipeActive\>
            <outputFieldName\>0lPxx000000000m</outputFieldName\>
            <outputFieldNameString\>false</outputFieldNameString\>
            <outputType\>AdjustmentType</outputType\>
	     <pricingElementType\>BundleDiscount</pricingElementType\>
        </pricingProcedureOutputMapList\>
        <pricingRecipe\>CMEDefaultRecipe</pricingRecipe\>
    </pricingRecipeTableMapping\>
</PricingRecipe\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PricingRecipe</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=dd9e141b3a3ff8200e311c955b562e5edc62ba47e6f99313f166f163e0e6bbf0 url=/legacydeveloper/current/en-us/api_meta/meta_privacysettings.md -->

# PrivacySettings

Represents an organization’s settings for data privacy and consent management. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

PrivacySettings values are stored in the Privacy.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

PrivacySettings components are available in API version 47.0 and later.

## Special Access Rules

To use PrivacySettings, you need the Customize Application or Modify Data Classification user permission.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| authorizationCaptureBrowser | boolean | Indicates whether browser information is captured during authorization consent capture (true) or not (false). The default value is false. Available in API version 59.0 and later. |
| authorizationCaptureEmail | boolean | Indicates whether email address is captured during authorization consent capture (true) or not (false). The default value is false. Available in API version 59.0 and later. |
| authorizationCaptureIp | boolean | Indicates whether IP address is captured during authorization consent capture (true) or not (false). The default value is false. Available in API version 59.0 and later. |
| authorizationCaptureLocation | boolean | Indicates whether location information is captured during authorization consent capture (true) or not (false). The default value is false. Available in API version 59.0 and later. |
| authorizationCustomSharing | boolean | Indicates whether custom sharing is enabled for authorization consent records (true) or not (false). The default value is false. Available in API version 59.0 and later. |
| authorizationCustomSharingPCU | boolean | Indicates whether custom sharing for authorization consent records uses permission-based access control (true) or not (false). The default value is false. Available in API version 62.0 and later. |
| authorizationLockingAndVersioning | boolean | Indicates whether locking and versioning is enabled for authorization consent records (true) or not (false). The default value is false. Available in API version 59.0 and later. |
| enableConfigurableUserPIIActive | boolean | Indicates whether configurable user PII (Personally Identifiable Information) classification is active (true) or not (false). The default value is false. Available in API version 59.0 and later. |
| enableConsentAuditTrail | boolean | Reserved for future use. |
| enableConsentEventStream | boolean | Allows orgs to stream consent changes to the party data model via platform events. This field has a default value of false. Available in API version 47.0 and later. |
| enableDefaultMetadataValues | boolean | Indicates whether a default data sensitivity value is applied to all contacts, leads, person accounts, and users (true) or not (false). This field has a default value of false. Available in API version 47.0 and later. |
| enableSalesforceArchive | boolean | Indicates whether Salesforce Archive is enabled for privacy-related data archival (true) or not (false). The default value is false. Available in API version 61.0 and later. |
| useUmaDefaultConsentRecs | boolean | Indicates whether a Preference Manager setup in Privacy Center uses default Marketing Cloud consent parameters and features. This field has a default value of false. Available in API version 58.0 and later. |

## Declarative Metadata Sample Definition

The following is an example of a PrivacySettings component.

<?xml version="1.0" encoding="UTF-8"?>
<PrivacySettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableDefaultMetadataValues\>false</enableDefaultMetadataValues\>
</PrivacySettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Privacy</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ed329fcfa546dfd72f73f972ae53d8a071e3c3d603d8de66a5ab4c47201c740f url=/legacydeveloper/current/en-us/api_meta/meta_processflowmigration.md -->

# ProcessFlowMigration

Represents a process's migrated criteria and the resulting migrated flow.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## Version

ProcessFlowMigration components are available in API version 58.0 and later.

## Special Access Rules

## Fields

| Field Name | Description |
| --- | --- |
| destinationFlowDefinition | 
Field Type

string

Description

Required. The ID of the resulting migrated flow.



 |
| destinationFlowVersion | 

Field Type

string

Description

Required. The version ID of the migrated flow.



 |
| developerName | 

Field Type

string

Description

Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.



 |
| masterLabel | 

Field Type

string

Description

Required. The label for the ProcessFlowMigration.



 |
| migratedCriteriaLabel | 

Field Type

string

Description

The label of the criteria that was migrated.



 |
| migratedCriteriaName | 

Field Type

string

Description

The name of the criteria that was migrated.



 |
| processVersion | 

Field Type

string

Description

Required. The version ID of the originating process.



 |

## Declarative Metadata Sample Definition

The following is an example of a ProcessFlowMigration component.

<?xml version="1.0" encoding="UTF-8"?>
<ProcessFlowMigration xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <destinationFlowDefinition\>Migration\_1</destinationFlowDefinition\>
    <destinationFlowVersion\>Migration\_1-1</destinationFlowVersion\>
    <developerName\>Migration</developerName\>
    <masterLabel\>Migration\_1</masterLabel\>
    <migratedCriteriaLabel\>myCriteria\_1</migratedCriteriaLabel\>
    <migratedCriteriaName\>myDecision</migratedCriteriaName\>
    <processVersion\>Migration-1</processVersion\>
</ProcessFlowMigration\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ProcessFlowMigration</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>Flow</name\>
    </types\>
    <version\>58.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=1ecdd273abf0b4c11208dd547053baba4e4a83d63d5aa15a14f582c166b91266 url=/legacydeveloper/current/en-us/api_meta/meta_productattributeset.md -->

# ProductAttributeSet

Represents the ProductAttribute information being used as and attribute such as color\__c, size_\_c .

## Version

ProductAttributeSet components are available in API version 54 and later.

## Special Access Rules

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | A meaningful explanation of the attribute set. |
| developerName | string | A unique name for the attribute set. |
| masterLabel | string | The name of the attribute set. |
| productAttributeSetItems | ProductAttributeSetItem | A list of ProductAttributeSetItem. |

## Subtype

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | The ID of the custom field on ProductAttribute. |
| isGroupedBy | boolean | Indicates if product variations are grouped by a specific attribute. Available in API version 64.0 and later. |
| sequence | integer | The order of the items, starting with 0. |

<!-- document id=b15bf16ccc9ddcb0ca2fe62d9b00b9c86d4298a3ed04a6ce091ca1e8a9952361 url=/legacydeveloper/current/en-us/api_meta/meta_productsettings.md -->

# ProductSettings

Represents organization preferences for quantity schedules, revenue schedules, and active flag interaction with prices. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

ProductSettings values are stored in a single file named Product.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

ProductSettings is available in API version 28.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableCascadeActivateToRelatedPrices | boolean | When changing active flag on a product record, automatically updates active flag on related prices. |
| enableMySettings | boolean | Moves users’ personal settings pages from Setup to a separate My Settings pane (true) or not (false). When set to (true), Salesforce makes a reorganized Setup pane accessible to admins via one click in the header. This setting affects all users in your organization. The default is true. Available in API version 47.0 and later. |
| enableQuantitySchedule | boolean | Enables quantity schedules for products. |
| enableRevenueSchedule | boolean | Enables revenue schedules for products. |

## Declarative Metadata Sample Definition

The following is an example of the package file.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Product</members\>
        <name\>Settings</name\>
    </types\>
    <version\>28.0</version\>
</Package\>

The package file references the following Product.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<ProductSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCascadeActivateToRelatedPrices\>true</enableCascadeActivateToRelatedPrices\>
    <enableQuantitySchedule\>false</enableQuantitySchedule\>
    <enableRevenueSchedule\>false</enableRevenueSchedule\>
</ProductSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=19b7815b5defff3bfd87d9ba593e47c7e46b8e11c2212c8d2b99572a77e2dce4 url=/legacydeveloper/current/en-us/api_meta/meta_profile.md -->

# Profile

Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field.

In API version 29.0 and later, you can retrieve and deploy access settings for these managed components in profiles and permission sets:

- Apex classes
- Apps
- Custom field permissions
- Custom object permissions
- Custom tab settings
- External data sources
- Record types
- Visualforce pages

In API version 51.0 and later, you can retrieve and deploy access settings for login flows. For more information, see Managed Component Access in the Components in a Module section of [Sample package.xml Manifest Files](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/manifest_samples.htm "This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if you want to work with all the metadata in one batch.").

As of API version 50.0 and later, only users with correct permissions can view profile names other than their own if the Profile Filtering setting is enabled.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Profile names are also exposed when users with permissions to perform the following tasks take these actions:

- Create a tab or record type with a wizard step that includes the assignment of tabs and record types to profiles.
- Configure a login flow where viewing profile lists is required to make flow associations.
- Set up delegated admins where looking up profiles is needed to identify assignable profiles.
- Administer an org as a delegated customer admin.
- Administer an org as a delegated admin to view and assign profiles of the delegated group.

## Declarative Metadata File Suffix and Directory Location

The file suffix is .profile. There's one file for each profile, stored in the profiles folder in the corresponding package directory.

## Version

Profiles are available in API version 10.0 and later.

## Special Access Rules

As of Summer ’20 and later, Customer Portal and Partner Portal users can’t access this type.

To view the following settings, assignments, and permissions for standard and custom objects in a specified profile, the View Setup and Configuration permission is required.

- Client settings
- Field permissions
- Layout assignments
- Object permissions
- Permission dependencies
- Permission set tab settings
- Permission set group components
- Record types

## Fields

The content of a profile returned by Metadata API depends on the content requested in the [RetrieveRequest](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve_request.htm "The RetrieveRequest parameter specified on a retrieve() call encapsulates options for determining which packages or files are retrieved.") message. For example, profiles only include field-level security for fields included in custom objects returned in the same RetrieveRequest as the profiles. The profile definition contains the following fields:

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

We designed Profile metadata deployment to overlay the existing Profile settings in a target org. For example, if you disable permissions for a profile, the newly disabled permission information isn't exported. To force all Profile changes to deploy through metadata, including permission disablement, add code that explicitly indicates disabled permissions. For example, add this code to the Profile metadata .xml file before deploying into a target org: <value>false</value>.

If you deploy a profile that doesn’t exist in the target org and don't specify any permissions or settings, then the resulting profile contains all permissions and settings in the standard Minimum Access - Salesforce profile (API version 60.0 and later) or the standard Standard User profile (API version 59.0 and earlier).

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

As of API version 38.0, you can change field permissions to make a field editable using the Metadata API for fields that you can't change through the user interface. For example, you can deploy Asset.ProductCode as an editable field even though you can't through the user interface.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d762099e223">Field Name</th>

              <th class="featureTableHeader  " id="d762099e226">Field Type </th>

              <th class="featureTableHeader  " id="d762099e229">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">agentAccesses</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profile_agentaccess">ProfileAgentAccess</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which agents are visible to users assigned to this
                profile. Available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">applicationVisibilities</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profileapplicationvisibility_title">ProfileApplicationVisibility</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which apps are visible to users assigned to this
                profile. In API version 29.0 and earlier, this field supports custom
                apps only. In API version 30.0 and later, this field supports both
                standard and custom apps.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">categoryGroupVisibilities</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profileCategoryGroupVisibility_title">ProfileCategoryGroupVisibility</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which data category groups are visible to users
                assigned to this profile. Available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">classAccesses</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profileApexClassAccess_title">ProfileApexClassAccess</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which top-level Apex classes have methods that users
                assigned to this profile can execute.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">custom</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates whether the profile is a custom (<samp class="codeph java">true</samp>) or standard (<samp class="codeph java">false</samp>) profile. Available in API
                version 30.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">customMetadataTypeAccesses</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#ProfileCustomMetadataTypeAccess_title">ProfileCustomMetadataTypeAccess</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates the custom metadata types that are read-accessible to a
                user assigned to this profile. Available in API version 47.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">customPermissions</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#ProfileCustomPermissions_title">ProfileCustomPermissions</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which custom permissions are available to users
                assigned to this profile. Available in API version 31.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">customSettingAccesses</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#ProfileCustomSettingAccesses_title">ProfileCustomSettingAccesses</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates the custom settings that are read-accessible to a user
                assigned to this profile. Available in API version 47.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e229" data-title="Description">The profile description. Limit: 255 characters. Available in API
                version 30.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">externalDataSourceAccesses</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profileExternalDataSourceAccess_title">ProfileExternalDataSourceAccess</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which data sources with identity type of <span class="keyword parmname">Per
                  User</span> are available to users assigned to this profile.
                <span class="ph" id="externalDataSourceBeta_Note"><a name="externalDataSourceBeta_Note"><!-- --></a>Available in API version
                  27.0 and later.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">fieldLevelSecurities</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profilefieldlevelsecurity_title">ProfileFieldLevelSecurity</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which fields are visible to a user assigned to this
                profile, and the kind of access available (editable or hidden). This
                field is available in API version 22.0 and earlier.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname" id="fieldPermissions_field"><a name="fieldPermissions_field"><!-- --></a>fieldPermissions</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profilefieldlevelsecurity_title">ProfileFieldLevelSecurity</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which fields are visible to a user assigned to this
                profile, and the kind of access available (editable or readable).
                This field is available in API version 23.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">flowAccesses</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#ProfileFlowAccess_title">ProfileFlowAccess</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which flows can be accessed by a user assigned to this
                profile. Available in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">genComputingSummaryDefAccesses</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#ProfileGenComputingSummaryDefAccess">ProfileGenComputingSummaryDefAccess</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates enhanced summary access configuration for users
                assigned to this profile. Available in API version 66.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e229" data-title="Description">The name can only contain characters, letters, and the underscore
                (_) character. The name must start with a letter, and can’t end with
                an underscore or contain two consecutive underscore
                characters.<p class="p">Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component, this field isn’t defined in
                  the WSDL for this component. It must be specified when creating,
                  updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see an example of this field
                  specified for a call.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">layoutAssignments</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profilelayoutassignments">ProfileLayoutAssignments</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which layout to use for this profile. </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">loginFlows</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#loginflow_title">LoginFlow</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates a business process that you direct users to before they
                access Salesforce.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">loginHours</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#ProfileLoginHours_title">ProfileLoginHours</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">
                <span class="ph" id="field_loginHours_desc"><a name="field_loginHours_desc"><!-- --></a>Indicates the hours within which a
                  user with this profile can log in. If not specified, the profile
                  doesn’t restrict a user’s login hours.</span>
                <p class="p">This field is
                  available in API version 25.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname" id="field_loginIpRanges"><a name="field_loginIpRanges"><!-- --></a>loginIpRanges</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#ProfileLoginIpRange_title">ProfileLoginIpRange</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">
                <span class="ph" id="field_field_loginIpRanges_desc"><a name="field_field_loginIpRanges_desc"><!-- --></a>The list of IP address
                  ranges from which users with a particular profile can log
                  in.</span>
                <p class="p">This field is available in API version 17.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">objectPermissions</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profileobjectpermissions_title">ProfileObjectPermissions</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">
                <span class="ph" id="field_objectPermissions_desc"><a name="field_objectPermissions_desc"><!-- --></a>Indicates which objects are
                  accessible to a user assigned to this profile, and the kind of
                  access available (create, read, edit, delete, and so on). In API
                  version 28.0 and later, this field is only retrieved when
                  <span class="keyword parmname">allowRead</span> is <samp class="codeph java">true</samp>.</span>
                <p class="p">In
                  API version 50.0 and later, editing standard objects on standard
                  profiles is disabled.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">pageAccesses</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profileApexPageAccess_title">ProfileApexPageAccess</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which Visualforce pages that users assigned to this
                profile can execute.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">profileActionOverrides</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#ProfileActionOverride_title">ProfileActionOverride</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">
                <span class="ph" id="profileActionOverrides_desc"><a name="profileActionOverrides_desc"><!-- --></a>A list of the Lightning
                  Experience Home page action overrides that are assigned to this
                  profile. When a user logs in with a profile, a matching
                  ProfileActionOverride assignment takes precedence over existing
                  overrides for the Home tab specified in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm#actionoverride" title="Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can access ActionOverride only by accessing its encompassing CustomObject.">ActionOverride</a>.</span>
                <p class="p">This field is available in API versions 37.0 to
                  44.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">recordTypeVisibilities</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profilerecordtypevisibility_title">ProfileRecordTypeVisibility</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates the visibility of record types for users assigned to
                this profile. In API version 29.0 and later, this field isn’t
                retrieved or deployed for inactive record types.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">ServicePresenceStatusAccesses</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type"><a class="xref" href="#section_w4v_tg4_1fc">ProfileServicePresenceStatusAccess[]</a></td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which Service presence statuses that the user assigned
                to this profile can execute. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">tabVisibilities</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profiletabvisibility_title">ProfileTabVisibility</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Indicates which record types are visible to a user assigned to
                this profile, and therefore which tabs within an app are
                visible.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname" id="field_userLicense"><a name="field_userLicense"><!-- --></a>userLicense</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e229" data-title="Description">
                <span class="ph" id="field_userLicense_desc"><a name="field_userLicense_desc"><!-- --></a>The <span class="keyword parmname">User
                    License</span> for the profile. A user license
                  determines the baseline of features that the user can access.
                  Every user must have exactly one user license.</span>
                <p class="p">This field
                  is available in API version 17.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e223" data-title="Field Name"><span class="keyword parmname">userPermissions</span></td>

              <td class="entry" headers="d762099e226" data-title="Field Type">
                <a class="xref" href="#profileUserPerm_title">ProfileUserPermission</a>[]
              </td>

              <td class="entry" headers="d762099e229" data-title="Description">Specifies a user permission (such as “API Enabled”)
                and whether it’s enabled for this profile. This field
                retrieves only enabled user permissions. Available in API version
                29.0 and later.</td>

            </tr>

          </tbody>

        </table>

## LoginFlow

LoginFlow represents a business process that you direct users to before they access Salesforce. You can use Metadata API to define existing flows as login flows and to edit login flow definitions. To delete login flow definitions, use the [Login Flow page](https://help.salesforce.com/articleView?id=security_login_flow_associate.htm&language=en_US "HTML (New Window)").

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d762099e757">Field Name</th>

              <th class="featureTableHeader  " id="d762099e760">Field Type</th>

              <th class="featureTableHeader  " id="d762099e763">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d762099e757" data-title="Field Name"><span class="keyword parmname">flow</span></td>

              <td class="entry" headers="d762099e760" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e763" data-title="Description">Required only if the <span class="keyword parmname">uiLoginFlowType</span> is
                <samp class="codeph java">VisualWorkflow</samp>. The
                <span class="keyword parmname">fullName</span> of the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm" target="_blank">Flow</a>. <p class="p">Before you can
                  deploy the LoginFlow, the Flow referenced here must be deployed
                  in your org and its status must be <samp class="codeph nolang">Active</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e757" data-title="Field Name"><span class="keyword parmname">flowtype</span></td>

              <td class="entry" headers="d762099e760" data-title="Field Type">LoginFlowType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d762099e763" data-title="Description">Required. The value is <samp class="codeph java">UI</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e757" data-title="Field Name"><span class="keyword parmname">friendlyname</span></td>

              <td class="entry" headers="d762099e760" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e763" data-title="Description">Required. The name of the LoginFlow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e757" data-title="Field Name"><span class="keyword parmname">uiLoginFlowType</span></td>

              <td class="entry" headers="d762099e760" data-title="Field Type">UiLoginFlowType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d762099e763" data-title="Description">Required. The type of login flow. These are valid values.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph java">VisualWorkflow</samp>—Indicates
                    a Salesforce <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm" target="_blank">Flow</a>. You can
                    create these flows using Flow Builder.
                  </li>

                  <li class="li">
                    <samp class="codeph java">VisualForce</samp>—Indicates a
                    flow created using Visualforce.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e757" data-title="Field Name"><span class="keyword parmname">useLightningRuntime</span></td>

              <td class="entry" headers="d762099e760" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e763" data-title="Description">Indicates if Lightning Runtime is used (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>
                (default)). Used only if <span class="keyword parmname">uiLoginFlowType</span> is
                <samp class="codeph java">VisualWorkflow</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e757" data-title="Field Name"><span class="keyword parmname">vfFlowPage</span></td>

              <td class="entry" headers="d762099e760" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e763" data-title="Description">Required only if the <span class="keyword parmname">uiLoginFlowType</span> is
                <samp class="codeph java">VisualForce</samp>. The name of the
                VisualForce page.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e757" data-title="Field Name"><span class="keyword parmname">vfFlowPageTitle</span></td>

              <td class="entry" headers="d762099e760" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e763" data-title="Description">Required only if the <span class="keyword parmname">uiLoginFlowType</span> is
                <samp class="codeph java">VisualForce</samp>. The name of the
                VisualForce page.
              </td>

            </tr>

          </tbody>

        </table>

## ProfileActionOverride

ProfileActionOverride represents a user profile-based override of an [ActionOverride](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm#actionoverride "Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can access ActionOverride only by accessing its encompassing CustomObject.") on a standard Home tab in Lightning Experience.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

- ProfileActionOverride can be defined only on Profile for API version 39.0 to 44.0. In API version 45.0 and later, ProfileActionOverride must be defined for CustomApplication instead. Beginning with API version 45.0, Home page assignments related to user profile must also have a corresponding app assignment because more granular Home page assignments are supported. As a result, ProfileActionOverride is defined for CustomApplication rather than Profile.
- ProfileActionOverride settings aren’t retrieved in the .profile file unless a Lightning page is referenced in the package.xml file.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d762099e986">Field Name</th>

              <th class="featureTableHeader  " id="d762099e989">Field Type</th>

              <th class="featureTableHeader  " id="d762099e992">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d762099e986" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d762099e989" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e992" data-title="Description">Required. The possible values are the same as the actions you can override:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">accept</samp></li>

                  <li class="li"><samp class="codeph nolang">clone</samp></li>

                  <li class="li"><samp class="codeph nolang">delete</samp></li>

                  <li class="li"><samp class="codeph nolang">edit</samp></li>

                  <li class="li"><samp class="codeph nolang">list</samp></li>

                  <li class="li"><samp class="codeph nolang">new</samp></li>

                  <li class="li"><samp class="codeph nolang">tab</samp></li>

                  <li class="li"><samp class="codeph nolang">view</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e986" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d762099e989" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e992" data-title="Description">Set this field if <span class="keyword parmname">type</span> is set to <samp class="codeph nolang">flexipage</samp>, <samp class="codeph nolang">lightningcomponent</samp>, <samp class="codeph nolang">scontrol</samp>, or <samp class="codeph nolang">visualforce</samp>. It refers to the name
                of the Lightning page, Lightning component, s-control, or
                Visualforce page to use as the override. To reference installed
                components, use this format: <samp class="codeph nolang"><var class="keyword varname">Component_namespace</var>__<var class="keyword varname">Component_name</var></samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e986" data-title="Field Name"><span class="keyword parmname">formFactor</span></td>

              <td class="entry" headers="d762099e989" data-title="Field Type">FormFactor (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d762099e992" data-title="Description">The size of the page being overridden.<p class="p">The <samp class="codeph nolang">Large</samp> value represents the
                  Lightning Experience desktop environment and is valid only for
                  the <samp class="codeph nolang">flexipage</samp> and <samp class="codeph nolang">lightningcomponent</samp> types. The
                  <samp class="codeph nolang">Small</samp> value represents
                  the Salesforce mobile app on a phone or tablet. The <samp class="codeph nolang">Medium</samp> value is reserved for
                  future use. The <samp class="codeph nolang">null</samp> value
                  (which is the same as specifying no value) represents Salesforce
                  Classic.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e986" data-title="Field Name"><span class="keyword parmname">pageOrSobjectType</span></td>

              <td class="entry" headers="d762099e989" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e992" data-title="Description">The name of the sObject type being overridden. Valid values are
                <samp class="codeph nolang">standard</samp> and <samp class="codeph nolang">custom</samp>.<p class="p">This
                  value must be <samp class="codeph nolang">standard-home</samp>
                  when actionName is <samp class="codeph nolang">tab</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e986" data-title="Field Name"><span class="keyword parmname">recordType</span></td>

              <td class="entry" headers="d762099e989" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e992" data-title="Description">The record type assigned to the ProfileActionOverride. If the
                <span class="keyword parmname">PageOrSobjectType</span> is <samp class="codeph nolang">standard-home</samp>, this field is
                null.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e986" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d762099e989" data-title="Field Type">ActionOverrideType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d762099e992" data-title="Description">Required. Represents the type of action override. Valid values
                are described in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/actionoverride.htm#actionOverrideType_section">ActionOverrideType</a>.</td>

            </tr>

          </tbody>

        </table>

## ProfileAgentAccess

ProfileAgentAccess represents the agent access configuration for users assigned through a profile.

| Field Name | Field Type | Description |
| --- | --- | --- |
| agentName | string | Required. The name of the employee agent. |
| enabled | boolean | Required. Indicates whether users assigned to this profile can use the Agentforce Employee Agent (true) or not (false). |

## ProfileApplicationVisibility

ProfileApplicationVisibility determines whether an app is visible to a user assigned to this profile.

| Field Name | Field Type | Description |
| --- | --- | --- |
| application | string | Required. The name of the app. |
| default | boolean | Required. Indicates whether the app is the default app (true) or not (false). Only one app per profile can be set to true. |
| visible | boolean | Required. Indicates whether this app is visible to users assigned to this profile (true) or not (false). |

## ProfileCategoryGroupVisibility

ProfileCategoryGroupVisibility determines whether a data category group is visible to a user assigned to this profile. Available in API version 41.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d762099e1379">Field Name</th>

              <th class="featureTableHeader  " id="d762099e1382">Field Type</th>

              <th class="featureTableHeader  " id="d762099e1385">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d762099e1379" data-title="Field Name"><span class="keyword parmname">dataCategories</span></td>

              <td class="entry" headers="d762099e1382" data-title="Field Type">string[]</td>

              <td class="entry" headers="d762099e1385" data-title="Description">Array of one or more data category names.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e1379" data-title="Field Name"><span class="keyword parmname">dataCategoryGroup</span></td>

              <td class="entry" headers="d762099e1382" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e1385" data-title="Description">Required. The name of the data category group.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e1379" data-title="Field Name"><span class="keyword parmname">visibility</span></td>

              <td class="entry" headers="d762099e1382" data-title="Field Type">CategoryGroupVisibility (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d762099e1385" data-title="Description">Required. Indicates the visibility of the data category. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ALL</samp></li>

                  <li class="li"><samp class="codeph nolang">CUSTOM</samp></li>

                  <li class="li"><samp class="codeph nolang">NONE</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ProfileCustomMetadataTypeAccess

[ProfileCustomMetadataTypeAccess](#ProfileCustomMetadataTypeAccess_title) represents the custom metadata type access for users assigned to a profile. Available in API version 47.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the records for this custom metadata type are readable (true) or not (false). |
| name | string | Required. The custom metadata type name. |

## ProfileApexClassAccess

ProfileApexClassAccess determines which top-level Apex classes have methods that users assigned to this profile can execute.

| Field Name | Field Type | Description |
| --- | --- | --- |
| apexClass | string | Required. The Apex class name. |
| enabled | boolean | Required. Indicates whether users assigned to this profile can execute methods in the top-level class (true) or not (false). |

## ProfileCustomPermissions

ProfileCustomPermissions represents the custom permissions access for users assigned to a profile. Only enabled custom permissions are retrieved.

| Field Name | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the custom permission is enabled (true) or not (false). |
| name | string | Required. The custom permission name. |

## ProfileCustomSettingAccesses

ProfileCustomSettingAccesses represents the custom setting access for users assigned to a profile. Available in API version 47.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the records for this custom setting are readable (true) or not (false). |
| name | string | Required. The custom setting name. |

## ProfileExternalDataSourceAccess

ProfileExternalDataSourceAccess represents the data source access for users with identity type of Available in API version 27.0 and later.Per User.

| Field Name | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the data source is enabled (true) or not (false). |
| externalDataSource | string | The name of the external data source. |

## ProfileFieldLevelSecurity

ProfileFieldLevelSecurity represents the field level security for users assigned to a profile. In API version 30.0 and later, permissions for required fields can’t be retrieved or deployed.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d762099e1837">Field Name</th>

              <th class="featureTableHeader  " id="d762099e1840">Field Type</th>

              <th class="featureTableHeader  " id="d762099e1843">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d762099e1837" data-title="Field Name"><span class="keyword parmname">editable</span></td>

              <td class="entry" headers="d762099e1840" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e1843" data-title="Description">Required. Indicates whether this field is editable (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). <p class="p">In API version 30.0 and
                  later, when deploying a new custom field, this field is <samp class="codeph java">false</samp> by default.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e1837" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d762099e1840" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e1843" data-title="Description">Required. Indicates the name of the field.<p class="p">When referencing
                  shared Activity fields, specify Event or Task. For example,
                  <samp class="codeph nolang">Event.Meeting__c</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e1837" data-title="Field Name"><span class="keyword parmname" id="profileFLSHidden_field"><a name="profileFLSHidden_field"><!-- --></a>hidden</span></td>

              <td class="entry" headers="d762099e1840" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e1843" data-title="Description">Indicates whether this field is hidden (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). This field is available in API version 22.0 and
                earlier. <p class="p">For portal profiles, this field is set to <samp class="codeph java">true</samp> by default in API version
                  19.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e1837" data-title="Field Name"><span class="keyword parmname" id="profileFLSReadable_field"><a name="profileFLSReadable_field"><!-- --></a>readable</span></td>

              <td class="entry" headers="d762099e1840" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e1843" data-title="Description">Indicates whether this field is readable (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). This field is available in
                API version 23.0 and later. It replaces the
                <span class="keyword parmname">hidden</span> field.<p class="p">In API version 30.0 and
                  later, when deploying a new custom field, this field is <samp class="codeph java">false</samp> by default.</p>
                <p class="p">For
                  portal profiles, this field is set to <samp class="codeph java">false</samp> by default.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ProfileFlowAccess

[ProfileFlowAccess](#ProfileFlowAccess_title) represents which flows a profile grants access to. Available in API version 47.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether users assigned this profile can access the flow (true) or not (false). The default value is false. |
| flow | string | Required. The name of the flow to which access is granted. |

## ProfileGenComputingSummaryDefAccess

ProfileGenComputingSummaryDefAccess represents the enhanced summary access configuration for users assigned through a profile. Available in API version 66.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| configName | string | Required. The enhanced summary access configuration name given by the admin. |
| enabled | boolean | Required. Indicates whether the configuration is enabled (true) or not (false). |

## ProfileLayoutAssignments

ProfileLayoutAssignments determines which layout to use for a profile and a given entity.

| Field Name | Field Type | Description |
| --- | --- | --- |
| layout | string | Required. Indicates the layout for this particular entity. |
| recordType | string | This field is optional. If the recordType of the record matches a layout assignment rule, it uses the specified layout. |

## ProfileLoginHours

ProfileLoginHours restricts the days and times within which users with a particular profile can log in.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d762099e2198">Field Name</th>

              <th class="featureTableHeader  " id="d762099e2201">Field Type</th>

              <th class="featureTableHeader  " id="d762099e2204">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d762099e2198" data-title="Field Name"><span class="keyword parmname"><var class="keyword varname">weekday</var>Start</span></td>

              <td class="entry" headers="d762099e2201" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e2204" data-title="Description">Specifies the earliest time on that day that a user with this
                profile can log in. If a start time for a particular day is
                specified, an end time for that day also must be specified. Start
                can’t be greater than end for a particular day.<ul class="ul bulletList">
                  <li class="li">Valid values for <span class="keyword parmname">weekday</span>:
                    <span class="keyword parmname">monday</span>,
                    <span class="keyword parmname">tuesday</span>,
                    <span class="keyword parmname">wednesday</span>,
                    <span class="keyword parmname">thursday</span>,
                    <span class="keyword parmname">friday</span>,
                    <span class="keyword parmname">saturday</span>, or
                    <span class="keyword parmname">sunday</span>. For example,
                    <span class="keyword parmname">mondayStart</span> indicates the beginning
                    of the login period for Monday.
                  </li>

                  <li class="li">Valid values for Start: the number of minutes since
                    midnight. Must be evenly divisible by 60 (full hours). For
                    example, <samp class="codeph nolang">300</samp> is 5:00
                    AM.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2198" data-title="Field Name"><span class="keyword parmname"><var class="keyword varname">weekday</var>End</span></td>

              <td class="entry" headers="d762099e2201" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e2204" data-title="Description">Specifies the time on that day that a user with this profile must
                log out by. <ul class="ul bulletList">
                  <li class="li">Valid values for <span class="keyword parmname">weekday</span>:
                    <span class="keyword parmname">monday</span>,
                    <span class="keyword parmname">tuesday</span>,
                    <span class="keyword parmname">wednesday</span>,
                    <span class="keyword parmname">thursday</span>,
                    <span class="keyword parmname">friday</span>,
                    <span class="keyword parmname">saturday</span>, or
                    <span class="keyword parmname">sunday</span>. For example,
                    <span class="keyword parmname">mondayEnd</span> indicates the close of
                    the login period for Monday.
                  </li>

                  <li class="li">Valid values for End: the number of minutes since midnight.
                    Must be evenly divisible by 60 (full hours). For example,
                    <samp class="codeph nolang">1020</samp> is 5:00
                    PM.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

To delete login hour restrictions from a profile that previously had them, you must explicitly include an empty loginHours tag without any start or end times.

## ProfileLoginIpRange

ProfileLoginIpRange IP defines an IP address range that users with a particular profile can log in from.

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Use this field to identify the purpose of the range, such as which part of a network corresponds to this range. This field is available in API version 31.0 and later. |
| endAddress | string | Required. The end IP address for the range. |
| startAddress | string | Required. The start IP address for the range. |

## ProfileObjectPermissions

ProfileObjectPermissions represents a user's access to objects.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

- In API version 18.0 and later, these permissions are disabled in new custom objects for any profiles where “View All Data” or “Modify All Data” is disabled.
- In API version 50.0 and later, editing standard objects on standard profiles is disabled.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d762099e2438">Field Name</th>

              <th class="featureTableHeader  " id="d762099e2441">Field Type</th>

              <th class="featureTableHeader  " id="d762099e2444">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d762099e2438" data-title="Field Name"><span class="keyword parmname">allowCreate</span></td>

              <td class="entry" headers="d762099e2441" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2444" data-title="Description">Indicates whether the object referenced by the
                <span class="keyword parmname">object</span> field can be created by the users
                assigned to this profile (<samp class="codeph java">true</samp>)
                or not (<samp class="codeph java">false</samp>).<p class="p" id="field_allowCreate_old_name"><a name="field_allowCreate_old_name"><!-- --></a>This field is named
                  <span class="keyword parmname">revokeCreate</span> before version 14.0 and
                  the logic is reversed. <span class="ph" id="boolean_logic_flip"><a name="boolean_logic_flip"><!-- --></a>The field
                    name change and the update from <samp class="codeph java">true</samp> to <samp class="codeph java">false</samp> and the reverse is automatically handled
                    between versions and doesn’t require any manual editing of
                    existing XML component files.</span>
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2438" data-title="Field Name"><span class="keyword parmname">allowDelete</span></td>

              <td class="entry" headers="d762099e2441" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2444" data-title="Description">Indicates whether the object referenced by the
                <span class="keyword parmname">object</span> field can be deleted by the users
                assigned to this profile (<samp class="codeph java">true</samp>)
                or not (<samp class="codeph java">false</samp>).<p class="p" id="field_allowDelete_old_name"><a name="field_allowDelete_old_name"><!-- --></a>This field is named
                  The field
                  name change and the update from <span class="keyword parmname">revokeDelete</span> before version 14.0 and
                  the logic is reversed. <samp class="codeph java">true</samp> to <samp class="codeph java">false</samp> and the reverse is automatically handled
                  between versions and doesn’t require any manual editing of
                  existing XML component files.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2438" data-title="Field Name"><span class="keyword parmname">allowEdit</span></td>

              <td class="entry" headers="d762099e2441" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2444" data-title="Description">Indicates whether the object referenced by the
                <span class="keyword parmname">object</span> field can be edited by the users
                assigned to this profile (<samp class="codeph java">true</samp>)
                or not (<samp class="codeph java">false</samp>).<p class="p" id="field_allowEdit_old_name"><a name="field_allowEdit_old_name"><!-- --></a>This field is named
                  The field
                  name change and the update from <span class="keyword parmname">revokeEdit</span> before version 14.0 and the
                  logic is reversed. <samp class="codeph java">true</samp> to <samp class="codeph java">false</samp> and the reverse is automatically handled
                  between versions and doesn’t require any manual editing of
                  existing XML component files.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2438" data-title="Field Name"><span class="keyword parmname">allowRead</span></td>

              <td class="entry" headers="d762099e2441" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2444" data-title="Description">Indicates whether the object referenced by the
                <span class="keyword parmname">object</span> field can be seen by the users
                assigned to this profile (<samp class="codeph java">true</samp>)
                or not (<samp class="codeph java">false</samp>).<p class="p" id="field_allowRead_old_name"><a name="field_allowRead_old_name"><!-- --></a>This field is named
                  The field
                  name change and the update from <span class="keyword parmname">revokeRead</span> before version 14.0 and the
                  logic is reversed. <samp class="codeph java">true</samp> to <samp class="codeph java">false</samp> and the reverse is automatically handled
                  between versions and doesn’t require any manual editing of
                  existing XML component files.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2438" data-title="Field Name"><span class="keyword parmname">modifyAllRecords</span></td>

              <td class="entry" headers="d762099e2441" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2444" data-title="Description">Indicates whether all records for the object referenced by the
                <span class="keyword parmname">object</span> field can be read, edited, or
                deleted by the users assigned to this profile (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>), regardless of the sharing
                settings for the object. This setting is equivalent to the Modify
                All Data user permission limited to the individual object level.
                Available in API version 15.0 and later. <p class="p">This field isn’t
                  available for all objects. Refer to the profile in the user
                  interface to determine which objects currently support these
                  permissions. Profiles with Modify All Data ignore
                  <span class="keyword parmname">modifyAllRecords</span> entries in Metadata
                  API and don't return an error if Modify All Data is enabled on
                  the profile.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2438" data-title="Field Name"><span class="keyword parmname" id="profileOobjectPermissions_object"><a name="profileOobjectPermissions_object"><!-- --></a>object</span></td>

              <td class="entry" headers="d762099e2441" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e2444" data-title="Description">Required. The name of the object whose permissions are altered by
                this profile, for example, <samp class="codeph nolang">MyCustomObject__c</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2438" data-title="Field Name"><span class="keyword parmname">viewAllFields</span></td>

              <td class="entry" headers="d762099e2441" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2444" data-title="Description">Indicates whether all fields and field data for the object
                referenced by the <span class="keyword parmname">object</span> field can be read by
                the users assigned to this profile (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2438" data-title="Field Name"><span class="keyword parmname">viewAllRecords</span></td>

              <td class="entry" headers="d762099e2441" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2444" data-title="Description">Indicates whether all records for the object referenced by the
                <span class="keyword parmname">object</span> field can be read by the users
                assigned to this profile (<samp class="codeph java">true</samp>)
                or not (<samp class="codeph java">false</samp>), regardless of the
                sharing settings for the object. This setting includes private
                records (records with no parent object). This setting is equivalent
                to the View All Data user permission limited to the individual
                object level. Available in API version 15.0 and later. <p class="p">This field
                  isn’t available for all objects. Refer to the profile in the
                  user interface to determine which objects currently support
                  these permissions. Profiles with "View All Data" ignore
                  <span class="keyword parmname">viewAllRecords</span> entries in the Metadata
                  API and don't return an error if View All Data is enabled on the
                  profile.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## ProfileApexPageAccess

ProfileApexPageAccess determines which Visualforce pages that users assigned to this profile can execute.

| Field Name | Field Type | Description |
| --- | --- | --- |
| apexPage | string | Required. The Visualforce page name. |
| enabled | boolean | Required. Indicates whether users assigned to this profile can execute the Visualforce page (true) or not (false). |

## ProfileRecordTypeVisibility

ProfileRecordTypeVisibility represents the visibility of record types for this profile. Record types let you offer different business processes, picklist values, and page layouts to different users.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d762099e2777">Field Name</th>

              <th class="featureTableHeader  " id="d762099e2780">Field Type</th>

              <th class="featureTableHeader  " id="d762099e2783">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d762099e2777" data-title="Field Name"><span class="keyword parmname">default</span></td>

              <td class="entry" headers="d762099e2780" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2783" data-title="Description">Required. Indicates whether the record type is the default when
                users with this profile create records for this object (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2777" data-title="Field Name"><span class="keyword parmname">personAccountDefault</span></td>

              <td class="entry" headers="d762099e2780" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2783" data-title="Description">
                <span class="ph" id="field_personAccountDefault_desc"><a name="field_personAccountDefault_desc"><!-- --></a>When Person Accounts is
                  enabled, this field indicates whether the record type is this
                  profile’s default person account record type (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When Person Accounts is
                  disabled, this field’s value has no impact.</span>
                <p class="p">Person
                  accounts aren’t enabled by default in Salesforce. To request
                  person accounts, contact Salesforce.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2777" data-title="Field Name"><span class="keyword parmname">recordType</span></td>

              <td class="entry" headers="d762099e2780" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e2783" data-title="Description">Required. The record type name, for example <samp class="codeph nolang">Account.MyRecordType</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2777" data-title="Field Name"><span class="keyword parmname">visible</span></td>

              <td class="entry" headers="d762099e2780" data-title="Field Type">boolean</td>

              <td class="entry" headers="d762099e2783" data-title="Description">Required. Indicates whether this record type is visible to users
                assigned to this profile (<samp class="codeph java">true</samp>)
                or not (<samp class="codeph java">false</samp>).</td>

            </tr>

          </tbody>

        </table>

## ProfileTabVisibility

ProfileTabVisibility represents the visibility of tabs for this profile. For version 17.0 and later, ProfileTabVisibility supports visibility of tabs for standard objects. The manifest file must include the standard object corresponding to a standard tab to retrieve the tab visibility in a profile.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d762099e2892">Field Name</th>

              <th class="featureTableHeader  " id="d762099e2895">Field Type</th>

              <th class="featureTableHeader  " id="d762099e2898">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d762099e2892" data-title="Field Name"><span class="keyword parmname">tab</span></td>

              <td class="entry" headers="d762099e2895" data-title="Field Type">string</td>

              <td class="entry" headers="d762099e2898" data-title="Description">Required. The name of the tab.</td>

            </tr>

            <tr>
              <td class="entry" headers="d762099e2892" data-title="Field Name"><span class="keyword parmname">visibility</span></td>

              <td class="entry" headers="d762099e2895" data-title="Field Type">TabVisibility (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d762099e2898" data-title="Description">Required. Indicates the visibility of the tab. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">DefaultOff</samp>—The
                    tab is available on the All Tabs page. Users can
                    individually customize their display to make the tab visible
                    in any app.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DefaultOn</samp>—The
                    tab is available on the All Tabs page and appears in the
                    visible tabs for its associated app. Users can individually
                    customize their display to hide the tab or make it visible
                    in other apps.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Hidden</samp>—The tab
                    isn’t available on the All Tabs page or visible in any
                    apps.
                  </li>

                </ul>

                <p class="p">In API version 36.0 and earlier, <samp class="codeph nolang">Hidden</samp> is returned only if <span class="keyword parmname">visibility</span>
                  was set using the API. If it was set to <samp class="codeph nolang">Hidden</samp> from the profile in Salesforce, the API doesn’t return
                  a visibility value. For version 37.0 and later, when tab visibility is set to
                  hidden, the API returns <samp class="codeph nolang">Hidden</samp>,
                  regardless of how the value was set.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ProfileUserPermission

ProfileUserPermission represents an app or system permission for a profile. Use one of these elements for each permission.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the permission is enabled (true) or disabled (false). |
| name | string | Required. The permission name. |

## ProfileServicePresenceStatusAccess

Represents the presence statuses that reps assigned to this profile have access. Available in API version 64.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| servicePresenceStatus | string | Required. The name of Service Presence Status. |
| enabled | boolean | Required. Indicates whether the rep assigned to this profile has access to the presence status (true) or not (false). |

## Java Sample

This sample uses picklists, profiles, record types, and a custom app:

public void profileSample() {
  try {
    // Create an expense report record, tab and app...
    CustomObject expenseRecord = new CustomObject();
    expenseRecord.setFullName("ExpenseReport\_\_c");
    expenseRecord.setLabel("Expense Report");
    expenseRecord.setPluralLabel("Expense Reports");
    
    expenseRecord.setDeploymentStatus(DeploymentStatus.Deployed);
    expenseRecord.setSharingModel(SharingModel.ReadWrite);
    
    CustomField nameField = new CustomField();
    nameField.setType(FieldType.AutoNumber);
    nameField.setLabel("Expense Report Number");
    nameField.setDisplayFormat("ER-{0000}");
    expenseRecord.setNameField(nameField);
    
    AsyncResult\[\] arsExpenseRecord =
        metadataConnection.create(new Metadata\[\] {expenseRecord});
    
    Picklist expenseStatus = new Picklist();
    PicklistValue unsubmitted = new PicklistValue();
    unsubmitted.setFullName("Unsubmitted");
    PicklistValue submitted = new PicklistValue();
    submitted.setFullName("Submitted");
    PicklistValue approved = new PicklistValue();
    approved.setFullName("Approved");
    PicklistValue rejected = new PicklistValue();
    rejected.setFullName("Rejected");
    expenseStatus.setPicklistValues(new PicklistValue\[\] {
        unsubmitted, submitted, approved, rejected}
    );
    
    CustomField expenseStatusField = new CustomField();
    expenseStatusField.setFullName(
        "ExpenseReport\_\_c.ExpenseStatus\_\_c"
    );
    expenseStatusField.setLabel("Expense Report Status");
    expenseStatusField.setType(FieldType.Picklist);
    expenseStatusField.setPicklist(expenseStatus);
    AsyncResult\[\] arsStatusField =
        metadataConnection.create(new Metadata\[\] 
            {expenseStatusField});
    
    CustomTab expenseTab = new CustomTab();
    expenseTab.setFullName("ExpenseReport\_\_c");
    expenseTab.setMotif("Custom70: Handsaw");
    expenseTab.setCustomObject(true);
    AsyncResult\[\] arsTab =
        metadataConnection.create(new Metadata\[\] {expenseTab});
    
    CustomApplication application = new CustomApplication();
    application.setFullName("ExpenseForce");
    application.setTab(new String\[\] {expenseTab.getFullName()});
    AsyncResult\[\] arsApp =
        metadataConnection.create(new Metadata\[\] {application});
    
    // Employees and managers have the same app visibility...
    ProfileApplicationVisibility appVisibility =
        new ProfileApplicationVisibility();
    appVisibility.setApplication("ExpenseForce");
    appVisibility.setVisible(true);
    
    Profile employee = new Profile(); 
    employee.setFullName("Employee");
    employee.setApplicationVisibilities(
        new ProfileApplicationVisibility\[\] {appVisibility}
    );
    AsyncResult\[\] arsProfileEmp =
    metadataConnection.create(new Metadata\[\] {employee});
    
    Profile manager = new Profile();
    manager.setFullName("Manager");
    manager.setApplicationVisibilities(
        new ProfileApplicationVisibility\[\] {appVisibility}
    );
    AsyncResult\[\] arsProfileMgr =
        metadataConnection.create(new Metadata\[\] {manager});
    
    // But employees and managers have different access
    // to the state of the expense sheet
    RecordType edit = new RecordType();
    edit.setFullName("ExpenseReport\_\_c.Edit");
    RecordTypePicklistValue editStatuses =
        new RecordTypePicklistValue();
    editStatuses.setPicklist("ExpenseStatus\_\_c");
    editStatuses.setValues(new PicklistValue\[\] 
        {unsubmitted, submitted});
    edit.setPicklistValues(new RecordTypePicklistValue\[\] 
        {editStatuses});
    AsyncResult\[\] arsRecTypeEdit =
        metadataConnection.create(new Metadata\[\] {edit});
    
    RecordType approve = new RecordType();
    approve.setFullName("ExpenseReport\_\_c.Approve");
    RecordTypePicklistValue approveStatuses =
        new RecordTypePicklistValue();
    approveStatuses.setPicklist("ExpenseStatus\_\_c");
    approveStatuses.setValues(new PicklistValue\[\] 
        {approved, rejected});
    approve.setPicklistValues(new RecordTypePicklistValue\[\]
        {approveStatuses});
    AsyncResult\[\] arsRecTypeApp =
        metadataConnection.create(new Metadata\[\] {approve});
  } catch (ConnectionException ce) {
    ce.printStackTrace();
  }
}

## Declarative Metadata Sample Definition

The definition of a profile in an organization with a custom app, custom object, record type, tab, and user permission is:

<?xml version="1.0" encoding="UTF-8"?>
<Profile xmlns="http://soap.sforce.com/2006/04/metadata">
    <applicationVisibilities\>
        <application\>PubApps\_\_Myriad\_Publishing</application\>
        <default\>false</default\>
        <visible\>true</visible\>
    </applicationVisibilities\>
    <custom\>true</custom\>
    <objectPermissions\>
        <object\>TestWeblinks\_\_c</object\>
        <allowCreate\>true</allowCreate\>
        <allowDelete\>true</allowDelete\>
        <allowEdit\>true</allowEdit\>
        <allowRead\>true</allowRead\>
        <viewAllRecords\>false</viewAllRecords\>
        <modifyAllRecords\>false</modifyAllRecords\>
        <viewAllFields\>false</viewAllFields\>
    </objectPermissions\>
    <recordTypeVisibilities\>
        <default\>true</default\>
        <recordType\>TestWeblinks\_\_c.My First Recordtype</recordType\>
        <visible\>true</visible\>
    </recordTypeVisibilities\>
    <tabVisibilities\>
        <tab\>Myriad Publications</tab\>
        <visibility\>DefaultOn</visibility\>
    </tabVisibilities\>
    <userPermissions\>
        <enabled\>true</enabled\>
        <name\>APIEnabled</name\>
    </userpermissions\>
</Profile\>

## Usage

To create custom profiles, we recommend that you use the Profile object instead of the [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") call on the Profile Metadata type. The Profile object allows you to create empty profiles that start without any permissions enabled except for required permissions for the profile’s user license.

When you use the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") call to get information about profiles, the returned .profile files only include security settings for the other metadata types referenced in the retrieve request. Exceptions include user permissions, IP address ranges, and login hours, which are always retrieved. For example, the following package.xml file contains a types element that matches all custom objects. The returned profiles contain object and field permissions for all custom objects in your organization but don’t include permissions for standard objects, such as Account, and standard fields.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>CustomObject</name\>
    </types\>
   <types\>
        <members\>\*</members\>
        <name\>Profile</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

The wildcard “\*” on CustomObject doesn’t match standard objects. This wildcard behavior helps you to avoid making unintended, high-impact profile changes. If you create a few custom objects in a Developer Edition organization, [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") the information, and later [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.") the custom objects to your production org, the profile and field-level security for all your standard objects and fields aren’t overwritten. You can only overwrite these standard objects and fields by explicitly creating separate types elements for the objects or fields.

Metadata API intentionally makes it difficult to include standard fields in [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") calls to prevent unexpected profile changes. But you can still retrieve and deploy profile permissions for custom and standard fields in standard objects, such as Account.

This package.xml file allows you to return profile permissions for Account standard and custom fields. Note how the standard Account object is defined in a types element by specifying it as a member of a CustomObject type.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Account</members\>
        <name\>CustomObject</name\>
    </types\>
   <types\>
        <members\>\*</members\>
        <name\>Profile</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

This package.xml file allows you to return profile permissions for the MyCustomField\_\_c custom field in the Account object.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
        <members\>Account.MyCustomField\_\_c</members\>
        <name\>CustomField</name\>
   </types\>
   <types\>
        <members\>\*</members\>
        <name\>Profile</name\>
   </types\>
   <version\>68.0</version\>
</Package\>

To retrieve field permissions for relationship fields, remove the “Id” part of the field. For example, in this package.xml file, to retrieve field permissions for the AccountId field for Contacts, you reference this field as Contact.Account not Contact.AcccountId.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
        <members\>Contact.Account</members\>
        <name\>CustomField</name\>
   </types\>
   <types\>
        <members\>\*</members\>
        <name\>Profile</name\>
   </types\>
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [_Salesforce DX Developer Guide_: Retrieve Changes to Profiles with Source Tracking](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_source_tracking_source_tracking_profiles.htm "Salesforce DX Developer Guide: Retrieve Changes to
    Profiles with Source Tracking - HTML (New Window)")

<!-- document id=20e263c711667262816e463b910ef34f25ff3afe57ce1d798b4180cbbe96735e url=/legacydeveloper/current/en-us/api_meta/meta_profileactionoverride.md -->

# ProfileActionOverride

Represents an override of an ActionOverride by a user profile. You can use it to override an ActionOverride on a standard Home tab or object record page in Lightning Experience. When a user logs in with a profile, a matching ProfileActionOverride assignment takes precedence over existing overrides for the Home tab or record page specified in ActionOverride. In API versions 39.0 to 44.0, you can access ProfileActionOverride by accessing its encompassing [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customapplication.htm#meta_customapplication "CustomApplication represents a custom or standard application. In API version 29.0 and earlier, CustomApplication represents only a custom application. An application is a list of tab references, with a description and a logo. This type extends the Metadata metadata type and inherits its fullName field.") or [Profile](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#meta_profile "Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field.") metadata types. In API version 45.0 and later, you can access ProfileActionOverride only by accessing its encompassing [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customapplication.htm#meta_customapplication "CustomApplication represents a custom or standard application. In API version 29.0 and earlier, CustomApplication represents only a custom application. An application is a list of tab references, with a description and a logo. This type extends the Metadata metadata type and inherits its fullName field.").

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

ProfileActionOverrides aren’t supported in packaging. They’re supported in change sets, but you have to add them manually.

## File Suffix and Directory Location

Profile-based action overrides are defined as part of a custom application or profile.

## Version

ProfileActionOverrides are available in API version 39.0 and later.

ProfileActionOverride can be defined on Profile or CustomApplication for API version 39.0 to 44.0. In API version 45.0 and later, ProfileActionOverride must be defined for CustomApplication instead. Beginning with API version 45.0, Home page assignments related to user profile must also have a corresponding app assignment because more granular Home page assignments are supported. As a result, ProfileActionOverride is defined for CustomApplication rather than Profile.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d771279e120">Field Name</th>

              <th class="featureTableHeader  " id="d771279e123">Field Type</th>

              <th class="featureTableHeader  " id="d771279e126">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d771279e120" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d771279e123" data-title="Field Type">string</td>

              <td class="entry" headers="d771279e126" data-title="Description">
                <span class="ph" id="actionname_desc"><a name="actionname_desc"><!-- --></a>The name of the action. The only valid values are
                  <samp class="codeph nolang">Tab</samp> and <samp class="codeph nolang">View</samp>.</span>
                <p class="p" id="actionname_desc2"><a name="actionname_desc2"><!-- --></a>If
                  <span class="keyword parmname">pageOrSobjectType</span> is <samp class="codeph nolang">standard-home</samp>, this field must be <samp class="codeph nolang">Tab</samp>. The <samp class="codeph nolang">Tab</samp> action is supported
                  only when ProfileActionOverride is being specified as part of a Profile in API
                  version 39.0 to 44.0.
                </p>
                <p class="p" id="actionname_desc4"><a name="actionname_desc4"><!-- --></a>In API version 45.0 and later,
                  this action is supported only when ProfileActionOverride is being specified as
                  part of a CustomApplication, <span class="keyword parmname">pageOrSobjectType</span> is <samp class="codeph nolang">standard-home</samp>, and this field is <samp class="codeph nolang">Tab</samp>.</p>
                <p class="p" id="actionname_desc3"><a name="actionname_desc3"><!-- --></a>If
                  <span class="keyword parmname">pageOrSobjectType</span> is <samp class="codeph nolang">record-home</samp>, this field must be <samp class="codeph nolang">View</samp>. The <samp class="codeph nolang">View</samp> action is
                  supported only when ProfileActionOverride is being specified as part of a
                  CustomApplication.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d771279e120" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d771279e123" data-title="Field Type">string</td>

              <td class="entry" headers="d771279e126" data-title="Description"><span class="ph" id="content_desc"><a name="content_desc"><!-- --></a>Read-only. Represents the name of the Lightning page
                  being used as the override.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d771279e120" data-title="Field Name"><span class="keyword parmname">formFactor</span></td>

              <td class="entry" headers="d771279e123" data-title="Field Type">FormFactor (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d771279e126" data-title="Description">The size of the page being overridden. The <samp class="codeph nolang">Large</samp> value represents the Lightning Experience desktop
                environment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d771279e120" data-title="Field Name"><span class="keyword parmname">pageOrSobjectType</span></td>

              <td class="entry" headers="d771279e123" data-title="Field Type">string</td>

              <td class="entry" headers="d771279e126" data-title="Description"><span class="ph" id="pageorsobjecttype_desc"><a name="pageorsobjecttype_desc"><!-- --></a>The name of the page being overridden. The only
                  valid values are <samp class="codeph nolang">record-home</samp> and <samp class="codeph nolang">standard-home</samp>. If the
                  <span class="keyword parmname">actionName</span> is <samp class="codeph nolang">Tab</samp>,
                  this field must be <samp class="codeph nolang">standard-home</samp></span></td>

            </tr>

            <tr>
              <td class="entry" headers="d771279e120" data-title="Field Name"><span class="keyword parmname">recordType</span></td>

              <td class="entry" headers="d771279e123" data-title="Field Type">string</td>

              <td class="entry" headers="d771279e126" data-title="Description">
                <span class="ph" id="recordtype_desc1"><a name="recordtype_desc1"><!-- --></a>The record type associated with the override.</span>
                <span class="ph" id="recordtype_desc2"><a name="recordtype_desc2"><!-- --></a>If <span class="keyword parmname">pageOrSobjectType</span> is <samp class="codeph nolang">standard-home</samp>, this field must be <samp class="codeph nolang">null</samp>.</span> This field is required when
                <span class="keyword parmname">actionName</span> is set to <samp class="codeph nolang">View</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d771279e120" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d771279e123" data-title="Field Type">ActionOverrideType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d771279e126" data-title="Description"><span class="ph" id="type_desc"><a name="type_desc"><!-- --></a>Read-only. The type of action override. The only valid value
                  is <samp class="codeph nolang">flexipage</samp>.</span></td>

            </tr>

          </tbody>

        </table>

## Usage

You can't delete custom app ProfileActionOverrides by deploying with destructiveChange.xml. To delete a ProfileActionOverride, retrieve the app. In the app definition file, find the <profileActionOverrides> section, and remove the <content> row. Then, change the <type> value in that same section to default instead of flexipage. Do this for every override you want to reset. After making the changes, rezip the folder and deploy.

You can remove one override at a time each with its own deploy, or you can remove multiple overrides in a single deploy. However, we recommend that you do a fresh retrieve every time you want to delete a new override. Don’t use a previously retrieved file.

Avoid creating duplicate ProfileActionOverrides in your org. Duplicate ProfileActionOverrides can cause problems, including being unable to select or deselect the **Disable end user personalization of nav items in this app** option in app settings and the **Disable Navigation Bar Personalization in Lightning Experience** User Interface setting.

## Declarative Metadata Sample Definition

You can define a ProfileActionOverride like this.

<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
    <profileActionOverrides\>
        <actionName\>View</actionName\>
        <content\>CustomObjectFlexiPage</content\>
        <formFactor\>Large</formFactor\>
        <pageOrSobjectType\>TestObj\_\_c</pageOrSobjectType\>
        <type\>Flexipage</type\>
        <profile\>standard</profile\>
        <recordType\>TestObj\_\_c.TestRecordType</recordType\>
    </profileActionOverrides\>
    <defaultLandingTab\>standard-home</defaultLandingTab\>
    <formFactors\>Large</formFactors\>
    <label\>My Custom App</label\>
    <tab\>standard-Account</tab\>
    <tab\>standard-Opportunity</tab\>
    <uiType\>Lightning</uiType\>
    <navType\>Standard</navType\>
</CustomApplication\>

Here’s an example package.xml.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyCustomApp</members\>
        <name\>CustomApplication</name\>
    </types\>
    <version\>39.0</version\>
</Package\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=9871ccb47fb7efe97515b530d08c978545305c16748310c030a0c1d1d76c7126 url=/legacydeveloper/current/en-us/api_meta/meta_profilepasswordpolicy.md -->

# ProfilePasswordPolicy

Represents a profile’s password policies. Profile password policies override org-wide password policies for that profile’s users. Use ProfilePasswordPolicy to retrieve password policies for a given profile. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

ProfilePasswordPolicy components have the suffix .profilePasswordPolicy and are stored in the profilePasswordPolicies folder.

## Version

ProfilePasswordPolicy components are available in API version 40.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d772177e85">Field Name</th>

              <th class="featureTableHeader  " id="d772177e88">Field Type</th>

              <th class="featureTableHeader  " id="d772177e91">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">forgotPasswordRedirect</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d772177e91" data-title="Description">If <samp class="codeph nolang">true</samp>, reset password links in forgot
                password emails don’t immediately expire the first time they’re clicked. Instead,
                the links stay active until a user confirms the password reset request on an
                interstitial page. The default value is <samp class="codeph nolang">false</samp>.<p class="p">This field is available in API version 43.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">lockoutInterval</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">int</td>

              <td class="entry" headers="d772177e91" data-title="Description">Required. The duration of the login lockout, in minutes. If users are locked
                out, they must wait until the lockout period expires. Valid values: <samp class="codeph java"><span class="number">0</span></samp>, <samp class="codeph java"><span class="number">15</span></samp>, <samp class="codeph java"><span class="number">30</span></samp>, <samp class="codeph java"><span class="number">60</span></samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">maxLoginAttempts</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">int</td>

              <td class="entry" headers="d772177e91" data-title="Description">Required. The number of times a user can enter a wrong password before getting
                locked out. Valid values: <samp class="codeph java"><span class="number">0</span></samp>, <samp class="codeph java"><span class="number">3</span></samp>, <samp class="codeph java"><span class="number">5</span></samp>, <samp class="codeph java"><span class="number">10</span></samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">minimumPasswordLength</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">int</td>

              <td class="entry" headers="d772177e91" data-title="Description">Required. Minimum number of characters required for a password. Valid values:
                <samp class="codeph java"><span class="number">5</span></samp>–<samp class="codeph java"><span class="number">50</span></samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">minimumPasswordLifetime</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d772177e91" data-title="Description">If <samp class="codeph java">true</samp>, a user cannot change a password
                more than once in a 24-hour period. </td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">obscure</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d772177e91" data-title="Description">If <samp class="codeph java">true</samp>, answers to security questions are
                hidden as the user types.</td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">passwordComplexity</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">int</td>

              <td class="entry" headers="d772177e91" data-title="Description">Required. Level of complexity required for the character types in a user’s
                password. <ul class="ul bulletList">
                  <li class="li">If <samp class="codeph java"><span class="number">0</span></samp>, the password can contain any type of
                    character.</li>

                  <li class="li">If <samp class="codeph java"><span class="number">1</span></samp>, the password must contain at least
                    one alphabetic character and 1 number.</li>

                  <li class="li">If <samp class="codeph java"><span class="number">2</span></samp>, the password must contain at least
                    one alphabetic character, one number, and one of the following special
                    characters: ! # $ % - _ = + &lt; &gt;.</li>

                  <li class="li">If <samp class="codeph java"><span class="number">3</span></samp>, the password must contain at least
                    one number, one uppercase letter, and one lowercase letter.</li>

                  <li class="li"> If <samp class="codeph java"><span class="number">4</span></samp>, the password must contain at least
                    one number, one uppercase letter, one lowercase letter, and one of the following
                    special characters: ! # $ % - _ = + &lt; &gt;.</li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">passwordExpiration</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">int</td>

              <td class="entry" headers="d772177e91" data-title="Description">Required. Number of days until user passwords expire and must be changed.
                Valid values: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph java"><span class="number">0</span></samp>—If set to <samp class="codeph java"><span class="number">0</span></samp>, the password never expires.
                  </li>

                  <li class="li"><samp class="codeph java"><span class="number">30</span></samp></li>

                  <li class="li"><samp class="codeph java"><span class="number">60</span></samp></li>

                  <li class="li"><samp class="codeph java"><span class="number">90</span></samp></li>

                  <li class="li"><samp class="codeph java"><span class="number">180</span></samp></li>

                  <li class="li"><samp class="codeph java"><span class="number">365</span></samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">passwordHistory</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">int</td>

              <td class="entry" headers="d772177e91" data-title="Description">Required. Number of previous passwords to save. Saving passwords is required to
                ensure that users reset their password to a new, unique password. This value must be
                set before a password reset succeeds. If <samp class="codeph java"><span class="number">0</span></samp>,
                <span class="keyword parmname">passwordExpiration</span> must be set to <samp class="codeph java"><span class="number">0</span></samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">passwordQuestion</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">int</td>

              <td class="entry" headers="d772177e91" data-title="Description">Required. If set to <samp class="codeph java"><span class="number">1</span></samp>, the answer to the
                password hint cannot contain the password itself. If <samp class="codeph java"><span class="number">0</span></samp>, the answer has no restrictions. </td>

            </tr>

            <tr>
              <td class="entry" headers="d772177e85" data-title="Field Name"><span class="keyword parmname">profile</span></td>

              <td class="entry" headers="d772177e88" data-title="Field Type">string</td>

              <td class="entry" headers="d772177e91" data-title="Description">Required. Name of the user profile.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ProfilePasswordPolicy component.

<?xml version="1.0" encoding="UTF-8"?>
<ProfilePasswordPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
    <forgotPasswordRedirect\>true</forgotPasswordRedirect\>    
    <lockoutInterval\>30</lockoutInterval\>
    <maxLoginAttempts\>0</maxLoginAttempts\>
    <minimumPasswordLength\>7</minimumPasswordLength\>
    <minimumPasswordLifetime\>false</minimumPasswordLifetime\>
    <obscure\>false</obscure\>
    <passwordComplexity\>1</passwordComplexity\>
    <passwordExpiration\>0</passwordExpiration\>
    <passwordHistory\>0</passwordHistory\>
    <passwordQuestion\>1</passwordQuestion\>
    <profile\>platformportal</profile\>
</ProfilePasswordPolicy\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=c3ab48e2acbb44a5748ddef226291b33f3fc3f7a09698f9e6ce3eeb8a7573aa5 url=/legacydeveloper/current/en-us/api_meta/meta_profilesearchlayouts.md -->

# ProfileSearchLayouts

Represents a user profile’s search results layouts for an object. ProfileSearchLayouts are similar to SearchLayouts. However, with profile-specific layouts, each user profile can have a different search results layout for an object.

## File Suffix and Directory Location

Profile search layouts are defined as part of a standard or custom object. SearchLayout is the default search results layout used when no layout is specified for a user profile. For more information, see [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.").

## Version

Profile search layouts for custom objects are available in API version 48.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| profileName | string\[\] | The name of the profile associated with a customized search results layout. The profile name can be a standard Salesforce profile or custom profile defined in your org. |
| fields | string\[\] | The list of fields displayed in search results for the object and for the users that have the profile Profile Name. The name field is required and is always displayed as the first column header, so it isn’t included in this list. All additional fields are included. The field name relative to the object name, for exampleMyCustomField\_\_c, is specified for each custom field. |

## Declarative Metadata Sample Definition

The following shows a sample definition of profile-specific search layouts in an object.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

To deploy a profile-specific search results layout, the profile must be defined in the destination org and if it's for a custom object, you must enable search for that custom object. If the profile-specific search results layout is for a custom object, the custom object's tab must exist in the destination org or must be included with the deployment.

<?xml version="1.0" encoding="UTF-8"?>
                <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
                . . .
                <profileSearchLayouts\>
                <fields\>ACCOUNT.NAME</fields\>
                <fields\>ACCOUNT.SITE</fields\>
                <fields\>ACCOUNT.PHONE1</fields\>
                <fields\>CORE.USERS.ALIAS</fields\>
                <fields\>ACCOUNT.ADDRESS2\_CITY</fields\>
                <profileName\>System Administrator</profileName\>
                </profileSearchLayouts\>
                <profileSearchLayouts\>
                <fields\>ACCOUNT.NAME</fields\>
                <fields\>ACCOUNT.SITE</fields\>
                <profileName\>WDC Only User</profileName\>
                </profileSearchLayouts\>
                . . .
                </CustomObject\>

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklist.htm "Picklist (Including Dependent Picklist)")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordtype.htm "RecordType")

#### See Also

- [SearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_searchlayouts.htm "Represents the metadata associated with the search layouts for an object. You can customize which fields to display for users in search results, search filter fields, lookup dialogs, and recent record lists on tab home pages. You can access SearchLayouts only by accessing its encompassing CustomObject.")

<!-- document id=a2be3dfef2353d29c68fe83a6610770ea6895397f4a035e70edf51c17890cab8 url=/legacydeveloper/current/en-us/api_meta/meta_profilesessionsetting.md -->

# ProfileSessionSetting

Represents a profile’s session settings. Use ProfileSessionSetting to retrieve the session settings for a given profile. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

ProfileSessionSetting components have the suffix .profileSessionSetting and are stored in the profileSessionSettings folder.

## Version

ProfileSessionSetting components are available in API version 40.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d773655e85">Field Name</th>

              <th class="featureTableHeader  " id="d773655e88">Field Type</th>

              <th class="featureTableHeader  " id="d773655e91">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d773655e85" data-title="Field Name"><span class="keyword parmname">profile</span></td>

              <td class="entry" headers="d773655e88" data-title="Field Type">string</td>

              <td class="entry" headers="d773655e91" data-title="Description">Required. Name of the user profile.</td>

            </tr>

            <tr>
              <td class="entry" headers="d773655e85" data-title="Field Name"><span class="keyword parmname">requiredSessionLevel</span></td>

              <td class="entry" headers="d773655e88" data-title="Field Type"><a class="xref" href="#sessionsessionlevel_title">SessionSecurityLevel</a></td>

              <td class="entry" headers="d773655e91" data-title="Description">Session security level.</td>

            </tr>

            <tr>
              <td class="entry" headers="d773655e85" data-title="Field Name"><span class="keyword parmname">sessionPersistence</span></td>

              <td class="entry" headers="d773655e88" data-title="Field Type">boolean</td>

              <td class="entry" headers="d773655e91" data-title="Description">Beta. If <samp class="codeph java">true</samp>, keep users logged in to their
                Experience Cloud site until the session times out—even if they close their
                browser. Use <span class="keyword parmname">sessionPersistence</span> to reduce how often users must
                log in to their site. Applies only to the External Identity profile.</td>

            </tr>

            <tr>
              <td class="entry" headers="d773655e85" data-title="Field Name"><span class="keyword parmname">sessionTimeout</span></td>

              <td class="entry" headers="d773655e88" data-title="Field Type">int</td>

              <td class="entry" headers="d773655e91" data-title="Description">Required. Specifies how many minutes of inactivity elapse before a user’s
                authenticated session times out. At the end of the session, the user must log in
                again. This session timeout value applies to users of the profile and overrides the
                org-wide timeout value. Changes to the org-wide timeout value don’t apply to users
                of this profile. Valid values: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">0</samp>—2 Hours
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">15</samp>—15 Minutes
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">30</samp>—30 Minutes
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">60</samp>—1 Hour
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">90</samp>—90 Minutes
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">120</samp>—2 Hours
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">240</samp>—4 Hours
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">480</samp>—8 Hours
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">720</samp>—12 Hours
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">1440</samp>—24 Hours
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## SessionSecurityLevel

Session security levels control access to certain types of resources based on the type of authentication used for logging in to the current session. For example, username and password authentication requires the standard session security level. Multi-factor authentication (MFA) requires HIGH\_ASSURANCE.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d773655e243">Field Name</th>

              <th class="featureTableHeader  " id="d773655e246">Field Type</th>

              <th class="featureTableHeader  " id="d773655e249">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d773655e243" data-title="Field Name"><span class="keyword parmname">SessionSecurityLevel</span></td>

              <td class="entry" headers="d773655e246" data-title="Field Type">(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d773655e249" data-title="Description">User’s security level for the current session. <ul class="ul bulletList">
                  <li class="li">The <samp class="codeph java">HIGH_ASSURANCE</samp> security level for this
                    session meets the High Assurance requirements set in the org’s session settings
                    under Session Security Levels.</li>

                  <li class="li">The <samp class="codeph java">STANDARD</samp> security level for this
                    session meets the Standard requirements set in the org’s session settings under
                    Session Security Levels.</li>

                  <li class="li">The <samp class="codeph java">LOW</samp> level isn’t available or used in
                    the Salesforce UI. It’s used at the API level, but users assigned to this level
                    experience unpredictable and reduced functionality. </li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ProfileSessionSetting component.

<?xml version="1.0" encoding="UTF-8"?>
<ProfileSessionSetting xmlns="http://soap.sforce.com/2006/04/metadata">
    <profile\>platformportal</profile\>
    <requiredSessionLevel\>HIGH\_ASSURANCE</requiredSessionLevel\>
    <sessionTimeout\>1440</sessionTimeout\>
</ProfileSessionSetting\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=5862e063a41b48b25f784114309daca6e89323f27ef5ae82b6cec3ec75b5a7c5 url=/legacydeveloper/current/en-us/api_meta/meta_prompt.md -->

# Prompt

Represents the metadata related to in-app guidance, which includes prompts and walkthroughs. Help users discover your products and services, adopt your processes, or learn how to use a new feature. Write the content, select the target audience, and specify where and when the in-app guidance appears.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

Prompt components have the suffix prompt and are stored in the prompts folder.

## Version

Prompt components are available in API version 46.0 and later.

## Special Access Rules

To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, see [Considerations for Creating In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_prompt_consider.htm&type=5&language=en_US "HTML (New Window)") and [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help for permissions.

## Prompts and Walkthroughs in Managed Packages

For considerations about including in-app guidance in a managed package, see [Guidelines for In-App Guidance in Managed Packages](https://help.salesforce.com/articleView?id=customhelp_iag_packages.htm&language=en_US) in Salesforce Help.

For more information about creating managed packages, see [Create a First-Generation Managed Package](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/creating_packages.htm).

Unmanaged packages must contain a namespace prefix. For more information, see [Register a Namespace for a First-Generation Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/register_namespace_prefix.htm) and [What happens to my namespace prefix when I install a package?](https://help.salesforce.com/articleView?id=faq_distribution_installing_what_happens_to_my.htm&language=en_US).

## Fields

| Field Name | Description |
| --- | --- |
| masterLabel | 
Field Type

string

Description

Required. The label. Maximum of 80 characters.



 |
| promptVersions | 

Field Type

[PromptVersion\[\]](#PromptVersion)

Description

A list of in-app guidance entries. Each entry represents a different prompt or walkthrough.



 |

## PromptVersion

A list of in-app guidance entries. Each entry represents a different prompt or walkthrough.

| Field Name | Description |
| --- | --- |
| actionButtonLabel | 
Field Type

string

Description

Label for the action button or link. Maximum of 25 characters. For a walkthrough, specify this value on the last step.



 |
| actionButtonLink | 

Field Type

string

Description

URL for the action button or link. Maximum of 1,000 characters. You can’t use the GROUP BY option in a SOQL query for this field. For a walkthrough, specify this value on the last step.



 |
| body | 

Field Type

string

Description

Required. Body content.

In API version 60.0 and later, enter up to 4,000 characters for all prompt types.

In earlier API versions, enter up to 240 characters for floating prompts and targeted prompts. Enter up to 4,000 characters for docked prompts.

For docked prompts, the maximum characters include HTML markup, not just readable text.





 |
| customApplication | 

Field Type

string

Description

Internal use only. No data is populated for this field.



 |
| delayDays | 

Field Type

int

Description

Required if recurrences are scheduled. Number of days in between occurrences. For a walkthrough, specify this value on the first step.



 |
| description | 

Field Type

string

Description

Description. Maximum of 255 characters.



 |
| dismissButtonLabel | 

Field Type

string

Description

Label for the dismiss button of a floating or targeted prompt. Maximum of 15 characters.



 |
| displayPosition | 

Field Type

PromptDisplayPosition (enumeration of type string)

Description

The position of a floating prompt on the page. Valid values are:

- BottomCenter
- BottomLeft
- BottomRight
- TopCenter
- TopLeft
- TopRight





 |
| displayType | 

Field Type

PromptDisplayType (enumeration of type string)

Description

Required. The type of prompt. Valid values are:

- DockedComposer—A docked prompt
- FloatingPanel—A floating prompt
- Targeted—A targeted prompt. Available in API version 52.0 and later.





 |
| elementRelativePosition | 

Field Type

PromptElementRelativePosition (enumeration of type string)

Description

Indicates the location of a targeted prompt relative to the element. Available in API version 52.0 and later. Valid values are:

- BottomCenter
- BottomLeft
- BottomRight
- LeftBottom
- LeftCenter
- LeftTop
- RightBottom
- RightCenter
- RightTop
- TopCenter
- TopLeft
- TopRight





 |
| endDate | 

Field Type

date

Description

The date to stop showing the in-app guidance. For a walkthrough, specify this value on the first step.



 |
| header | 

Field Type

string

Description

Label for the header of a docked prompt. This value is the label contained in the window’s browser bar. Maximum of 36 characters.



 |
| image | 

Field Type

string

Description

The developer name of the contentAsset that holds the image. You can specify this field or the imageLink field, but not both.



 |
| imageAltText | 

Field Type

string

Description

Indicates the alt text of an image. Required if imageLocation, imageLink, or image is specified.



 |
| imageLink | 

Field Type

string

Description

The URL for a prompt’s image. You can specify this field or the image field, but not both. Available in API version 53.0 and later.



 |
| imageLocation | 

Field Type

picklist

Description

Indicates the location of the image in relation to the body text. Required if image, imageLink, or imageAltText is specified. Valid values are:

- Top
- Bottom
- Right, which is for floating or targeted prompts only
- Left, which is for floating or targeted prompts only





 |
| indexWithIsPublished | 

Field Type

string

Description

Used by Salesforce for efficient querying.



 |
| indexWithoutIsPublished | 

Field Type

string

Description

Used by Salesforce for efficient querying.



 |
| isPublished | 

Field Type

boolean

Description

Indicates whether the in-app guidance is active (true) or not (false).



 |
| masterLabel | 

Field Type

string

Description

Required. The label.



 |
| publishedByUser | 

Field Type

string

Description

Internal use only. No data is populated for this field.



 |
| publishedDate | 

Field Type

date

Description

Indicates the date the in-app guidance was activated. If installed from a package, this value is the date when the package was installed. For walkthroughs, this field can only be specified on the first step.



 |
| referenceElementContext | 

Field Type

textarea

Description

Used by Salesforce to identify the element that the targeted prompt is associated with. Available in API version 52.0 and later.



 |
| shouldDisplayActionButton | 

Field Type

boolean

Description

Indicates whether an action button or link is included (true) or not (false).



 |
| shouldIgnoreGlobalDelay | 

Field Type

boolean

Description

Indicates whether the in-app guidance ignores the global time delay and instead shows on page load (true) or not (false). This field is available in API version 48.0 and later.



 |
| startDate | 

Field Type

date

Description

Indicates the date to start showing the in-app guidance. For a walkthrough, specify this value on the first step.

In API version 48.0 and earlier, this field is required.





 |
| stepNumber | 

Field Type

int

Description

Required for walkthroughs only. Indicates the number of the last step the user viewed or interacted with in a walkthrough. Include up to 10 steps. Numbers must be consecutive without repeated or skipped numbers. Available in API version 49.0 and later.



 |
| targetAppDeveloperName | 

Field Type

string

Description

The app’s developer name where the in-app guidance appears. Deprecated in API version 51.0 and later.



 |
| targetAppNamespacePrefix | 

Field Type

string

Description

The app’s namespace prefix where the in-app guidance appears. This value must match the target app’s NamespacePrefix in the org that the package is being installed into. Maximum of 15 characters. Deprecated in API version 51.0 and later.



 |
| targetPageKey1 | 

Field Type

string

Description

Required. Used by Salesforce to identity the prompt’s page location along with targetPageKey2, targetPageKey3, targetPageKey4, and targetPageType.



 |
| targetPageKey2 | 

Field Type

string

Description

Used by Salesforce to identity the prompt’s page location along with targetPageKey1, targetPageKey3, targetPageKey4, and targetPageType.



 |
| targetPageKey3 | 

Field Type

string

Description

Used by Salesforce to identify the prompt’s page location along with targetPageKey1, targetPageKey2, targetPageKey4, and targetPageType.



 |
| targetPageKey4 | 

Field Type

string

Description

Used by Salesforce to identify the prompt’s page location along with targetPageKey1, targetPageKey2, targetPageKey3, and targetPageType. This field is available in API version 53.0 and later.



 |
| targetPageType | 

Field Type

string

Description

Required. Used by Salesforce to identity the page location along with targetPageKey1, targetPageKey2, targetPageKey3, and targetPageKey4.



 |
| targetRecordType | 

Field Type

string

Description

Used by Salesforce to determine if in-app guidance is specific to a record type. This field is available in API version 53.0 and later.



 |
| themeColor | 

Field Type

PromptThemeColor (enumeration of type string)

Description

Indicates which custom theme color is applied to the in-app guidance. Required if themeSaturation is specified. For a walkthrough, specify this value on the first step. Valid values are:

- Theme1, which is derived from the current brand color
- Theme2, which is derived from the current page background color
- Theme3, which is derived from the current global header color
- Theme4, which is derived from the current app theme color





 |
| themeSaturation | 

Field Type

PromptThemeSaturation (enumeration of type string)

Description

Indicates which color value, or saturation, is applied to the in-app guidance that has a custom theme color. Required if themeColor is specified. For a walkthrough, specify this value on the first step. Valid values are:

- Dark
- Light





 |
| timesToDisplay | 

Field Type

int

Description

Required if recurrences are scheduled. The maximum number of times to show the in-app guidance. Salesforce detects whether the user interacts with the in-app guidance, then determines whether to show the in-app guidance again or cancel scheduled recurrences. Maximum value of 30. For a walkthrough, specify this value on the first step.



 |
| title | 

Field Type

string

Description

Required. The label for the title. Maximum of 36 characters.



 |
| uiFormulaRule | 

Field Type

[UiFormulaRule\[\]](#UiFormulaRule)

Description

A set of one or more permission filters that define the conditions under which the in-app guidance displays on the page.

If the rule evaluates to true, the in-app guidance displays on the page. If false, it doesn't display. If this field is null, the in-app guidance displays by default.





 |
| userAccess | 

Field Type

PromptUserAccess (enumeration of type string)

Description

Indicates which permissions can see the in-app guidance. Valid values are:

- Everyone, which indicates that there’s no permission restrictions
- SpecificPermissions, which indicates that only users with all the specific user permissions specified can see the in-app guidance

In API version 48.0 and earlier, this field is required.





 |
| userProfileAccess | 

Field Type

PromptUserProfileAccess (enumeration of type string)

Description

Indicates which profiles can see the in-app guidance. This field is available in API version 48.0 and later. Valid values are:

- Everyone, which indicates that there are no profile restrictions
- SpecificProfiles, which indicates that users with any of the specified user profiles can see the in-app guidance





 |
| versionNumber | 

Field Type

int

Description

Required. The number remains 1 since multiple versions aren’t saved in the org.



 |
| videoLink | 

Field Type

string

Description

The embed URL for a video in a docked prompt. Maximum of 1,000 characters. You can specify this field or the image field, but not both. This field is available in API version 48.0 and later. See [Considerations for Creating In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_prompt_consider.htm&type=5&language=en_US "HTML (New Window)").



 |

## UiFormulaRule

A set of one or more filters that define the conditions under which a prompt displays on a Lightning Experience page.

| Field Name | Description |
| --- | --- |
| booleanFilter | 
Field Type

string

Description

Specifies the AND filter condition.



 |
| criteria | 

Field Type

[UiFormulaCriterion\[\]](#UiFormulaCriterion)

Description

List of one or more filters that, when evaluated, determine visibility.



 |

## UiFormulaCriterion

A single filter that, when evaluated, helps define visibility on a Lightning Experience page.

| Field Name | Description |
| --- | --- |
| leftValue | 
Field Type

string

Description

Required. The field used for filtering. Only standard and custom permissions can be included. You can use these expressions in the leftValue field when setting filters for visibility.

- {!$Permission.CustomPermission.permissionName}—Use this expression to control visibility based on the custom permissions of the user viewing the Lightning page. Supported for app, Home, and record pages only.
- {!$Permission.StandardPermission.permissionName}—Use this expression to control visibility based on the standard permissions of the user viewing the Lightning page. Supported for app, Home, and record pages only.
- {!ENCODED:{!ID:$User.Profile.Key}}—Use this expression to control visibility based on the custom or standard profile of the user viewing the Lightning page. Available in API Version 48.0 and later.





 |
| operator | 

Field Type

string

Description

Required. Defines the operator used to filter the data. Valid value is EQUAL.



 |
| rightValue | 

Field Type

string

Description

Specifies if you want to evaluate the visibility for permissions or the name of the profile.

- For permissions, use true.
- For profiles, use the name of the profile. Available in API Version 48.0 and later. For example, Standardor custom\_regionalsales.





 |

## Declarative Metadata Sample Definition

The following is an example of a Prompt component.

<?xml version="1.0" encoding="UTF-8"?>
<Prompt xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>Prompt Label</masterLabel\>
    <promptVersions\>
        <actionButtonLabel\>Learn How</actionButtonLabel\>
        <actionButtonLink\>https://trailhead.salesforce.com/en/content/learn/modules/scrum-and-kanban-at-salesforce/learn-about-kanban</actionButtonLink\>
        <body\>Explore how the Path and the Kanban view can help you track, manage, and update your records.</body\>
        <delayDays\>1</delayDays\>
        <description\>Kanban floating prompt</description\>
        <dismissButtonLabel\>OK</dismissButtonLabel\>
        <displayPosition\>TopLeft</displayPosition\>
        <displayType\>FloatingPanel</displayType\>
        <endDate\>2019-03-11</endDate\>
        <isPublished\>true</isPublished\>
        <masterLabel\>Prompt Label</masterLabel\>
        <publishedDate\>2019-03-11</publishedDate\>
        <shouldDisplayActionButton\>false</shouldDisplayActionButton\>
        <shouldIgnoreGlobalDelay\>false</shouldIgnoreGlobalDelay\>
        <startDate\>2019-03-11</startDate\>
        <targetAppDeveloperName\>LightningSales</targetAppDeveloperName\>
        <targetAppNamespacePrefix\>standard</targetAppNamespacePrefix\>
        <timesToDisplay\>3</timesToDisplay\>
        <title\>Get on the Path to Success</title\>
        <userAccess\>SpecificPermissions</userAccess\>
        <userProfileAccess\>SpecificProfiles</userProfileAccess\>
        <versionNumber\>1</versionNumber\>
        <videolink\>https://www.youtube.com/embed/Ko-gcObzTVo</videolink\>
        <uiFormulaRule\>
            <booleanFilter\>(1 AND 2 AND 3) AND (4 OR 5)</booleanFilter\>
            <criteria\>
                <leftValue\>{!$Permission.StandardPermission.ActivitiesAccess}</leftValue\>
                <operator\>EQUAL</operator\>
                <rightValue\>TRUE</rightValue\>
            </criteria\>
            <criteria\>
                <leftValue\>{!$Permission.StandardPermission.ContentWorkspaces}</leftValue\>
                <operator\>EQUAL</operator\>
                <rightValue\>TRUE</rightValue\>
            </criteria\>
            <criteria\>
                <leftValue\>{!$Permission.CustomPermission.MyCustomPerm}</leftValue\>
                <operator\>EQUAL</operator\>
                <rightValue\>TRUE</rightValue\>
            </criteria\>
            <criteria\>
                <leftValue\>{!ENCODED:{!ID:$User.Profile.Key}}</leftValue\>
                <operator\>EQUAL</operator\>
                <rightValue\>Standard</rightValue\>
            </criteria\>
            <criteria\>
                <leftValue\>{!ENCODED:{!ID:$User.Profile.Key}}</leftValue\>
                <operator\>EQUAL</operator\>
                <rightValue\>custom\_mysysadmin</rightValue\>
            </criteria\>
        </uiFormulaRule\>
    </promptVersions\>
</Prompt\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>Prompt</name\>
    </types\>
    <version\>46.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=c0f9d904146b5f6eb0d512aa7bffc85ba552b34ab03e251bfd7050fb603d687f url=/legacydeveloper/current/en-us/api_meta/meta_publickeycertificate.md -->

# PublicKeyCertificate

Represents the public key certificate. On this entity we store a public certificate or a JSON web key, which is used to validate the customer-provided JWT.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

PublicKeyCertificate components have the suffix .PublicKeyCertificate and are stored in the PublicKeyCertificate folder.

## Version

PublicKeyCertificate components are available in API version 62 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

A description of the public key certificate.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the public key certificate is active (true) or inactive (false). The default value is false.



 |
| jsonWebKey | 

Field Type

string

Description

Represents a public cryptographic key that can be used to verify the validity of a token.



 |
| masterLabel | 

Field Type

string

Description

Required. The label for the public key certificate.





 |

## Declarative Metadata Sample Definition

The following is an example of a PublicKeyCertificate component.

<?xml version="1.0" encoding="UTF-8"?>
<PublicKeyCertificate xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>pck1</masterLabel\>
    <isActive\>true</isActive\>
    <description\>This is my description for a test PublicKeyCertificate</description\>
    <jsonWebKey\>
{
  "kid":"123456",
  "alg":"RS256",
  "use":"sig",
  "kty":"RSA",
  "x5c":\["<Your public certificate>"\],
  "y":"y",
  "n":"<Base64-encoded modulus>",
  "e":"<Base64-encoded public exponent>",
  "crv":"crv",
  "d":"d",
  "k":"k"
}
    </jsonWebKey\>
</PublicKeyCertificate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Copyright 2024 salesforce.com, inc.
  ~ All Rights Reserved
  ~ Company Confidential
  -->

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>PublicKeyCertificate</name>
    </types>
    <version>62.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=f4bb01fc73d0c4a1fb8e4bf75b81286f455b12a3d76a4a7af6a4ec4306702cf8 url=/legacydeveloper/current/en-us/api_meta/meta_publickeycertificateset.md -->

# PublicKeyCertificateSet

Represents a set of public certificate keys. On this entity we store a public certificates or JSON web keys.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

PublicKeyCertificateSet components have the suffix .PublicKeyCertificateSet and are stored in the PublicKeyCertificateSet folder.

## Version

PublicKeyCertificateSet components are available in API version 62 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

A description of the public key certificate set.



 |
| jwksEndPoint | 

Field Type

string

Description

The URL of the HTTPS Server that returns the JWKS.



 |
| jwtIssuer | 

Field Type

string

Description

The user, organization, or service that issued the JSON web token. This value is case-sensitive.



 |
| masterLabel | 

Field Type

string

Description

Required. The label for the public key certificate set.





 |
| publicKeyCertificateSetKeys | 

Field Type

[PublicKeyCertificateSetKey\[\]](#PublicKeyCertificateSetKey)

Description

A set of public certificate keys associated with the public key certificate set.



 |
| type | 

Field Type

PublicKeyCertificateSetType (enumeration of type string)

Description

Required. Determines how the server's public key set is retrieved. The keys are represented in JWK format.

Values are:

- JWKS\- Used to specify a certificate via the child Type PublicKeyCertificateSetKey.
- JWKS\_URL\- Used to specify a certificate via the jwksEndPoint field on this Type.





 |

## PublicKeyCertificateSetKeys

Represents a set of public certificate keys associated with the public key certificate set.

| Field Name | Description |
| --- | --- |
| publicKeyCertificate | 
Field Type

string

Description

Required.

The PublicKeyCertificate we want to reference.



 |

## Declarative Metadata Sample Definition

The following is an example of a PublicKeyCertificateSet component.

<?xml version="1.0" encoding="UTF-8"?>
<PublicKeyCertificateSet xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>pcks1</masterLabel\>
    <description\>This is my description for a PublicKeyCertificateSet</description\>
    <type\>JWKS</type\>
    <jwtIssuer\>example.com</jwtIssuer\>
    <publicKeyCertificateSetKeys\>
            <publicKeyCertificate\>pck1</publicKeyCertificate\>
    </publicKeyCertificateSetKeys\>
</PublicKeyCertificateSet\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>PublicKeyCertificate</name>
    </types>
    <types>
        <members>\*</members>
        <name>PublicKeyCertificateSet</name>
    </types>
    <version>62.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=3ffc52d2df5c8b25e4b379cea38bc3ea244f4e26b89f0106958fd93720f1e51d url=/legacydeveloper/current/en-us/api_meta/meta_queue.md -->

# Queue

Represents a holding area for items before they are processed.

## Declarative Metadata File Suffix and Directory Location

The file suffix for queue components is .queue and components are stored in the queues directory of the corresponding package directory. This component supports cases, leads, service contracts (if Entitlements are enabled), and custom objects.

## Version

Queue components are available in API version 24.0 and later.

## Special Access Rules

As of Summer ’20 and later, only authenticated internal and external users can access this type.

## Fields

This metadata type represents the valid values that define a queue:

| Field Name | Field Type | Description |
| --- | --- | --- |
| doesIncludeBosses | boolean | Required. Indicates whether records shared with users in this queue are also shared with users higher in the role hierarchy (true) or not (false). This field corresponds to the Grant Access Using Hierarchies checkbox on the queue’s detail page. Available in API version 67.0 and later. |
| doesSendEmailToMembers | boolean | Indicates whether emails are sent to queue members (true) or not (false) when a new record is added to the queue. |
| email | string | The email address of the queue owner. |
| name | string | Required. The name of the queue. Corresponds to **Label** in the user interface. |
| queueMembers | [QueueMembers](#QueueMembers)\[\] | Represents queue members added to the queue. Members can be added directly or selected by roles and public groups they belong to. Available in API version 42.0 and later. |
| queueRoutingConfig | string | Routing configuration name. Applies to orgs that use Omni-Channel with a routing configuration. Available in API version 42.0 and later. |
| queueSobject | [QueueSobject\[\]](#QueueSobject) | Indicates the supported entity types. |

## QueueMembers

Represents queue members added to the queue. Members can be added directly as users or selected by the roles and public groups they belong to. Available in API version 42.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| publicGroups | [PublicGroups](#PublicGroups)\[\] | Represents public groups in the org. Public groups are optionally used to add queue members. |
| roleAndSubordinates | [RoleAndSubordinates](#RoleAndSubordinate)\[\] | Represents roles and their subordinates in the org’s role hierarchy, including customer and partner roles. Roles and their subordinate hierarchy are optionally used to add queue members. |
| roleAndSubordinatesInternal | [RoleAndSubordinatesInternal](#RoleAndSubordinateInternal)\[\] | Represents internal roles and their subordinates in the org’s role hierarchy, excluding customer and partner roles. Roles and their subordinate hierarchy are optionally used to add queue members. |
| roles | [Roles](#Roles)\[\] | Represents roles in the org. Roles are optionally used to add queue members. |
| users | [Users](#Users)\[\] | Represents users in the org. Users can be added directly as queue members. |

## PublicGroups

Represents public groups in the org. Public groups are optionally used to add queue members. Available in API version 42.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| publicGroup | string | Represents a public group. |

## RoleAndSubordinates

Represents roles and their subordinates in the org’s role hierarchy, including customer and partner roles. Roles and their subordinate hierarchy can be used to add queue members. Available in API version 42.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| roleAndSubordinate | string | Represents a role and its subordinates, including customer and partner roles. Only available when digital experiences is enabled for your org and Experience Cloud site users are created with external account roles other than a shared person account role. |

## RoleAndSubordinatesInternal

Represents internal roles and their subordinates in the org’s role hierarchy, excluding customer and partner roles. Roles and their subordinate hierarchy can be used to add queue members. Available in API version 42.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| roleAndSubordinateInternal | string | Represents a role and its subordinates, excluding customer and partner roles. |

## Roles

Represents roles in the org. Roles can be used to add queue members. Available in API version 42.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| role | string | Represents a role. |

## Users

Represents users in the org. Users can be added directly as queue members. Available in API version 42.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| user | string | Represents a user. Specify the user’s username. |

## QueueSobject

QueueSobject represents an entity type that the queue supports.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d780010e634">Field Name</th>

              <th class="featureTableHeader  " id="d780010e637">Field Type</th>

              <th class="featureTableHeader  " id="d780010e640">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d780010e634" data-title="Field Name"><span class="keyword parmname">sobjectType</span></td>

              <td class="entry" headers="d780010e637" data-title="Field Type">string</td>

              <td class="entry" headers="d780010e640" data-title="Description">Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Case</samp></li>

                  <li class="li"><samp class="codeph nolang">ContactRequest</samp></li>

                  <li class="li"><samp class="codeph nolang">Lead</samp></li>

                  <li class="li"><samp class="codeph nolang">ServiceContract</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Task</samp> (Available in API
                    version 48.0 and later.)
                  </li>

                  <li class="li">Custom objects (such as <samp class="codeph nolang">ObjA_c</samp>)</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of a queue, which supports Case, Lead, and a custom object named ObjA.

<?xml version="1.0" encoding="UTF-8"?>
<Queue xmlns="http://soap.sforce.com/2006/04/metadata">
    <doesIncludeBosses\>false</doesIncludeBosses\>
    <doesSendEmailToMembers\>true</doesSendEmailToMembers\>
    <email\>member@company.com</email\>
    <fullName\>Your Name</fullName\>
    <name\>memberQueue</name\>
    <queueSobject\>
        <sobjectType\>Case</sobjectType\>
    </queueSobject\>
    <queueSobject\>
        <sobjectType\>Lead</sobjectType\>
    </queueSobject\>
    <queueSobject\>
        <sobjectType\>ObjA\_\_c</sobjectType\>
    </queueSobject\>
</Queue\>

Here’s another definition of a queue containing queue members added directly or via public groups and roles. Queries retrieve values using the DeveloperName field, not the Name field, so that the returned names are unique. The query also appends letters to the end of duplicate names, so these groups and roles can be referred to independently.

<?xml version="1.0" encoding="UTF-8"?>
<Queue xmlns="http://soap.sforce.com/2006/04/metadata">
    <doesIncludeBosses\>false</doesIncludeBosses\>
    <doesSendEmailToMembers\>false</doesSendEmailToMembers\>
    <name\>queue1</name\>
    <queueMembers\>
        <publicGroups\>
            <publicGroup\>All Internal Users</publicGroup\>
        <publicGroups\>
        <queueRoleAndSubordinates\>
            <queueRoleAndSubordinate\>role1</queueRoleAndSubordinate\>
            <queueRoleAndSubordinate\>role2</queueRoleAndSubordinate\>
            <queueRoleAndSubordinate\>role3</queueRoleAndSubordinate\>
        </queueRoleAndSubordinates\>
        <roles\>
            <role\>role1</role\>
        </roles\>
        <users\>
            <user\>s@sm.com</user\>
            <user\>std@sm.com</user\>
        </users\>
    </queueMembers\>
    <queueRoutingConfig\>my\_omni\_routing\_config</queueRoutingConfig\>
    <queueSobject\>
        <sobjectType\>Case</sobjectType\>
    </queueSobject\>
    <queueSobject\>
        <sobjectType\>Lead</sobjectType\>
    </queueSobject\>
</Queue\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=18306f58dce681dbdb7bb3f96bb129bd70ad85ed0ace0f40f1de65af22d9edc5 url=/legacydeveloper/current/en-us/api_meta/meta_queueroutingconfig.md -->

# QueueRoutingConfig

Represents the settings that determine how work items are routed to agents.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ServicePresenceStatus components have the suffix .queueRoutingConfig and are stored in the queueRoutingConfigs folder.

## Version

QueueRoutingConfig components are available in API version 44.0 and later.

## Special Access Rules

This type is available only if Omni-Channel is enabled in your org.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d781856e107">Field Name</th>

              <th class="featureTableHeader  " id="d781856e110">Field Type</th>

              <th class="featureTableHeader  " id="d781856e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">capacityPercentage</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">double</td>

              <td class="entry" headers="d781856e113" data-title="Description">The percentage of an agent’s capacity for work items that’s consumed by a
                specific type of work item from this service channel. Voice calls must have a
                capacity percentage of 100. If an agent receives a voice call, the agent won’t
                receive new work items until the call ends, because at that point the agent’s
                capacity will have reached 100%.</td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">capacityType</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">CapacityType</td>

              <td class="entry" headers="d781856e113" data-title="Description">The setting applies for PSRs (<a class="xref" href="https://help.salesforce.com/s/articleView?id=service.omnichannel_psr_lifecycle.htm&amp;type=5&amp;language=en_US" target="_blank">PendingServiceRouting</a>) that are created and
                managed by the system. <ul class="ul bulletList">
                  <li class="li">When set to <samp class="codeph nolang">INHERITED</samp>, the value of the
                    Interruptible check box or value set on the Service Channel applies. </li>

                  <li class="li">When set to <samp class="codeph nolang">INTERRUPTIBLE</samp>, the generated
                    PSR has the <span class="keyword parmname">isInterruptible</span> flag set to true. </li>

                  <li class="li">When set to NOT <samp class="codeph nolang">INTERRUPTIBLE</samp>, the
                    generated PSR has the <span class="keyword parmname">isInterruptible</span> flag set to
                    false.</li>

                  <li class="li">When not set, its behavior is equivalent to <samp class="codeph nolang">INHERITED</samp>.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">capacityWeight</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">double</td>

              <td class="entry" headers="d781856e113" data-title="Description">The amount of an agent’s capacity for work items that’s consumed by a work item
                from this service channel. For example, if an agent has a capacity of 6, and cases
                are assigned a capacity weight of 2, an agent can be assigned up to 3 cases before
                the agent is at capacity and can’t receive new work items. Voice calls must use the
                entire capacity weight.</td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">dropAdditionalSkillsTimeout</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">int</td>

              <td class="entry" headers="d781856e113" data-title="Description">
                <p class="p">The number of seconds to elapse before additional skills are dropped from
                  Omni-Channel routing. In skills-based routing, you can set some skills to
                  <strong class="ph uicontrol">Additional Skill</strong>. After the timeout elapses, a skill
                  marked as <strong class="ph uicontrol">Additional Skill</strong> is dropped from Omni-Channel
                  routing and the case is routed to the best-matched agent, even if the agent
                  doesn’t have all the skills.
                </p>
                <p class="p">If CustomRequestedDateTime is set in the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_pendingservicerouting.htm" target="_blank">PendingServiceRouting object</a>,
                  DropAdditionalSkillsTimeout uses CustomRequestedDateTime as the start time. If
                  CustomRequestedDateTime + DropAdditionalSkillsTimeout has already passed,
                  Omni-Channel immediately drops the additional skills after the pending service
                  request is created.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">isAttributeBased</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d781856e113" data-title="Description">Indicates whether this routing configuration is used with skills-based routing
                rules (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">string</td>

              <td class="entry" headers="d781856e113" data-title="Description">Required. The label of the presence status.</td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">PausedCapacityPercentage</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">double</td>

              <td class="entry" headers="d781856e113" data-title="Description">The percentage of a rep’s capacity that’s consumed when this work item is
                paused. The paused capacity feature is available with status-based capacity and
                Enhanced Omni-Channel only. Available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">PausedCapacityWeight</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">double</td>

              <td class="entry" headers="d781856e113" data-title="Description">The amount of a rep’s capacity that’s consumed when this work item is paused.
                The paused capacity feature is available with status-based capacity and Enhanced
                Omni-Channel only. Available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">pushTimeout</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">int</td>

              <td class="entry" headers="d781856e113" data-title="Description">The number of seconds set for push timeout. <samp class="codeph nolang">0</samp> is returned when push timeout isn’t enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">queueOverflowAssignee</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">string</td>

              <td class="entry" headers="d781856e113" data-title="Description">The ID of the queue that’s set as the Overflow Assignee.</td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">skills</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">
                <a class="xref" href="#QueueRoutingConfigSkill">QueueRoutingConfigSkill</a>[]
              </td>

              <td class="entry" headers="d781856e113" data-title="Description">Default skills associated with the routing configuration. Work is routed using
                a combination of rules and default skills. </td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">routingModel</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">RoutingModel (enumeration of type string)</td>

              <td class="entry" headers="d781856e113" data-title="Description">Required. The routing type that determines how work items are routed (pushed)
                to agents. Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">LEAST_ACTIVE</samp></li>

                  <li class="li"><samp class="codeph nolang">MOST_AVAILABLE</samp></li>

                  <li class="li"><samp class="codeph nolang">EXTERNAL_ROUTING</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">routingPriority</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">int</td>

              <td class="entry" headers="d781856e113" data-title="Description">Required. The priority in which work items from the service channels that are
                related to this routing configuration are routed to agents. Work items from routing
                configurations that have lower priority values (for example, 0) are routed to agents
                first.</td>

            </tr>

            <tr>
              <td class="entry" headers="d781856e107" data-title="Field Name"><span class="keyword parmname">userOverflowAssignee</span></td>

              <td class="entry" headers="d781856e110" data-title="Field Type">string</td>

              <td class="entry" headers="d781856e113" data-title="Description">The ID of the user that’s set as the Overflow Assignee.</td>

            </tr>

          </tbody>

        </table>

## QueueRoutingConfigSkill

Represents default skills associated with the routing configuration.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| skill | string | Skill used to route a work item. |

## Declarative Metadata Sample Definition

The following is an example of a QueueRoutingConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<QueueRoutingConfig xmlns="http://soap.sforce.com/2006/04/metadata">
  <capacityWeight\>1.0</capacityWeight\>
  <label\>Case Routing</label\>
  <pushTimeout\>120</pushTimeout\> 
  <queueOverflowAssignee\>queueOverflow</queueOverflowAssignee\>
  <routingModel\>LEAST\_ACTIVE</routingModel\>
  <routingPriority\>1</routingPriority\>
  <capacityType\>INHERITED</capacityType\>
  <pausedCapacityWeight\>0.25</pausedCapacityWeight\>
</QueueRoutingConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>QueueRoutingConfig</name\>
    </types\>
    <version\>44.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6670df8ca1236d98d0dde6d00e6b1abe68031b54be3e2a3f78bd7b8427b9a3ce url=/legacydeveloper/current/en-us/api_meta/meta_quickstart_retrieve.md -->

# Quick Start: Metadata API

Get started with Metadata API by retrieving a small set of metadata components from your org on the Salesforce CLI.

## Resources for Beginner Developers

If you’re a beginner developer and haven’t used Salesforce CLI before, learn how to set up your environment and practice with a sample application. These Trailheads guide you through setup with SFDX and introduce you to Metadata API.

[App Development with Salesforce DX](https://trailhead.salesforce.com/content/learn/modules/sfdx_app_dev)

Walk through setting up your environment and developing with Salesforce CLI using the Dreamhouse sample app. After you add a feature to your Dreamhouse app, you deploy metadata to your Dev Hub org with Salesforce CLI.

[Package.xml Metadata Management](https://trailhead.salesforce.com/content/learn/modules/package-xml)

Learn more about metadata and package.xml files. Build a package.xml file to deploy changes from a scratch org to your Trailhead Playground.

## Quick Start for Developing with Metadata API

If you have some experience in Salesforce development but want to get started with Metadata API, use this quick start. The quick start walks you through a retrieval of metadata components, which is the first step of the development process.

1. [Metadata Development Prerequisites](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_prereqs.htm)  
    Complete these prerequisites before you start developing with Metadata API.
2. [Step 1: (Optional) Add Metadata Components to an Org Using the UI](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_add_components.htm)  
    If you’re starting with a new practice org that doesn’t have customizations, you only have standard metadata that can’t be retrieved. To use the Metadata API retrieve call, add a component on the Salesforce UI to your practice org. If you’re working on an existing project, you already have components to retrieve and can skip this step.
3. [Step 2: Build a Package.xml Manifest](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_build_manifest.htm)  
    The package.xml manifest file lists the components to retrieve from your org.
4. [Step 3: Retrieve Components with Metadata API](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_use_retrieve.htm)  
    With Salesforce CLI, retrieve a file representation of the specified components in your package.xml manifest.

#### See Also

- [Move Metadata from Production to Your Local File System](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_use_cases_prod_to_local.htm "To make development changes without affecting your existing configurations, use Metadata API to move metadata to your local file system. Next, push metadata from your local file system to a shareable repository for development.")

<!-- document id=e7d8f9290d46b6ab964a78c52dc8144b4ca48daab41f5cd2e966219a95b95f02 url=/legacydeveloper/current/en-us/api_meta/meta_salesforce_api_mcp_intro.md -->

# Quick Start: Metadata API Context MCP Tools

The Metadata API Context MCP tools provide contextual information about Salesforce metadata types to help generate accurate Salesforce metadata files when working with the Metadata API.

<table class="editionTable" border="0" summary="Salesforce editions needed for the documented functionality" width="100%"><tbody class="tbody"><tr><td class="subHead">Available in: <strong class="ph b">Professional</strong>, <strong class="ph b">Enterprise</strong>, <strong class="ph b">Unlimited</strong>, <strong class="ph b">Developer</strong>, <strong class="ph b">sandbox</strong>, and <strong class="ph b">scratch orgs</strong> that have API enabled.</td></tr></tbody></table>

  

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Metadata API Context MCP Tools are a beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this beta service is at the Customer's sole discretion.

For a given metadata type, these tools give you:

- complete field definitions
- valid values
- constraints
- examples

They’re a useful resource for creating valid Salesforce metadata XML files when you need to generate them programmatically, or want to ensure accuracy.

Table 1. MCP Details
| Server Name | Tool Name | Tool Description |
| --- | --- | --- |
| platform/salesforce-api-context | get\_metadata\_type\_sections | Returns valid context sections available for a metadata type. |
| platform/salesforce-api-context | get\_metadata\_type\_context | Returns metadata context for the requested metadata type sections. |
| platform/salesforce-api-context | get\_metadata\_type\_fields | Returns field names and field-column metadata for a metadata type. |
| platform/salesforce-api-context | get\_metadata\_type\_fields\_properties | Returns field properties for the specified field. |
| platform/salesforce-api-context | search\_metadata\_types | Searches metadata type names for a provided string and returns a list of matching metadata types. |

These MCP tools are part of the Salesforce API Context MCP Server, which is [hosted in Salesforce](https://help.salesforce.com/s/articleView?id=platform.hosted_mcp_servers.htm&type=5&language=en_US).

With this feature, you might make API calls to your org. API usage counts against your org’s API quota.

- **[Prerequisites: Set Up Salesforce Hosted MCP Servers](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mcp_server_eca.htm)**  
    The Salesforce API Context MCP server is one of many Salesforce Hosted MCP Servers. To use the Salesforce API Context MCP server, you must first set up the Salesforce Hosted MCP Server.
- **[Step 1: Configure an MCP Client](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mcp_cursor_configuration.htm)**  
    Configure a client to connect to MCP servers hosted in your Salesforce org. In this quick start guide, we provide guidance on how to configure Agentforce Vibes, Cursor, and Claude.
- **[Step 2: Test Your Connection to the MCP Server](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mcp_prompt_examples.htm)**  
    Use simple prompts to test your client’s connection to the Salesforce API Context MCP server you configured.
- **[Step 3 (Optional): Configure a Rule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mcp_configure_rule.htm)**  
    ​​To help the MCP server function optimally, you can create a rule that guides your AI assistant, such as Agentforce Vibes or Cursor Agent, to call the Metadata API Context MCP tools. An AI rule is a plain-text file like markdown that provides specific instructions, context, or constraints to your AI assistant.

<!-- document id=9012f9da91c8b69e4c33cedb84934b8e511ca6f0557a9d5d8003044dc367a413 url=/legacydeveloper/current/en-us/api_meta/meta_quickaction.md -->

# QuickAction

Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields.

The parent objects supported include:

- Account
- Campaign
- Case
- Contact
- ContentNote
- Custom objects
- Group
- Lead
- Opportunity

## File Suffix and Directory Location

QuickAction components have the suffix quickAction and are stored in the quickActions folder.

## Version

QuickAction components are available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d783215e119">Field Name</th>

              <th class="featureTableHeader  " id="d783215e122">Field Type</th>

              <th class="featureTableHeader  " id="d783215e125">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">actionSubtype</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">ActionSybtype (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d783215e125" data-title="Description">The subtype of the action.<div class="p">The valid values are:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">Action</samp>—This value
                      is available only for actions of type <samp class="codeph nolang">LightningWebComponent</samp>.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Create</samp>—The Quick
                      Action Page defines the field layout of the record
                      creation form. This value is available only for actions
                      of type <samp class="codeph nolang">Flexipage</samp>.
                      (This value is available as a Beta in API version 68.0
                      and later)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">ScreenAction</samp>—This
                      value is available only for actions of type <samp class="codeph nolang">LightningWebComponent</samp>.
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Update</samp>—The Quick
                      Action Page defines the field layout of the record
                      update form. This value is available only for actions of
                      type <samp class="codeph nolang">Flexipage</samp>.
                      (This value is available as a Beta in API version 68.0
                      and later)
                    </li>

                  </ul>
                </div>
                <p class="p">This field is available in API version 50.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="ph" id="field_canvas"><a name="field_canvas"><!-- --></a><span class="keyword parmname">canvas</span></span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">
                <span class="ph" id="field_canvas_desc"><a name="field_canvas_desc"><!-- --></a>If the custom action invokes a Canvas
                  app, the app name. Returns the fully qualified name of the
                  Canvas app in the format <samp class="codeph nolang"><span class="keyword parmname">&lt;namespace&gt;</span>__<span class="keyword parmname">&lt;dev_name&gt;</span></samp>,
                  if the quick action type is <samp class="codeph nolang">Canvas</samp>; otherwise, returns <samp class="codeph nolang">null</samp>.</span>
                <p class="p">This field is available in API version 29.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">The description of the action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">fieldOverrides</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">
                <a class="xref" href="#fieldOverride_title">FieldOverride</a>[]
              </td>

              <td class="entry" headers="d783215e125" data-title="Description">The specific field that can be overridden within a <a class="xref" href="#meta_quickaction" title="Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields.">QuickAction</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">flexiPage</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">The API name of the Quick Action Page that contains the fields
                and layout for the action. This field applies only when the quick
                action type is <samp class="codeph nolang">Flexipage</samp>.
                <p class="p">This field is available as a Beta in API version 68.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">flowDefinition</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">If the custom action invokes a flow, this field represents the
                API name of the flow. Otherwise, this field is <samp class="codeph nolang">null</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">int</td>

              <td class="entry" headers="d783215e125" data-title="Description">If a custom action is created, this field represents the height
                in pixels of the action pane.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">icon</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">The icon used to identify the action.<p class="p">API version 32.0 and
                  later returns different icons than in earlier API
                  versions.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">boolean</td>

              <td class="entry" headers="d783215e125" data-title="Description">Indicates whether this component is protected (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Protected components cannot
                be linked to or referenced by components created in the installing
                organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">Identifies the action and displays to users. Also the default
                identifier used for the API and managed packages.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">lightningComponent</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">
                <span class="ph" id="field_lightningcomponent_desc"><a name="field_lightningcomponent_desc"><!-- --></a>If the custom action
                  invokes a Lightning component, this field represents the fully
                  qualified name of the component. Otherwise, this field is
                  <samp class="codeph nolang">null</samp>.</span>
                <p class="p">Available
                  in API version 38.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">optionsCreateFeedItem</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">boolean</td>

              <td class="entry" headers="d783215e125" data-title="Description">Required. Indicates whether successful completion of the action
                creates a feed item (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). Applies only to
                Create Record, Update Record, and Log a Call quick action
                types.<p class="p">Available in API version 36.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">If the custom action invokes a Visualforce page, this field
                identifies the page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">quickActionLayout</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">
                <a class="xref" href="#quickActionLayout_title">QuickActionLayout</a>
              </td>

              <td class="entry" headers="d783215e125" data-title="Description">The layout of fields on the action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">quickActionParameters</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">
                <a class="xref" href="#quickActionParameter_title">QuickActionParameter</a>[]
              </td>

              <td class="entry" headers="d783215e125" data-title="Description">The input and output of the quick action.<p class="p">Available in API
                  version 63.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname" id="standardLabelName"><a name="standardLabelName"><!-- --></a>standardLabel</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">QuickActionLabel (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d783215e125" data-title="Description">Specifies the standard label to use for the action. The valid
                values are:<a name="quickaction_standardlabel"><!-- --></a>
                <ul class="ul bulletList" id="quickaction_standardlabel">
                  <li class="li"><samp class="codeph nolang">AddRecord</samp></li>

                  <li class="li"><samp class="codeph nolang">AddMember</samp></li>

                  <li class="li"><samp class="codeph nolang">ChangeDueDate</samp></li>

                  <li class="li"><samp class="codeph nolang">ChangePriority</samp></li>

                  <li class="li"><samp class="codeph nolang">ChangeStatus</samp></li>

                  <li class="li"><samp class="codeph nolang">CreateNew</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">CreateNewRecordType</samp>
                    (For example, a label with something like “Create New
                    Idea”)
                  </li>

                  <li class="li"><samp class="codeph nolang">Defer</samp></li>

                  <li class="li"><samp class="codeph nolang">EditDescription</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">EnrollInProgram</samp>
                    (Available in API versions 46.0 and later only if the org
                    has Health Cloud enabled)
                  </li>

                  <li class="li"><samp class="codeph nolang">Escalate</samp></li>

                  <li class="li"><samp class="codeph nolang">EscalateToRecord</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Forward</samp> (Available in
                    API version 42.0 and later)
                  </li>

                  <li class="li"><samp class="codeph nolang">LogACall</samp></li>

                  <li class="li"><samp class="codeph nolang">LogANote</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ModifyAppointment</samp>
                    (Available in API version 47.0 and later)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">New</samp> (A new record)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NewChild</samp> (A new child
                    record)
                  </li>

                  <li class="li"><samp class="codeph nolang">NewChildRecordType</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">NewRecordType</samp> (For
                    example, a label with something like “New
                    Idea”)
                  </li>

                  <li class="li"><samp class="codeph nolang">OfferFeedback</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">PatientDetails</samp>
                    (Available in API version 57.0 and later if the org has
                    Health Cloud enabled)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PerformCount</samp> (Available
                    in API version 63.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Quick</samp> (A quick
                    record)
                  </li>

                  <li class="li"><samp class="codeph nolang">QuickRecordType</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">RelocateAsset</samp>
                    (Available in API version 63.0 and later)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ReplaceAsset</samp> (Available
                    in API version 63.0 and later)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Reply</samp> (Available in API
                    version 42.0 and later)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ReplyAll</samp> (Available in
                    API version 42.0 and later)
                  </li>

                  <li class="li"><samp class="codeph nolang">RequestFeedback</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">SendEmail</samp> (This value
                    is available in API version 31.0 and later.)
                  </li>

                  <li class="li"><samp class="codeph nolang">Update</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">successMessage</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">The message that displays to the user upon successful completion
                of the action.<p class="p">Available in API version 36.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">targetObject</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">The object for which the action is created and performed. <p class="p">For
                  example, you can create an action that, on the detail page of an
                  account, allows a user to create a contact related to that
                  account from the Chatter feed on that page. QuickAction can be
                  created on objects that permit custom fields. In this case,
                  Contact is the <span class="keyword parmname">targetObject</span>. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">targetParentField</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">The parent object type of the action. Links the target object to
                the parent object. For example, use Account if the target object is
                Contact and the parent object is Account.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">targetRecordType</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e125" data-title="Description">Specifies which record type to create. Valid values are:<a name="ul_e3z_rtt_w2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_e3z_rtt_w2c">
                  <li class="li">Business Account</li>

                  <li class="li">Person Account</li>

                  <li class="li">Master</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="ph" id="field_type"><a name="field_type"><!-- --></a><span class="keyword parmname">type</span></span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">QuickActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d783215e125" data-title="Description">Required. The type of quick action. Valid values
                are:<a name="quickaction_type_values"><!-- --></a>
                <ul class="ul bulletList" id="quickaction_type_values">
                  <li class="li"><samp class="codeph nolang">Canvas</samp></li>

                  <li class="li"><samp class="codeph nolang">Create</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Flexipage</samp> (This value
                    is available as a Beta in API version 68.0 and later)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Flow</samp> (This value is
                    available as a Beta in API version 41.0 and later)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LightningComponent</samp>
                    (This value is available in API version 38.0 and
                    later.)
                  </li>

                  <li class="li"><samp class="codeph nolang">LightningWebComponent</samp></li>

                  <li class="li"><samp class="codeph nolang">LogACall</samp></li>

                  <li class="li"><samp class="codeph nolang">Post</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">SendEmail</samp> (This value
                    is available in API version 31.0 and later.)
                  </li>

                  <li class="li"><samp class="codeph nolang">SocialPost</samp></li>

                  <li class="li"><samp class="codeph nolang">Update</samp></li>

                  <li class="li"><samp class="codeph nolang">VisualforcePage</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e119" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d783215e122" data-title="Field Type">int</td>

              <td class="entry" headers="d783215e125" data-title="Description">If a custom action is created, this field represents the width in
                pixels of the action pane.</td>

            </tr>

          </tbody>

        </table>

## FieldOverride

Represents the field names and their respective formulas and literal values that comprise predefined value settings for a [QuickAction](#meta_quickaction "Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields."). If a field on an action has both a predefined value and a default value set, the action uses the predefined value, not the default value. A formula value takes precedence over a literal value if both are defined.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Required. The name of the field to allow predefined values on. |
| formula | string | Specifies the formula to use when setting a field’s predefined value. Supported for single-select picklists as of API version 43.0. |
| literalValue | string | Supported for picklists only. Specifies the literal value of the field defined from values in the picklist. Corresponds to the Specific Value field in the predefined value UI. |

## QuickActionLayout

The layout of fields on the action. There’s no hard limit to the number of fields you can add to an action layout. However, for optimum usability, we recommend a maximum of eight fields. Adding more than 20 fields can severely affect user efficiency.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d783215e880">Field Name</th>

              <th class="featureTableHeader  " id="d783215e883">Field Type</th>

              <th class="featureTableHeader  " id="d783215e886">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d783215e880" data-title="Field Name"><span class="keyword parmname">layoutSectionStyle</span></td>

              <td class="entry" headers="d783215e883" data-title="Field Type">LayoutSectionStyle (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d783215e886" data-title="Description">Required. The type of layout structure used. The valid values
                are:<a name="ul_h3z_rtt_w2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_h3z_rtt_w2c">
                  <li class="li"><samp class="codeph nolang">TwoColumnsTopToBottom</samp></li>

                  <li class="li"><samp class="codeph nolang">TwoColumnsLeftToRight</samp></li>

                  <li class="li"><samp class="codeph nolang">OneColumn</samp></li>

                  <li class="li"><samp class="codeph nolang">CustomLinks</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e880" data-title="Field Name"><span class="keyword parmname">quickActionLayoutColumns</span></td>

              <td class="entry" headers="d783215e883" data-title="Field Type">
                <a class="xref" href="#quickActionLayoutColumn_title">QuickActionLayoutColumn</a>[]
              </td>

              <td class="entry" headers="d783215e886" data-title="Description">Specifies columns in a <a class="xref" href="#quickActionLayout_title">QuickActionLayout</a>.</td>

            </tr>

          </tbody>

        </table>

## QuickActionLayoutColumn

A column defined for a [QuickActionLayout](#quickActionLayout_title).

| Field Name | Field Type | Description |
| --- | --- | --- |
| quickActionLayoutItems | [QuickActionLayoutItem](#quickActionLayoutItem_title) \[\] | Specifies row items in a [QuickActionLayoutColumn](#quickActionLayoutColumn_title). |

## QuickActionLayoutItem

A row item comprised of fields and defined for a [QuickActionLayoutColumn](#quickActionLayoutColumn_title).

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d783215e1041">Field Name</th>

              <th class="featureTableHeader  " id="d783215e1044">Field Type</th>

              <th class="featureTableHeader  " id="d783215e1047">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d783215e1041" data-title="Field Name"><span class="keyword parmname">emptySpace</span></td>

              <td class="entry" headers="d783215e1044" data-title="Field Type">boolean</td>

              <td class="entry" headers="d783215e1047" data-title="Description">Controls if this layout item is a blank space (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e1041" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d783215e1044" data-title="Field Type">string</td>

              <td class="entry" headers="d783215e1047" data-title="Description">Represents a specific field in <a class="xref" href="#quickActionLayoutItem_title">QuickActionLayoutItem</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d783215e1041" data-title="Field Name"><span class="keyword parmname">uiBehavior</span></td>

              <td class="entry" headers="d783215e1044" data-title="Field Type">UiBehavior (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d783215e1047" data-title="Description">Specifies user input behavior for specific fields in <a class="xref" href="#quickActionLayoutItem_title">QuickActionLayoutItem</a>. The
                valid values are:<a name="ul_k3z_rtt_w2c"><!-- --></a>
                <ul class="ul bulletList" id="ul_k3z_rtt_w2c">
                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">Required</samp></li>

                  <li class="li"><samp class="codeph nolang">Readonly</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## QuickActionParameter

Represents the input and output of the associated quick action. Available in API version 63.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Name of the parameter. |
| type | QuickActionParameterType ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | Required. Input is the only valid value. |
| value | string | Represents the value associated with the given parameter name. |

## Declarative Metadata Sample Definition

The following is an example of a [QuickAction](#meta_quickaction "Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields.") component:

<?xml version="1.0" encoding="UTF-8"?>
<QuickAction xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>testActionDefinitionTypesCreateTask</description\>
    <label\>testActionDefinitionTypesCreateTask</label\>
    <optionsCreateFeedItem\>true</optionsCreateFeedItem\>
    <quickActionLayout\>
        <layoutSectionStyle\>TwoColumnsLeftToRight</layoutSectionStyle\>
        <quickActionLayoutColumns\>
            <quickActionLayoutItems\>
                <emptySpace\>false</emptySpace\>
                <field\>OwnerId</field\>
                <uiBehavior\>Required</uiBehavior\>
            </quickActionLayoutItems\>
            <quickActionLayoutItems\>
                <emptySpace\>false</emptySpace\>
                <field\>WhoId</field\>
                <uiBehavior\>Edit</uiBehavior\>
            </quickActionLayoutItems\>
            <quickActionLayoutItems\>
                <emptySpace\>false</emptySpace\>
                <field\>WhatId</field\>
                <uiBehavior\>Edit</uiBehavior\>
            </quickActionLayoutItems\>
            <quickActionLayoutItems\>
                <emptySpace\>false</emptySpace\>
                <field\>ActivityDate</field\>
                <uiBehavior\>Edit</uiBehavior\>
            </quickActionLayoutItems\>
            <quickActionLayoutItems\>
                <emptySpace\>false</emptySpace\>
                <field\>Subject</field\>
                <uiBehavior\>Edit</uiBehavior\>
            </quickActionLayoutItems\>
            <quickActionLayoutItems\>
                <emptySpace\>false</emptySpace\>
                <field\>Status</field\>
                <uiBehavior\>Required</uiBehavior\>
            </quickActionLayoutItems\>
            <quickActionLayoutItems\>
                <emptySpace\>false</emptySpace\>
                <field\>Priority</field\>
                <uiBehavior\>Required</uiBehavior\>
            </quickActionLayoutItems\>
        </quickActionLayoutColumns\>
        <quickActionLayoutColumns/\>
    </quickActionLayout\>
    <successMessage\>This is a success message</successMessage\>
    <targetObject\>Task</targetObject\>
    <targetParentField\>What</targetParentField\>
    <type\>Create</type\>
</QuickAction\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=91358fa2bab988782435e4949dd8989106295b072bc3afd1ba22eab0d96ad8b3 url=/legacydeveloper/current/en-us/api_meta/meta_quotessettings.md -->

# QuoteSettings

Represents an org’s quotes settings, such as enabling quotes or creating quotes without an associated opportunity. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

QuoteSettings values are stored in a single file named Quote.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

QuoteSettings is available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d786745e103">Field Name</th>

              <th class="featureTableHeader  " id="d786745e106">Field Type</th>

              <th class="featureTableHeader  " id="d786745e109">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d786745e103" data-title="Field Name"><span class="keyword parmname">enableQuote</span></td>

              <td class="entry" headers="d786745e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d786745e109" data-title="Description">When set to <samp class="codeph nolang">true</samp>, users can
                access Quotes.</td>

            </tr>

            <tr>
              <td class="entry" headers="d786745e103" data-title="Field Name"><span class="keyword parmname">enableQuotesWithoutOppEnabled</span></td>

              <td class="entry" headers="d786745e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d786745e109" data-title="Description">When set to <samp class="codeph nolang">true</samp>, users can
                create quotes independently of an opportunity. For example, a user
                can create a quote for budgeting purposes, before creating the
                Opportunity. Default value is <samp class="codeph nolang">false</samp>.<p class="p">When set to <samp class="codeph nolang">false</samp>, users can only create quotes from an
                  Opportunity. Before setting to <samp class="codeph nolang">false</samp>, delete any quotes that do not have
                  opportunities.</p>
                <p class="p">Available in API version 47.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the package file.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Quote</members\>
        <name\>Settings</name\>
    </types\>
    <version\>28.0</version\>
</Package\>

The package file references the following Quote.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<QuoteSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableQuote\>true</enableQuote\>
    <enableQuotesWithoutOppEnabled\>true</enableQuotesWithoutOppEnabled\>
</QuoteSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=6538df2032877a028168d2080dccedc9feec400790e234e50758205bebb25a84 url=/legacydeveloper/current/en-us/api_meta/meta_readMetadata.md -->

# readMetadata()

Returns one or more metadata components from your organization synchronously.

## Syntax

[ReadResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_readResult.htm "Contains result information for the readMetadata call.") = metadataConnection.readMetadata(string metadataType, string\[\] fullNames);

## Usage

Use the readMetadata() call to retrieve any component that extends [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm). All components must be of the same type in the same call. For more details, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

This call executes synchronously, which means that the call returns only when the operation completes.

## Version

Available in API version 30.0 and later.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Basic Steps for Reading Metadata Components

Use the following process to read metadata components:

1. Determine the metadata type of the components you want to read and the [fullName](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm#meta_fullname) of each component to read.
    
    The full names must match one or more full names returned by the listMetadata() call, which includes namespace prefixes. If you obtain the fullName from a package manifest file, and the component has a namespace prefix, prepend the namespace prefix to the fullName. Use this syntax: namespacePrefix\_\_ComponentName. For example, for the custom object component MyCustomObject\_\_c and the namespace MyNS, the fullName is MyNS\_\_MyCustomObject\_\_c. For more information about the [fullName](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm#meta_fullname) field, see [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm).
    
    You can read only components of the same type in a single call.
2. Invoke the readMetadata() call. For the first argument, pass in the name of the metadata type. The metadata type must match one of the values returned by the describeMetadata() call. For the second argument, pass in an array of full names corresponding to the components you wish to get.
3. A ReadResult is returned that contains an array of Metadata components. Cast each returned Metadata object to the metadata type you specified in the call to get the component’s properties.

## Sample Code—Java

public void readCustomObjectSync() {
    try {
        ReadResult readResult = metadataConnection
                .readMetadata("CustomObject", new String\[\] {
                        "MyCustomObject1\_\_c", "MyCustomObject2\_\_c" });
        Metadata\[\] mdInfo = readResult.getRecords();
        System.out.println("Number of component info returned: "
                + mdInfo.length);
        for (Metadata md : mdInfo) {
            if (md != null) {
                CustomObject obj = (CustomObject) md;
                System.out.println("Custom object full name: "
                        + obj.getFullName());
                System.out.println("Label: " + obj.getLabel());
                System.out.println("Number of custom fields: "
                        + obj.getFields().length);
                System.out.println("Sharing model: "
                        + obj.getSharingModel());
            } else {
                System.out.println("Empty metadata.");
            }
        }
    } catch (ConnectionException ce) {
        ce.printStackTrace();
    }
}

## Arguments

### metadataType

- **Type**: string
- **Description**: The metadata type of the components to read.

### fullNames

- **Type**: string\[\]
- **Description**: Array of full names of the components to read.
    
    Limit: 10. (For [CustomMetadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_custommetadata.htm) and [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_customapplication.htm) only, the limit is 200.)
    
    You must submit arrays of only one type of component. For example, you can submit an array of 10 custom objects or 10 profiles, but not a mix of both types.

## Response

[ReadResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_readResult.htm "Contains result information for the readMetadata call.")

<!-- document id=4089bcad628f8b992220209b009ea8f63377edb6a7003bf1c691eaeb7716fe8d url=/legacydeveloper/current/en-us/api_meta/meta_readResult.md -->

# ReadResult

Contains result information for the readMetadata call.

## Version

Available in API version 30.0 and later.

## Fields

### records

- **Type**: [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\]
- **Description**: An array of metadata components returned from readMetadata().

<!-- document id=a0b05b95685f49a526bc61440ae1a3247323e5815f8f7105e9695931723a4efc url=/legacydeveloper/current/en-us/api_meta/meta_realtimeeventsettings.md -->

# RealTimeEventSettings

Represents the list of Real-Time Event entities that you want to enable or disable. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

Real-Time Event settings are stored in a single file named RealTimeEvent.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

RealTimeEventSettings is available in API version 50.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| realTimeEvents | [RealTimeEvent](#RealTimeEvent)\[\] | Represents the list of Real-Time Event entities that you want to enable or disable. |

## RealTimeEvent

Represents one of the Real-Time Event entities that you want to enable or disable.

| Field Name | Field Type | Description |
| --- | --- | --- |
| entityName | string | The storage or streaming entity name that you want to modify. For example: ApiEvent or ApiEventStream. |
| isEnabled | boolean | Indicates whether you want the storage or streaming capability to be enabled (true) or disabled (false). |

## Declarative Metadata Sample Definition

The following is an example RealTimeEvent.settings metadata file:

<?xml version=“1.0” encoding=“UTF-8"?>
<RealTimeEventSettings xmlns=“http://soap.sforce.com/2006/04/metadata”/>
  <realTimeEvents\>
    <entityName\>ApiEventStream</entityName\>
    <isEnabled\>true</isEnabled\>
  </realTimeEvents\>
  <realTimeEvents\>
    <entityName\>ApiEvent</entityName\>
    <isEnabled\>true</isEnabled\>
  </realTimeEvents\>
</RealTimeEventSettings\>

The following is an example package.xml manifest that references the RealTimeEventSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>RealTimeEvent</members\>
        <name\>Settings</name\>
    </types\>
    <version\>51.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b7af6263b4dfb171adeaf62aa38fe1a97079a5f0ed05eafca61126e05bee48dd url=/legacydeveloper/current/en-us/api_meta/meta_recommendationstrategy.md -->

# RecommendationStrategy

Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations.

## File Suffix and Directory Location

RecommendationStrategy components have the suffix .recommendationStrategy and are stored in the recommendationStrategies folder.

## Version

RecommendationStrategy components are available in API version 45.0 and later.

## Special Access Rules

Metadata access for the RecommendationStrategy type is backed by the ManageRecommendationStrategies user permission.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| actionContext | [StrategyAction](#StrategyAction)\[\] | An array of action contexts used by the strategy. |
| contextRecordType | string | The sObject type of the $record used by the flow. |
| description | string | Description of the recommendation strategy. |
| filter | [StrategyNodeFilter](#StrategyNodeFilter)\[\] | An array of filter nodes. |
| if | [StrategyNodeIf](#StrategyNodeIf)\[\] | An array of if nodes. |
| invocableAction | [StrategyNodeInvocableAction](#StrategyNodeInvocableAction)\[\] | An array of Apex invocable action nodes. Available in API version 46.0 and later. |
| isTemplate | boolean | Indicates whether the recommendation strategy is a template (true) or not (false). When installed from managed packages, recommendation strategies can’t be viewed or cloned by subscribers because of intellectual property (IP) protection. But when those recommendation strategies are templates, subscribers can open them in a builder, clone them, and customize the clones. The default value of this field is false. Available in API version 47.0 and later. |
| label | string | Required. Label for the flow. |
| map | [StrategyNodeMap](#StrategyNodeMap)\[\] | An array of map nodes. Available in API version 46.0 and later. |
| mutuallyExclusive | [StrategyNodeExclusive](#StrategyNodeExclusive)\[\] | An array of mutuallyExclusive nodes. |
| onBehalfOfExpression | string | Formula expression defining the intended target of the recommendations (in other words, the Contact associated with a Case). Mainly used for reaction tracking. |
| recommendationLimit | [StrategyNodeRecommendationLimit](#StrategyNodeRecommendationLimit)\[\] | An array of recommendation limit nodes. |
| recommendationLoad | [StrategyNodeRecommendationLoad](#StrategyNodeRecommendationLoad)\[\] | An array of recommendation load nodes. |
| sort | [StrategyNodeSort](#StrategyNodeSort)\[\] | An array of sort nodes. |
| union | [StrategyNodeUnion](#StrategyNodeUnion)\[\] | An array of union nodes. |

## StrategyNodeBase

Base class for all strategy nodes. This is an abstract class.

| Field Name | Field Type | Description |
| --- | --- | --- |
| childNode | string | Array of child node names, in order of execution. |
| description | string | Description of the node. |
| label | string | Label of the node. |
| name | string | Required. Unique name of the node. |

## StrategyAction

Defines a call to an invocable action from the strategy. Results are used by decision elements in the strategy.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d787666e457">Field Name</th>

              <th class="featureTableHeader  " id="d787666e460">Field Type</th>

              <th class="featureTableHeader  " id="d787666e463">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d787666e457" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d787666e460" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e463" data-title="Description">Required. The name or id of the InvocableAction to execute.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e457" data-title="Field Name"><span class="keyword parmname">argument</span></td>

              <td class="entry" headers="d787666e460" data-title="Field Type">
                <a class="xref" href="#StrategyActionArg">StrategyActionArg</a>[]
              </td>

              <td class="entry" headers="d787666e463" data-title="Description">List of strategy action arguments.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e457" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d787666e460" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e463" data-title="Description">Description of the strategy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e457" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d787666e460" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e463" data-title="Description">Label for the strategy action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e457" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d787666e460" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e463" data-title="Description">Required. Unique name of the strategy action, which is referenced by
                decisioning elements in the strategy.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e457" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d787666e460" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d787666e463" data-title="Description">Required. The action type. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">activateSessionPermSet</samp>—Activates a session-based
                    permission set for the running user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">activationSchema</samp>— Gets the
                    activation schema for the specified activation. This value is available in API
                    version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addMessageToChat</samp>—Adds a
                    message to an existing Salesforce Anywhere chat. This value is available in
                    API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addMessageToQuipChat</samp>—Adds a
                    Quip message to an existing chat room. This value is available in API version
                    46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addMessageToQuipDocument</samp>—Adds
                    a Quip message to an existing Quip document, spreadsheet, or slide. This value
                    is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addQuipDocumentToFolder</samp>—Adds
                    an existing Quip document, spreadsheet, or slide to an existing folder. This
                    value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addUsersToChat</samp>—Adds users to
                    an existing Salesforce Anywhere chat. This value is available in API version
                    49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addUsersToQuipDocument</samp>—Adds
                    users, identified by their email addresses, to an existing Quip document,
                    spreadsheet, or slide. This value is available in API version 46.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addUsersToQuipChat</samp>—Adds users,
                    identified by their email addresses, to an existing Quip chat room. This value
                    is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">answerQuestionsWithSalesforceDocumentation</samp>—Searches
                    Salesforce documentation to answer questions and provide links to relevant
                    articles.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">attachQuipDocumentToRecord</samp>—Attaches a Quip document,
                    spreadsheet, or slide to a Salesforce record. This value is available in API
                    version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="actiontype_apex"><a name="actiontype_apex"><!-- --></a>apex</samp>—Invokes an Apex method that has the @invocableMethod
                    annotation.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">archiveKnowledgeArticles</samp>—Archives
                    a list of published Knowledge articles. This value is available in API version
                    45.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">assignKnowledgeArticles</samp>—Mass
                    assigns knowledge articles from article list views. This value is available in
                    API version 44.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cdpRunIdentityResolution</samp>—Runs
                    a <span class="ph">Data 360</span> identity resolution process. This value is
                    available in API version 57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">chat</samp>—Creates a Salesforce
                    Anywhere chat. This value is available in API version 49.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">chatterPost</samp>—Posts to Chatter.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">choosePricebook</samp>—Selects a price
                    book.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">contactRequestAction</samp>—Creates a
                    contact request record. This value is available in API version 45.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">component</samp>—Invokes the Lightning
                    component that implements the <samp class="codeph nolang">lightning:availableForFlowActions</samp> interface and that is referenced
                    by <span class="keyword parmname">actionName</span>. This value is available in API version 43.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">contentWorkspaceEnableFolders</samp>—Enables folders in a
                    library.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">convertAttributesToJson</samp>—Converts
                    the given attributes into a JSON string format. This value is available in API
                    version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">copyQuipDocument</samp>—Creates a
                    copy of an existing Quip document, spreadsheet, or slide, and gives it a new
                    title. This value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createDraftFromOnlineKnowledgeArticle</samp>—Creates a draft from a
                    published knowledge article. This value is available in API version 45.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createInvoiceFromFulfillmentOrder</samp>—Creates
                    an invoice from a purchase order. Available to B2B Commerce. This value is
                    available in API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createQuipChat</samp>—Creates a Quip
                    chat room. This value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createQuipDocument</samp>—Creates a
                    Quip document, spreadsheet, or slide. This value is available in API version
                    46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createQuipFolder</samp>—Creates a
                    Quip folder. This value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">customNotificationAction</samp>—Sends
                    a custom notification. This value is available in API version 46.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">deactivateSessionPermSet</samp>—Deactivates a session-based permission
                    set for the running user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">deleteKnowledgeArticle</samp>—Deletes a
                    draft version (translation or master-language) or an entire archived knowledge
                    article. This value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">dynamicSendSurveyInvitation</samp>—Sends
                    customized notifications to users about important events or updates to the
                    records that they’re working on. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">editQuipDocument</samp>—Modifies the
                    contents of an existing Quip document, spreadsheet, or slide. This value is
                    available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">emailAlert</samp>—Sends an email by
                    referencing a workflow email alert
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">emailSimple</samp>—Sends an email by
                    using flow resources
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">exploreConversation</samp>—Retrieves
                    insights from a conversation. This value is available in API version 61.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">externalConnector</samp>—Executes a
                    process or method exposed via a connector to an external system. This value is
                    available in API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">externalService</samp>—Invokes an
                    External Service operation that makes an HTTP request to an external system made
                    available by an External Service schema registered through Setup. This value is
                    available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">findMatchingIndividuals</samp>—Finds
                    contact, lead, or employee records that match a search term.
                  </li>

                  <li class="li">
                    <div class="codeSection nolang">
                      <pre class="codeblock nolang">findPastCollaborators</pre>
                    </div>
                    —Leverages
                    insights from Einstein Activity Capture to identify individuals with past
                    collaborative ties, aiding in securing introductions to relevant parties in
                    ongoing or future deals. This value is available in API version 63.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">flow</samp>—Invokes an autolaunched flow.
                    This action type isn’t available for flows with a processType of Flow or
                    AutolaunchedFlow. To invoke an autolaunched flow from one of those types, use
                    FlowSubflow. This value is available in API version 32.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateAiAgentResponse</samp>—Generates
                    a response from the AI agent based on input and instructions to support
                    intelligent, conversational experiences. This value is available in API version
                    63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateVerificationCode</samp>—Sends a
                    verification code to the customer's email to verify their identity. This value
                    is available in API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getArticleSmartLinkUrl</samp>—Gets the
                    Smart Link URL of the Salesforce Knowledge article. Smart links go to the right
                    article and version, even when a new version is published or the URL name
                    changes. This value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getNrbyScvTerritories</samp>—Queries for
                    active service territories within a specified radius of given geographic
                    coordinates using database-level DISTANCE filtering. Available in API version
                    68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getPoliciesByObject</samp>—Gets Policy
                    Center policies that contain a given object and returns a list of matching
                    policy names.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getPoliciesByPolicyType</samp>—Gets
                    Policy Center policies of the type specified in the user input, such as Data
                    Backup or Data Archive.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getPolicyDetails</samp>—Gets details
                    about a policy in Policy Center, such as the policy type and the objects the
                    policy targets.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getProductPricing</samp>—Gets the pricing
                    information of a product, including relevant historical sale price data from
                    previous won deals involving the same product. This value is available in API
                    version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">goToCadenceStep</samp>—Jumps to the
                    specified step in the Sales cadence. This value is available in API version 57.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">groupClaimsByFields</samp>—Groups open
                    claims by configurable fields and returns counts per group. Available in API
                    version 68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">internalTestAction</samp>—Reserved for
                    internal use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">internalTestConnectApiAction</samp>—Reserved for internal use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">limitRepetitions</samp>—Limit the number
                    of times the same recommendation or offer appears on the same record or for the
                    same user during a time period in a recommendation strategy flow. This value is
                    available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">massUpdateAccountForecast</samp>—Bulk
                    updates forecasts asynchronously. This value is available in API version 48.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">massUpdateSalesAgreement</samp>—Bulk
                    updates sales agreements asynchronously. This value is available in API
                    version 48.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">processAccessDelegationRequest</samp>—Processes
                    the specified access delegation request. Available in API version 68.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">quickAction</samp>—Invokes a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickaction.htm" title="Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields.">QuickAction</a>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">publishActionableOrchSrcEvent</samp>—Publishes events triggered
                    by an external system. This value is available in API version 62.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">publishKnowledgeArticles</samp>—Mass
                    publishes knowledge articles from article list views. This value is available
                    in API version 44.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">recalculateHouseholdNames</samp>—Recalculates
                    the names and greetings of the specified households based on the active household
                    naming configurations. Available in API version 68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">restoreKnowledgeArticleVersion</samp>—Restores an archived version of
                    a knowledge article. This value is available in API version 45.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">reviewBuyingCommittee</samp>—Identifies
                    and reviews key contacts associated with a deal, their influence on that deal,
                    and other deals that they’ve impacted. This value is available in API version
                    63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">scheduleSvcApptActnblEvntOrch</samp>—Creates
                    service appointments in response to actionable events by identifying work type
                    and assigning service territories. This value is available in API version 63.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sendAlert</samp>—Sends Salesforce
                    Anywhere alerts to users. This value is available in API version 49.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sendNotification</samp>—Sends an
                    available notification type. This value is available in API version 54.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sendSurveyInvitation</samp>—Sends email
                    survey invitations to leads, contacts, and users in your org based on an action,
                    such as when a customer support case closes. This value is available in API
                    version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">performSurveySentimentAnalysis</samp>—Perform survey sentiment
                    analysis to create or update the AI Sentiment Result records. This value is
                    available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">skillsBasedRouting</samp>—Creates a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_pendingservicerouting.htm" target="_blank" title="HTML (New Window)">PendingServiceRouting</a> record used for Omni-Channel skills-based
                    routing. This value is available in version 44.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackArchiveChannel</samp>—Archives a
                    Slack channel in a Slack workspace. This value is available in API version
                    54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackCheckUsersAreConnectedToSlack</samp>—Indicates whether a
                    collection of Salesforce users is connected to a given Slack app. This value
                    is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackCreateChannel</samp>—Creates a
                    Slack channel in a Slack workspace. This value is available in API version
                    54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackGetConversationInfo</samp>—Retrieves the name of a Slack
                    channel or group direct message and finds out whether it’s archived. This
                    value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackInviteUsersToChannel</samp>—Adds
                    users who are connected to a given Slack app to a Slack channel or group
                    direct message. This value is available in API version 54.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackPinMessage</samp>—Pin or unpin a
                    message in a Slack channel or group direct message. This value is available in
                    API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackPostMessage</samp>—Send a
                    message to a Slack channel or group direct message. This value is available in
                    API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackSendMessageToLaunchFlow</samp>—Send a message to a Slack
                    channel, direct message, or the Messages tab of a Slack app that includes a
                    button that a recipient can use to launch a screen flow. This value is
                    available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackUpdateMessage</samp>—Edits a
                    message that was previously sent to a Slack channel or group direct message.
                    This value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">submitKnowledgeArticleForTranslation</samp>—Submits a published or
                    draft knowledge article for translation. This value is available in API version
                    46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">submit</samp>—Submits a record for
                    approval.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">triggerJourney</samp>— Send an individual
                    to a specified journey. This value is available in API version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">verifyCustomerCode</samp>—Verifies the
                    code entered by the customer to complete identity verification. This value is
                    available in API version 49.0 and later.
                  </li>

                </ul>
                These values are used in Omnichannel Inventory. If no version is specified, the
                value is available in API version 51.0 and later.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ociCreateReservation</samp>—Creates one
                    or more inventory reservations at a location or location group.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ociFulfillReservation</samp>—Fulfills one
                    or more inventory reservations at a location.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ociGetAvailability</samp>—Gets inventory
                    availability data for one or more products at one or more inventory locations or
                    location groups.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ociReleaseReservation</samp>—Releases one
                    or more inventory reservations.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ociTransferReservation</samp>—Transfers
                    one or more inventory reservations between locations or location groups.
                  </li>

                </ul>
                <p class="p">These values are used in the B2B Commerce Checkout Flow. If no version is
                  specified, the value is available in API version 47.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">updateCheckoutSessionStateAction</samp>—Updates the checkout session
                    next state for checkout flows. This value is available in API version 49.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">priceCart</samp>—Requests prices for all
                    items in a cart during B2B Commerce checkout. This value is available in API
                    version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">checkoutSessionAction</samp>—Initiates or
                    retrieves an existing Checkout Session for Checkout Flows. Available to B2B
                    Commerce. This value is available in API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelCartAsyncOperation</samp>—Cancels a
                    WebCart’s async operation. Available to B2B Commerce. This value is available in
                    API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calcCartPromotionsAction</samp>—Requests
                    a full cart promotion calculation of all applicable line items in the Web Cart
                    during B2B Commerce checkout. This value is available in API version 52.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">checkCartInventoryAction</samp>—Requests
                    an inventory for all items in a Web Cart during B2B Commerce checkout. This
                    value is available in API version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calcCartShipmentAction</samp>—Calculates
                    the shipping cost for all items in a Web Cart during B2B Commerce checkout. This
                    value is available in API version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cartToOrderAction</samp>—Creates a
                    Salesforce Standard Order in draft mode. This value is available in API version
                    47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">activateOrderAction</samp>—Activates a
                    draft order, which creates an order summary. This value is available in API
                    version 47.0 and later.
                  </li>

                </ul>
                <p class="p">For values used in Business Rules Engine, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/bre_flow_metadata_api.htm" target="_blank" title="HTML (New Window)">Flow for Business
                    Rules Engine</a>.</p>
                <p class="p">These values are used in Context Service. If no
                  version is specified, the value is available in API version 64.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">deleteContextCache</samp>—Deletes the
                    context instance from the context cache using specified context ID.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">queryContextTags</samp>—Queries context
                    instance tags associated with a context definition.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">updateContextAttributes</samp>—Updates
                    attributes on the context instance using context tags.
                  </li>

                </ul>
                <p class="p">These values are used in the Commerce Checkout Flow. If no version is
                  specified, the value is available in API version 55.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">addCartItem</samp>—Adds an item to a cart
                    during Commerce checkout.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createCart</samp>—Creates a cart during
                    Commerce checkout.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">deleteCart</samp>—Deletes a cart during
                    Commerce checkout.
                  </li>

                </ul>
                <p class="p">These values are used in <span class="ph">Data 360</span>. If no version is
                  specified, the value is available in API version 64.0 and later.</p>
                <a name="ul_egc_ckz_ggc"><!-- --></a>
                <ul class="ul bulletList" id="ul_egc_ckz_ggc">
                  <li class="li">
                    <samp class="codeph nolang">dataKitGetComponentAction</samp> Gets the
                    deployment status of data kit deployment jobs.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">dataKitDeployComponentAction</samp> Deploys data
                    kit components in a target org.
                  </li>

                </ul>
                <p class="p">These values are used in Salesforce CMS Workflows and Approvals. If no
                  version is specified, the value is available in API version 58.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">managedContentPublishVariant</samp>—Publishes a content variant
                    associated with a flow. This value is available in API version 59.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">managedContentRoleStepInteractive</samp>—Assigns a content variant
                    review to a CMS role.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">managedContentUnpublishVariant</samp>—Unpublishes a published content
                    variant associated with a flow. This value is available in API version 59.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">managedContentVariantSetLockStatus</samp>—Sets the locked status of a
                    content variant.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">managedContentVariantSetReadyStatus</samp>—Sets the ready for
                    publication status of a content variant.
                  </li>

                </ul>
                <p class="p">These values are used in Employee Service. If no version is specified, the
                  value is available in API version 64.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">createServiceRequestCase</samp>—Creates a
                    case or incident for the requested service.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getDirectDepositDetails</samp>—Gets the
                    direct deposit details for the specified record ID.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getLeaveBalance</samp>—Gets the leave
                    balance of a specific employee.
                  </li>

                </ul>
                <p class="p">These values are used in Insurance. If no version is specified, the value is
                  available in API version 63.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">cancelInsurancePolicy</samp>—Cancel an
                    insurance policy by using a set of user inputs that represent policy
                    details.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">endorseInsurancePolicy</samp>—Endorse an
                    insurance policy by using a set of user inputs that represent policy
                    details.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getInsurancePolicy</samp>—Get the details
                    of an insurance policy.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">issueInsurancePolicy</samp>— Issue an
                    insurance policy by using a set of user inputs that represent policy
                    details.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">renewInsurancePolicy</samp>—Renew an
                    insurance policy by using a set of user inputs that represent policy
                    details.
                  </li>

                </ul>
                These values are used in Insurance Brokerage. If no version is specified, the
                value is available in API version 63.0 and later.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">computeProducerSplits</samp>—Compute the
                    producer splits for the producers associated with an Insurance Policy, for a
                    Commission Statement Line Item.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createProducerCommissions</samp>—Create
                    records for the commissions that producers receive for the insurance policy
                    associated with the specified commission statement line item, and update the
                    commission statement line item record status.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">findInsurancePolicy</samp>—Get the
                    insurance policy associated with a commission statement line item that matches
                    the specified criteria, and update the status of the commission statement line
                    item record.
                  </li>

                </ul>
                These values are used in Order Management. If no version is specified, the
                value is available in API version 48.0 and later.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">addOrderItemSummarySubmit</samp>—Adds
                    order item summaries to an order summary. This value is available in API version
                    54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">adjustOrderItemSummariesPreview</samp>—Previews the expected results
                    of applying a price adjustment to order item summaries from an order summary
                    without actually applying it. This value is available in API version 49.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">adjustOrderItemSummariesSubmit</samp>—Applies a price adjustment to
                    order item summaries from an order summary. This value is available in API
                    version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">authorizePayment</samp>—Authorizes a card
                    payment. This value is available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelFulfillmentOrderItem</samp>—Removes
                    items from a fulfillment order.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelOrderItemSummariesPreview</samp>—Previews the expected results
                    of canceling order item summaries from an order summary without actually
                    canceling them.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelOrderItemSummariesSubmit</samp>—Cancels order item summaries
                    from an order summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">confirmHeldFulfillmentOrderCapacity</samp>—Confirms held fulfillment
                    order capacity. This value is available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createCreditMemoOrderSummary</samp>—Creates a credit memo for an order
                    summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createFieldGnrnPromptTmplResp</samp>—Creates a field generation prompt
                    template response. This value is available in API version 62.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createFulfillmentOrder</samp>—Creates one
                    or more fulfillment orders and fulfillment order products for an order delivery
                    group summary, which defines a recipient and delivery method.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createFulfillmentOrders</samp>—Creates
                    fulfillment orders and fulfillment order products for multiple order delivery
                    group summaries, each of which defines a recipient and delivery method. This
                    value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createInvoiceFromChangeOrders</samp>—Creates an invoice for one or
                    more change orders. This value is available in API version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createInvoiceFromFulfillmentOrder</samp>—Creates an invoice for a
                    fulfillment order.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createOrderPaymentSummary</samp>—Creates
                    an order payment summary for an authorization or payments belonging to an order
                    summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createOrderSummary</samp>—Creates an
                    order summary for an order.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createReturnOrder</samp>—Creates a return
                    order and return order items for an order.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ensureFundsOrderSummaryAsync</samp>—Triggers an asynchronous
                    background process to ensure funds through a payment provider for an invoice
                    belonging to an order summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ensureRefundsOrderSummaryAsync</samp>—Triggers an asynchronous
                    background process to ensure refunds through a payment provider for an invoice
                    belonging to an order summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getFulfillmentOrderCapacityValues</samp>—Gets fulfillment order
                    capacity information. This value is available in API version 55.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">holdFulfillmentOrderCapacity</samp>—Holds
                    fulfillment order capacity. This value is available in API version 55.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">orderRoutingFindRoutesWithFewestSplits</samp>—Evaluates ordered
                    product quantities against available inventory to determine the smallest
                    combination of locations that can fulfill the order. This value is available in
                    API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">orderRoutingFindRoutesWithFewestSplitsUsingOCI</samp>—Evaluates
                    ordered product quantities against available inventory at specified location
                    groups and locations to determine the smallest combination of locations that can
                    fulfill the order. This value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">orderRoutingRankByAverageDistance</samp>—Calculates the average
                    distance from sets of inventory locations to an order recipient, and returns the
                    sets sorted by that average distance. This value is available in API version
                    51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">releaseHeldFulfillmentOrderCapacity</samp>—Releases held fulfillment
                    order capacity. This value is available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">returnOrderItemSummariesPreview</samp>—Previews the expected results
                    of returning order item summaries from an order summary without actually
                    returning them.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">returnOrderItemSummariesSubmit</samp>—Returns order item summaries
                    from an order summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">returnReturnOrderItems</samp>—Processes
                    return order line items.
                  </li>
                </ul>
                <p class="p">For values used in Financial Services Cloud, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/fsc_meta_visual_workforce.htm" target="_blank" title="HTML (New Window)">Flow for Financial
                    Services Cloud</a>. </p>
                <p class="p">For values used in Fundraising for Nonprofit
                  Cloud, see Flow for Fundraising. </p>
                <p class="p">For values
                  used in Health Cloud, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/health_cloud_flow_metadata_api.htm" target="_blank" title="HTML (New Window)">Flow for Health Cloud</a>.</p>
                <p class="p">For
                  values used in Manufacturing Cloud, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.mfg_api_devguide.meta/mfg_api_devguide/mfg_flow_metadata_api.htm" target="_blank" title="HTML (New Window)">Flow for Manufacturing Cloud</a>.
                </p>
                <p class="p">For values used in Automotive Cloud, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/https://developer.salesforce.com/docs/atlas.en-us.264.0.automotive_cloud.meta/automotive_cloud/auto_flow_metadata_api.htm" target="_blank" title="HTML (New Window)">Flow for Automotive Cloud</a>.
                </p>
                <p class="p">This value is used in Omnistudio.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">executeIntegrationProcedure</samp>—Executes an Integration Procedure
                    with Agentforce configured. This value is available in API version 64.0 and
                    later.
                  </li>

                </ul>
                <p class="p">These values are used in Rebate Management. </p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">addRebateMemberList</samp>—Adds a list of
                    members to a rebate program. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calculateProjectedRebateAmount</samp>—Calculates
                    the projected rebate amount for rebate types associated with a specified
                    transaction ID. This value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calculateRebateAmountAndUpsertPayout</samp>—Calculates the rebate amount and
                    upserts the rebate payout for the specified aggregate record. This value is
                    available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getBenefitAndCalculateRebateAmount</samp>— Gets
                    benefit details, and optionally calculates the rebate amount for the specified
                    aggregate record. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getEligibleProgramRebateTypes</samp>—Retrieves
                    the eligible program rebate types for a mapped object. This value is available
                    in API version 52.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateRebatePayoutPeriods</samp>—Generates
                    payout periods for a rebate program based on the frequency specified in the
                    program. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">processRebatesBatchCalculationJob</samp>—Processes a rebate batch calculation
                    job from the Data Processing Engine. This value is available in API version 51.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">processProgramRebateTypeProducts</samp>—Insert
                    or delete records in the Program Rebate Type Product object. This value is
                    available in API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">rebatesProcessCSV</samp>—Processes an uploaded
                    CSV file using Bulk API 2.0 and converts the file’s data into records in the
                    target object. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">upsertCustomRebatePayout</samp>—Upserts the
                    custom calculated rebate payout for the specified aggregate record. This value
                    is available in API version 51.0 and later.
                  </li>

                </ul>
                <p class="p">These values are used in B2B Referral Management. If no version is
                  specified, the value is available in API version 64.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">enrollAdvocateB2bReferralProm</samp>—Enroll an existing or new
                    customer as an advocate for a referral promotion.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">processB2bReferralEvent</samp>—Create
                    referral event records when an advocate refers a friend, or when referred
                    friends sign up or make a purchase.
                  </li>

                </ul>
                <p class="p">These values are used in Referral Marketing.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">processReferralEvent</samp>—Create
                    referral event records when an advocate refers a friend, or when referred
                    friends sign up or make a purchase. This value is available in API version 60.0
                    and later.
                  </li>

                </ul>
                <p class="p">These values are used in Loyalty Management.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">adjustPoints</samp>—Adjusts loyalty points for a
                    specified program member or journal transaction. This value is available in API
                    version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">assignTierBenefits</samp>— Assigns Member
                    Benefits to a member tier for benefits that are associated with a Benefit
                    Action. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelAccrual</samp>—Cancels a specific set of
                    accrual transactions.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">creditPoints</samp>—Credits loyalty points to a
                    specified program member’s balance. This value is available in API version 51.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelRedemption</samp>—Reverts a specific set
                    of redemption transactions. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">changeTier</samp>—Changes the tier for a
                    specified program member. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">changeTierWhenNoErrors</samp>—Changes tier for a
                    specified loyalty program member only when all the input parameters meet the
                    criteria. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">debitPoints</samp>—Debits loyalty points to a
                    specified program member’s balance. This value is available in API version 51.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">executeMemberBenefit</samp>—Processes the
                    benefit action associated with the benefit, which is assigned to a loyalty
                    program member. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateMemberReferralCode</samp>—Generates a
                    unique 8-character referral code for a loyalty program member. This value is
                    available in API version 57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getMemberActiveSegments</samp>—Retrieve active
                    <span class="ph">Data 360</span> market segments that a loyalty program member is a
                    part of.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getTier</samp>—Gets the current tier for a
                    specified program member. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getPointsBalance</samp>—Gets the loyalty points
                    balance for a specified program member. This value is available in API version
                    51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getLoyaltyPromotion</samp>—Gets active loyalty
                    promotions based on a transaction journal. This value is available in API
                    version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getLoyaltyPromotionBasedOnSalesforceCDP</samp>—Gets promotions for a member
                    based on the market segment the member belongs to. This value is available in
                    API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">issueVoucher</samp>—Issues a voucher for a
                    member or contract. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">mergeLoyaltyProgramMembership</samp>—Merges two active loyalty program
                    member records that both belong to the same loyalty program. This value is
                    available in API version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">transferMemberPointsToGroups</samp>—Transfers
                    points from an individual member or a corporate member to the member’s
                    associated group. This value is available in API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">transferPoints</samp>—Transfers points from a
                    source loyalty program member to a target loyalty program member, or to a group
                    that the member is a part of. This value is available in API version 64.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">updateProgressForCumulativePromotionUsage</samp>—Updates the progress a
                    member has made towards attaining a cumulative type promotion. This value is
                    available in API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">unmergeLoyaltyProgramMembership</samp>—Unmerges loyalty program member
                    records that have a Merged status. The action unmerges memberships in the Merged
                    status from the previously merged membership. This value is available in API
                    version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">runProgramProcess</samp>—Triggers an active
                    loyalty program process. This value is available in API version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">runProgramProcessForTransactionJournal</samp>—Triggers an active loyalty
                    program process whose process type is TransactionJournal. This value is
                    available in API version 54.0 and later.
                  </li>

                </ul>
                <p class="p">These values are for Decision Table.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">decisionTableAction</samp>—Runs an active
                    decision table definition. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">refreshDecisionTable</samp>—Refreshes the
                    decision table cache. This value is available in API version 51.0 and
                    later.
                  </li>

                </ul>
                <p class="p">These values are for the Batch Management jobs.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">batchJobAction</samp>—Runs the batch management
                    jobs definitions. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">submitFailedRecordsBatchJob</samp>—Resubmits an
                    existing batch job with failed records for processing. This value is available
                    in API version 52.0 and later.
                  </li>

                </ul>
                <p class="p">This value is for Data Processing Engine.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">dataProcessingEngineAction</samp>—Runs the data
                    processing engine definitions. This value is available in API version 51.0 and
                    later.
                  </li>

                </ul>
                <p class="p">This value is used for Einstein Visit Recommendation.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">saveRecommendationDecision</samp>—Save visit and
                    task recommendation decisions. This value is available in API version 51.0 and
                    later.
                  </li>

                </ul>
                These values are used in Field Service. If no version is specified, the value
                is available in API version 52.0 and later.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">addWorkPlans</samp>—Creates work plan and work
                    step objects from the work plan library. Available in API version 52.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addWorkSteps</samp>—Creates work step objects
                    from the work plan library. available in API version 52.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">deleteWorkPlans</samp>—Deletes all the work
                    plans and work steps associated with a work order or work order line item.
                    Available in API version 52.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateWorkPlans</samp>—Generates work plans
                    based off rules defined in the work plan library. Available in API version 52.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">assignApptForServiceResourceForFieldService</samp>—Assigns the service
                    appointment selected by the dispatcher to a service resource, in the gap
                    identified in the service resource’s schedule on a specific date. Available in
                    API version 63.0 and later.
                  </li>

                </ul>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">assignApptForServiceResourceForFieldService</samp>—Assigns the service
                    appointment selected by the dispatcher to a service resource, in the gap
                    identified in the service resource’s schedule on a specific date.
                  </li>

                </ul>
                <p class="p">For values used in Intelligent Form Reader, see Flow for
                  Intelligent Form Reader. </p>
                <p class="p">For values used in Intelligent Document
                  Reader, see Flow for Intelligent Document Reader. </p>
                <p class="p">These values are
                  used in Public Sector Solutions.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">bulkEnqueuePostingsToGenLeads</samp>—Enqueues active recruitment
                    postings so that matching candidates are sourced as lead records. This value is
                    available in API version 68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createBenefitDisbursement</samp>—Creates
                    a benefit disbursement for an eligible benefit assignment. This value is
                    available in API version 57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">invocableCallContentSearch</samp>—Searches
                    file content stored in Amazon S3, including images, audio, video, and PDFs, and
                    returns matching files with citations. This value is available in API version
                    68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">runRecordAggrBatchProcDef</samp>—Runs a
                    Data Processing Engine definition to process an asynchronous batch job that
                    creates or updates record aggregation results. This value is available in API
                    version 59.0 and later.
                  </li>

                </ul>
                <p class="p">These values are used in Unified Catalog. If no version is specified, the
                  value is available in API version 64.0 and later.</p>
                <a name="ul_jlw_43x_hgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_jlw_43x_hgc">
                  <li class="li">
                    <samp class="codeph nolang">checkProductEligibility</samp>—Determines
                    whether a user is eligible for a list of products, which represent service
                    processes, based on predefined criteria.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">checkSvcPrcActionEligibility</samp>—Determines whether an AI agent is
                    eligible for a list of products, which represent service processes, and if the
                    list is linked to a service process.
                  </li>

                </ul>
                <p class="p">This value is used in the Get Opportunity Grounding Data flow.</p>
                <a name="ul_jl3_p2b_lgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_jl3_p2b_lgc">
                  <li class="li">
                    <samp class="codeph nolang">getContentNote</samp>— Gets the content
                    note data for a specified record. This value is available in API version 64.0
                    and later.
                  </li>

                </ul>
                <p class="p">This value is used in the Process Field Update Suggestions flow.</p>
                <a name="ul_gkp_32b_lgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_gkp_32b_lgc">
                  <li class="li">
                    <samp class="codeph nolang">getOrExecFieldUpdtSuggestion</samp>—
                    Enqueues requests to get a field update suggestion from a field generation
                    prompt template. This value is available in API version 64.0 and later.
                  </li>

                </ul>
                <p class="p">These values are used in Channel Revenue Management. Available in API
                  version 64.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">adjustPartnerInvShipAndDebit</samp>—
                    Adjusts the point of sale during ship and debit claim processing to a different
                    partner unsold inventory. Available in API version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">adjustPartnerUnsoldInventory</samp>—
                    Adjusts the partner unsold inventory quantities and prices. Available in API
                    version 64.0 and later.
                  </li>

                </ul>
                <p class="p">This value is used in Einstein Conversation Insights.</p>
                <a name="ul_a1j_4pk_pgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_a1j_4pk_pgc">
                  <li class="li">
                    <samp class="codeph nolang">getConversationTranscript</samp>—Gets the
                    conversation transcript for the specified voice or video call record. This value
                    is available in API version 63.0 and later.
                  </li>

                </ul>
                These values are reserved for future use.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang" id="actiontype_thanks"><a name="actiontype_thanks"><!-- --></a>thanks</samp></li>

                  <li class="li"><samp class="codeph nolang">metricRefresh</samp></li>

                  <li class="li"><samp class="codeph nolang">exportSurveyResponses</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## StrategyActionArg

Defines arguments passed to invocable actions associated with a strategy action.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Unique name for the parameter to pass to the invocable action. |
| value | string | Required. A Salesforce formula expression that is evaluated with the result being used as the parameter value for the Strategy Action. |

## StrategyNodeUnionBase

Base class for nodes that perform a union of their children. Union nodes combine the outputs of their children to form the input to themselves. StrategyNodeUnionBase extends StrategyNodeBase and inherits all of its fields. This is an abstract class.

| Field Name | Field Type | Description |
| --- | --- | --- |
| limit | int | Maximum number of results to output. |

## StrategyNodeFilter

Defines a filter element that filters recommendations. It extends StrategyNodeUnionBase and inherits all its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| expression | string | Required. A formula expression that results in a boolean value when executed on each recommendation in the node’s input. Inputs that result in true form the output, and inputs that result in false are excluded. |

## StrategyNodeIf

Selects specific children to execute and combines their results. Executes and returns results of children based on the array of child node expressions. Extends StrategyNodeUnionBase and inherits all of its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| childNodeExpression | [IfExpression](#IfExpression)\[\] | Array of if expressions. |
| onlyFirstMatch | boolean | If true, selects only the results from the matching child. If false, selects and combines results from all matching children. The default value is false. |

## IfExpression

Expression used by StrategyNodeIf.

| Field Name | Field Type | Description |
| --- | --- | --- |
| childName | string | Required. Name of child to match. |
| expression | string | Required. Formula expression returning true or false. |

## StrategyNodeInvocableAction

Defines an element that calls an Apex invocable action to generate or enhance a list of recommendations. It extends [StrategyNodeUnionBase](#StrategyNodeUnionBase) and inherits all its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d787666e2241">Field Name</th>

              <th class="featureTableHeader  " id="d787666e2244">Field Type</th>

              <th class="featureTableHeader  " id="d787666e2247">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d787666e2241" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d787666e2244" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e2247" data-title="Description">Required. The name of the invocable action to execute.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e2241" data-title="Field Name"><span class="keyword parmname">argument</span></td>

              <td class="entry" headers="d787666e2244" data-title="Field Type">
                <a class="xref" href="#StrategyNodeInvocableActionArg">StrategyNodeInvocableActionArg</a>[]
              </td>

              <td class="entry" headers="d787666e2247" data-title="Description">List of arguments that are passed to the invocable action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e2241" data-title="Field Name"><span class="keyword parmname">isGenerator</span></td>

              <td class="entry" headers="d787666e2244" data-title="Field Type">boolean</td>

              <td class="entry" headers="d787666e2247" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, the UI displays the
                Generate element. If <samp class="codeph nolang">false</samp>, the UI displays the
                Enhance element. Defaults to <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e2241" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d787666e2244" data-title="Field Type">InvocableActionType (enumeration of type string)</td>

              <td class="entry" headers="d787666e2247" data-title="Description">Required. The action type. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">activateSessionPermSet</samp>—Activates a session-based
                    permission set for the running user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">activationSchema</samp>— Gets the
                    activation schema for the specified activation. This value is available in API
                    version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addMessageToChat</samp>—Adds a
                    message to an existing Salesforce Anywhere chat. This value is available in
                    API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addMessageToQuipChat</samp>—Adds a
                    Quip message to an existing chat room. This value is available in API version
                    46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addMessageToQuipDocument</samp>—Adds
                    a Quip message to an existing Quip document, spreadsheet, or slide. This value
                    is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addQuipDocumentToFolder</samp>—Adds
                    an existing Quip document, spreadsheet, or slide to an existing folder. This
                    value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addUsersToChat</samp>—Adds users to
                    an existing Salesforce Anywhere chat. This value is available in API version
                    49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addUsersToQuipDocument</samp>—Adds
                    users, identified by their email addresses, to an existing Quip document,
                    spreadsheet, or slide. This value is available in API version 46.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addUsersToQuipChat</samp>—Adds users,
                    identified by their email addresses, to an existing Quip chat room. This value
                    is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">answerQuestionsWithSalesforceDocumentation</samp>—Searches Salesforce
                    documentation to provide answer to questions, as well as links to relevant
                    articles.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">attachQuipDocumentToRecord</samp>—Attaches a Quip document,
                    spreadsheet, or slide to a Salesforce record. This value is available in API
                    version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">apex</samp>—<span class="ph" id="actiontype_apex_desc"><a name="actiontype_apex_desc"><!-- --></a>Invokes an Apex method that has the @invocableMethod annotation</span>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">archiveKnowledgeArticles</samp>—Archives
                    a list of published Knowledge articles. This value is available in API version
                    45.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">assignKnowledgeArticles</samp>—Mass
                    assigns knowledge articles from article list views. This value is available in
                    API version 44.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cdpRunIdentityResolution</samp>—Runs
                    a <span class="ph">Data 360</span> identity resolution process. This value is
                    available in API version 57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">chat</samp>—Creates a Salesforce
                    Anywhere chat. This value is available in API version 49.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">chatterPost</samp>—Posts to Chatter.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">choosePricebook</samp>—Selects a price
                    book.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">contactRequestAction</samp>—Creates a
                    contact request record. This value is available in API version 45.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">component</samp>—Invokes the Lightning
                    component that implements the <samp class="codeph nolang">lightning:availableForFlowActions</samp> interface and that is referenced
                    by <span class="keyword parmname">actionName</span>. This value is available in API version 43.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">contentWorkspaceEnableFolders</samp>—Enables folders in a
                    library.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">convertAttributesToJson</samp>—Converts
                    the given attributes into a JSON string format. This value is available in API
                    version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">copyQuipDocument</samp>—Creates a
                    copy of an existing Quip document, spreadsheet, or slide, and gives it a new
                    title. This value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createDraftFromOnlineKnowledgeArticle</samp>—Creates a draft from a
                    published knowledge article. This value is available in API version 45.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createInvoiceFromFulfillmentOrder</samp>—Creates
                    an invoice from a purchase order. Available to B2B Commerce. This value is
                    available in API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createQuipChat</samp>—Creates a Quip
                    chat room. This value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createQuipDocument</samp>—Creates a
                    Quip document, spreadsheet, or slide. This value is available in API version
                    46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createQuipFolder</samp>—Creates a
                    Quip folder. This value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">customNotificationAction</samp>—Sends
                    a custom notification. This value is available in API version 46.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">deactivateSessionPermSet</samp>—Deactivates a session-based permission
                    set for the running user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">deleteKnowledgeArticle</samp>—Deletes a
                    draft version (translation or master-language) or an entire archived knowledge
                    article. This value is available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">dynamicSendSurveyInvitation</samp>—Sends
                    customized notifications to users about important events or updates to the
                    records that they’re working on. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">editQuipDocument</samp>—Modifies the
                    contents of an existing Quip document, spreadsheet, or slide. This value is
                    available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">emailAlert</samp>—Sends an email by
                    referencing a workflow email alert
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">emailSimple</samp>—Sends an email by
                    using flow resources
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">exploreConversation</samp>—Retrieves
                    insights from a conversation. This value is available in API version 61.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">externalService</samp>—Invokes an
                    External Service operation that makes an HTTP request to an external system made
                    available by an External Service schema registered through Setup. This value is
                    available in API version 46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">findMatchingIndividuals</samp>—Finds
                    contact, lead, or employee records that match a search term.
                  </li>

                  <li class="li">
                    <div class="codeSection nolang">
                      <pre class="codeblock nolang">findPastCollaborators</pre>
                    </div>
                    —Leverages
                    insights from Einstein Activity Capture to identify individuals with past
                    collaborative ties, aiding in securing introductions to relevant parties in
                    ongoing or future deals. This value is available in API version 63.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">flow</samp>—Invokes an autolaunched flow.
                    This action type isn’t available for flows with a processType of Flow or
                    AutolaunchedFlow. To invoke an autolaunched flow from one of those types, use
                    FlowSubflow. This value is available in API version 32.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateAiAgentResponse</samp>—Generates
                    a response from the AI agent based on input and instructions to support
                    intelligent, conversational experiences. This value is available in API version
                    63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateVerificationCode</samp>—Sends a
                    verification code to the customer's email to verify their identity. This value
                    is available in API version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getAgentConvTscp</samp>—Retrieves the
                    transcript of conversations between the agent and the customer. This value is
                    available in API version 50.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getArticleSmartLinkUrl</samp>—Gets the
                    Smart Link URL of the Salesforce Knowledge article. Smart links go to the right
                    article and version, even when a new version is published or the URL name
                    changes. This value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getNrbyScvTerritories</samp>—Queries for
                    active service territories within a specified radius of given geographic
                    coordinates using database-level DISTANCE filtering. Available in API version
                    68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getPoliciesByObject</samp>—Gets Policy
                    Center policies that contain a given object and returns a list of matching
                    policy names.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getPoliciesByPolicyType</samp>—Gets
                    Policy Center policies of the type specified in the user input, such as Data
                    Backup or Data Archive.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getPolicyDetails</samp>—Gets details
                    about a policy in Policy Center, such as the policy type and the objects the
                    policy targets.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getProductPricing</samp>—Gets the pricing
                    information of a product, including relevant historical sale price data from
                    previous won deals involving the same product. This value is available in API
                    version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">groupClaimsByFields</samp>—Groups open
                    claims by configurable fields and returns counts per group. Available in API
                    version 68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">internalTestAction</samp>—Reserved for
                    internal use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">internalTestConnectApiAction</samp>—Reserved for internal use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">limitRepetitions</samp>—Limit the number
                    of times the same recommendation or offer appears on the same record or for the
                    same user during a time period in a recommendation strategy flow. This value is
                    available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">massUpdateAccountForecast</samp>—Bulk
                    updates forecasts asynchronously. This value is available in API version 48.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">massUpdateSalesAgreement</samp>—Bulk
                    updates sales agreements asynchronously. This value is available in API
                    version 48.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">processAccessDelegationRequest</samp>—Processes
                    the specified access delegation request. Available in API version 68.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">quickAction</samp>—Invokes a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickaction.htm" title="Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields.">QuickAction</a>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">parseConvoAnalysis</samp>—Parses
                    conversation data to analyze sentiment or extract actionable insights. This
                    value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">publishActionableOrchSrcEvent</samp>—Publishes events triggered
                    by an external system. This value is available in API version 62.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">publishKnowledgeArticles</samp>—Mass
                    publishes knowledge articles from article list views. This value is available
                    in API version 44.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">recalculateHouseholdNames</samp>—Recalculates
                    the names and greetings of the specified households based on the active household
                    naming configurations. Available in API version 68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">restoreKnowledgeArticleVersion</samp>—Restores an archived version of
                    a knowledge article. This value is available in API version 45.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">reviewBuyingCommittee</samp>—Identifies
                    and reviews key contacts associated with a deal, their influence on that deal,
                    and other deals that they’ve impacted. This value is available in API version
                    63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">scheduleSvcApptActnblEvntOrch</samp>—Creates
                    service appointments in response to actionable events by identifying work type
                    and assigning service territories. This value is available in API version 63.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sendAlert</samp>—Sends Salesforce
                    Anywhere alerts to users. This value is available in API version 49.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sendNotification</samp>—Sends an
                    available notification type. This value is available in API version 54.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">sendSurveyInvitation</samp>—Sends email
                    survey invitations to leads, contacts, and users in your org based on an action,
                    such as when a customer support case closes. This value is available in API
                    version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">performSurveySentimentAnalysis</samp>—Perform survey sentiment
                    analysis to create or update the AI Sentiment Result records. This value is
                    available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">skillsBasedRouting</samp>—Creates a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_pendingservicerouting.htm" target="_blank" title="HTML (New Window)">PendingServiceRouting</a> record used for Omni-Channel skills-based
                    routing. This value is available in version 44.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackArchiveChannel</samp>—Archives a
                    Slack channel in a Slack workspace. This value is available in API version
                    54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackCheckUsersAreConnectedToSlack</samp>—Indicates whether a
                    collection of Salesforce users is connected to a given Slack app. This value
                    is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackCreateChannel</samp>—Creates a
                    Slack channel in a Slack workspace. This value is available in API version
                    54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackGetConversationInfo</samp>—Retrieves the name of a Slack
                    channel or group direct message and finds out whether it’s archived. This
                    value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackInviteUsersToChannel</samp>—Adds
                    users who are connected to a given Slack app to a Slack channel or group
                    direct message. This value is available in API version 54.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackPinMessage</samp>—Pin or unpin a
                    message in a Slack channel or group direct message. This value is available in
                    API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackPostMessage</samp>—Send a
                    message to a Slack channel or group direct message. This value is available in
                    API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackSendMessageToLaunchFlow</samp>—Send a message to a Slack
                    channel, direct message, or the Messages tab of a Slack app that includes a
                    button that a recipient can use to launch a screen flow. This value is
                    available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">slackUpdateMessage</samp>—Edits a
                    message that was previously sent to a Slack channel or group direct message.
                    This value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">submitKnowledgeArticleForTranslation</samp>—Submits a published or
                    draft knowledge article for translation. This value is available in API version
                    46.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">submit</samp>—Submits a record for
                    approval.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">triggerJourney</samp>— Send an individual
                    to a specified journey. This value is available in API version 64.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">verifyCustomerCode</samp>—Verifies the
                    code entered by the customer to complete identity verification. This value is
                    available in API version 63.0 and later.
                  </li>

                </ul>
                These values are used in Omnichannel Inventory. If no version is specified, the
                value is available in API version 51.0 and later.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ociCreateReservation</samp>—Creates one
                    or more inventory reservations at a location or location group.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ociFulfillReservation</samp>—Fulfills one
                    or more inventory reservations at a location.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ociGetAvailability</samp>—Gets inventory
                    availability data for one or more products at one or more inventory locations or
                    location groups.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ociReleaseReservation</samp>—Releases one
                    or more inventory reservations.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ociTransferReservation</samp>—Transfers
                    one or more inventory reservations between locations or location groups.
                  </li>

                </ul>
                <p class="p">These values are used in the B2B Commerce Checkout Flow. If no version is
                  specified, the value is available in API version 47.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">updateCheckoutSessionStateAction</samp>—Updates the checkout session
                    next state for checkout flows. This value is available in API version 49.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">priceCart</samp>—Requests prices for all
                    items in a cart during B2B Commerce checkout. This value is available in API
                    version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">checkoutSessionAction</samp>—Initiates or
                    retrieves an existing Checkout Session for Checkout Flows. Available to B2B
                    Commerce. This value is available in API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelCartAsyncOperation</samp>—Cancels a
                    WebCart’s async operation. Available to B2B Commerce. This value is available in
                    API version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calcCartPromotionsAction</samp>—Requests
                    a full cart promotion calculation of all applicable line items in the Web Cart
                    during B2B Commerce checkout. This value is available in API version 52.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">checkCartInventoryAction</samp>—Requests
                    an inventory for all items in a Web Cart during B2B Commerce checkout. This
                    value is available in API version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calcCartShipmentAction</samp>—Calculates
                    the shipping cost for all items in a Web Cart during B2B Commerce checkout. This
                    value is available in API version 47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cartToOrderAction</samp>—Creates a
                    Salesforce Standard Order in draft mode. This value is available in API version
                    47.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">activateOrderAction</samp>—Activates a
                    draft order, which creates an order summary. This value is available in API
                    version 47.0 and later.
                  </li>

                </ul>
                <p class="p">For values used in Business Rules Engine, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/bre_flow_metadata_api.htm" target="_blank" title="HTML (New Window)">Flow for Business
                    Rules Engine</a>.</p>
                <p class="p">These values are used in Context Service. If no
                  version is specified, the value is available in API version 64.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">deleteContextCache</samp>—Deletes the
                    context instance from the context cache using specified context ID.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">queryContextTags</samp>—Queries context
                    instance tags associated with a context definition.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">updateContextAttributes</samp>—Updates
                    attributes on the context instance using context tags.
                  </li>

                </ul>
                <p class="p">These values are used in the Commerce Checkout Flow. If no version is
                  specified, the value is available in API version 55.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">addCartItem</samp>—Adds an item to a cart
                    during Commerce checkout.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createCart</samp>—Creates a cart during
                    Commerce checkout.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">deleteCart</samp>—Deletes a cart during
                    Commerce checkout.
                  </li>

                </ul>
                <p class="p">These values are used in Salesforce CMS Workflows and Approvals. If no
                  version is specified, the value is available in API version 58.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">managedContentPublishVariant</samp>—Publishes a content variant
                    associated with a flow. This value is available in API version 59.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">managedContentRoleStepInteractive</samp>—Assigns a content variant
                    review to a CMS role.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">managedContentUnpublishVariant</samp>—Unpublishes a published content
                    variant associated with a flow. This value is available in API version 59.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">managedContentVariantSetLockStatus</samp>—Sets the locked status of a
                    content variant.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">managedContentVariantSetReadyStatus</samp>—Sets the ready for
                    publication status of a content variant.
                  </li>

                </ul>
                <p class="p">These values are used in Employee Service. If no version is specified, the
                  value is available in API version 64.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">createServiceRequestCase</samp>—Creates a
                    case or incident for the requested service.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getDirectDepositDetails</samp>—Gets the
                    direct deposit details for the specified record ID.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getLeaveBalance</samp>—Gets the leave
                    balance of a specific employee.
                  </li>

                </ul>
                These values are used in Insurance. If no version is specified, the value is
                available in API version 63.0 and later.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">cancelInsurancePolicy</samp>—Cancel an
                    insurance policy by using a set of user inputs that represent policy
                    details.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">endorseInsurancePolicy</samp>—Endorse an
                    insurance policy by using a set of user inputs that represent policy
                    details.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getInsurancePolicy</samp>—Get the details
                    of an insurance policy.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">issueInsurancePolicy</samp>— Issue an
                    insurance policy by using a set of user inputs that represent policy
                    details.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">renewInsurancePolicy</samp>—Renew an
                    insurance policy by using a set of user inputs that represent policy
                    details.
                  </li>

                </ul>
                These values are used in Insurance Brokerage. If no version is specified, the
                value is available in API version 63.0 and later.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">computeProducerSplits</samp>—Compute the
                    producer splits for the producers associated with an Insurance Policy, for a
                    Commission Statement Line Item.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createProducerCommissions</samp>—Create
                    records for the commissions that producers receive for the insurance policy
                    associated with the specified commission statement line item, and update the
                    commission statement line item record status.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">findInsurancePolicy</samp>—Get the
                    insurance policy associated with a commission statement line item that matches
                    the specified criteria, and update the status of the commission statement line
                    item record.
                  </li>

                </ul>
                These values are used in Order Management. If no version is specified, the
                value is available in API version 48.0 and later.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">addOrderItemSummarySubmit</samp>—Adds
                    order item summaries to an order summary. This value is available in API version
                    54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">adjustOrderItemSummariesPreview</samp>—Previews the expected results
                    of applying a price adjustment to order item summaries from an order summary
                    without actually applying it. This value is available in API version 49.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">adjustOrderItemSummariesSubmit</samp>—Applies a price adjustment to
                    order item summaries from an order summary. This value is available in API
                    version 49.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">authorizePayment</samp>—Authorizes a card
                    payment. This value is available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calcPriceProtectPayoutAmt</samp>—Calculates the payout after a price
                    protection adjustment or execution is made. This value is available in API
                    version 63.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelFulfillmentOrderItem</samp>—Removes
                    items from a fulfillment order.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelOrderItemSummariesPreview</samp>—Previews the expected results
                    of canceling order item summaries from an order summary without actually
                    canceling them.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelOrderItemSummariesSubmit</samp>—Cancels order item summaries
                    from an order summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">confirmHeldFulfillmentOrderCapacity</samp>—Confirms held fulfillment
                    order capacity. This value is available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createCreditMemoOrderSummary</samp>—Creates a credit memo for an order
                    summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createFieldGnrnPromptTmplResp</samp>—Creates a field generation prompt
                    template response. This value is available in API version 62.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createFulfillmentOrder</samp>—Creates one
                    or more fulfillment orders and fulfillment order products for an order delivery
                    group summary, which defines a recipient and delivery method.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createFulfillmentOrders</samp>—Creates
                    fulfillment orders and fulfillment order products for multiple order delivery
                    group summaries, each of which defines a recipient and delivery method. This
                    value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createInvoiceFromChangeOrders</samp>—Creates an invoice for one or
                    more change orders. This value is available in API version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createInvoiceFromFulfillmentOrder</samp>—Creates an invoice for a
                    fulfillment order.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createOrderPaymentSummary</samp>—Creates
                    an order payment summary for an authorization or payments belonging to an order
                    summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createOrderSummary</samp>—Creates an
                    order summary for an order.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createReturnOrder</samp>—Creates a return
                    order and return order items for an order.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ensureFundsOrderSummaryAsync</samp>—Triggers an asynchronous
                    background process to ensure funds through a payment provider for an invoice
                    belonging to an order summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ensureRefundsOrderSummaryAsync</samp>—Triggers an asynchronous
                    background process to ensure refunds through a payment provider for an invoice
                    belonging to an order summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getFulfillmentOrderCapacityValues</samp>—Gets fulfillment order
                    capacity information. This value is available in API version 55.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">holdFulfillmentOrderCapacity</samp>—Holds
                    fulfillment order capacity. This value is available in API version 55.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">orderRoutingFindRoutesWithFewestSplits</samp>—Evaluates ordered
                    product quantities against available inventory to determine the smallest
                    combination of locations that can fulfill the order. This value is available in
                    API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">orderRoutingFindRoutesWithFewestSplitsUsingOCI</samp>—Evaluates
                    ordered product quantities against available inventory at specified location
                    groups and locations to determine the smallest combination of locations that can
                    fulfill the order. This value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">orderRoutingRankByAverageDistance</samp>—Calculates the average
                    distance from sets of inventory locations to an order recipient, and returns the
                    sets sorted by that average distance. This value is available in API version
                    51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">releaseHeldFulfillmentOrderCapacity</samp>—Releases held fulfillment
                    order capacity. This value is available in API version 55.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">returnOrderItemSummariesPreview</samp>—Previews the expected results
                    of returning order item summaries from an order summary without actually
                    returning them.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">returnOrderItemSummariesSubmit</samp>—Returns order item summaries
                    from an order summary.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">returnReturnOrderItems</samp>—Processes
                    return order line items.
                  </li>
                </ul>
                <p class="p">These values are used in Financial Services Cloud. </p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">createFinancialRecords</samp>—Creates person
                    accounts, contacts, financial accounts, properties, assets, and liabilities
                    from a residential loan application. This value is available in API version
                    49.0 and later.
                  </li>

                </ul>
                <p class="p">For values used in Fundraising for Nonprofit Cloud, see Flow for Fundraising. </p>
                <p class="p">For values
                  used in Health Cloud, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/health_cloud_flow_metadata_api.htm" target="_blank" title="HTML (New Window)">Flow for Health Cloud</a>.</p>
                <p class="p">For
                  values used in Manufacturing Cloud, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.mfg_api_devguide.meta/mfg_api_devguide/mfg_flow_metadata_api.htm" target="_blank" title="HTML (New Window)">Flow for Manufacturing Cloud</a>.
                </p>
                <p class="p">This value is used in Omnistudio.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">executeIntegrationProcedure</samp>—Executes an Integration Procedure
                    with Agentforce configured. This value is available in API version 64.0 and
                    later.
                  </li>

                </ul>
                <p class="p">These values are used in Rebate Management. </p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">addRebateMemberList</samp>—Adds a list of
                    members to a rebate program. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calculateProjectedRebateAmount</samp>—Calculates
                    the projected rebate amount for rebate types associated with a specified
                    transaction ID. This value is available in API version 54.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calculateRebateAmountAndUpsertPayout</samp>—Calculates the rebate amount and
                    upserts the rebate payout for the specified aggregate record. This value is
                    available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getBenefitAndCalculateRebateAmount</samp>— Gets
                    benefit details, and optionally calculates the rebate amount for the specified
                    aggregate record. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getEligibleProgramRebateTypes</samp>—Retrieves
                    the eligible program rebate types for a mapped object. This value is available
                    in API version 52.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateRebatePayoutPeriods</samp>—Generates
                    payout periods for a rebate program based on the frequency specified in the
                    program. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">processRebatesBatchCalculationJob</samp>—Processes a rebate batch calculation
                    job from the Data Processing Engine. This value is available in API version 51.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">processProgramRebateTypeProducts</samp>—Insert
                    or delete records in the Program Rebate Type Product object. This value is
                    available in API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">rebatesProcessCSV</samp>—Processes an uploaded
                    CSV file using Bulk API 2.0 and converts the file’s data into records in the
                    target object. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">upsertCustomRebatePayout</samp>—Upserts the
                    custom calculated rebate payout for the specified aggregate record. This value
                    is available in API version 51.0 and later.
                  </li>

                </ul>
                <p class="p">These values are used in B2B Referral Management. If no version is
                  specified, the value is available in API version 64.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">enrollAdvocateB2bReferralProm</samp>—Enroll an existing or new
                    customer as an advocate for a referral promotion.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">processB2bReferralEvent</samp>—Create
                    referral event records when an advocate refers a friend, or when referred
                    friends sign up or make a purchase.
                  </li>

                </ul>
                <p class="p">These values are used in Referral Marketing.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">processReferralEvent</samp>—Create
                    referral event records when an advocate refers a friend, or when referred
                    friends sign up or make a purchase. This value is available in API version 60.0
                    and later.
                  </li>

                </ul>
                <p class="p">These values are used in Loyalty Management.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">adjustPoints</samp>—Adjusts loyalty points for a
                    specified program member or journal transaction. This value is available in API
                    version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">assignTierBenefits</samp>— Assigns Member
                    Benefits to a member tier for benefits that are associated with a Benefit
                    Action. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelAccrual</samp>—Cancels a specific set of
                    accrual transactions.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">creditPoints</samp>—Credits loyalty points to a
                    specified program member’s balance. This value is available in API version 51.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">cancelRedemption</samp>—Reverts a specific set
                    of redemption transactions. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">changeTier</samp>—Changes the tier for a
                    specified program member. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">changeTierWhenNoErrors</samp>—Changes tier for a
                    specified loyalty program member only when all the input parameters meet the
                    criteria. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">debitPoints</samp>—Debits loyalty points to a
                    specified program member’s balance. This value is available in API version 51.0
                    and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">executeMemberBenefit</samp>—Processes the
                    benefit action associated with the benefit, which is assigned to a loyalty
                    program member. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateMemberReferralCode</samp>—Generates a
                    unique 8-character referral code for a loyalty program member. This value is
                    available in API version 57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getMemberActiveSegments</samp>—Retrieve active
                    <span class="ph">Data 360</span> market segments that a loyalty program member is a
                    part of.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getTier</samp>—Gets the current tier for a
                    specified program member. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getPointsBalance</samp>—Gets the loyalty points
                    balance for a specified program member. This value is available in API version
                    51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getLoyaltyPromotion</samp>—Gets active loyalty
                    promotions based on a transaction journal. This value is available in API
                    version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">getLoyaltyPromotionBasedOnSalesforceCDP</samp>—Gets promotions for a member
                    based on the market segment the member belongs to. This value is available in
                    API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">issueVoucher</samp>—Issues a voucher for a
                    member or contract. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">mergeLoyaltyProgramMembership</samp>—Merges two active loyalty program
                    member records that both belong to the same loyalty program. This value is
                    available in API version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">transferMemberPointsToGroups</samp>—Transfers
                    points from an individual member or a corporate member to the member’s
                    associated group. This value is available in API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">transferPoints</samp>—Transfers points from a
                    source loyalty program member to a target loyalty program member, or to a group
                    that the member is a part of. This value is available in API version 64.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">updateProgressForCumulativePromotionUsage</samp>—Updates the progress a
                    member has made towards attaining a cumulative type promotion. This value is
                    available in API version 53.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">unmergeLoyaltyProgramMembership</samp>—Unmerges loyalty program member
                    records that have a Merged status. The action unmerges memberships in the Merged
                    status from the previously merged membership. This value is available in API
                    version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">runProgramProcess</samp>—Triggers an active
                    loyalty program process. This value is available in API version 56.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">runProgramProcessForTransactionJournal</samp>—Triggers an active loyalty
                    program process whose process type is TransactionJournal. This value is
                    available in API version 54.0 and later.
                  </li>

                </ul>
                <p class="p">These values are for Decision Table.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">decisionTableAction</samp>—Runs an active
                    decision table definition. This value is available in API version 51.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">refreshDecisionTable</samp>—Refreshes the
                    decision table cache. This value is available in API version 51.0 and
                    later.
                  </li>

                </ul>
                <p class="p">These values are for the Batch Management jobs.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">batchJobAction</samp>—Runs the batch management
                    jobs definitions. This value is available in API version 51.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">submitFailedRecordsBatchJob</samp>—Resubmits an
                    existing batch job with failed records for processing. This value is available
                    in API version 52.0 and later.
                  </li>

                </ul>
                <p class="p">This value is for Data Processing Engine.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">dataProcessingEngineAction</samp>—Runs the data
                    processing engine definitions. This value is available in API version 51.0 and
                    later.
                  </li>

                </ul>
                <p class="p">This value is used for Einstein Visit Recommendation.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">saveRecommendationDecision</samp>—Save visit and
                    task recommendation decisions. This value is available in API version 51.0 and
                    later.
                  </li>

                </ul>
                These values are used in Field Service. If no version is specified, the value
                is available in API version 52.0 and later.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">addWorkPlans</samp>—Creates work plan and work
                    step objects from the work plan library.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">addWorkSteps</samp>—Creates work step objects
                    from the work plan library.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">deleteWorkPlans</samp>—Deletes all the work
                    plans and work steps associated with a work order or work order line item.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">generateWorkPlans</samp>—Generates work plans
                    based off rules defined in the work plan library.
                  </li>

                </ul>
                <p class="p">For values used in Intelligent Form Reader, see Flow for
                  Intelligent Form Reader. </p>
                <p class="p">For values used in Intelligent Document
                  Reader, see Flow for Intelligent Document Reader. </p>
                <p class="p">These values are
                  used in Public Sector Solutions.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">bulkEnqueuePostingsToGenLeads</samp>—Enqueues active recruitment
                    postings so that matching candidates are sourced as lead records. This value is
                    available in API version 68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">createBenefitDisbursement</samp>—Creates
                    a benefit disbursement for an eligible benefit assignment. This value is
                    available in API version 57.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">invocableCallContentSearch</samp>—Searches
                    file content stored in Amazon S3, including images, audio, video, and PDFs, and
                    returns matching files with citations. This value is available in API version
                    68.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">runRecordAggrBatchProcDef</samp>—Runs a
                    Data Processing Engine definition to process an asynchronous batch job that
                    creates or updates record aggregation results. This value is available in API
                    version 59.0 and later.
                  </li>

                </ul>
                <p class="p">These values are used in Unified Catalog. If no version is specified, the
                  value is available in API version 64.0 and later.</p>
                <a name="ul_sfb_k3x_hgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_sfb_k3x_hgc">
                  <li class="li">
                    <samp class="codeph nolang">checkProductEligibility</samp>—Determines
                    whether a user is eligible for a list of products, which represent service
                    processes, based on predefined criteria.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">checkSvcPrcActionEligibility</samp>—Determines whether an AI agent is
                    eligible for a list of products, which represent service processes, and if the
                    list is linked to a service process.
                  </li>

                </ul>
                <p class="p">This value is used in the Get Opportunity Grounding Data flow.</p>
                <a name="ul_vq4_w2b_lgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_vq4_w2b_lgc">
                  <li class="li">
                    <samp class="codeph nolang">getOpportunityContentNote</samp>— Gets
                    the content note data for a specified opportunity record. This value is
                    available in API version 64.0 and later.
                  </li>

                </ul>
                <p class="p">This value is used in the Process Field Update Suggestions flow.</p>
                <a name="ul_wq4_w2b_lgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_wq4_w2b_lgc">
                  <li class="li">
                    <samp class="codeph nolang">getOrExecFieldUpdtSuggestion</samp>—
                    Enqueues requests to get a field update suggestion from a field generation
                    prompt template. Also enqueues requests to update a field based on the generated
                    suggestion. This value is available in API version 64.0 and later.
                  </li>

                </ul>
                <p class="p">This value is used in Einstein Conversation Insights.</p>
                <a name="ul_kgj_zpk_pgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_kgj_zpk_pgc">
                  <li class="li">
                    <samp class="codeph nolang">getConversationTranscript</samp>—Gets the
                    conversation transcript for the specified voice or video call record. This value
                    is available in API version 63.0 and later.
                  </li>

                </ul>
                <p class="p">These values are used in Channel Revenue Management. Available in API
                  version 64.0 and later.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">adjustPartnerInvShipAndDebit</samp>—
                    Adjusts the point of sales record during ship and debit claim processing to a
                    different partner unsold inventory. Available in API version 64.0 and
                    later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">adjustPartnerUnsoldInventory</samp>—
                    Adjusts the partner unsold inventory quantities and prices. Available in API
                    version 64.0 and later.
                  </li>

                </ul>
                These values are reserved for future use.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">thanks</samp></li>

                  <li class="li"><samp class="codeph nolang">metricRefresh</samp></li>

                  <li class="li"><samp class="codeph nolang">exportSurveyResponses</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## StrategyNodeInvocableActionArg

Defines arguments passed to an Apex invocable action that generates or enhances a list of recommendations.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Unique name for the parameter to pass to the invocable action. The name must match a parameter that's defined in the invocable action. |
| value | string | Required. A Salesforce formula expression that is evaluated with the result used as the parameter value for the action. |

## StrategyNodeRecommendationLimit

Filters out recommendations that have already been accepted or rejected. Extends StrategyNodeUnionBase and inherits all of its fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d787666e3717">Field Name</th>

              <th class="featureTableHeader  " id="d787666e3720">Field Type</th>

              <th class="featureTableHeader  " id="d787666e3723">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d787666e3717" data-title="Field Name"><span class="keyword parmname">filterMode</span></td>

              <td class="entry" headers="d787666e3720" data-title="Field Type">StrategyReactionType (enumeration of type string)</td>

              <td class="entry" headers="d787666e3723" data-title="Description">
                <p class="p">Available reactions to filter out. The valid values are:</p>

                <a name="StrategyReactionTypeValues"><!-- --></a>
                <ul class="ul bulletList" id="StrategyReactionTypeValues">
                  <li class="li"><samp class="codeph nolang">Accepted</samp></li>

                  <li class="li"><samp class="codeph nolang">Rejected</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e3717" data-title="Field Name"><span class="keyword parmname">lookbackDuration</span></td>

              <td class="entry" headers="d787666e3720" data-title="Field Type">int</td>

              <td class="entry" headers="d787666e3723" data-title="Description">Number of days to search back.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e3717" data-title="Field Name"><span class="keyword parmname">maxRecommendationCount</span></td>

              <td class="entry" headers="d787666e3720" data-title="Field Type">int</td>

              <td class="entry" headers="d787666e3723" data-title="Description">Maximum number of times recommendation has been accepted or rejected.</td>

            </tr>

          </tbody>

        </table>

## StrategyNodeRecommendationLoad

Retrieves Recommendation objects. Extends StrategyNodeUnionBase and inherits all of its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| condition | [RecommendationLoadCondition](#RecommendationLoadCondition)\[\] | Array of conditions specifying which recommendations to load. |
| conditionLogic | string | Logic to combine conditions, either AND or OR. All conditions are combined (not mixed). For example: Cond1 AND Cond2 AND Cond3. |
| object | string | Required. Specifies the API name of the sObject from which recommendations are loaded. For example, the field references Account or MyCustomObject\_\_c and not a specific record of that object. Available in API version 48.0 and later. |
| sortField | [StrategyNodeSortField](#StrategyNodeSortField) | The field to sort on. Available in API version 48.0 and later. |

## RecommendationLoadCondition

Represents a condition used as part of the query constructed by StrategyNodeRecommendationLoad.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d787666e3914">Field Name</th>

              <th class="featureTableHeader  " id="d787666e3917">Field Type</th>

              <th class="featureTableHeader  " id="d787666e3920">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d787666e3914" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d787666e3917" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e3920" data-title="Description">Required. Any field from Recommendation BPO (SOAP) object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e3914" data-title="Field Name"><span class="keyword parmname">operator</span></td>

              <td class="entry" headers="d787666e3917" data-title="Field Type">RecommendationConditionOperator (enumeration of type string)</td>

              <td class="entry" headers="d787666e3920" data-title="Description">Required.<p class="p" id="RecommendationConditionOperator_values"><a name="RecommendationConditionOperator_values"><!-- --></a>Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">EQUALS</samp></li>

                  <li class="li"><samp class="codeph nolang">GREATER_THAN</samp></li>

                  <li class="li"><samp class="codeph nolang">GREATER_THAN_OR_EQUAL_TO</samp></li>

                  <li class="li"><samp class="codeph nolang">LESS_THAN</samp></li>

                  <li class="li"><samp class="codeph nolang">LESS_THAN_OR_EQUAL_TO</samp></li>

                  <li class="li"><samp class="codeph nolang">NOT_EQUALS</samp></li>

                  <li class="li"><samp class="codeph nolang">LIKE</samp></li>

                  <li class="li"><samp class="codeph nolang">STARTS_WITH</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ENDS_WITH</samp>=
                  </li>

                  <li class="li"><samp class="codeph nolang">CONTAINS</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e3914" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d787666e3917" data-title="Field Type"><a class="xref" href="#RecommendationConditionValue">RecommendationConditionValue</a></td>

              <td class="entry" headers="d787666e3920" data-title="Description">Required. Constant value to use in query.</td>

            </tr>

          </tbody>

        </table>

## RecommendationConditionValue

Represents a value used as part of a RecommendationCondition.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d787666e4040">Field Name</th>

              <th class="featureTableHeader  " id="d787666e4043">Field Type</th>

              <th class="featureTableHeader  " id="d787666e4046">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d787666e4040" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d787666e4043" data-title="Field Type">RecommendationConditionValueType (enumeration of type string)</td>

              <td class="entry" headers="d787666e4046" data-title="Description">Required. <p class="p" id="RecommendationConditionValueType_values"><a name="RecommendationConditionValueType_values"><!-- --></a>Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">TEXT</samp></li>

                  <li class="li"><samp class="codeph nolang">NUMBER</samp></li>

                  <li class="li"><samp class="codeph nolang">BOOLEAN</samp></li>

                  <li class="li"><samp class="codeph nolang">DATE</samp></li>

                  <li class="li"><samp class="codeph nolang">DATE_TIME</samp></li>

                  <li class="li"><samp class="codeph nolang">TIME</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e4040" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d787666e4043" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e4046" data-title="Description">Required. The constant value.</td>

            </tr>

          </tbody>

        </table>

## StrategyNodeSortField

Defines the field to sort on for StrategyNodeSort and StrategyNodeRecommendationLoad.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d787666e4135">Field Name</th>

              <th class="featureTableHeader  " id="d787666e4138">Field Type</th>

              <th class="featureTableHeader  " id="d787666e4141">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d787666e4135" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d787666e4138" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e4141" data-title="Description">Required. Name of the field to sort.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e4135" data-title="Field Name"><span class="keyword parmname">nullsFirst</span></td>

              <td class="entry" headers="d787666e4138" data-title="Field Type">boolean</td>

              <td class="entry" headers="d787666e4141" data-title="Description">If <samp class="codeph nolang">true</samp>, null values are sorted to the
                beginning of the list. Defaults to <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e4135" data-title="Field Name"><span class="keyword parmname">order</span></td>

              <td class="entry" headers="d787666e4138" data-title="Field Type">SortOrder (enumeration of type string)</td>

              <td class="entry" headers="d787666e4141" data-title="Description">
                <p class="p">Order in which the list is sorted. Defaults to <samp class="codeph nolang">Asc</samp>. Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Asc</samp> (ascending)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Desc</samp> (descending)
                  </li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## StrategyNodeSort

Sorts the recommendations. Extends StrategyNodeUnionBase and inherits all of its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | [StrategyNodeSortField](#StrategyNodeSortField) | Required. Field to sort on. |

## StrategyNodeUnion

StrategyNodeUnion combines the output of all its child nodes. StrategyNodeUnion is a concrete implementation of StrategtNodeUnionBase and inherits all its fields.

## StrategyNodeMap

Set recommendation fields with values. Extends StrategyNodeUnionBase and inherits all of its fields.

| Field Name | Field Type | Description |
| --- | --- | --- |
| mapExpression | [MapExpression](#MapExpression)\[\] | List of MaxExpressions. |

## StrategyNodeExclusive

Returns results from the first child node that has results and no other. Extends StrategyNodeUnionBase and inherits all its fields.

## MapExpression

Sets the value for a recommendation field used by the strategy.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d787666e4367">Field Name</th>

              <th class="featureTableHeader  " id="d787666e4370">Field Type</th>

              <th class="featureTableHeader  " id="d787666e4373">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d787666e4367" data-title="Field Name"><span class="keyword parmname">expression</span></td>

              <td class="entry" headers="d787666e4370" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e4373" data-title="Description">Required. A formula expression that results in a valid value supported by the
                data type specified in the <span class="keyword parmname">type</span> field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e4367" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d787666e4370" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e4373" data-title="Description">Required. Recommendation field name that the expression sets the value
                for.</td>

            </tr>

            <tr>
              <td class="entry" headers="d787666e4367" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d787666e4370" data-title="Field Type">string</td>

              <td class="entry" headers="d787666e4373" data-title="Description">Required. The data type of the value resulting from the value in the
                <span class="keyword parmname">expression</span> field.<p class="p" id="MapExpressionType_values"><a name="MapExpressionType_values"><!-- --></a>Valid
                  values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">BOOLEAN</samp></li>

                  <li class="li"><samp class="codeph nolang">CURRENCY</samp></li>

                  <li class="li"><samp class="codeph nolang">DATE</samp></li>

                  <li class="li"><samp class="codeph nolang">DOUBLE</samp></li>

                  <li class="li"><samp class="codeph nolang">DATE_TIME</samp></li>

                  <li class="li"><samp class="codeph nolang">INTEGER</samp></li>

                  <li class="li"><samp class="codeph nolang">LONG</samp></li>

                  <li class="li"><samp class="codeph nolang">PERCENT</samp></li>

                  <li class="li"><samp class="codeph nolang">TEXT</samp></li>

                  <li class="li"><samp class="codeph nolang">TIME</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a RecommendationStrategy component that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<RecommendationStrategy xmlns="http://soap.sforce.com/2006/04/metadata">
    <contextRecordType\>Asset</contextRecordType\>
    <description\>Hills Brothers Coffee strategy to handle machine down incidents</description\>
    <if\>
        <childNode\>IfNoEscaladeOrBetterSupport</childNode\>
        <childNode\>IfModel</childNode\>
        <description\>If Machine Down</description\>
        <label\>RootNode</label\>
        <name\>RootNode</name\>
        <childNodeExpression\>
            <childName\>IfModel</childName\>
            <expression\>ISPICKVAL($Record.Status, &quot;OutOfOrder&quot;)</expression\>
        </childNodeExpression\>
        <childNodeExpression\>
            <childName\>IfNoEscaladeOrBetterSupport</childName\>
            <expression\>ISPICKVAL($Record.Status, &quot;OutOfOrder&quot;)</expression\>
        </childNodeExpression\>
        <onlyFirstMatch\>false</onlyFirstMatch\>
    </if\>
    <if\>
        <childNode\>LoadEscalade</childNode\>
        <description\>If Customer does not have escalade support plan</description\>
        <label\>IfNoEscaladeOrBetterSupport</label\>
        <name\>IfNoEscaladeOrBetterSupport</name\>
        <childNodeExpression\>
            <childName\>LoadEscalade</childName\>
            <expression\>NOT(ISPICKVAL($Record.Account.SLA\_\_c, &quot;Gold&quot;) || ISPICKVAL($Record.Account.SLA\_\_c, &quot;Platinum&quot;))</expression\>
        </childNodeExpression\>
        <onlyFirstMatch\>false</onlyFirstMatch\>
    </if\>
    <if\>
        <childNode\>LoadMiniDiagnostic</childNode\>
        <childNode\>LoadMaxiDiagnostic</childNode\>
        <description\>If Machine Model switch node</description\>
        <label\>IfModel</label\>
        <name\>IfModel</name\>
        <childNodeExpression\>
            <childName\>LoadMiniDiagnostic</childName\>
            <expression\>$Record.Product2.Name == &quot;Mini Coffee Roaster&quot;</expression\>
        </childNodeExpression\>
        <childNodeExpression\>
            <childName\>LoadMaxiDiagnostic</childName\>
            <expression\>$Record.Product2.Name == &quot;Maxi Coffee Roaster&quot;</expression\>
        </childNodeExpression\>
        <onlyFirstMatch\>false</onlyFirstMatch\>
    </if\>
    <label\>HillsBrothersCoffee</label\>
    <recommendationLoad\>
        <description\>Load upgrade to escalade support plan</description\>
        <label\>LoadEscalade</label\>
        <name\>LoadEscalade</name\>
        <condition\>
            <field\>Name</field\>
            <operator\>EQUALS</operator\>
            <value\>
                <type\>TEXT</type\>
                <value\>Upgrade your Maintenance Package</value\>
            </value\>
        </condition\>
        <conditionLogic\>and</conditionLogic\>
    </recommendationLoad\>
    <recommendationLoad\>
        <description\>Load Mini Coffee Roaster Diagnostic Troubleshooting proposition</description\>
        <label\>LoadMiniDiagnostic</label\>
        <name\>LoadMiniDiagnostic</name\>
        <condition\>
            <field\>Name</field\>
            <operator\>EQUALS</operator\>
            <value\>
                <type\>TEXT</type\>
                <value\>Mini Coffee Roaster Diagnostic Troubleshooting</value\>
            </value\>
        </condition\>
        <conditionLogic\>and</conditionLogic\>
    </recommendationLoad\>
    <recommendationLoad\>
        <description\>Load Maxi Coffee Roaster Diagnostic Troubleshooting proposition</description\>
        <label\>LoadMaxiDiagnostic</label\>
        <name\>LoadMaxiDiagnostic</name\>
        <condition\>
            <field\>Name</field\>
            <operator\>EQUALS</operator\>
            <value\>
                <type\>TEXT</type\>
                <value\>Maxi Coffee Roaster Diagnostic Troubleshooting</value\>
            </value\>
        </condition\>
        <conditionLogic\>and</conditionLogic\>
    </recommendationLoad\>
    <union\>
        <childNode\>RootNode</childNode\>
        <label\>Output</label\>
        <name\>Output</name\>
    </union\>
    <invocableAction\>
        <action\>MyInvocableApexClass</action\>
        <isGenerator\>true</isGenerator\>
        <type\>apex</type\>
        <argument\>
            <name\>MyNameParam</name\>
            <value\>$User.FirstName</value\>
        </argument\>
        <argument\>
            <name\>MyIdParam</name\>
            <value\>$Record.Id</value\>
        </argument\>
    </invocableAction\>
    <map\>
        <expression\>
            <name\>Name</name\>
            <expression\>'Hello' & $User.FirstName</expression\>
            <type\>TEXT</type\>
        </expression\>
        <expression\>
            <name\>MyDynamicField</name\>
            <expression\>Id == $Record.Id</expression\>
            <type\>BOOLEAN</type\>
        </expression\>
    </map\>
</RecommendationStrategy\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b046490bcb2c7ed9c8420f77b973e62db6a09662ae70f3dc908a2d2ff1d16f78 url=/legacydeveloper/current/en-us/api_meta/meta_recordactiondeployment.md -->

# RecordActionDeployment

Represents configuration settings for the Actions & Recommendations, Action Launcher, and Bulk Action Panel components. For example, you can have a deployment that specifies which types of actions to display, default actions for channels, and the actions that users can add at runtime. If the component shows Next Best Action recommendations, the deployment configures which strategies to use and how recommendations appear. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

RecordActionDeployment values are stored in the developer\_name.deployment file in the recordActionDeployments directory.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

We don’t recommend programmatically changing the API name of a RecordActionDeployment.

## Version

RecordActionDeployment is available in API version 45.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d797855e98">Field Name</th>

              <th class="featureTableHeader  " id="d797855e101">Field Type</th>

              <th class="featureTableHeader  " id="d797855e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">channelConfigurations</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type"><a class="xref" href="#recordActionDeploymentChannel">RecordActionDeploymentChannel</a></td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies configuration settings for different channels in an Actions &amp;
                Recommendations deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">componentName</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">ComponentName (enumeration of type string)</td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies the name of the component used in the deployment: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ActionsAndRecommendations</samp>—0
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ActionLauncher</samp>—1
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">BulkActionPanel</samp>—2. This value is
                    available in API version 60.0 and later
                  </li>

                </ul>
                For example, a value of 1 indicates that 1 is stored in the database if Action
                Launcher is used to create a deployment. Available in API version 56.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">deploymentContexts</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type"><a class="xref" href="#recordActionDeploymentContext">RecordActionDeploymentContext</a></td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies the object context for quick actions and Next Best Action strategies.
                Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">hasComponents</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Indicates whether the record actions deployment includes components (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">hasGuidedActions</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies that the component shows standard actions; for example, flows and
                quick actions. Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name">hasOmniscripts</td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Indicates whether the record actions deployment includes OmniScripts (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 56.0 and later. The default value is
                <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">hasRecommendations</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies that the component shows recommendations from a Next Best Action
                strategy. Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">string</td>

              <td class="entry" headers="d797855e104" data-title="Description">Required. Specifies the name of the deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">recommendation</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">
                <a class="xref" href="#recordActionRecommendation">RecordActionRecommendation</a>
              </td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies settings for how Next Best Action recommendations appear in the
                component. Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">selectableItems</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type"><a class="xref" href="#recordActionDeploymentSelectableItems">RecordActionDeploymentSelectableItems</a></td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies the actions that users can add at runtime.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">shouldLaunchActionOnReject</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, launch the flow when
                the recommendation is rejected
 by the agent. Available in API version 48.0 and
                later.</td>

            </tr>

          </tbody>

        </table>

## RecordActionDefaultItem

Represents actions and attributes specified as channel defaults in a deployment.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d797855e325">Field Name</th>

              <th class="featureTableHeader  " id="d797855e328">Field Type</th>

              <th class="featureTableHeader  " id="d797855e331">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">string </td>

              <td class="entry" headers="d797855e331" data-title="Description">Required. Specifies the API name of an action. For example, the API name of a
                flow, such as <samp class="codeph nolang">Verify_Information</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">isMandatory</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e331" data-title="Description">Specifies whether the action is marked as mandatory. The default value is
                <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">isUiRemoveHidden</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e331" data-title="Description">Specifies whether the remove option is hidden in the UI. The default value is
                false. If <samp class="codeph nolang">true</samp>, the UI hides the ability to
                remove the action from the list. </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">pinned</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">PinnedAction (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d797855e331" data-title="Description">Required. Indicates whether the action is pinned to the <samp class="codeph nolang">Top</samp> or <samp class="codeph nolang">Bottom</samp>,
                or unpinned (<samp class="codeph nolang">None</samp>). The default value is
                <samp class="codeph nolang">None</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">position</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">int</td>

              <td class="entry" headers="d797855e331" data-title="Description">Required. Indicates the order of the action among all actions associated with
                this record.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">RecordActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d797855e331" data-title="Description">Required. The type of action that’s associated with the record. Valid values
                are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Flow</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">QuickAction</samp> (Available in API version
                    46.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OmniScript</samp> (Available in API version 56.0
                    and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LWC</samp> (Available in API version 62.0 and
                    later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SvcCatalogItemDef</samp> (Available in API
                    version 62.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WebLink</samp> (Available in API version 62.0
                    and later.)
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## RecordActionDeploymentChannel

Specifies channel-specific defaults to show in the Actions & Recommendations component. The component displays the channel defaults when the list is otherwise empty.

| Field Name | Field Type | Description |  |
| --- | --- | --- | --- |
| channel | ChannelSource ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | Required. Specifies the channel. Valid values are Phone, Chat, or Default. |  |
| channelItems | [RecordActionDefaultItem](#recordActionDefaultItem) | Specifies default actions for a channel and attributes for each action, such as whether the action is pinned to the list top or bottom or whether an action is considered mandatory. |  |
| isAutopopEnabled | boolean | Specifies whether the first action in the list is launched when the record page opens. If true, the first action is launched. The default value is false. |  |

## RecordActionDeploymentContext

Specifies an object that provides context for quick actions and Next Best Action strategies. When the component appears on this type of page, it includes object-specific quick actions and uses an object-specific strategy to filter recommendations. Available in API version 46.0 and later.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

We support a maximum of 10 objects that provide context within a deployment.

| Field Name | Field Type | Description |
| --- | --- | --- |
| entityName | string | Required. Specifies the API name of an object to use as context. |
| recommendationStrategy | string | Specifies the API name of a Next Best Action strategy that overrides the default strategy on this page. A strategy is a metadata type [RecommendationStrategy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recommendationstrategy.htm "Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations."). |

## RecordActionRecommendation

Specifies settings to display Next Best Action recommendations in the component. Available in API version 46.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| defaultStrategy | string | Specifies the API name of the default Next Best Action strategy, which is a metadata type, [RecommendationStrategy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recommendationstrategy.htm "Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations."). |
| hasDescription | boolean | Required. If true, display the description for the recommendation. |
| hasImage | boolean | Required. If true, display the image for the recommendation. |
| hasRejectAction | boolean | Required. If true, display the label that the user clicks to reject the recommendation. |
| hasTitle | boolean | Required. If true, display the title for the recommendation. |
| maxDisplayRecommendations | int | Required. Specifies the maximum number of recommendations to display. Valid values are 1–4. |

## RecordActionSelectableItem

Represents the set of actions available for users to add to the component at runtime.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d797855e829">Field Name</th>

              <th class="featureTableHeader  " id="d797855e832">Field Type</th>

              <th class="featureTableHeader  " id="d797855e835">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d797855e829" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d797855e832" data-title="Field Type">string</td>

              <td class="entry" headers="d797855e835" data-title="Description">Required. Specifies the API name of an action. For example, the API name of a
                flow, such as <samp class="codeph nolang">Verify_Information</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e829" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d797855e832" data-title="Field Type">RecordActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d797855e835" data-title="Description">Required. The type of action that’s associated with the record. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Flow</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">QuickAction</samp> (Available in API version
                    46.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OmniScript</samp> (Available in API version 56.0
                    and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LWC</samp> (Available in API version 62.0 and
                    later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SvcCatalogItemDef</samp> (Available in API
                    version 62.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WebLink</samp> (Available in API version 62.0
                    and later.)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e829" data-title="Field Name"><span class="keyword parmname">isFrequentAction</span></td>

              <td class="entry" headers="d797855e832" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e835" data-title="Description">Indicates whether an action is frequently accessed by users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in version 57.0 and later. <p class="p">This field applies only
                  to Action Launcher.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e829" data-title="Field Name">frequentActionSequenceNbr</td>

              <td class="entry" headers="d797855e832" data-title="Field Type">integer</td>

              <td class="entry" headers="d797855e835" data-title="Description">The sequence number that's assigned to a frequently used action that's shown on
                Action Launcher. Available in version 57.0 and later. <p class="p" id="note_bmb_l3v_wvb"><a name="note_bmb_l3v_wvb"><!-- --></a>This
                  field applies only to Action Launcher.&nbsp;</p>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

## Declarative Metadata Sample Definition

The following is a sample of a recordActionDeployment file.

<RecordActionDeployment xmlns="http://soap.sforce.com/2006/04/metadata">
    <channelConfigurations\>
        <channel\>Phone</channel\>
        <channelItems\>
            <action\>Sample\_Flow</action\>
            <isMandatory\>false</isMandatory\>
            <isUiRemoveHidden\>false</isUiRemoveHidden\>
            <position\>1</position\>
            <pinned\>Top</pinned\>
            <type\>Flow</type\>
        </channelItems\>
        <channelItems\>
            <action\>Another\_Sample\_Flow</action\>
            <isMandatory\>false</isMandatory\>
            <isUiRemoveHidden\>true</isUiRemoveHidden\>
            <position\>2</position\>
            <pinned\>Top</pinned\>
            <type\>Flow</type\>
        </channelItems\>
        <isAutopopEnabled\>true</isAutopopEnabled\>
    </channelConfigurations\>
    <masterLabel\>Sample Deployment</masterLabel\>
    <selectableItems\>
        <action\>Sample\_Flow</action\>
        <type\>Flow</type\>
        <isFrequentAction\>true</isFrequentAction\>
        <frequentActionSequenceNbr\>1</frequentActionSequenceNbr\>
    </selectableItems\>
    <selectableItems\>
        <action\>Sample\_Flow\_2</action\>
        <type\>Flow</type\>
        <isFrequentAction\>false</isFrequentAction\>
    </selectableItems\>
    <hasGuidedActions\>true</hasGuidedActions\>
    <hasRecommendations\>true</hasRecommendations\>
    <recommendation\>
        <defaultStrategy\>Sample\_Global\_Strategy</defaultStrategy\>
        <maxDisplayRecommendations\>4</maxDisplayRecommendations\>
        <hasImage\>true</hasImage\>
        <hasDescription\>true</hasDescription\>
        <hasRejectAction\>true</hasRejectAction\>
        <hasTitle\>true</hasTitle\>
    </recommendation\>
    <deploymentContexts\>
        <entityName\>Case</entityName\>
        <recommendationStrategy\>Sample\_Case\_Strategy</recommendationStrategy\>
    </deploymentContexts\>
    <deploymentContexts\>
        <entityName\>Account</entityName\>
        <recommendationStrategy\>Sample\_Acc\_Strategy</recommendationStrategy\>
    </deploymentContexts\>
</RecordActionDeployment\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>SecondTest</fullName\>
    <types\>
        <members\>Sample\_Flow</members\>
        <members\>Another\_Sample\_Flow</members\>
        <members\>Sample\_Flow\_2</members\>
        <name\>Flow</name\>
    </types\>
    <types\>
        <members\>SampleDeployment</members\>
        <name\>RecordActionDeployment</name\>
    </types\>
    <version\>45.0</version\>
</Package\>

#### See Also

- [RecommendationStrategy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recommendationstrategy.htm "Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations.")

<!-- document id=8d9197e20180bcc6addba61cca9744caf5a39e5315238ae40000a372f2546ee4 url=/legacydeveloper/current/en-us/api_meta/meta_recordaggregationdefinition.md -->

# RecordAggregationDefinition

Represents a data aggregation from one object to another object to which it is connected by other objects in the data model.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

RecordAggregationDefinition components have the suffix .RecordAggregationDefinition and are stored in the RecordAggregationDefinitions folder.

## Version

RecordAggregationDefinition components are available in API version 59.0 and later.

## Special Access Rules

To access the RecordAggregationDefinition metadata type, you must have the Record Aggregation permission set license and the Record Aggregation Access permission.

## Fields

### aggregateFromObject

- **Field Type**: string
- **Description**: Required.
    
    API name of the object from which data is aggregated.

### aggregateToObject

- **Field Type**: string
- **Description**: Required.
    
    API name of the object to which data is aggregated.

### aggregationType

- **Field Type**: RecordAggregationDefinitionAggregationType (enumeration of type string)
- **Description**: Required.
    
    Type of the data aggregation.
    
    Valid value is:
    
    - Record

### batchProcessingDefinition

- **Field Type**: string
- **Description**: Data Processing Engine definition that aggregates data from one record to another.

### description

- **Field Type**: string
- **Description**: Description for this record aggregation definition.

### displayName

- **Field Type**: string
- **Description**: Required.
    
    Name of the record aggregation definition that's displayed in the record page.

### onDemandProcDefinition

- **Field Type**: string
- **Description**: Data Processing Engine definition that aggregates data from one record to another on demand. Available in API version 63.0 and later.

### recordAggregationObject

- **Field Type**: [RecordAggregationObject\[\]](#RecordAggregationObject)
- **Description**: List of record aggregation objects in the record aggregation join sequence.

### status

- **Field Type**: RecordAggregationDefinitionStatus (enumeration of type string)
- **Description**: Required.
    
    Status of this record aggregation definition.
    
    Values are:
    
    - Active
    - Draft
    - Inactive

## RecordAggregationObject

Represents an object in the record aggregation join sequence.

### associatedObject

- **Field Type**: string
- **Description**: Required.
    
    API name of the object associated with this record aggregation object.

### developerName

- **Field Type**: string
- **Description**: Developer name of the record aggregation object. May contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

### filterLogic

- **Field Type**: string
- **Description**: Logical sequence in which the record aggregation object filters associated with this record aggregation object are applied to the associated object's records. If you define two or more record aggregation object filters, but don’t specify the sequence in which to apply the filters, the filters are applied by using a logical AND expression.
    
    Available in API version 60.0 and later.

### masterLabel

- **Field Type**: string
- **Description**: Required.
    
    A user-friendly name for RecordAggregationDefinition, which is defined when the RecordAggregationDefinition is created.

### recordAggregationJoinCondition

- **Field Type**: [RecordAggregationJoinCondition\[\]](#RecordAggregationJoinCondition)
- **Description**: List of join conditions that apply to this record aggregation object.

### recordAggregationObjectFilter

- **Field Type**: [RecordAggregationObjectFilter\[\]](#RecordAggregationObjectFilter)
- **Description**: List of filters that are applied to the records of this record aggregation object.
    
    Available in API version 60.0 and later.

## RecordAggregationJoinCondition

Represents a condition in a join between two record aggregation objects.

### joinField

- **Field Type**: string
- **Description**: Required.
    
    API name of the field on the record aggregation object's associated object that is used in the join condition.

### navigationSequenceNumber

- **Field Type**: int
- **Description**: Required.
    
    Sequence number corresponding to this join in the join sequence from the object to which the data is aggregated to the object that contains the data being aggregated.

### relatedJoinField

- **Field Type**: string
- **Description**: Required.
    
    API name of the field on the related record aggregation object's associated object that is used in the join condition.

### relatedRecordAggregationObject

- **Field Type**: string
- **Description**: Required.
    
    Second record aggregation object in the join condition.

### type

- **Field Type**: RecordAggregationJoinConditionType (enumeration of type string)
- **Description**: Required.
    
    Type of this record aggregation join in the join path from the object to which the data is aggregated to the object that contains the data being aggregated.
- **Possible values**:
    - AggregateFrom
    - AggregateTo
    - Intermediate

## RecordAggregationObjectFilter

Represents a filter that is applied to the records of an object in the record aggregation join sequence. Available in API version 60.0 and later.

### associatedObjectField

- **Field Type**: string
- **Description**: Required.
    
    API name of the associated object's field whose value is used to filter the object's records. The associated object is specified in the record aggregation object.

### operator

- **Field Type**: RecordAggregationObjectFilterOperator (enumeration of type string)
- **Description**: Required.
    
    Operator used in the filter expression.
    
    Values are:
    
    - Contains
    - Equals
    - GreaterThan
    - GreaterThanOrEquals
    - In
    - LessThan
    - LessThanOrEquals
    - NotEquals
    - NotIn

### sequenceNumber

- **Field Type**: int
- **Description**: Required.
    
    Sequence number of this record aggregation object filter.

### value

- **Field Type**: string
- **Description**: Required.
    
    Reference value with which the designated field's values are compared when the filter is applied on the associated object's records.

## Declarative Metadata Sample Definition

The following is an example of a RecordAggregationDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<RecordAggregationDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <aggregateToObject\>PartyRelationshipGroup</aggregateToObject\>
    <aggregateFromObject\>PartyIncome</aggregateFromObject\>
    <status\>Active</status\>
    <aggregationType\>Record</aggregationType\>
    <description\>Aggregate head of household's income to household</description\>
    <displayName\>Party Income to Party Relationship Group</displayName\>
    <recordAggregationObject\>
        <associatedObject\>PartyRelationshipGroup</associatedObject\>
        <masterLabel\>Party Relationship Group Object</masterLabel\>
        <developerName\>PartyRelationshipGroupObject</developerName\>
        <recordAggregationJoinCondition\>
            <joinField\>Account</joinField\>
            <navigationSequenceNumber\>1</navigationSequenceNumber\>
            <relatedJoinField\>Account</relatedJoinField\>
            <relatedRecordAggregationObject\>AccountContactrelationObject</relatedRecordAggregationObject\>
            <type\>Intermediate</type\>
        </recordAggregationJoinCondition\>
        <recordAggregationObjectFilter\>
          <associatedObjectField\>Type</associatedObjectField\>
          <operator\>Equals</operator\>
          <value\>Household</value\>
          <sequenceNumber\>1</sequenceNumber\>
        </recordAggregationObjectFilter\>
    </recordAggregationObject\>
    <recordAggregationObject\>
        <associatedObject\>AccountContactRelation</associatedObject\>
        <masterLabel\>Account Contact Relation Object</masterLabel\>
        <developerName\>AccountContactRelationObject</developerName\>
        <recordAggregationJoinCondition\>
            <joinField\>Contact</joinField\>
            <navigationSequenceNumber\>2</navigationSequenceNumber\>
            <relatedJoinField\>Party</relatedJoinField\>
            <relatedRecordAggregationObject\>PartyIncomeObject</relatedRecordAggregationObject\>
            <type\>Intermediate</type\>
        </recordAggregationJoinCondition\>
        <recordAggregationObjectFilter\>
          <associatedObjectField\>IsPrimaryMember</associatedObjectField\>
          <operator\>Equals</operator\>
          <value\>true</value\>
          <sequenceNumber\>1</sequenceNumber\>
        </recordAggregationObjectFilter\>
    </recordAggregationObject\>
    <recordAggregationObject\>
        <associatedObject\>PartyIncome</associatedObject\>
        <masterLabel\>Party Income Object</masterLabel\>
        <developerName\>PartyIncomeObject</developerName\>
        <filterLogic\>1 AND 2</filterLogic\>
        <recordAggregationObjectFilter\>
          <associatedObjectField\>IncomeFrequency</associatedObjectField\>
          <operator\>Equals</operator\>
          <value\>Monthly</value\>
          <sequenceNumber\>1</sequenceNumber\>
        </recordAggregationObjectFilter\>
        <recordAggregationObjectFilter\>
          <associatedObjectField\>IncomeStatus</associatedObjectField\>
          <operator\>Equals</operator\>
          <value\>Active</value\>
          <sequenceNumber\>2</sequenceNumber\>
        </recordAggregationObjectFilter\>
    </recordAggregationObject\>
</RecordAggregationDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>RecordAggregationDefinition</name\>
    </types\>
    <version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based.htm "HTML (New Window)").

<!-- document id=9f445c73a7cfb418d51e65d600d6f92d932f6f8c56a7dcb8eb34e793019828c0 url=/legacydeveloper/current/en-us/api_meta/meta_recordalertcategory.md -->

# RecordAlertCategory

Represents a category to group and present record alerts.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

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

## File Suffix and Directory Location

RecordAlertCategory components have the suffix recordAlertCategory and are stored in the recordAlertCategories folder.

## Version

RecordAlertCategory components are available in API version 54.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The description of the record alert category.



 |
| masterLabel | 

Field Type

string

Description

Required.

The user-interface name of the record alert category.



 |
| severity | 

Field Type

string

Description

Indicates the degree of impact that an alert in this category can have.

Possible Education Cloud values are:

- High
- Low
- Medium

Possible Financial Service Cloud values are:

- Error
- Info
- Minor
- Warning





 |

## Declarative Metadata Sample Definition

The following is an example of a RecordAlertCategory component.

<?xml version="1.0" encoding="UTF-8"?>
<RecordAlertCategory xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Tracks Financial Account Fraud Alerts</description\>
    <masterLabel\>Fraud</masterLabel\>
    <severity\>Error</severity\>
</RecordAlertCategory\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Fraud</members\>
        <name\>RecordAlertCategory</name\>
    </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e7b6918b714bc34536b8b3716aa1908b90bc51843b312cd6c5dadaf14a74d024 url=/legacydeveloper/current/en-us/api_meta/meta_recordpagesettings.md -->

# RecordPageSettings

Represents an org’s record page settings. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## Declarative Metadata File Suffix and Directory Location

RecordPageSettings values are stored in a single file named RecordPage.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

Record page settings are available in API version 47.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| enableActivityRelatedList | boolean | Indicates whether the default activities view is related lists (true) or activity timeline (false). |
| enableDynamicForms | boolean | Indicates whether Dynamic Forms is enabled for the org. Removed in API version 50.0 and later. |
| enableFullRecordView | boolean | Indicates whether the default record page view is full view (true) or grouped view (false). |

## Declarative Metadata Sample Definition

This is a sample recordpage.settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>
<RecordPageSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableDynamicForms\>true</enableDynamicForms\>
    <enableActivityRelatedList\>true</enableActivityRelatedList\>
    <enableFullRecordView\>true</enableFullRecordView\>
</RecordPageSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Record Page settings metadata for an organization

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>RecordPage</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.")

<!-- document id=db0a68de3201a54441c00020571dd5673bce0112b6e3d25745b437c0327d85ce url=/legacydeveloper/current/en-us/api_meta/meta_recordtype.md -->

# RecordType

Represents the metadata associated with a record type. Record types let you offer different business processes, picklist values, and page layouts to different users. Use this metadata type to create, update, or delete record type definitions for a custom object.

For more information, see Tailor Busines Processes to Different Record Types Users in Salesforce Help. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Don’t use record types as an access control mechanism. Profile assignment governs create and edit access for an object but doesn’t govern read access. For example, a user assigned to a profile that isn't enabled for a particular record type can't create records with that record type, but can access records associated with that record type.

Users with access to an object can read all record type information for that object. We strongly recommend against storing sensitive information in the record type description, name, or label. Instead, store sensitive information in a separate object or fields to which you’ve applied appropriate access controls.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet components that are retrieved in the same package.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Metadata API doesn’t retrieve custom picklist values on person account record types, if the picklist exists on a contact. In this case, Metadata API retrieves standard picklist values only.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Metadata API doesn't retrieve specific picklist fields that are associated with a record type.

## Version

Record types are available in API version 12.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d801288e102">Field</th>

              <th class="featureTableHeader  " id="d801288e105">Field Type</th>

              <th class="featureTableHeader  " id="d801288e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d801288e102" data-title="Field"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d801288e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d801288e108" data-title="Description">Required. Indicates whether the record type is active.</td>

            </tr>

            <tr>
              <td class="entry" headers="d801288e102" data-title="Field"><span class="keyword parmname" id="field_businessProcess"><a name="field_businessProcess"><!-- --></a>businessProcess</span></td>

              <td class="entry" headers="d801288e105" data-title="Field Type">string</td>

              <td class="entry" headers="d801288e108" data-title="Description">
                <span class="ph" id="field_businessProcess_desc"><a name="field_businessProcess_desc"><!-- --></a>The name of the business
                  process associated with the record type, specified as the bare
                  process name. (For example, Bulk Orders), not object-qualified.
                  As the record type is already defined within the object, don't
                  prefix the object name (Opportunity. Bulk Orders). This field is
                  required in record types for lead, opportunity, solution, and
                  case, and not allowed otherwise.</span> See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_businessprocess.htm" title="The BusinessProcess metadata type enables you to display different picklist values for users based on their profile.">BusinessProcess</a>.<p class="p">This field is available in API version 17.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d801288e102" data-title="Field"><span class="keyword parmname" id="field_compactlayoutassignment"><a name="field_compactlayoutassignment"><!-- --></a>compactLayoutAssignment</span></td>

              <td class="entry" headers="d801288e105" data-title="Field Type">string</td>

              <td class="entry" headers="d801288e108" data-title="Description">
                <span class="ph" id="field_compactlayoutassignment_desc"><a name="field_compactlayoutassignment_desc"><!-- --></a>Represents the
                  compact layout that is assigned to the record type.</span>
                <p class="p">This
                  field is available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d801288e102" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d801288e105" data-title="Field Type">string</td>

              <td class="entry" headers="d801288e108" data-title="Description">Record type description. Maximum of 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d801288e102" data-title="Field"><span class="keyword parmname" id="recordtype_fullName"><a name="recordtype_fullName"><!-- --></a>fullName</span></td>

              <td class="entry" headers="d801288e105" data-title="Field Type">string</td>

              <td class="entry" headers="d801288e108" data-title="Description">Record type name. The <span class="keyword parmname">fullName</span> can contain
                only underscores and alphanumeric characters. It must be unique,
                begin with a letter, not include spaces, not end with an underscore,
                and not contain two consecutive underscores. If this field contained
                characters before version 14.0 that are no longer allowed, the
                characters were stripped out of this field, and the previous value
                of the field was saved in the <a class="xref" href="#recordtype_label"><span class="keyword parmname">label</span></a> field.<p class="p" id="fullname_desc"><a name="fullname_desc"><!-- --></a>Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component, this field isn’t defined in
                  the WSDL for this component. It must be specified when creating,
                  updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see an example of this field
                  specified for a call.</p>
                <p class="p">This value can't be <samp class="codeph java">null</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d801288e102" data-title="Field"><span class="keyword parmname" id="recordtype_label"><a name="recordtype_label"><!-- --></a>label</span></td>

              <td class="entry" headers="d801288e105" data-title="Field Type">string</td>

              <td class="entry" headers="d801288e108" data-title="Description">Required. Descriptive label for the record type. The list of
                characters allowed in the <a class="xref" href="#recordtype_fullName"><span class="keyword parmname">fullName</span></a> field
                has been reduced for versions 14.0 and later. This field contains
                the value contained in the <a class="xref" href="#recordtype_fullName"><span class="keyword parmname">fullName</span></a> field
                before version 14.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d801288e102" data-title="Field"><span class="keyword parmname">picklistValues</span></td>

              <td class="entry" headers="d801288e105" data-title="Field Type">
                <a class="xref" href="#recordtypepicklistvalue_title">RecordTypePicklistValue</a>[]
              </td>

              <td class="entry" headers="d801288e108" data-title="Description">Represents a set of values for a picklist.</td>

            </tr>

          </tbody>

        </table>

## RecordTypePicklistValue

RecordTypePicklistValue represents the combination of picklists and valid values that define a record type:

| Field Name | Field Type | Description |
| --- | --- | --- |
| picklist | string | Required. The name of the picklist. |
| values | [PicklistValue](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_globalpicklistvalue.htm#picklistvalue) | One or more of the picklist values in the picklist. Each value defined is available in the record type that contains this component. |

## Java Sample

The following sample uses two record types. For the complete sample that includes profiles and picklists, see [Profile](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm "Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field.").

public void recordTypeSample() {
  try {
    // Employees and managers have different access
    // to the state of the expense sheet
    RecordType edit = new RecordType();
    edit.setFullName("ExpenseReport\_\_c.Edit");
    edit.setLabel("ExpenseReport\_\_c.Label");
    PicklistValue unsubmitted = new PicklistValue();
    unsubmitted.setFullName("Unsubmitted");
    PicklistValue submitted = new PicklistValue();
    submitted.setFullName("Submitted");
    RecordTypePicklistValue editStatuses = 
        new RecordTypePicklistValue();
    editStatuses.setPicklist("ExpenseStatus\_\_c");
    editStatuses.setValues(
        new PicklistValue\[\] {unsubmitted, submitted});
    edit.setPicklistValues(
        new RecordTypePicklistValue\[\] {editStatuses});
    AsyncResult\[\] arsEdit =
        metadataConnection.create(new Metadata\[\] {edit});
    
    RecordType approve = new RecordType();
    approve.setFullName("ExpenseReport\_\_c.Approve");
    PicklistValue approved = new PicklistValue();
    approved.setFullName("Approved");
    PicklistValue rejected = new PicklistValue();
    rejected.setFullName("Rejected");
    RecordTypePicklistValue approveStatuses = 
        new RecordTypePicklistValue();
    approveStatuses.setPicklist("ExpenseStatus\_\_c");
    approveStatuses.setValues(
        new PicklistValue\[\] {approved, rejected});
    approve.setPicklistValues(
        new RecordTypePicklistValue\[\] {approveStatuses});
    AsyncResult\[\] arsApprove =
      metadataConnection.create(new Metadata\[\] {approve});
  } catch (ConnectionException ce) {
    ce.printStackTrace();
  }
}

## Declarative Metadata Sample Definition

The definition of a record type in a custom object is shown in this code block.

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
. . .
   <recordTypes\>
        <fullName\>My\_First\_Recordtype</fullName\>
    </recordTypes\>
 . . .
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profilesearchlayouts.htm "ProfileSearchLayouts")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_searchlayouts.htm "SearchLayouts")

<!-- document id=f77a1fbd28d67b39ff6d64fcb60ca787a7ac8de07be11e402ab726b99192d3f5 url=/legacydeveloper/current/en-us/api_meta/meta_redirectwhitelisturl.md -->

# RedirectWhitelistUrl

Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

## File Suffix and Directory Location

RedirectWhitelistUrl components have the suffix .redirectWhitelistUrl and are stored in the redirectWhitelistUrls folder.

## Version

RedirectWhitelistUrl components are available in API version 48.0 and later.

## Special Access Rules

Only authenticated internal and external users with the View Setup and Customize Application permissions can access or edit this type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d802343e109">Field Name</th>

              <th class="featureTableHeader  " id="d802343e112">Field Type</th>

              <th class="featureTableHeader  " id="d802343e115">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d802343e109" data-title="Field Name"><span class="keyword parmname">url</span></td>

              <td class="entry" headers="d802343e112" data-title="Field Type">string</td>

              <td class="entry" headers="d802343e115" data-title="Description">
                <p class="p">Required. The trusted URL.</p>
                <p class="p">These formats are accepted:
                  <span class="ph filepath">example.com</span>, <span class="ph filepath">*.example.com</span>, and
                  <span class="ph filepath">https://example.com</span>.
                </p>
                <p class="p">The host section of the URL can
                  include an asterisk (<samp class="codeph nolang">*</samp>) as a wildcard.
                  Otherwise, the URL cannot be malformed. Examples of malformed URLs that fail a
                  syntax check are <samp class="codeph nolang">malformed^url.example.com</samp>,
                  and <samp class="codeph nolang">https://{subdomain}.example.com</samp>.</p>
                <p class="p">To
                  add a <span class="keyword parmname">URL</span> based on parameters, build the URL before you add
                  it to this Metadata Type.</p>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b496783d4e121494d9856d8b5160853520c2123fa0af0c928cd63d22dad16a7c url=/legacydeveloper/current/en-us/api_meta/meta_referenceddashboard.md -->

# ReferencedDashboard

Represents the ReferencedDashboard object in CRM Analytics. A referenced dashboard stores information about an externally referenced dashboard.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

ReferencedDashboard components have the suffix .refdash and are stored in the wave folder.

## Version

ReferencedDashboard components are available in API version 57.0 and later.

## Special Access Rules

To view referenced dashboards, you need the Enables Tableau Dashboards in CRM Analytics permission.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| application | string | Required. The internal name of the Analytics app. |
| description | string | The dashboard description that appears in the user interface. |
| embedUrl | string | Required. The URL to the referenced dashboard. |
| masterLabel | string | Required. The dashboard name that appears in the user interface. |
| templateAssetSourceName | string | Links the dashboard to the template used to create it. Null for assets not created from a template. |
| visibility | string | The visibility of the dashboard. Valid values are: ALL and LIMITED. |

## Declarative Metadata Sample Definition

The following is an example of a WaveDashboard component.

<?xml version="1.0" encoding="UTF-8"?>
<ReferencedDashboard xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <application\>my\_app</application\>
    <masterLabel\>ReferencedDashboard1</masterLabel\>
    <description\>My Tableau Dashboard</description\>
    <embedUrl\>https://public.tableau.com/views/Superstore\_24/Overview</embedUrl\>
    <visibility\>ALL</visibility\>
</ReferencedDashboard\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=2ad0ebc29d7918b5ccb5ff514ee91bd7ac63c5ba27bd89cc6c5b5f8bf05089f2 url=/legacydeveloper/current/en-us/api_meta/meta_registeredexternalservice.md -->

# RegisteredExternalService

Represents a registered external service, which provides an extension or integration.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

RegisteredExternalService components have the suffix .registeredExternalService and are stored in the registeredExternalServices folder.

## Version

RegisteredExternalService components are available in API version 49.0 and later.

## Special Access Rules

This metadata type is available only if the B2B Commerce or D2C Commerce license is enabled.

## Fields

| Field Name | Description |
| --- | --- |
| configUrl | 
Field Type

string

Description

Link to the configuration page for the integration.



 |
| description | 

Field Type

string

Description

Description of the external service provider.

This field is available in API version 59.0 and later.



 |
| documentationUrl | 

Field Type

string

Description

Link to documentation for the registered external service.



 |
| extensionPointName | 

Field Type

ExtensionPointName (enumeration of type string)

Description

This field is available in API version 55.0 and later. Name of an extension point.

Possible values are:

- Commerce\_Domain\_BuyerGroup\_EvaluationService—Available in API version 65.0 and later.
- Commerce\_Domain\_Cart\_Calculate
- Commerce\_Domain\_Checkout\_CreateOrder
- Commerce\_Domain\_Inventory\_CartCalculator
- Commerce\_Domain\_Inventory\_Service
- Commerce\_Domain\_OrderManagement\_Product
- Commerce\_Domain\_Pricing\_CartCalculator
- Commerce\_Domain\_Pricing\_Service
- Commerce\_Domain\_Promotions\_CartCalculator
- Commerce\_Domain\_Promotions\_ShippingCalculator
- Commerce\_Domain\_Shipping\_CartCalculator
- Commerce\_Domain\_Shipping\_SplitShipment
- Commerce\_Domain\_Tax\_CartCalculator
- Commerce\_Domain\_Tax\_Service
- Commerce\_Endpoint\_Account\_Address
- Commerce\_Endpoint\_Account\_Addresses
- Commerce\_Endpoint\_Cart\_Item—Available in API version 62.0 and later.
- Commerce\_Endpoint\_Cart\_ItemCollection—Available in API version 62.0 and later.
- Commerce\_Endpoint\_Catalog\_Product
- Commerce\_Endpoint\_Catalog\_Products
- Commerce\_Endpoint\_Search\_ProductSearch
- Commerce\_Endpoint\_Gift\_Wraps—Available in API version 65.0 and later.
- Commerce\_Endpoint\_Search\_Products
- Commerce\_Endpoint\_Search\_ProductsByCategory





 |
| externalServiceProvider | 

Field Type

string

Description

Required. The ID of an Apex class functioning as a provider. The Apex class can either implement one of the following interfaces:

- sfdc\_checkout.CartInventoryValidation
- sfdc\_checkout.CartPriceCalculations
- sfdc\_checkout.CartShippingCharges
- sfdc\_checkout.CartTaxCalculations

or the Apex class can extend one of the base classes for an extension. See [Available Extensions](https://developer.salesforce.com/docs/commerce/salesforce-commerce/guide/available-extensions.html).



 |
| externalServiceProviderType | 

Field Type

RegistryProviderType (enumeration of type string)

Description

Required. The type of external service provider. For an extension, you set the type to Extension, and you specify an extensionPointName. For example, for a Pricing Cart Calculator extension, you specify Commerce\_Domain\_Pricing\_CartCalculator as the extensionPointName. For an integration, you set the type to one of the other possible values, such as Price, and you omit extensionPointName.

Possible values are:

- Extension (this value is available in API version 55.0 and later)
- Inventory
- Price
- Promotions (this value is available in API version 53.0 and later)
- Shipment
- Tax





 |
| iconUri | 

Field Type

string

Description

URI of icon for the extension provider.

This field is available in API version 59.0 and later.



 |
| isApplication | 

Field Type

boolean

Description

Indicates if the extension provider is contained within a managed package.

The default value is false.

This field is available in API version 59.0 and later.



 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type.

The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. The primary label for the RegisteredExternalService.





 |

## Declarative Metadata Sample Definition

The following is an example of a RegisteredExternalService component.

<?xml version="1.0" encoding="UTF-8"?>
<RegisteredExternalService xmlns="http://soap.sforce.com/2006/04/metadata">
    <externalServiceProvider\>TaxSample</externalServiceProvider\>
    <externalServiceProviderType\>Tax</externalServiceProviderType\>
    <documentationUrl\>http://sample.com/doc</documentationUrl\>
    <configUrl\>http://sample.com/config</configUrl\>
    <masterLabel\>TaxService</masterLabel\>
    <isProtected\>false</isProtected\>
</RegisteredExternalService\>

The following is an example package.xml that references the previous definition.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>TaxSample</members\>
        <name\>ApexClass</name\>
    </types\>
    <types\>
        <members\>TaxService</members\>
        <name\>RegisteredExternalService</name\>
    </types\>
    <version\>60.0</version\>
</Package\>

<!-- document id=a3cd4cd1daf6a2210694a19eede482bc78ebb613f7caeb2d3e59e2578c6926a3 url=/legacydeveloper/current/en-us/api_meta/meta_related_resources.md -->

# Related Resources

The Salesforce developer website provides a full suite of developer toolkits, sample code, sample SOAP messages, community-based support, and other resources to help you with your development projects. Be sure to visit [https://developer.salesforce.com/page/Getting\_Started](https://developer.salesforce.com/page/Getting_Started) for more information, or visit [https://developer.salesforce.com/signup](https://developer.salesforce.com/signup) to sign up for a free Developer Edition account.

You can visit these websites to find out more about Salesforce applications:

- [Salesforce Developers](https://developer.salesforce.com/page/Tools "HTML (New Window)") provides useful information for developers.
- [Salesforce](https://salesforce.com) for information about the Salesforce application.
- [Lightning Platform AppExchange](https://appexchange.salesforce.com/) for access to apps created for Salesforce.
- [Trailblazer Community](https://trailhead.salesforce.com/en/trailblazer-community/feed) for services to ensure Salesforce customer success.

<!-- document id=526ca3d1b1e1ea51c1ab43736cf092d23a0f81f717cd037df39cba8ced6bdf27 url=/legacydeveloper/current/en-us/api_meta/meta_relatedrecordassoccriteria.md -->

# RelatedRecordAssocCriteria

Represents criteria for automatically linking records like accounts, leads, opportunities, and cases with the branches that work with them.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

RelatedRecordAssocCriteria components have the suffix .relatedRecordAssocCriteria and are stored in the relatedRecordAssocCriteria folder.

## Version

RelatedRecordAssocCriteria components are available in API version 52.0 and later.

## Special Access Rules

To use this object, you must have the Financial Services Cloud Extension permission set.

## Fields

| Field Name | Description |
| --- | --- |
| associationHandlerApexClass | 
Field Type

string

Description

The name of a custom Apex class that handles the creation of association records for specific association criteria. This class must:

- Apply to an object that the Record Association Builder doesn't directly support
- Implement the fscwmgen.BranchManagement​AssociationHandler interface
- Return a list of Branch Unit Related Records
- Populate at least the minimum required fields in each Branch Unit Related Record:
    - BranchUnitId: Represents the current branch unit of the user or contact
    - BusinessUnitMemberId: The Banker ID of the user or contact
    - RelatedRecordId: The ID of the custom object to be related

This field is a relationship field.



 |
| associationType | 

Field Type

AssociationType (enumeration of type string)

Description

Required.

The association type. Values are:

- BranchManagement





 |
| description | 

Field Type

string

Description

A description of the association criteria.



 |
| eventType | 

Field Type

AssociationEventType (enumeration of type string)

Description

Required.

The type of reference object event that triggers creation of the association. Values are:

- Create
- Update





 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required.

The master label of the association criteria. This internal label doesn’t get translated.



 |
| preCondition | 

Field Type

string

Description

Required.

A formula that, when true, causes a new association to be created.



 |
| referenceObject | 

Field Type

string

Description

Required.

The reference object for the association criteria.



 |
| selectedOwnerField | 

Field Type

string

Description

A field to use instead of the default Owner ID.



 |
| status | 

Field Type

AssociationStatusType (enumeration of type string)

Description

Required.

The status of the association criteria. Values are:

- Active
- Draft
- Inactive





 |

## Declarative Metadata Sample Definition

The following is an example of a RelatedRecordAssocCriteria component.

<?xml version="1.0" encoding="UTF-8"?>
<RelatedRecordAssocCriteria xmlns="http://soap.sforce.com/2006/04/metadata">
   <associationType\>BranchManagement</associationType\>
   <eventType\>Create</eventType\>
   <masterLabel\>RevenueThreeMillion</masterLabel\>
   <preCondition\>\[Account\].AnnualRevenue > 3000000</preCondition\>
   <referenceObject\>Account</referenceObject\>
   <status\>Active</status\>
</RelatedRecordAssocCriteria\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>RelatedRecordAssocCriteria</name\>
    </types\>
    <version\>52.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=c4683b7a7378f9ee5a9cc5a481eef7c0d502ccc24547da691afa7420d9cb79f2 url=/legacydeveloper/current/en-us/api_meta/meta_relationshipgraphdefinition.md -->

# RelationshipGraphDefinition

Represents a definition of a graph that you can configure in your organization to traverse object hierarchies and record details, giving you a glimpse of how your business works.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

RelationshipGraphDefinition components have the suffix .relationshipGraphDefinition and are stored in the relationshipGraphDefinitions folder.

## Version

RelationshipGraphDefinition components are available in API version 55.0 and later.

## Special Access Rules

The Financial Services Cloud permission set license is required to access this object.

## Fields

| Field Name | Description |
| --- | --- |
| isActive | 
Field Type

boolean

Description

Required.

Indicates whether the relationship graph is available for use (true) or not (false). The default value is true.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This field is read-only in API version 55.0.















 |
| isTemplate | 

Field Type

boolean

Description

Required.

Indicates whether you can configure this relationship graph as a template (true or not false). The default value is false. In the UI, this field is _Set as Template_.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for RelationshipGraphDefinition, which is defined when the RelationshipGraphDefinition is created. In the UI, this field is _Label_.



 |
| relationshipGraphDefVersions | 

Field Type

[RelationshipGraphDefVersion\[\]](#subtype_RelationshipGraphDefVersion)

Description

Represents a list of graph versions associated with the relationship graph definition.



 |

## RelationshipGraphDefVersion

The list of graph versions associated with the relationship graph definition.

| Field Name | Description |
| --- | --- |
| graphDefinition | 
Field Type

string

Description

Required.

Specifies a set of properties required to create a relationship graph, such as parent node, child relationships, filter and sort fields, and graph UI elements.



 |
| graphType | 

Field Type

string

Description

Required.

Specifies the type of graph. In API version 55.0, only HorizontalHierarchy graph type is supported.



 |

## Declarative Metadata Sample Definition

The following is an example of a RelationshipGraphDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<RelationshipGraphDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
     <isActive\>false</isActive\>
     <isTemplate\>true</isTemplate\>
     <masterLabel\>Account Graph</masterLabel\>
     <relationshipGraphDefVersions\>
         <graphDefinition\>{
   "graph" : {
     "rootNode" : {
       "object" : {
         "entity" : "Account"
       },
       "configurationType" : "Primary",
       "sortFields" : \[ {
         "field" : {
           "field" : "LastModifiedDate",
           "whichEntity" : "TARGET"
         },
         "order" : "DESC"
       } \],
       "nodeUiConfig" : {
         "fieldsToDisplay" : \[ \],
         "showFieldLabels" : true,
         "actions" : { }
       },
       "childRelationships" : \[ {
         "OneToMany" : {
           "targetObjectNode" : {
             "object" : {
               "entity" : "Contact"
             },
             "configurationType" :"Custom",
             "sortFields" : \[ {
               "field" : {
                 "field" : "LastModifiedDate",
                 "whichEntity" : "TARGET"
               },
               "order" : "DESC"
             } \],
             "nodeUiConfig" : {
               "fieldsToDisplay" : \[ {
                 "field" : "Name",
                 "whichEntity" : "TARGET"
               }, {
                 "field" : "Phone",
                 "whichEntity" :"TARGET"
               } \],
               "showFieldLabels" : true,
               "actions" : {
                 "containerActions" : \[ {
                   "action" : "New"
                 } \],
                 "recordActions" : \[ {
                   "action" : "Edit"
                 }, {
                   "action" : "Delete"
                 } \]
               }
             },
             "childRelationships" : \[ \]
           },
           "relationshipUiConfig" : { },
           "filter" : {
             "filterCriteria" : \[ {
               "field" : {
                 "field" : "Name",
                 "whichEntity" : "TARGET"
               },
               "operator" : "eq",
               "value" : "Salesforce"
             } \],
             "booleanFilter" : "1"
           },
           "targetObjectField" : {
             "field" : "AccountId",
             "whichEntity" : "TARGET"
           }
         }
       } \]
     },
     "globalUiConfig" : {
       "borderColor" : "Green2",
       "borderThickness" : "2px";,
       "colorShading" : "Black",
       "fieldLayout" : "Vertically Stacked",
       "recordContainerExpansion" : true,
       "recordExpansion" : true
     }
   }
 }</graphDefinition\>
         <graphType\>HorizontalHierarchy</graphType\>
     </relationshipGraphDefVersions\>
</RelationshipGraphDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <fullName\>Package1</fullName\>
   <types\>
       <members\>\*</members\>
       <name\>RelationshipGraphDefinition</name\>
   </types\>
   <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=e56e58dacc0c6b32d85ac7f48b0f15a5a89431d11c64cb2dfb2a54a3bdea9235 url=/legacydeveloper/current/en-us/api_meta/meta_remotesitesetting.md -->

# RemoteSiteSetting

Represents a remote site setting. Before any Visualforce page, Apex callout, or JavaScript code using XmlHttpRequest in an s-control or custom button can call an external site, that site must be registered in the Remote Site Settings page, or the call fails.

[RemoteSiteSetting](#meta_remotesitesetting "Represents a remote site setting. Before any Visualforce page, Apex callout, or JavaScript code using XmlHttpRequest in an s-control or custom button can call an external site, that site must be registered in the Remote Site Settings page, or the call fails.") extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Declarative Metadata File Suffix and Directory Location

[RemoteSiteSetting](#meta_remotesitesetting "Represents a remote site setting. Before any Visualforce page, Apex callout, or JavaScript code using XmlHttpRequest in an s-control or custom button can call an external site, that site must be registered in the Remote Site Settings page, or the call fails.") components are stored in the remoteSiteSettings directory of the corresponding package directory. The file name matches the unique name of the remote site setting, and the extension is .remoteSite.

## Version

[RemoteSiteSetting](#meta_remotesitesetting "Represents a remote site setting. Before any Visualforce page, Apex callout, or JavaScript code using XmlHttpRequest in an s-control or custom button can call an external site, that site must be registered in the Remote Site Settings page, or the call fails.") components are available in API version 19.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806309e119">Field</th>

              <th class="featureTableHeader  " id="d806309e122">Field Type</th>

              <th class="featureTableHeader  " id="d806309e125">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806309e119" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d806309e122" data-title="Field Type">string</td>

              <td class="entry" headers="d806309e125" data-title="Description">The description explaining what this remote site setting is used
                for.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806309e119" data-title="Field"><span class="keyword parmname">disableProtocolSecurity</span></td>

              <td class="entry" headers="d806309e122" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806309e125" data-title="Description">Required. Indicates whether code within Salesforce
                can access the remote site regardless of whether the user's
                connection is over HTTP or HTTPS (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). When <samp class="codeph java">true</samp>, code
                within Salesforce can pass data from an HTTPS session to an HTTP session,
                and vice versa.
                <p class="p">Only set to <samp class="codeph java">true</samp> if you understand
                  the security implications.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806309e119" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d806309e122" data-title="Field Type">string</td>

              <td class="entry" headers="d806309e125" data-title="Description">The name can only contain characters, letters, and the underscore
                (_) character. The name must start with a letter, and can’t end with
                an underscore or contain two consecutive underscore
                characters.<p class="p">Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component, this field isn’t defined in
                  the WSDL for this component. It must be specified when creating,
                  updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see an example of this field
                  specified for a call.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806309e119" data-title="Field"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d806309e122" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806309e125" data-title="Description">Required. Indicates if the remote site setting is active (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d806309e119" data-title="Field"><span class="keyword parmname">url</span></td>

              <td class="entry" headers="d806309e122" data-title="Field Type">string</td>

              <td class="entry" headers="d806309e125" data-title="Description">Required. The URL for the remote site.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample XML definition of a remote site setting is shown in this code block.

<?xml version="1.0" encoding="UTF-8"?>
<RemoteSiteSetting xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Used for Apex callout to mapping web service</description\>
    <disableProtocolSecurity\>false</disableProtocolSecurity\>
    <isActive\>true</isActive\>
    <url\>https://www.maptestsite.net/mapping1</url\>
</RemoteSiteSetting\>

<!-- document id=7d6093979d8ef720928f08dab931101182a75b343ddb7006bd07a5b6e193c75d url=/legacydeveloper/current/en-us/api_meta/meta_renameMetadata.md -->

# renameMetadata()

Renames a metadata component in your organization synchronously.

## Syntax

[SaveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_saveResult.htm#meta_saveResult "Contains result information for the createMetadata, updateMetadata, or renameMetadata call.") = metadataConnection.renameMetadata(string metadataType, String oldFullname, String newFullname);

## Usage

Use the renameMetadata() call to rename one metadata component in your organization. This call executes synchronously, meaning the call returns only when the operation completes.

You can use this call to rename any of the objects that extend [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm). For more details, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

## Version

Available in API version 30.0 and later.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Basic Steps for Renaming Metadata Components

Use this process to rename a metadata component.

1. Determine the metadata type of the component you want to rename, its current full name, and the new full name. See [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) for more details on the fullName field.
2. Invoke the renameMetadata() call. For the first argument, pass in the name of the metadata type. Pass in the old full name as the second argument and the new full name as the last argument.
    
    A SaveResult object that contains information about whether the operation was successful is returned. If successful, the object contains the name of the renamed component, which is the new name. If it wasn’t successful, the object returns any errors.

## Sample Code—Java

public void renameCustomObjectSync() {
 try {
    SaveResult\[\] results = metadataConnection.renameMetadata(
        "CustomObject", "MyCustomObject1\_\_c","MyCustomObject1New\_\_c");
    for (SaveResult r : results) {
    	if (r.isSuccess()) {
    		System.out.println("Renamed component: " + r.getName());
    	}
    	else {
    		System.out.println("Errors were encountered while renaming " + r.getName());
    		for(Error e : r.getErrors()) {
    			System.out.println("Error message: " + e.getMessage());
    			System.out.println("Status code: " + e.getStatusCode());
    		}
    	}
    }
  } catch (ConnectionException ce) {
    ce.printStackTrace();
  } catch (InterruptedException ie) {
    ie.printStackTrace();
  }
}

## Arguments

### metadataType

- **Type**: string
- **Description**: The metadata type of the components to rename.

### oldFullName

- **Type**: string
- **Description**: The current component full name.

### newFullName

- **Type**: string
- **Description**: The full name of the new component.

## Response

[SaveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_saveResult.htm "Contains result information for the createMetadata, updateMetadata, or renameMetadata call.")

<!-- document id=d3463959e865cced73f5a1325421ba6c940a2aae01630caf152e29d22f011c5d url=/legacydeveloper/current/en-us/api_meta/meta_report.md -->

# Report

Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

Redeploying a report with the same fullName as a previously deleted report via Metadata API restores the deleted report instead of creating a new one, even if the report was removed from the Recycle Bin. The restored report keeps its original Id, CreatedDate, and CreatedById.

## Declarative Metadata File Suffix and Directory Location

Reports are stored in the reports directory of the package directory. The file name consists of the report title with the extension .report.

## Retrieving Reports

You can’t use the wildcard (\*) symbol with reports in package.xml.

To retrieve the list of explicit report names to populate package.xml with, first call listMetadata(ListMetadataQuery\[\]) with a [ListMetadataQuery](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listmetadataquery.htm "The ListMetadataQuery parameter represents a list of objects that specify which components you are interested in.") entry with the type field set to ReportFolder and the folder field to \* (wildcard). This call returns an array of [FileProperties](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm#fileproperties_intro) objects with the names of report folders in the fullName field.

Now call listMetadata with ListMetadataQuery entries where the type field is Report and the folder fields are the full name values from the first listMetadata call. These calls return FileProperties objects where the fullName field is the combination of the folder name and report name. Use these values in the package.xml to designate the members for the Report metadata type.

ReportFolder isn’t returned as a type in describeMetadata(). Report is returned from describeMetadata() with an associated attribute of inFolder set to true. If that attribute is set to true, you can construct the type by using the component name with the word Folder, such as ReportFolder.

The following example shows folders in package.xml:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyDBFolder/MyDBName</members\>
        <name\>Dashboard</name\>
    </types\>
    <types\>
        <members\>MyDocumentFolder/MyDocumentName</members\>
        <name\>Document</name\>
    </types\>
    <types\>
        <members\>unfiled$public/MarketingProductInquiryResponse</members\>
        <members\>unfiled$public/SalesNewCustomerEmail</members\>
        <name\>EmailTemplate</name\>
    </types\>
    <types\>
        <members\>MyReportFolder/MyReportName</members\>
        <name\>Report</name\>
    </types\>
    <version\>68.0</version\>
                        </Package\>

To retrieve or deploy ReportFolders, use the Report metadata type in your package.xml. When you reference a nested folder by itself (without its contents), the API can misinterpret the path as a report component.

For example, the API interprets <members\>TopLevel/SubLevel</members\> as a request for a report named SubLevel.

To correctly reference the nested folder, append a trailing slash (/) to its full name. This syntax explicitly identifies the member as a folder.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>TopLevel/SubLevel/</members\>
        <members\>TopLevel/SubLevel/MyReport</members\>
        <name\>Report</name\>
    </types\>
    <version\>58.0</version\>
</Package\>
                

Omitting the trailing slash (/) for the folder causes the operation to fail with an error: "Entity of type 'Report' named 'TopLevel/SubLevel' cannot be found".

## Version

Report components are available in API version 14.0 and later.

## Fields

The following information assumes that you’re familiar with creating and running reports. For more information on these fields, see [Build a Report](https://help.salesforce.com/s/articleView?id=analytics.rd_reports_build.htm&type=5&language=en_US) in Salesforce Help.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e267">Field</th>

              <th class="featureTableHeader  " id="d806901e270">Field Type</th>

              <th class="featureTableHeader  " id="d806901e273">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">aggregateFilters</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportAggregateFilter">ReportAggregateFilter</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">List that defines filters on custom summary formulas for summary,
                matrix, and joined reports. <p class="p">Available in API version 64.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">aggregates</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportAggregate">ReportAggregate</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">List that defines custom summary formulas for summary, matrix,
                and joined reports. </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname" id="block"><a name="block"><!-- --></a>block</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#" title="Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.">Report</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description"><span class="ph" id="block_desc"><a name="block_desc"><!-- --></a>Represents each block in a joined report
                  where every block can be of a different report
                  type.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname" id="blockInfo"><a name="blockInfo"><!-- --></a>blockInfo</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type"><a class="xref" href="#ReportBlockInfo">ReportBlockInfo</a></td>

              <td class="entry" headers="d806901e273" data-title="Description"><span class="ph" id="blockInfo_desc"><a name="blockInfo_desc"><!-- --></a>Defines attributes for each block in a
                  joined report.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">buckets</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportBucketField">ReportBucketField</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">Defines a bucket field to be used in the report. This field is
                available in API version 24.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">chart</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type"><a class="xref" href="#ReportChart">ReportChart</a></td>

              <td class="entry" headers="d806901e273" data-title="Description">Defines a chart for summary and matrix reports.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">colorRanges</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportColorRange">ReportColorRange</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">List that specifies conditional highlighting for report summary
                data. Salesforce Classic only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">columns</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportColumn">ReportColumn</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">List that specifies the fields displayed in the report. Fields
                appear in the report in the same order as they appear in the
                Metadata API file.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">crossFilters</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportCrossFilter">ReportCrossFilter</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">Defines a cross filter's object, related object, and condition
                (WITH or WITHOUT). This field is available in API version <span class="ph">68.0</span> and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">currency</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <span class="keyword parmname">CurrencyIsoCode</span> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">When using multiple currencies, some reports allow you to display
                converted amounts by selecting the appropriate column to display.
                For example, in opportunity reports, you can include the Amount
                (converted) column on the report. This field is an enumeration of
                type string that defines the currency in which to display converted
                amounts. Valid values: Must be one of the valid alphabetic,
                three-letter currency ISO codes defined by the ISO 4217 standard,
                such as <samp class="codeph nolang">USD</samp>, <samp class="codeph nolang">GBP</samp><samp class="codeph nolang">SLE</samp>, or <samp class="codeph nolang">JPY</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">dataCategoryFilters</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">Specifies a filter according to the data category.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">Specifies a general description, which is displayed with the
                report name. Maximum characters: 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname" id="field_division"><a name="field_division"><!-- --></a>division</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <span class="ph" id="field_division_desc"><a name="field_division_desc"><!-- --></a>If your organization uses divisions
                  to segment data and the Affected by Divisions permission is
                  enabled, records in the report must match this
                  division.</span>
                <p class="p">This field is available in API version 17.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">filter</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type"><a class="xref" href="#ReportFilter">ReportFilter</a></td>

              <td class="entry" headers="d806901e273" data-title="Description">Limits report results to records with specific data. For example,
                you can limit report results to opportunities for which the amount
                is greater than
                $1,000:<div class="codeSection xml">
                  <pre class="codeblock xml"><span class="tag">&lt;filter</span>&gt;
	<span class="tag">&lt;criteriaItems</span>&gt;
		<span class="tag">&lt;column</span>&gt;AMOUNT<span class="tag">&lt;/column</span>&gt;
		<span class="tag">&lt;operator</span>&gt;greaterThan<span class="tag">&lt;/operator</span>&gt;
		<span class="tag">&lt;value</span>&gt;1000<span class="tag">&lt;/value</span>&gt;
	<span class="tag">&lt;/criteriaItems</span>&gt;
<span class="tag">&lt;/filter</span>&gt;</pre>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname" id="report_folderName"><a name="report_folderName"><!-- --></a>folderName</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <span class="ph" id="report_folderName_desc"><a name="report_folderName_desc"><!-- --></a>Name of the folder that houses
                  the report.</span>
                <p class="p">This field is available in API version 35.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">format</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportFormat">ReportFormat</a> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">Defines the report format. For example, <samp class="codeph nolang">Tabular</samp> for a simple data list
                without subtotals.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">formattingRules</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportFormattingRule">ReportFormattingRule[]</a> (enumeration
                of type string)
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">List that specifies conditional highlighting for report data.
                Lightning Experience only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">groupingsAcross</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportGrouping">ReportGrouping</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">List that defines the fields by which you want to group and
                subtotal data across a matrix report (row headings). When grouping
                by a date field, you can further group the data by a specific time
                period such as days, weeks, or months. Maximum: 2 fields.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">groupingsDown</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportGrouping">ReportGrouping</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">For Summary and Matrix reports: List that defines the fields by
                which you want to group and subtotal. For summary reports, choosing
                more than one sort field allows you to subsort your data. For matrix
                reports, specifies summary fields for column headings. When grouping
                by a date field, you can further group the data by a specific time
                period such as days, weeks, or months. Maximum for matrix reports:
                2. Maximum for summary reports: 3</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">historicalSelector</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type"><a class="xref" href="#ReportHistoricalSelector">ReportHistoricalSelector</a></td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <span class="ph" id="historicalselector_desc"><a name="historicalselector_desc"><!-- --></a>Defines a date range for which
                  historical trend reporting data is to be captured. Default is
                  “Any Historical Date.” </span>
                <p class="p">Available in API
                  version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">isSmartTotalDisabled</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <samp class="codeph java">false</samp> displays smart totalling
                on the report.<p class="p">Available in API version 29.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">Required. The report name. For example, <samp class="codeph nolang">Opportunity Pipeline</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">numSubscriptions</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">int</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <span class="ph" id="numSubscriptions_desc"><a name="numSubscriptions_desc"><!-- --></a>Indicates whether a user has
                  subscribed to this report Lightning Experience (1) or not (0).
                  Tied to user context.</span>
                <p class="p">This field is available in API
                  version 38.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">params</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#ReportParam">ReportParam</a>[]
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">List that specifies settings specific to each report type, in
                particular options that let you filter a report to obtain useful
                subsets. For example, the Activities report type lets you specify
                whether you want to see open or closed activities or both and
                whether you want to see tasks or events or both. Valid values depend
                on the report type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="ph" id="reportCustomDetailFormula"><a name="reportCustomDetailFormula"><!-- --></a><span class="keyword parmname">customDetailFormulas</span></span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#CustomDetailFormulas">CustomDetailFormulas</a>
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">Allows you to apply row-level formulas to reports. </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname" id="reporttype"><a name="reporttype"><!-- --></a>reportType</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">Required. Defines the type of data in the report. For example,
                <samp class="codeph xml">Opportunity</samp> to create a report
                of opportunities data.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname" id="reporttypeapiname"><a name="reporttypeapiname"><!-- --></a>reportTypeApiName</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">Defines the API Name for the report type. <p class="p">This field is
                  available in API version 48.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname" id="field_roleHierarchyFilter"><a name="field_roleHierarchyFilter"><!-- --></a>roleHierarchyFilter</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <span class="ph" id="field_roleHierarchyFilter_desc"><a name="field_roleHierarchyFilter_desc"><!-- --></a>The role name for a
                  report drill down. Some reports, such as opportunity and
                  activity reports, display Hierarchy links that allow you to
                  drill down to different datasets based on the role
                  hierarchy.</span>
                <p class="p">This field is available in API version 17.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">rowLimit</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">int</td>

              <td class="entry" headers="d806901e273" data-title="Description">Defines the maximum number of rows that can be returned for the
                report.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">scope</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">Defines the scope of data on which you run the report. For
                example, whether you want to run the report against all
                opportunities, opportunities you own, or opportunities your team
                owns. Valid values depend on the <span class="keyword parmname">reportType</span>.
                For example, for Accounts reports:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">MyAccounts</samp></li>

                  <li class="li"><samp class="codeph nolang">MyTeamsAccounts</samp></li>

                  <li class="li"><samp class="codeph nolang">AllAccounts</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">showCommonRowsOnly</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e273" data-title="Description">Indicates whether the report shows common rows only
                (<span class="keyword parmname">true)</span> or not (<span class="keyword parmname">false</span>).
                Default is <span class="keyword parmname">false</span>.<p class="p">Available in API version
                  67.0 and later</p>
                .</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">showCurrentDate</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <span class="ph" id="showcurrentdate_desc"><a name="showcurrentdate_desc"><!-- --></a>Can be set to <samp class="codeph java">true</samp> for historical trending
                  reports in matrix format.</span>
                <p class="p">Available in API version 29.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">showDetails</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <samp class="codeph java">false</samp> shows a collapsed view
                of the report with only the headings, subtotals, and total. Default:
                <samp class="codeph java">true</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">showGrandTotal</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <samp class="codeph java">true</samp> displays the calculated
                total for the full report.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">showSubTotals</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <samp class="codeph java">true</samp> displays the calculated
                subtotals for sections of the report.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="ph" id="sortcol"><a name="sortcol"><!-- --></a><span class="keyword parmname">sortColumn</span></span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">Specifies the field on which to sort data in the report. Use
                <span class="keyword parmname">sortOrder</span> to specify the sort
                order.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="ph" id="SortOrder_field"><a name="SortOrder_field"><!-- --></a><span class="keyword parmname">sortOrder</span></span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">
                <a class="xref" href="#SortOrder">SortOrder</a> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d806901e273" data-title="Description">Specifies the sort order. Use <span class="keyword parmname">sortColumn</span> to
                specify the field on which to sort.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname" id="field_territoryHierarchyFilter"><a name="field_territoryHierarchyFilter"><!-- --></a>territoryHierarchyFilter</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <span class="ph" id="field_territoryHierarchyFilter_desc"><a name="field_territoryHierarchyFilter_desc"><!-- --></a>The territory name
                  for a report drill down. If your organization uses territory
                  management, some reports display Hierarchy links that allow you
                  to drill down to different datasets based on the territory
                  hierarchy.</span>
                <p class="p">This field is available in API version 17.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname">timeFrameFilter</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type"><a class="xref" href="#ReportTimeFrameFilter">ReportTimeFrameFilter</a></td>

              <td class="entry" headers="d806901e273" data-title="Description">Limits report results to records within a specified time
                frame.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e267" data-title="Field"><span class="keyword parmname" id="field_userFilter"><a name="field_userFilter"><!-- --></a>userFilter</span></td>

              <td class="entry" headers="d806901e270" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e273" data-title="Description">
                <span class="ph" id="field_userFilter_desc"><a name="field_userFilter_desc"><!-- --></a>The username for a report drill
                  down. Some reports, such as opportunity and activity reports,
                  display Hierarchy links that allow you to drill down to
                  different datasets based on the user hierarchy.</span>
                <p class="p">This
                  field is available in API version 17.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ReportAggregateFilter

ReportAggregateFilter defines custom summary formula filters on summary, matrix, and joined reports.

| Field | Field Type | Description |
| --- | --- | --- |
| aggregate | string | Required. The name of the report aggregate to apply the filter to. |
| operator | string | Required. The filter operator. |
| value | string | Required. The filter value. |

## ReportAggregate

ReportAggregate defines custom summary formulas on summary, matrix, and joined reports. For more information on these fields, see [Add a Summary Formula Column to a Report](https://help.salesforce.com/s/articleView?id=analytics.building_custom_summary_formulas.htm&type=5&language=en_US) in Salesforce Help.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e1080">Field</th>

              <th class="featureTableHeader  " id="d806901e1083">Field Type</th>

              <th class="featureTableHeader  " id="d806901e1086">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">acrossGroupingContext</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1086" data-title="Description">Defines the row grouping level at which you want your custom
                summary formula to be displayed. This field is available in API
                version 15.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">calculatedFormula</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1086" data-title="Description">Required. The custom summary formula. For example, <samp class="codeph xml">AMOUNT:SUM + OPP_QUANTITY:SUM</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">datatype</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">
                <a class="xref" href="#ReportAggregateDatatype">ReportAggregateDatatype</a> (enumeration
                of type string)
              </td>

              <td class="entry" headers="d806901e1086" data-title="Description">Required. Specifies the data type for formatting and display of
                the custom summary formula results.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1086" data-title="Description">The custom summary formula description. Maximum: 255
                characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1086" data-title="Description">Required. The internal development name of the custom summary
                formula, for example, <samp class="codeph nolang">FORMULA1</samp>.
                This name is used to reference custom summary formulas from other
                report components, including conditional highlighting.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">downGroupingContext</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1086" data-title="Description">Defines the column grouping level at which you want your custom
                summary formula to be displayed. This field is available in API
                version 15.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e1086" data-title="Description">Required. <samp class="codeph java">true</samp> displays the
                formula result in the report. <samp class="codeph java">false</samp> doesn’t display the result in the
                report.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">isCrossBlock</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e1086" data-title="Description">
                <span class="ph" id="isCrossBlockDef"><a name="isCrossBlockDef"><!-- --></a>Determines whether the custom summary
                  formula is a cross-block formula, which is available with joined
                  reports. <samp class="codeph java">true</samp> indicates a
                  cross-block custom summary formula. <samp class="codeph java">false</samp> indicates a standard custom summary
                  formula.</span>
                <p class="p">This field is available in API version 25.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1086" data-title="Description">Required. The custom summary formula label (name). </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname" id="reportType"><a name="reportType"><!-- --></a>reportType</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1086" data-title="Description">
                <span class="ph" id="reportType_desc"><a name="reportType_desc"><!-- --></a>Required for joined reports. Specifies
                  the <span class="keyword parmname">reportType</span> of the blocks to which the
                  <span class="keyword parmname">aggregate</span> can be added.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1080" data-title="Field"><span class="keyword parmname">scale</span></td>

              <td class="entry" headers="d806901e1083" data-title="Field Type">int</td>

              <td class="entry" headers="d806901e1086" data-title="Description">The formula result is calculated to the specified number of
                decimal places. Valid values <samp class="codeph nolang">0</samp>
                through <samp class="codeph nolang">18</samp>.</td>

            </tr>

          </tbody>

        </table>

## ReportBlockInfo

ReportBlockInfo defines blocks in a joined report.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e1300">Field</th>

              <th class="featureTableHeader  " id="d806901e1303">Field Type</th>

              <th class="featureTableHeader  " id="d806901e1306">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e1300" data-title="Field"><span class="keyword parmname">aggregateReferences</span></td>

              <td class="entry" headers="d806901e1303" data-title="Field Type">
                <a class="xref" href="#ReportAggregateReference">ReportAggregateReference</a>[]
              </td>

              <td class="entry" headers="d806901e1306" data-title="Description">Lists the <span class="keyword parmname">aggregates</span> that represent the
                custom summary formulas used in a joined report block. </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1300" data-title="Field"><span class="keyword parmname">blockId</span></td>

              <td class="entry" headers="d806901e1303" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1306" data-title="Description">
                <span class="ph" id="blockIDDef"><a name="blockIDDef"><!-- --></a>Required. <span class="keyword parmname">blockId</span> is
                  used in cross-block custom summary formulas and joined report
                  charts to identify the block containing each summary field.
                  <span class="keyword parmname">blockId</span> is assigned automatically.
                  Valid values are B1 through B5. </span>
                <p class="p">This field is available
                  in API version 25.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1300" data-title="Field"><span class="keyword parmname">joinTable</span></td>

              <td class="entry" headers="d806901e1303" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1306" data-title="Description">Required. Refers to the entity used to join blocks in a joined
                report. The entity provides a list of fields that are available for
                globally grouping across the blocks.</td>

            </tr>

          </tbody>

        </table>

## ReportAggregateReference

ReportAggregateReference defines the developer name used for custom summary formulas in joined reports.

| Field | Field Type | Description |
| --- | --- | --- |
| aggregate | string | Required. The developerName of the ReportAggregate, which specifies the custom summary formula used in a block of a joined report. |

## ReportBucketField

ReportBucketField defines a bucket to be used in the report.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e1449">Field</th>

              <th class="featureTableHeader  " id="d806901e1452">Field Type</th>

              <th class="featureTableHeader  " id="d806901e1455">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e1449" data-title="Field"><span class="keyword parmname">bucketType</span></td>

              <td class="entry" headers="d806901e1452" data-title="Field Type">ReportBucketFieldType (enumeration of type string)</td>

              <td class="entry" headers="d806901e1455" data-title="Description">Required. Specifies the type of bucket. Valid values:<ul class="ul bulletList">
                  <li class="li">text</li>

                  <li class="li">number</li>

                  <li class="li">picklist</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1449" data-title="Field"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d806901e1452" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1455" data-title="Description">Required. A unique name used as the <samp class="codeph xml"><span class="tag">&lt;field</span>&gt;</samp> value to display a bucket field in the
                column list and other report components, including sort, filter,
                list, group, and chart. Must be of the format <samp class="codeph nolang">BucketField_<var class="keyword varname">name</var></samp>. For example, <samp class="codeph nolang">BucketField_BusinessSize</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1449" data-title="Field"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d806901e1452" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1455" data-title="Description">Required. The bucket field label. Maximum 40 characters. Any line
                breaks, tabs, or multiple spaces at the beginning or end of the
                label are removed. Any of these characters within the label are
                reduced to a single space.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1449" data-title="Field"><span class="keyword parmname">nullTreatment</span></td>

              <td class="entry" headers="d806901e1452" data-title="Field Type">ReportBucketFieldNullTreatment (enumeration of type
                string)</td>

              <td class="entry" headers="d806901e1455" data-title="Description">For numeric bucket fields only. Specifies whether empty values
                are treated as zeros (<samp class="codeph nolang">z</samp>) or not
                (<samp class="codeph nolang">n</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1449" data-title="Field"><span class="keyword parmname">otherBucketLabel</span></td>

              <td class="entry" headers="d806901e1452" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1455" data-title="Description">The label of the container for unbucketed values.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1449" data-title="Field"><span class="keyword parmname">sourceColumnName</span></td>

              <td class="entry" headers="d806901e1452" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1455" data-title="Description">Required. The source field that the bucket is applied to. For
                example, <samp class="codeph nolang">SALES</samp> or <samp class="codeph nolang">INDUSTRY</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1449" data-title="Field"><span class="keyword parmname" id="BucketFieldValues"><a name="BucketFieldValues"><!-- --></a>values</span></td>

              <td class="entry" headers="d806901e1452" data-title="Field Type">
                <a class="xref" href="#ReportBucketFieldValue">ReportBucketFieldValue</a>
                (enumeration of type string)
              </td>

              <td class="entry" headers="d806901e1455" data-title="Description">Defines one bucket value used in the bucket field.<p class="p">While this
                  name is plural, it represents a single bucket. In typical use, a
                  bucket field contains multiple buckets.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ReportBucketFieldValue

ReportBucketFieldValue defines a bucket value used in the bucket field.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e1619">Field</th>

              <th class="featureTableHeader  " id="d806901e1622">Field Type</th>

              <th class="featureTableHeader  " id="d806901e1625">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e1619" data-title="Field"><span class="keyword parmname">sourceValues</span></td>

              <td class="entry" headers="d806901e1622" data-title="Field Type">ReportBucketFieldSourceValue (enumeration of type string)</td>

              <td class="entry" headers="d806901e1625" data-title="Description">The value of a bucket in the bucket field. Valid values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">sourceValue</samp>—Used
                    for picklist and text bucket fields. For picklists,
                    describes the picklist item in the bucket. For example, the
                    sourceValue of a bucket on <samp class="codeph nolang">TYPE</samp> could be <samp class="codeph nolang">Customer</samp>. For text, the full string for the
                    item in the bucket. For example, the sourceValue of a bucket
                    on <samp class="codeph nolang">ADDRESS_STATE1</samp> could
                    be <samp class="codeph nolang">NY</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">from</samp>—Used only
                    on numeric bucket fields. A non-inclusive lower bound for a
                    numeric bucket range. This value must be a number.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">to</samp>—Used only on
                    numeric bucket fields. The inclusive upper bound for a
                    numeric bucket range. This value must be a number.
                  </li>

                </ul>
                <p class="p">In numeric buckets, the first value must only have <samp class="codeph nolang">to</samp> and last value must only
                  have <samp class="codeph nolang">from</samp>. All other values
                  must have both <samp class="codeph nolang">to</samp> and
                  <samp class="codeph nolang">from</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1619" data-title="Field"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d806901e1622" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1625" data-title="Description">Required. The name of a specific bucket value within the bucket
                field.</td>

            </tr>

          </tbody>

        </table>

## ReportGrouping

ReportGrouping defines how to group, subtotal, and sort data for summary, matrix, and joined reports.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e1727">Field</th>

              <th class="featureTableHeader  " id="d806901e1730">Field Type</th>

              <th class="featureTableHeader  " id="d806901e1733">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e1727" data-title="Field"><span class="keyword parmname" id="aggregatetype"><a name="aggregatetype"><!-- --></a>aggregateType</span></td>

              <td class="entry" headers="d806901e1730" data-title="Field Type">ReportAggrType (enumeration of type string) </td>

              <td class="entry" headers="d806901e1733" data-title="Description">
                <span class="ph" id="aggregateTypeDesc"><a name="aggregateTypeDesc"><!-- --></a>The type of aggregate value to sort
                  by.</span> Valid values are:<a name="aggregateTypeValues"><!-- --></a>
                <ul class="ul bulletList" id="aggregateTypeValues">
                  <li class="li"><samp class="codeph nolang">Sum</samp></li>

                  <li class="li"><samp class="codeph nolang">Average</samp></li>

                  <li class="li"><samp class="codeph nolang">Maximum</samp></li>

                  <li class="li"><samp class="codeph nolang">Minimum</samp></li>

                  <li class="li"><samp class="codeph nolang">RowCount</samp></li>

                  <li class="li"><samp class="codeph nolang">Unique</samp></li>

                  <li class="li"><samp class="codeph nolang">Median</samp></li>

                  <li class="li"><samp class="codeph nolang">Noop</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1727" data-title="Field"><span class="keyword parmname">dateGranularity</span></td>

              <td class="entry" headers="d806901e1730" data-title="Field Type">
                <a class="xref" href="#UserDateGranularity">UserDateGranularity</a> (enumeration of
                type string)
              </td>

              <td class="entry" headers="d806901e1733" data-title="Description">When grouping by a date field, the time period by which to
                group.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1727" data-title="Field"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d806901e1730" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1733" data-title="Description">Required. The field by which you want to summarize data. For
                example, <samp class="codeph nolang">CAMPAIGN_SOURCE</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1727" data-title="Field"><span class="keyword parmname">hierarchyApiName</span></td>

              <td class="entry" headers="d806901e1730" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1733" data-title="Description">The hierarchy API name for this report.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1727" data-title="Field"><span class="keyword parmname">sortByName</span></td>

              <td class="entry" headers="d806901e1730" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1733" data-title="Description">The API name of the column, aggregate, or custom summary field
                used to order the grouping.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1727" data-title="Field"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d806901e1730" data-title="Field Type"><a class="xref" href="#SortOrder">SortOrder</a></td>

              <td class="entry" headers="d806901e1733" data-title="Description">Required. Whether to sort data in ascending or descending
                alphabetical and numerical order.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e1727" data-title="Field"><span class="keyword parmname">sortType</span></td>

              <td class="entry" headers="d806901e1730" data-title="Field Type">ReportSortType (enumeration of type string)</td>

              <td class="entry" headers="d806901e1733" data-title="Description">
                <span class="ph" id="sortTypeDesc"><a name="sortTypeDesc"><!-- --></a>Indicates if the grouping is sorted by a
                  column, aggregate, or custom summary field.</span> Valid values
                are:<a name="sortTypeValues"><!-- --></a>
                <ul class="ul bulletList" id="sortTypeValues">
                  <li class="li"><samp class="codeph nolang">Column</samp></li>

                  <li class="li"><samp class="codeph nolang">Aggregate</samp></li>

                  <li class="li"><samp class="codeph nolang">CustomSummaryFormula</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## ReportHistoricalSelector

ReportHistoricalSelector defines a date range for historical data.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e1918">Field</th>

              <th class="featureTableHeader  " id="d806901e1921">Field Type</th>

              <th class="featureTableHeader  " id="d806901e1924">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e1918" data-title="Field"><span class="keyword parmname">snapshot</span></td>

              <td class="entry" headers="d806901e1921" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e1924" data-title="Description">Represents the date value to apply a historical filter, either
                relative (in the format <samp class="codeph nolang">N_DAYS_AGO:2</samp>) or absolute (in the format <samp class="codeph nolang">yyyy-MM-dd</samp>). If unspecified, it’s
                assumed that the filter is applied to all the columns the user
                sees.<p class="p">Available in API version 29.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## CustomDetailFormulas

CustomDetailFormulas defines row-level formulas for reports.

| Field | Field Type | Description |
| --- | --- | --- |
| calculatedFormula | string | Required. The custom formula. For example, AMOUNT:SUM + OPP\_QUANTITY:SUM |
| datatype | [ReportCustomDetailFormulaDatatype](#ReportCustomDetailFormulaDatatype) (enumeration of type string) | Required. Specifies the data type for formatting and display of the formula results. |
| description | string | The formula description. Maximum: 255 characters. |
| developerName | string | Required. The internal development name of the formula, for example, FORMULA1. This name is used to reference custom formulas from other report components, including conditional highlighting. |
| label | string | Required. The name that identifies this formula. |
| scale | int | The formula result is calculated to the specified number of decimal places. Valid values 0 through 18. |

## ReportCustomDetailFormulaDatatype

An enumeration of type string that specifies the data type for formatting and display of row-level formula results. Valid values:

| Enumeration Value |
| --- |
| Double |
| DateOnly |
| DateTime |
| Text |

## SortOrder

An enumeration of type string that defines the order in which data is sorted in the report fields. Valid values:

| Field | Description |
| --- | --- |
| Asc | Sorts data in ascending alphabetical and numerical order. |
| Desc | Sorts data in descending alphabetical and numerical order. |

## UserDateGranularity

An enumeration of type string that defines the time period by which to group data. Valid values:

| Enumeration Value | Description |
| --- | --- |
| None | No grouping by date |
| Day | By day |
| Week | By week |
| Month | By month |
| Quarter | By quarter |
| Year | By year |
| FiscalQuarter | By fiscal quarter. You can set the fiscal year for your organization. See [Set the Fiscal Year](https://help.salesforce.com/s/articleView?id=xcloud.setting_the_fiscal_year.htm&type=5&language=en_US) in Salesforce Help. |
| FiscalYear | By fiscal year |
| MonthInYear | By calendar month in year |
| DayInMonth | By calendar day in month |
| FiscalPeriod | When custom fiscal years are enabled: By fiscal period |
| FiscalWeek | When custom fiscal years are enabled: By fiscal week |

## ReportSummaryType

An enumeration of type string that defines how report fields are summarized. Valid values:

| Enumeration Value | Description |
| --- | --- |
| Sum | Total |
| Average | Average |
| Maximum | Largest value |
| Minimum | Smallest value |
| Unique | Unique values |
| Median | Median value |
| Noop | The summary is a no-op. |
| None | The field isn’t summarized. |

## ReportColorRange

ReportColorRange defines conditional highlighting for report summary data.

| Field | Field Type | Description |
| --- | --- | --- |
| aggregate | [ReportSummaryType](#ReportSummaryType) (enumeration of type string) | Required. Defines how the field specified in columnName is summarized. For example, Sum. |
| columnName | string | Required. Specifies the field whose value ranges are represented by background colors. |
| highBreakpoint | double | Required. Specifies the number that separates the mid color from the high color. |
| highColor | string | Required. Specifies the color (in HTML format) to represent data that falls into the high number range. This color spans from the highBreakpoint value. |
| lowBreakpoint | double | Required. Specifies the number that separates the low color from the mid color. |
| lowColor | string | Required. Specifies a color (in HTML format) to represent data that falls into the low value range, below the lowBreakpoint value. |
| midColor | string | Required. Specifies a color (in HTML format) to represent data that falls into the mid value range. |

## ReportColumn

ReportColumn defines how fields (columns) are displayed in the report.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e2643">Field</th>

              <th class="featureTableHeader  " id="d806901e2646">Field Type</th>

              <th class="featureTableHeader  " id="d806901e2649">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e2643" data-title="Field"><span class="keyword parmname">aggregateTypes</span></td>

              <td class="entry" headers="d806901e2646" data-title="Field Type">
                <a class="xref" href="#ReportSummaryType">ReportSummaryType</a>[] (enumeration of
                type string)
              </td>

              <td class="entry" headers="d806901e2649" data-title="Description">List that defines if and how each report field is summarized.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2643" data-title="Field"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d806901e2646" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e2649" data-title="Description">Required. The field name. For example, <samp class="codeph nolang">AGE</samp> or <samp class="codeph nolang">OPPORTUNITY_NAME</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2643" data-title="Field"><span class="keyword parmname">isExtendedColumn</span></td>

              <td class="entry" headers="d806901e2646" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e2649" data-title="Description">Indicates whether the column is extended
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                <p class="p">Available in API version 65.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2643" data-title="Field"><span class="keyword parmname">reverseColors</span></td>

              <td class="entry" headers="d806901e2646" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e2649" data-title="Description">
                <span class="ph" id="reversecolors_desc"><a name="reversecolors_desc"><!-- --></a>In historical trend reports, displays
                  greater Date values as green and greater Amount values as red,
                  reversing the default colors.</span>
                <p class="p">Available in API version
                  29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2643" data-title="Field"><span class="keyword parmname">showChanges</span></td>

              <td class="entry" headers="d806901e2646" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e2649" data-title="Description">
                <span class="ph" id="showchanges_desc"><a name="showchanges_desc"><!-- --></a>In historical trend reports, adds a
                  column displaying the difference between current and historical
                  Date and Amount values.</span>
                <p class="p">Available in API version 29.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ReportFilter

ReportFilter limits the report results by filtering data on specified fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e2771">Field</th>

              <th class="featureTableHeader  " id="d806901e2774">Field Type</th>

              <th class="featureTableHeader  " id="d806901e2777">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e2771" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d806901e2774" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e2777" data-title="Description">Specifies filter logic conditions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2771" data-title="Field"><span class="keyword parmname">criteriaItems</span></td>

              <td class="entry" headers="d806901e2774" data-title="Field Type"><a class="xref" href="#ReportFilterItem">ReportFilterItem</a></td>

              <td class="entry" headers="d806901e2777" data-title="Description">The criteria by which you want to filter report data, either by
                comparing historical values or by applying a date
                range.<div class="codeSection xml">
                  <pre class="codeblock xml"><span class="tag">&lt;criteriaItems</span>&gt;
   criteriaItems ReportFilterItem
   <span class="tag">&lt;column</span>&gt;Opportunity.Opportunity__hd$Amount__hst<span class="tag">&lt;/column</span>&gt;
   <span class="tag">&lt;columnToColumn</span>&gt;false<span class="tag">&lt;/columnToColumn</span>&gt;
   <span class="tag">&lt;operator</span>&gt;equals<span class="tag">&lt;/operator</span>&gt;
   <span class="tag">&lt;snapshot</span>&gt;N_DAYS_AGO:90<span class="tag">&lt;/snapshot</span>&gt;
   <span class="tag">&lt;value</span>&gt;100<span class="tag">&lt;/value</span>&gt;
<span class="tag">&lt;/criteriaItems</span>&gt;</pre>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2771" data-title="Field"><span class="keyword parmname">language</span></td>

              <td class="entry" headers="d806901e2774" data-title="Field Type">Language (enumeration of type string)</td>

              <td class="entry" headers="d806901e2777" data-title="Description">The language used when a report filters against a picklist value
                using the operators <samp class="codeph soql">contains</samp> or
                <samp class="codeph soql">startsWith</samp>. For a list of
                valid language values, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm" title="Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.">Language</a>.
              </td>

            </tr>

          </tbody>

        </table>

## ReportFilterItem

ReportFilterItem limits the report results by filtering data on specified fields.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e2869">Field</th>

              <th class="featureTableHeader  " id="d806901e2872">Field Type</th>

              <th class="featureTableHeader  " id="d806901e2875">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e2869" data-title="Field"><span class="keyword parmname">column</span></td>

              <td class="entry" headers="d806901e2872" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e2875" data-title="Description">Required. The field in which to filter data. For example, <samp class="codeph xml">AMOUNT</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2869" data-title="Field"><span class="keyword parmname">columnToColumn</span></td>

              <td class="entry" headers="d806901e2872" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e2875" data-title="Description">
                <p class="p">Indicates whether the filter is a column-to-column
                  (field-to-field) filter.</p>

                <p class="p">Available in API version 29.0 and later for historical trending
                  reports. Available in API version 48.0 and later for general
                  reports.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2869" data-title="Field"><span class="keyword parmname">isUnlocked</span></td>

              <td class="entry" headers="d806901e2872" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e2875" data-title="Description">Optional. Indicates whether the report filter is unlocked
                (<samp class="codeph java">true</samp>) or locked (<samp class="codeph java">false</samp>). You can edit unlocked filters
                on the report run page in Lightning Experience. If unspecified, the
                default value is <samp class="codeph java">false</samp>.<p class="p">Available in API version 38.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2869" data-title="Field"><span class="keyword parmname">operator</span></td>

              <td class="entry" headers="d806901e2872" data-title="Field Type">FilterOperation (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d806901e2875" data-title="Description">Required. An enumeration of type string that defines the operator
                used to filter the data, for example, <samp class="codeph soql">greaterThan</samp>. Valid values are: <a name="ul_msr_vtr_q3c"><!-- --></a>
                <ul class="ul bulletList" id="ul_msr_vtr_q3c">
                  <li class="li"><samp class="codeph soql">equals</samp></li>

                  <li class="li"><samp class="codeph soql">notEqual</samp></li>

                  <li class="li"><samp class="codeph soql">lessThan</samp></li>

                  <li class="li"><samp class="codeph soql">greaterThan</samp></li>

                  <li class="li"><samp class="codeph soql">lessOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">greaterOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">contains</samp></li>

                  <li class="li"><samp class="codeph soql">notContain</samp></li>

                  <li class="li"><samp class="codeph soql">startsWith</samp></li>

                  <li class="li"><samp class="codeph soql">includes</samp></li>

                  <li class="li"><samp class="codeph soql">excludes</samp></li>

                  <li class="li">
                    <samp class="codeph soql">within</samp> (<samp class="codeph nolang">DISTANCE</samp> criteria
                    only)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2869" data-title="Field"><span class="keyword parmname">snapshot</span></td>

              <td class="entry" headers="d806901e2872" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e2875" data-title="Description">Represents the date value, either relative (in the format <samp class="codeph nolang">N_DAYS_AGO:2</samp>) or absolute (in the
                format <samp class="codeph nolang">yyyy-MM-dd</samp>).<p class="p">Available
                  in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e2869" data-title="Field"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d806901e2872" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e2875" data-title="Description">The value by which you want to filter the data, for example,
                <samp class="codeph xml">1000</samp>. The Metadata API filter
                condition values don’t always match the values that you enter in the
                report wizard. For example, in the Metadata API dates are always
                converted to the US date format and values entered in a non-US
                English language can be converted to a standard US English
                equivalent.
              </td>

            </tr>

          </tbody>

        </table>

## ReportFormat

An enumeration of type string that defines the report format. Valid values:

| Enumeration Value | Description |
| --- | --- |
| Matrix | Summarizes data in a grid. Use to compare related totals. |
| Summary | Lists, sorts, and subtotals data. |
| Tabular | Lists data with no sorting or subtotals. |
| Joined | Joins data from different report types storing each report’s data in its own block. |

## ReportFormattingRule

Defines conditional highlighting for report summary data. You can specify up to 5 formatting rules per report.

| Field | Field Type | Description |
| --- | --- | --- |
| aggregate | [ReportFormattingSummaryType](#ReportFormattingSummaryType) (enumeration of type string) | Defines how the field specified in columnName is summarized. For example, Sum. |
| columnName | string | Required. Specifies the field whose value ranges are represented by colors. |
| values | [ReportFormattingRuleValue](#ReportFormattingRuleValue) (enumeration of type string) | Required. Specifies the background colors and associated ranges for formatted data values. |

## ReportFormattingSummaryType

An enumeration of type string that defines how report fields are summarized. Valid values:

| Enumeration Value | Description |
| --- | --- |
| Sum | Total |
| Average | Average |
| Maximum | Largest value |
| Minimum | Smallest value |
| Unique | Unique values |

## ReportFormattingRuleValue

Specifies the background colors and associated ranges for formatted data values. You can specify up to 3 background colors and 0–3 range upper bounds. Valid values:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e3328">Field</th>

              <th class="featureTableHeader  " id="d806901e3331">Field Type</th>

              <th class="featureTableHeader  " id="d806901e3334">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e3328" data-title="Field"><span class="keyword parmname">backgroundColor</span></td>

              <td class="entry" headers="d806901e3331" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e3334" data-title="Description">(Required) Specifies a highlighting color for the field in
                <samp class="codeph nolang">columnName</samp>. Must be a valid
                hex color string such as #54C254. At least one color is required.
                You can optionally specify a different color for up to 3 ranges as
                determined by <samp class="codeph nolang">rangeUpperBound</samp>.
                If you don’t specify a color for a particular range, the background
                is transparent.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3328" data-title="Field"><span class="keyword parmname">rangeUpperBound</span></td>

              <td class="entry" headers="d806901e3331" data-title="Field Type">double</td>

              <td class="entry" headers="d806901e3334" data-title="Description">Delineates a range to which a background color applies. If you
                don’t specify an upper bound for a particular range, the bound is
                assumed to be plus infinity. The following example sets the
                background color for the Sales column to #B50E03 for aggregate sales
                less than or equal to 100, sets no background for sales from 100 to
                1000, and sets the background color to #006714 for sales greater
                than 1000. <div class="codeSection xml">
                  <pre class="codeblock xml"><span class="tag">&lt;formattingRules</span>&gt;
	<span class="tag">&lt;aggregate</span>&gt;Sum<span class="tag">&lt;/aggregate</span>&gt;
	<span class="tag">&lt;columnName</span>&gt;Sales<span class="tag">&lt;/columnName</span>&gt;
        <span class="tag">&lt;values</span>&gt;
            <span class="tag">&lt;backgroundColor</span>&gt;#B50E03<span class="tag">&lt;/backgroundColor</span>&gt; 
            <span class="tag">&lt;rangeUpperBound</span>&gt;100.0<span class="tag">&lt;/rangeUpperBound</span>&gt;
        <span class="tag">&lt;/values</span>&gt;
        <span class="tag">&lt;values</span>&gt;
            <span class="tag">&lt;rangeUpperBound</span>&gt;1000.0<span class="tag">&lt;/rangeUpperBound</span>&gt;
        <span class="tag">&lt;/values</span>&gt;
        <span class="tag">&lt;values</span>&gt;
            <span class="tag">&lt;backgroundColor</span>&gt;#006714<span class="tag">&lt;/backgroundColor</span>&gt;
        <span class="tag">&lt;/values</span>&gt;
<span class="tag">&lt;/formattingRules</span>&gt;</pre>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## ReportParam

ReportParam represents settings specific to a report type, especially options that let you filter a report to certain useful subsets.

| Field | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Specifies a specific reportType setting. |
| value | string | Required. The setting value. |

## ReportAggregateDatatype

An enumeration of type string that specifies the data type for formatting and display of custom summary formula results. Valid values:

| Enumeration Value |
| --- |
| currency |
| number |
| percent |

## ReportChart

ReportChart represents charts on summary, matrix, and joined reports.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e3520">Field</th>

              <th class="featureTableHeader  " id="d806901e3523">Field Type</th>

              <th class="featureTableHeader  " id="d806901e3526">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="ph" id="backgroundColor1"><a name="backgroundColor1"><!-- --></a><span class="keyword parmname">backgroundColor1</span></span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e3526" data-title="Description">Specifies the beginning color (in HTML format) for a gradient
                color background.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="ph" id="backgroundColor2"><a name="backgroundColor2"><!-- --></a><span class="keyword parmname">backgroundColor2</span></span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e3526" data-title="Description">Specifies the end color (in HTML format) for a gradient color
                background.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">backgroundFadeDir</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">ChartBackgroundDirection (enumeration of type string)</td>

              <td class="entry" headers="d806901e3526" data-title="Description">Specifies the direction for a gradient color background. Use with
                <span class="keyword parmname">backgroundColor1</span> to specify the beginning
                color and <span class="keyword parmname">backgroundColor2</span> to specify the end
                color for the gradient design. Use white for both if you don’t want
                a background design. Valid values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Diagonal</samp></li>

                  <li class="li"><samp class="codeph nolang">LeftToRight</samp></li>

                  <li class="li"><samp class="codeph nolang">TopToBottom</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname"><span class="ph" id="ChartSummaries"><a name="ChartSummaries"><!-- --></a>chartSummaries</span></span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">
                <a class="xref" href="#ChartSummary">ChartSummary</a>[]
              </td>

              <td class="entry" headers="d806901e3526" data-title="Description">
                <span class="ph" id="ChartSummariesDesc"><a name="ChartSummariesDesc"><!-- --></a>Specifies the summaries you want to
                  use for the chart.</span> Invalid summaries are ignored without
                notification. If there are no valid summaries, RowCount is used by
                default for the axis value. This field is available in API version
                17.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname"><span class="ph" id="chartType"><a name="chartType"><!-- --></a>chartType</span></span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">
                <a class="xref" href="#ChartType">ChartType</a> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d806901e3526" data-title="Description"><span class="ph" id="chartTypeDescription"><a name="chartTypeDescription"><!-- --></a>Required. Specifies the chart type.
                  Available chart types depend on the <span class="keyword parmname">report
                    type</span>.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname" id="EnableHoverLabels"><a name="EnableHoverLabels"><!-- --></a>enableHoverLabels</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e3526" data-title="Description">
                <span class="ph" id="EnableHoverDesc"><a name="EnableHoverDesc"><!-- --></a>Specifies whether to display values,
                  labels, and percentages when hovering over charts. Hover details
                  depend on chart type. Percentages apply to pie, donut, and
                  funnel charts only.</span> This field is available in API version
                17.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname"><span class="ph" id="ExpandOthers"><a name="ExpandOthers"><!-- --></a>expandOthers</span></span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e3526" data-title="Description">
                <span class="ph" id="ExpandOthersDesc"><a name="ExpandOthersDesc"><!-- --></a>Specifies whether to combine all groups
                  less than or equal to 3% of the total into a single 'Others'
                  wedge or segment. Only applies to pie, donut, and funnel charts.
                  Set to <samp class="codeph java">true</samp> to show all
                  values individually on the chart; set to <samp class="codeph java">false</samp> to combine small groups
                  into 'Others.'</span> This field is available in API version 17.0
                and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname" id="GroupingColumn"><a name="GroupingColumn"><!-- --></a>groupingColumn</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e3526" data-title="Description"><span class="ph" id="GroupingColumnDesc"><a name="GroupingColumnDesc"><!-- --></a>Specifies the field by which to group
                  data. This data is displayed on the X-axis for vertical column
                  charts and on the Y-axis for horizontal bar charts.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">legendPosition</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">ChartLegendPosition (enumeration of type string)</td>

              <td class="entry" headers="d806901e3526" data-title="Description">Required.<p class="p">The location of the legend with respect to the chart.
                  The valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Bottom</samp></li>

                  <li class="li"><samp class="codeph nolang">OnChart</samp></li>

                  <li class="li"><samp class="codeph nolang">Right</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">location</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">
                <a class="xref" href="#ChartPosition">ChartPosition</a> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d806901e3526" data-title="Description">Required. Specifies whether the chart is displayed at the top or
                bottom of the report.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">secondaryGroupingColumn</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e3526" data-title="Description">For grouped chart types: Specifies the field by which to group
                the data.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">showAxisLabels</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e3526" data-title="Description">For bar and line charts: Specifies whether the chart displays
                names for each axis.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname"><span class="ph" id="showPercentage"><a name="showPercentage"><!-- --></a>showPercentage</span></span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e3526" data-title="Description"><span class="ph" id="showPercentageDescription"><a name="showPercentageDescription"><!-- --></a>Indicates if percentages are
                  displayed for wedges and segments of pie, donut, and funnel
                  charts, as well as for gauges (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>).</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname"><span class="ph" id="showTotal"><a name="showTotal"><!-- --></a>showTotal</span></span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e3526" data-title="Description"><span class="ph" id="showTotalDescription"><a name="showTotalDescription"><!-- --></a>Indicates if the total is displayed
                  for donut charts and gauges (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>).</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname"><span class="ph" id="showValues"><a name="showValues"><!-- --></a>showValues</span></span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">boolean</td>

              <td class="entry" headers="d806901e3526" data-title="Description"><span class="ph" id="showValueDescription"><a name="showValueDescription"><!-- --></a>Indicates if the values of
                  individual records or groups are displayed for charts (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>).</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">size</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">
                <a class="xref" href="#ChartSize">ReportChartSize</a> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d806901e3526" data-title="Description">Required. Specifies the chart size.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname" id="SummaryAggregate"><a name="SummaryAggregate"><!-- --></a>summaryAggregate</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">
                <a class="xref" href="#ReportSummaryType">ReportSummaryType</a> (enumeration of type string)
              </td>

              <td class="entry" headers="d806901e3526" data-title="Description">Defines how to summarize the chart data. For example, <samp class="codeph soql">Sum</samp>. <span class="ph" id="SeeChartSummaries"><a name="SeeChartSummaries"><!-- --></a>No
                  longer supported in version API 17.0 and later. See
                  <span class="keyword parmname">chartSummaries</span>.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">summaryAxisManualRangeEnd</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">double</td>

              <td class="entry" headers="d806901e3526" data-title="Description">When specifying the axis range manually: Defines the ending
                value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">summaryAxisManualRangeStart</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">double</td>

              <td class="entry" headers="d806901e3526" data-title="Description">When specifying the axis range manually: Defines the starting
                value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">summaryAxisRange</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">
                <a class="xref" href="#ChartAxisRangeOptions">ChartRangeType</a> (enumeration of type
                string)
              </td>

              <td class="entry" headers="d806901e3526" data-title="Description">Required. For bar, line, and column charts: Defines whether to
                specify the axis range manually or automatically.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname" id="SummaryColumn"><a name="SummaryColumn"><!-- --></a>summaryColumn</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e3526" data-title="Description">Required. Specifies the field by which to summarize the chart
                data. Typically this field is displayed on the Y-axis. No longer
                supported in version API 17.0 and later. See
                <span class="keyword parmname">chartSummaries</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">textColor</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e3526" data-title="Description">The color (in HTML format) of the chart text and labels.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">textSize</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">int</td>

              <td class="entry" headers="d806901e3526" data-title="Description">The size of the chart text and labels. Valid values:<a name="text_size"><!-- --></a>
                <ul class="ul bulletList" id="text_size">
                  <li class="li"><samp class="codeph nolang">8</samp></li>

                  <li class="li"><samp class="codeph nolang">9</samp></li>

                  <li class="li"><samp class="codeph nolang">10</samp></li>

                  <li class="li"><samp class="codeph nolang">12</samp></li>

                  <li class="li"><samp class="codeph nolang">14</samp></li>

                  <li class="li"><samp class="codeph nolang">18</samp></li>

                  <li class="li"><samp class="codeph nolang">24</samp></li>

                  <li class="li"><samp class="codeph nolang">36</samp></li>

                </ul>
                <p class="p">The maximum size is 18. Larger values are shown at 18
                  points.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">title</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e3526" data-title="Description">The chart title. Max 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">titleColor</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e3526" data-title="Description">The color (in HTML format) of the title text.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e3520" data-title="Field"><span class="keyword parmname">titleSize</span></td>

              <td class="entry" headers="d806901e3523" data-title="Field Type">int</td>

              <td class="entry" headers="d806901e3526" data-title="Description">The size of the title text. Valid values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">8</samp></li>

                  <li class="li"><samp class="codeph nolang">9</samp></li>

                  <li class="li"><samp class="codeph nolang">10</samp></li>

                  <li class="li"><samp class="codeph nolang">12</samp></li>

                  <li class="li"><samp class="codeph nolang">14</samp></li>

                  <li class="li"><samp class="codeph nolang">18</samp></li>

                  <li class="li"><samp class="codeph nolang">24</samp></li>

                  <li class="li"><samp class="codeph nolang">36</samp></li>

                </ul>
                <p class="p">The maximum size is 18. Larger values are shown at 18
                  points.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ChartType

An enumeration of type string that defines the chart type. For information on each of these chart types, see [Chart Types](https://help.salesforce.com/s/articleView?id=analytics.chart_types.htm&type=5&language=en_US) in Salesforce Help. Valid values:

<table class="featureTable sort_table" summary="">

          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e4087">Enumeration Value</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">None</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">HorizontalBar</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">HorizontalBarGrouped</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">HorizontalBarStacked</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">HorizontalBarStackedTo100</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">VerticalColumn</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">VerticalColumnGrouped</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">VerticalColumnStacked</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">VerticalColumnStackedTo100</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">Line</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">LineGrouped</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">LineCumulative</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">LineCumulativeGrouped</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">Pie</span></td>

            </tr>

            <tr valign="top">
              <td class="vertical-align-top " headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">Donut</span></td>

            </tr>

            <tr valign="top">
              <td class="vertical-align-top " headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">Funnel</span></td>

            </tr>

            <tr valign="top">
              <td class="vertical-align-top " headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">Scatter</span></td>

            </tr>

            <tr valign="top">
              <td class="vertical-align-top " headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname">ScatterGrouped</span></td>

            </tr>

            <tr valign="top">
              <td class="vertical-align-top " headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname" id="ChartTypeVCL"><a name="ChartTypeVCL"><!-- --></a>VerticalColumnLine</span></td>

            </tr>

            <tr valign="top">
              <td class="vertical-align-top " headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname" id="ChartTypeVCGL"><a name="ChartTypeVCGL"><!-- --></a>VerticalColumnGroupedLine</span></td>

            </tr>

            <tr valign="top">
              <td class="vertical-align-top " headers="d806901e4087" data-title="Enumeration Value"><span class="keyword parmname" id="ChartTypeVCSL"><a name="ChartTypeVCSL"><!-- --></a>VerticalColumnStackedLine</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4087" data-title="Enumeration Value">
                <span class="keyword parmname" id="ChartTypePlugin"><a name="ChartTypePlugin"><!-- --></a>Plugin</span>
                <p class="p">Reserved for
                  future use. This value is available in API version 31.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## ChartPosition

An enumeration of type string that specifies the position of the chart in the report. Valid values:

| Enumeration Value |
| --- |
| CHART\_TOP |
| CHART\_BOTTOM |

## ChartSummary

ChartSummary defines how data in the chart is summarized. Valid values:

| Field | Field Type | Description |
| --- | --- | --- |
| aggregate | [ReportSummaryType](#ReportSummaryType) | Specifies the aggregation method—such as Sum, Average, Min, and Max—for the summary value. Use the column field to specify the summary value to use for the aggregation. You don't need to specify this field for RowCount or custom summary formulas. |
| axisBinding | [ChartAxis](#ChartAxis) | Specifies the axis or axes to use on the chart. Use the column field to specify the summary value to use for the axis. |
| column | string | Required. Specifies the summary field for the chart data. If all columns are invalid, RowCount is used by default for the axis value. For vertical column and horizontal bar combination charts, you can specify up to four values. |

## ChartAxis

An enumeration of type string that specifies the axis or axes to be used in charts. Valid values:

| Enumeration Value | Description |
| --- | --- |
| x | The summary value to use for the X-axis of a scatter chart. |
| y | The Y-axis for the chart. |
| y2 | The secondary Y-axis for vertical column combination charts with a line added. |

## ReportChartSize

An enumeration of type string that specifies the chart size. Valid values:

| Enumeration Value |
| --- |
| Tiny |
| Small |
| Medium |
| Large |
| Huge |

## ChartRangeType

An enumeration of type string that defines the report format. Valid values:

| Enumeration Value |
| --- |
| Auto |
| Manual |

## ReportTimeFrameFilter

ReportTimeFrameFilter represents the report time period.

| Field | Field Type | Description |
| --- | --- | --- |
| dateColumn | string | Required. The date field on which to filter data. For example, CLOSE\_DATE |
| endDate | date | When interval is INTERVAL\_CUSTOM, specifies the end of the custom time period. |
| interval | [UserDateInterval](#UserDateInterval) (enumeration of type string) | Required. Specifies the period. |
| startDate | date | When interval is INTERVAL\_CUSTOM, specifies the start of the custom time period. |

## ReportCrossFilter

ReportCrossFilter represents the cross filter functionality in reports.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d806901e4716">Field</th>

              <th class="featureTableHeader  " id="d806901e4719">Field Type</th>

              <th class="featureTableHeader  " id="d806901e4722">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d806901e4716" data-title="Field"><span class="keyword parmname">criteriaItems</span></td>

              <td class="entry" headers="d806901e4719" data-title="Field Type"><a class="xref" href="#ReportFilterItem">ReportFilterItem</a></td>

              <td class="entry" headers="d806901e4722" data-title="Description">Represents the subfilters of a cross filter. There can be up to
                five subfilters. This field requires the following attributes.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Column</samp></li>

                  <li class="li"><samp class="codeph nolang">Operator</samp></li>

                  <li class="li"><samp class="codeph nolang">Value</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4716" data-title="Field"><span class="keyword parmname">operation</span></td>

              <td class="entry" headers="d806901e4719" data-title="Field Type">ObjectFilterOperator (Enumeration of type string)</td>

              <td class="entry" headers="d806901e4722" data-title="Description">The action indicating whether to include or exclude an object.
                Valid values: <samp class="codeph nolang">with</samp> and <samp class="codeph nolang">without</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4716" data-title="Field"><span class="keyword parmname">primaryTableColumn</span></td>

              <td class="entry" headers="d806901e4719" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e4722" data-title="Description">The field from the parent object used for the cross
                filter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4716" data-title="Field"><span class="keyword parmname">relatedTable</span></td>

              <td class="entry" headers="d806901e4719" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e4722" data-title="Description">The child object used for the cross filter.</td>

            </tr>

            <tr>
              <td class="entry" headers="d806901e4716" data-title="Field"><span class="keyword parmname">relatedTableJoinColumn</span></td>

              <td class="entry" headers="d806901e4719" data-title="Field Type">string</td>

              <td class="entry" headers="d806901e4722" data-title="Description">The field from the child object that is used to join the
                parent.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample XML snippet using cross filters to build an Accounts report for cases where case status isn’t closed:

    <crossFilters\>
        <criteriaItems\>
            <column\>Status</column\>
            <operator\>notequal</operator\>
            <value\>Closed</value\>
        </criteriaItems\>
        <operation\>with</operation\>
        <primaryTableColumn\>ACCOUNT\_ID</primaryTableColumn\>
        <relatedTable\>Case</relatedTable\>
        <relatedTableJoinColumn\>Account</relatedTableJoinColumn\>
    </crossFilters\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This sample was generated using the API version 23.0.

## UserDateInterval

An enumeration of type string that defines the period. Valid values:

| Enumeration Value | Description |
| --- | --- |
| INTERVAL\_CURRENT | Current fiscal quarter |
| INTERVAL\_CURNEXT1 | Current and next fiscal quarters |
| INTERVAL\_CURPREV1 | Current and previous fiscal quarters |
| INTERVAL\_NEXT1 | Next fiscal quarter |
| INTERVAL\_PREV1 | Previous fiscal quarter |
| INTERVAL\_CURNEXT3 | Current and next three fiscal quarters |
| INTERVAL\_CURFY | Current fiscal year |
| INTERVAL\_PREVFY | Previous fiscal year |
| INTERVAL\_PREV2FY | Previous two fiscal years |
| INTERVAL\_AGO2FY | Two fiscal years ago |
| INTERVAL\_NEXTFY | Next fiscal year |
| INTERVAL\_PREVCURFY | Current and previous fiscal years |
| INTERVAL\_PREVCUR2FY | Current and previous two fiscal years |
| INTERVAL\_CURNEXTFY | Current and next fiscal year |
| INTERVAL\_CUSTOM | A custom time period. Use startDate and endDate fields to specify the time period's start date and end date. |
| INTERVAL\_YESTERDAY | Yesterday |
| INTERVAL\_TODAY | Today |
| INTERVAL\_TOMORROW | Tomorrow |
| INTERVAL\_LASTWEEK | Last calendar week |
| INTERVAL\_THISWEEK | This calendar week |
| INTERVAL\_NEXTWEEK | Next calendar week |
| INTERVAL\_LASTMONTH | Last calendar month |
| INTERVAL\_THISMONTH | This calendar month |
| INTERVAL\_NEXTMONTH | Next calendar month |
| INTERVAL\_LASTTHISMONTH | Current and previous calendar months |
| INTERVAL\_THISNEXTMONTH | Current and next calendar months |
| INTERVAL\_CURRENTQ | Current calendar quarter |
| INTERVAL\_CURNEXTQ | Current and next calendar quarters |
| INTERVAL\_CURPREVQ | Current and previous calendar quarters |
| INTERVAL\_NEXTQ | Next calendar quarter |
| INTERVAL\_PREVQ | Previous calendar quarter |
| INTERVAL\_CURNEXT3Q | Current and next three calendar quarters |
| INTERVAL\_CURY | Current calendar year |
| INTERVAL\_PREVY | Previous calendar year |
| INTERVAL\_PREV2Y | Previous two calendar years |
| INTERVAL\_AGO2Y | Two calendar years ago |
| INTERVAL\_NEXTY | Next calendar year |
| INTERVAL\_PREVCURY | Current and previous calendar years |
| INTERVAL\_PREVCUR2Y | Current and previous two calendar years |
| INTERVAL\_CURNEXTY | Current and next calendar years |
| INTERVAL\_LAST7 | Last 7 days |
| INTERVAL\_LAST30 | Last 30 days |
| INTERVAL\_LAST60 | Last 60 days |
| INTERVAL\_LAST90 | Last 90 days |
| INTERVAL\_LAST120 | Last 120 days |
| INTERVAL\_NEXT7 | Next 7 days |
| INTERVAL\_NEXT30 | Next 30 days |
| INTERVAL\_NEXT60 | Next 60 days |
| INTERVAL\_NEXT90 | Next 90 days |
| INTERVAL\_NEXT120 | Next 120 days |
| LAST\_FISCALWEEK | When custom fiscal years are enabled: Last fiscal week |
| THIS\_FISCALWEEK | When custom fiscal years are enabled: This fiscal week |
| NEXT\_FISCALWEEK | When custom fiscal years are enabled: Next fiscal week |
| LAST\_FISCALPERIOD | When custom fiscal years are enabled: Last fiscal period |
| THIS\_FISCALPERIOD | When custom fiscal years are enabled: This fiscal period |
| NEXT\_FISCALPERIOD | When custom fiscal years are enabled: Next fiscal period |
| LASTTHIS\_FISCALPERIOD | When custom fiscal years are enabled: This fiscal period and last fiscal period |
| THISNEXT\_FISCALPERIOD | When custom fiscal years are enabled: This fiscal period and next fiscal period |
| CURRENT\_ENTITLEMENT\_PERIOD | Current entitlement period |
| PREVIOUS\_ENTITLEMENT\_PERIOD | Previous entitlement period |
| PREVIOUS\_TWO\_ENTITLEMENT\_PERIODS | Previous two entitlement periods |
| TWO\_ENTITLEMENT\_PERIODS\_AGO | Two entitlement periods ago |
| CURRENT\_AND\_PREVIOUS\_ENTITLEMENT\_PERIOD | Current and previous entitlement period |
| CURRENT\_AND\_PREVIOUS\_TWO\_ENTITLEMENT\_PERIODS | Current and previous two entitlement periods |

## Declarative Metadata Sample Definition

A sample XML report definition:

<?xml version="1.0" encoding="UTF-8"?>
<Report xmlns="http://soap.sforce.com/2006/04/metadata">
    <aggregates\>
        <acrossGroupingContext\>CRT\_Object\_\_c$Id</acrossGroupingContext\>
        <calculatedFormula\>PREVGROUPVAL(CRT\_Object\_\_c.Currency\_\_c:AVG, CRT\_Object\_\_c.Id) \*
                PARENTGROUPVAL(CRT\_Object\_\_c.Number\_\_c:MAX, CRT\_Object\_\_c.CreatedBy.Name, 
                COLUMN\_GRAND\_SUMMARY)/RowCount</calculatedFormula\>
        <datatype\>number</datatype\>
        <developerName\>FORMULA1</developerName\>
        <downGroupingContext\>CRT\_Object\_\_c$CreatedBy</downGroupingContext\>
        <isActive\>true</isActive\>
        <masterLabel\>CurrCSF</masterLabel\>
        <scale\>2</scale\>
    </aggregates\>
    <aggregates\>
        <acrossGroupingContext\>CRT\_Object\_\_c$LastModifiedDate</acrossGroupingContext\>
        <calculatedFormula\>IF(RowCount&gt;10, 
                BLANKVALUE(ROUND(PREVGROUPVAL(CRT\_Object\_\_c.Currency\_\_c:SUM, 
                CRT\_Object\_\_c.LastModifiedDate),3), 
                PARENTGROUPVAL(CRT\_Object\_\_c.Number\_\_c:SUM, ROW\_GRAND\_SUMMARY, 
                CRT\_Object\_\_c.Id))  , 1000)</calculatedFormula\>
        <datatype\>number</datatype\>
        <developerName\>FORMULA2</developerName\>
        <downGroupingContext\>GRAND\_SUMMARY</downGroupingContext\>
        <isActive\>true</isActive\>
        <masterLabel\>numCSF</masterLabel\>
        <scale\>2</scale\>
    </aggregates\>
    <buckets\>
        <bucketType\>number</bucketType\>
        <developerName\>BucketField\_BusinessSize</developerName\>
        <masterLabel\>NumericBucket</masterLabel\>
        <nullTreatment\>z</nullTreatment\>
        <sourceColumnName\>SALES</sourceColumnName\>
        <values\>
            <sourceValues\>
                <to\>10000</to\>
            </sourceValues\>
            <value\>low</value\>
        </values\>
        <values\>
            <sourceValues\>
                <from\>10000</from\>
                <to\>25000</to\>
            </sourceValues\>
            <value\>mid</value\>
        </values\>
        <values\>
            <sourceValues\>
                <from\>25000</from\>
            </sourceValues\>
            <value\>high</value\>
        </values\>
    </buckets\>
    <buckets\>
        <bucketType\>text</bucketType\>
        <developerName\>BucketField\_Region</developerName\>
        <masterLabel\>TextBucket</masterLabel\>
        <nullTreatment\>n</nullTreatment\>
        <otherBucketLabel\>Other</otherBucketLabel\>
        <sourceColumnName\>ADDRESS1\_STATE</sourceColumnName\>
        <values\>
            <sourceValues\>
                <sourceValue\>CA</sourceValue\>
            </sourceValues\>
            <value\>west</value\>
        </values\>
        <values\>
            <sourceValues\>
                <sourceValue\>NY</sourceValue\>
            </sourceValues\>
            <sourceValues\>
                <sourceValue\>Ontario</sourceValue\>
            </sourceValues\>
            <value\>east</value\>
        </values\>
    </buckets\>
    <chart\>
        <backgroundColor1\>#FFFFFF</backgroundColor1\>
        <backgroundColor2\>#FFFFFF</backgroundColor2\>
        <backgroundFadeDir\>Diagonal</backgroundFadeDir\>
        <chartSummaries\>
            <axisBinding\>y</axisBinding\>
            <column\>FORMULA1</column\>
        </chartSummaries\>
        <chartSummaries\>
            <axisBinding\>y</axisBinding\>
            <column\>FORMULA2</column\>
        </chartSummaries\>
        <chartSummaries\>
            <aggregate\>Maximum</aggregate\>
            <axisBinding\>y</axisBinding\>
            <column\>CRT\_Object\_\_c$Number\_\_c</column\>
        </chartSummaries\>
        <chartSummaries\>
            <axisBinding\>y</axisBinding\>
            <column\>RowCount</column\>
        </chartSummaries\>
        <chartType\>VerticalColumn</chartType\>
        <groupingColumn\>CRT\_Object\_\_c$LastModifiedDate</groupingColumn\>
        <legendPosition\>Right</legendPosition\>
        <location\>CHART\_TOP</location\>
        <size\>Medium</size\>
        <summaryAxisRange\>Auto</summaryAxisRange\>
        <textColor\>#000000</textColor\>
        <textSize\>12</textSize\>
        <titleColor\>#000000</titleColor\>
        <titleSize\>18</titleSize\>
    </chart\>
    <columns\>
        <field\>CRT\_Object\_\_c$Name</field\>
    </columns\>
    <columns\>
        <aggregateTypes\>Average</aggregateTypes\>
        <field\>CRT\_Object\_\_c$Currency\_\_c</field\>
    </columns\>
    <columns\>
        <aggregateTypes\>Maximum</aggregateTypes\>
        <field\>CRT\_Object\_\_c$Number\_\_c</field\>
    </columns\>
    <columns\>
        <field\>BucketField\_\_Region</field\>
    </columns\>
    <format\>Matrix</format\>
    <groupingsAcross\>
        <dateGranularity\>Day</dateGranularity\>
        <field\>CRT\_Object\_\_c$Id</field\>
        <sortOrder\>Asc</sortOrder\>
    </groupingsAcross\>
    <groupingsAcross\>
        <dateGranularity\>Year</dateGranularity\>
        <field\>CRT\_Object\_\_c$LastModifiedDate</field\>
        <sortOrder\>Asc</sortOrder\>
    </groupingsAcross\>
    <groupingsDown\>
        <dateGranularity\>Day</dateGranularity\>
        <field\>CRT\_Object\_\_c$CreatedBy</field\>
        <sortOrder\>Asc</sortOrder\>
    </groupingsDown\>
    <groupingsDown\>
        <dateGranularity\>Day</dateGranularity\>
        <field\>CRT\_Object\_\_c$Currency\_\_c</field\>
        <sortOrder\>Desc</sortOrder\>
    </groupingsDown\>
    <name\>CrtMMVC</name\>
    <reportType\>CRT1\_\_c</reportType\>
    <scope\>organization</scope\>
    <showDetails\>false</showDetails\>
    <timeFrameFilter\>
        <dateColumn\>CRT\_Object\_\_c$CreatedDate</dateColumn\>
        <interval\>INTERVAL\_CUSTOM</interval\>
    </timeFrameFilter\>
</Report\>

## Declarative Metadata Sample Definition for a Joined Report

A sample XML report definition:

<?xml version="1.0" encoding="UTF-8"?>
<Report xmlns="http://soap.sforce.com/2006/04/metadata">
<!-- This is a cross-block custom summary formula. Note that the calculated formula reference for a blocks reference uses the BlockId#Aggregate. -->
    <aggregates\>
        <calculatedFormula\>B1#AMOUNT:SUM+B2#EMPLOYEES:SUM</calculatedFormula\>
        <datatype\>number</datatype\>
        <developerName\>FORMULA</developerName\>
        <isActive\>true</isActive\>
        <isCrossBlock\>true</isCrossBlock\>
        <masterLabel\>Cross-Block CSF Example</masterLabel\>
        <scale\>2</scale\>
    </aggregates\>
<!-- This is a standard custom summary formula. Note that the calculated formula reference does not have block reference but just the aggregate name of the report type associated (Opportunity).-->
    <aggregates\>
        <calculatedFormula\>AMOUNT:SUM</calculatedFormula\>
        <developerName\>FORMULA2</developerName\>
        <isActive\>true</isActive\>
        <isCrossBlock\>false</isCrossBlock\>
        <masterLabel\>Standard CSF Example</masterLabel\>
        <reportType\>Opportunity</reportType\>
        <scale\>2</scale\>
    </aggregates\>
    <block\>
      <blockInfo\>
<!-- This is how the block defines that the custom summary formula should be referenced. In this example, it’s the in standard FORMULA 2 defined above. This block report has blockID B1.-->
        <aggregateReferences\>    
          <aggregate\>FORMULA2</aggregate\>
        </aggregateReference\>
        <blockId\>B1</blockId\>
        <joinTable\>a</joinTable\>
      </blockInfo\>
      <columns\>
        <field\>TYPE</field\>
      </columns\>
      <format\>Summary</format\>
      <name\>Opportunities BLock 3</name\>
      <params\>
        <name\>role\_territory</name\>
        <value\>role</value\>
      </params\>
      <params\>
        <name\>terr</name\>
        <value\>all</value\>
      </params\>
      <params\>
        <name\>open</name\>
        <value\>all</value\>
      </params\>
      <params\>
        <name\>probability</name\>
        <value\>0</value\>
      </params\>
      <params\>
        <name\>co</name\>
        <value\>1</value\>
      </params\>
      <reportType\>Opportunity</reportType\>
      <scope\>organization</scope\>
      <timeFrameFilter\>
        <dateColumn\>CLOSE\_DATE</dateColumn\>
        <interval\>INTERVAL\_CUSTOM</interval\>
      </timeFrameFilter\>
    </block\>
    <block\>
      <blockInfo\>
<!-- This is how the block defines that the custom summary formula should be referenced. In this example, it’s the cross-block custom summary formula FORMULA 1 defined above. This block report has blockId B2.-->
        <aggregateReferences\>
          <aggregate\>FORMULA1</aggregate\>
        </aggregateReferences\>
        <blockId\>B2</blockId\>
        <joinTable\>a</joinTable\>
      </blockInfo\>
      <columns\>
        <field\>USERS.NAME</field\>
      </columns\>
      <columns\>
        <field\>TYPE</field\>
      </columns\>
      <columns\>
         <field\>DUE\_DATE</field\>
      </columns\>
      <columns\>
        <field\>LAST\_UPDATE</field\>
      </columns\>
      <columns\>
        <field\>ADDRESS1\_STATE</field\>
      </columns\>
      <format\>Summary</format
      <name\>Accounts block 5</name\>
      <params\>
        <name\>terr</name\>
        <value\>all</value\>
      </params\>
      <params\>
        <name\>co</name\>
        <value\>1</value\>
      </params\>
      <reportType\>AccountList</reportType\>
      <scope\>organization</scope\>
      <timeFrameFilter\>
        <dateColumn\>CREATED\_DATE</dateColumn\>
        <interval\>INTERVAL\_CUSTOM</interval\>
      </timeFrameFilter\>
    </block\>
    <blockInfo\>
      <blockId xsi:nil="true"/>
      <joinTable\>a</joinTable\>
    </blockInfo\>
<chart\>
        <backgroundColor1\>#FFFFFF</backgroundColor1\>
        <backgroundColor2\>#FFFFFF</backgroundColor2\>
        <backgroundFadeDir\>Diagonal</backgroundFadeDir\>
        <chartSummaries\>
            <axisBinding\>y</axisBinding\>
<!-- This is how chart aggregates are designed in multiblock. We're using RowCount from Block 1.-->
            <column\>B1#RowCount</column\>
        </chartSummaries\>
        <chartType\>HorizontalBar</chartType\>
        <enableHoverLabels\>false</enableHoverLabels\>
        <expandOthers\>true</expandOthers\>
        <groupingColumn\>ACCOUNT\_NAME</groupingColumn\>
        <location\>CHART\_TOP</location\>
        <showAxisLabels\>true</showAxisLabels\>
        <showPercentage\>false</showPercentage\>
        <showTotal\>false</showTotal\>
        <showValues\>false</showValues\>
        <size\>Medium</size\>
        <summaryAxisRange\>Auto</summaryAxisRange\>
        <textColor\>#000000</textColor\>
        <textSize\>12</textSize\>
        <titleColor\>#000000</titleColor\>
        <titleSize\>18</titleSize\>
    </chart\>
    <format\>MultiBlock</format\>
    <groupingsDown\>
        <dateGranularity\>Day</dateGranularity\>
        <field\>ACCOUNT\_NAME</field\>
        <sortOrder\>Asc</sortOrder\>
    </groupingsDown\>
    <name\>mb\_mbapi</name\>
    <reportType\>Opportunity</reportType\>
    <showDetails\>true</showDetails\>
</Report\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

#### See Also

- [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dashboard.htm "Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.")

<!-- document id=cf405fb57436c34a4eaeefd91065546698c25c083c56469c7f6f2fd69f46a7f4 url=/legacydeveloper/current/en-us/api_meta/meta_reporttype.md -->

# ReportType

Represents the metadata associated with a custom report type. Custom report types allow you to build a framework from which users can create and customize reports.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

Redeploying a report type with the same fullName as a previously deleted report type via Metadata API restores the deleted report type instead of creating a new one, even if the report type was removed from the Recycle Bin. The restored report type keeps its original Id, CreatedDate, and CreatedById.

## Declarative Metadata File Suffix and Directory Location

The file suffix is .reportType for the custom report type definition. There’s one file per custom report type. Report types are stored in the reportTypes directory of the corresponding package directory.

## Version

Custom report types are available in API version 14.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d824651e120">Field Name</th>

              <th class="featureTableHeader  " id="d824651e123">Field Type</th>

              <th class="featureTableHeader  " id="d824651e126">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d824651e120" data-title="Field Name"><span class="keyword parmname">autogenerated</span></td>

              <td class="entry" headers="d824651e123" data-title="Field Type">boolean</td>

              <td class="entry" headers="d824651e126" data-title="Description">
                <span class="ph" id="autogenerated_desc"><a name="autogenerated_desc"><!-- --></a>Indicates that the report type was
                  automatically generated when historical trending was enabled for
                  an entity.</span>
                <p class="p">Available in API version 29 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d824651e120" data-title="Field Name"><span class="keyword parmname" id="field_baseObject"><a name="field_baseObject"><!-- --></a>baseObject</span></td>

              <td class="entry" headers="d824651e123" data-title="Field Type">string</td>

              <td class="entry" headers="d824651e126" data-title="Description">Required. The primary object for the custom report type, for
                example, Account. All objects, including custom and external
                objects, are supported. You can’t edit this field after initial
                creation.<p class="p">Support for external objects is available in API
                  version 38.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d824651e120" data-title="Field Name"><span class="keyword parmname">category</span></td>

              <td class="entry" headers="d824651e123" data-title="Field Type">ReportTypeCategory (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d824651e126" data-title="Description">This field controls the category for the report. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">accounts</samp></li>

                  <li class="li"><samp class="codeph nolang">opportunities</samp></li>

                  <li class="li"><samp class="codeph nolang">forecasts</samp></li>

                  <li class="li"><samp class="codeph nolang">cases</samp></li>

                  <li class="li"><samp class="codeph nolang">leads</samp></li>

                  <li class="li"><samp class="codeph nolang">campaigns</samp></li>

                  <li class="li"><samp class="codeph nolang">activities</samp></li>

                  <li class="li"><samp class="codeph nolang">busop</samp></li>

                  <li class="li"><samp class="codeph nolang">products</samp></li>

                  <li class="li"><samp class="codeph nolang">admin</samp></li>

                  <li class="li"><samp class="codeph nolang">territory</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">territory2</samp> (This value
                    is available in API version 31.0 and later.)
                  </li>

                  <li class="li"><samp class="codeph nolang">usage_entitlement</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">wdc</samp> (This value is
                    available in API version 29.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">calibration</samp> (This value
                    is available in API version 29.0 and later.)
                  </li>

                  <li class="li"><samp class="codeph nolang">other</samp></li>

                  <li class="li"><samp class="codeph nolang">content</samp></li>

                  <li class="li"><samp class="codeph nolang">quotes</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">individual</samp> (This value
                    is available in API version 45.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">employee</samp> (This value is
                    available in API version 46.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">data_cloud</samp> (This value
                    is available in API version 55.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">commerce</samp> (This value is
                    available in API version 60.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">flow</samp> (This value is
                    available in API version 60.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">semantic_model</samp> (This
                    value is available in API version 60.0 and later.)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d824651e120" data-title="Field Name"><span class="keyword parmname">deployed</span></td>

              <td class="entry" headers="d824651e123" data-title="Field Type">boolean</td>

              <td class="entry" headers="d824651e126" data-title="Description">Required. Indicates whether the report type is available to users
                (<samp class="codeph nolang">true</samp>) or whether it's still
                in development (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d824651e120" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d824651e123" data-title="Field Type">string</td>

              <td class="entry" headers="d824651e126" data-title="Description">The description of the custom report type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d824651e120" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d824651e123" data-title="Field Type">string</td>

              <td class="entry" headers="d824651e126" data-title="Description">The report type developer name used as a unique identifier for
                API access. The <span class="keyword parmname">fullName</span> can contain only
                underscores and alphanumeric characters. It must be unique, begin
                with a letter, not include spaces, not end with an underscore, and
                not contain two consecutive underscores.</td>

            </tr>

            <tr>
              <td class="entry" headers="d824651e120" data-title="Field Name"><span class="keyword parmname">join</span></td>

              <td class="entry" headers="d824651e123" data-title="Field Type"><a class="xref" href="#ObjectRelationship">ObjectRelationship</a></td>

              <td class="entry" headers="d824651e126" data-title="Description">The object joined to the <a class="xref" href="#field_baseObject"><span class="keyword parmname">baseObject</span></a>. For
                example, Contacts can be joined to the primary Accounts
                object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d824651e120" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d824651e123" data-title="Field Type">string</td>

              <td class="entry" headers="d824651e126" data-title="Description">Required. The report type label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d824651e120" data-title="Field Name"><span class="keyword parmname">sections</span></td>

              <td class="entry" headers="d824651e123" data-title="Field Type">
                <a class="xref" href="#ReportLayoutSection">ReportLayoutSection</a>[]
              </td>

              <td class="entry" headers="d824651e126" data-title="Description">The groups of columns available for the report type. Though
                columns aren’t strictly required, a report without columns isn’t
                useful. </td>

            </tr>

          </tbody>

        </table>

## ObjectRelationship

ObjectRelationship represents a join to another object.

| Field Name | Field Type | Description |
| --- | --- | --- |
| join | [ObjectRelationship](#ObjectRelationship) | This field is a recursive reference that allows you to join more than two objects. A maximum of four objects can be joined in a custom report type. When more than two objects are joined, an inner join isn’t allowed if there has been an outer join earlier in the join sequence. The [baseObject](#field_baseObject) is first joined to the object specified in [relationship](#field_relationship); the resulting dataset is then joined with any objects specified in this field. |
| outerJoin | boolean | Required. Indicates whether it’s an outer join (true) or not (false). An outer join returns a row even if the joined table doesn’t contain a matching value in the join column. |
| relationship | string | Required. The object joined to the primary object; for example, Contacts. |

## ReportLayoutSection

ReportLayoutSection represents a group of columns used in the custom report type.

| Field Name | Field Type | Description |
| --- | --- | --- |
| columns | [ReportTypeColumn](#ReporttColumn)\[\] | The list of columns projected from the query, defined by this custom report type. |
| masterLabel | string | Required. The label for this group of columns in the report wizard. |

## ReportTypeColumn

ReportTypeColumn represents a column in the custom report type.

| Field Name | Field Type | Description |
| --- | --- | --- |
| checkedByDefault | boolean | Required. Indicates whether this column is selected by default (true) or not (false). |
| displayNameOverride | string | A customized column name, if desired. |
| field | string | Required. The field name associated with the report column. |
| table | string | Required. The table associated with the field; for example, Account. |

## Declarative Metadata Sample Definition

The definition of a custom report type is shown in this example. Account is joined to Contacts and the resulting dataset is joined with Assets.

<?xml version="1.0" encoding="UTF-8"?>
<ReportType xmlns="http://soap.sforce.com/2006/04/metadata">
    <baseObject\>Account</baseObject\>
    <category\>accounts</category\>
    <deployed\>true</deployed\>
    <description\>Account linked to Contacts and Assets</description\>
    <join\>
        <join\>
            <outerJoin\>false</outerJoin\>
            <relationship\>Assets</relationship\>
        </join\>
        <outerJoin\>false</outerJoin\>
        <relationship\>Contacts</relationship\>
    </join\>
    <label\>Account Contacts and Assets</label\>
    <sections\>
        <columns\>
            <checkedByDefault\>true</checkedByDefault\>
            <field\>obj\_lookup\_\_c.Id</field\>
            <table\>Account</table\>
        </columns\>
        <columns\>
            <checkedByDefault\>false</checkedByDefault\>
            <field\>obj\_lookup\_\_c.Name</field\>
            <table\>Account</table\>
        </columns\>
        <columns\>
            <checkedByDefault\>false</checkedByDefault\>
            <field\>Opportunity\_\_c.Amount</field\>
            <table\>Account</table\>
        </columns\>
        <columns\>
            <checkedByDefault\>false</checkedByDefault\>
            <field\>Owner.IsActive</field\>
            <table\>Account</table\>
        </columns\>
        <masterLabel\>Accounts</masterLabel\>
    </sections\>
    <sections\>
        <columns\>
            <checkedByDefault\>false</checkedByDefault\>
            <field\>Owner.Email</field\>
            <table\>Account.Contacts</table\>
        </columns\>
        <columns\>
            <checkedByDefault\>false</checkedByDefault\>
            <field\>byr\_\_c</field\>
            <table\>Account.Contacts</table\>
        </columns\>
        <columns\>
            <checkedByDefault\>true</checkedByDefault\>
            <field\>ReportsTo.CreatedBy.Contact.Owner.MobilePhone</field\>
            <table\>Account.Contacts</table\>
        </columns\>
        <masterLabel\>Contacts</masterLabel\>
    </sections\>
</ReportType\>

## Usage

The custom report type refers to fields by using their API names. For a historical field (one that has trackTrending set to true) the API name includes hst, such as Field2\_\_c\_hst.

<sections\>
    <columns\>
        <checkedByDefault\>false</checkedByDefault\>
        <field\>Field2\_\_c\_hst</field\>
        <table\>CustomTrendedObject\_\_c.CustomTrendedObject\_\_c\_hst</table\>
    </columns\>
    <masterLabel\>History</masterLabel\>
</sections\>

For more information, see [trackTrending](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#tracktrending_name).

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=39d4ad3b41d302ced3f5307a614913f7a6ca5aae9756d9f6e0965d2653ad1990 url=/legacydeveloper/current/en-us/api_meta/meta_rest_intro.md -->

# REST Resources for Metadata

Use the REST resource deployRequest to move metadata (XML files) between a Salesforce organization and a local file system.

Data in XML files is formatted using the English (United States) locale. This approach ensures that fields that depend on locale, such as date fields, are interpreted consistently during data migrations between organizations using different languages. Organizations can support multiple languages for presentation to their users.

Metadata deployment is used primarily for the following development scenarios.

- Development of a custom application (or customization) in a sandbox organization. After development and testing are completed, the application or customization is then deployed into a production organization using Metadata API.
- Team development of an application in a Developer Edition organization. After development and testing are completed, you can then distribute the application via Lightning Platform AppExchange.

**Working with the Zip File**

The deployRequest resource is used to deploy a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.

A component is an instance of a metadata type. For example, CustomObject is a metadata type for custom objects, and the MyCustomObject\_\_c component is an instance of a custom object.

The files that are deployed in a .zip file can be unpackaged components that reside in your organization (such as standard objects). The files can also be packaged components that reside within named packages.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can deploy up to 10,000 files at once. (In API version 43.0 and later, AppExchange packages can contain up to 12,500 files.) The .zip file size limit that applies to SOAP calls doesn’t apply to the deployRequest REST resource. However, the 400-MB limit for components that are uncompressed into an unzipped folder after upload applies to both SOAP and REST deployments.

Every .zip file contains a project manifest, a file that’s named package.xml, and a set of directories that contain the components. The manifest file defines the components that you’re trying to retrieve or deploy and the API version used for the deployment or retrieval.

The following is a sample package.xml file.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyCustomObject\_\_c</members\>
        <name\>CustomObject</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>CustomTab</name\>
    </types\>
    <types\>
        <members\>Standard</members\>
        <name\>Profile</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

The following elements can be defined in package.xml.

- <fullName\> contains the name of the server-side package. If no <fullName\> exists, it’s a client-side unpackaged package.
- <types\> contains the name of the metadata type (for example, CustomObject) and the named members (for example, myCustomObject\_\_c) to be deployed. You can add multiple <types\> elements in a manifest file.
- <members\> contains the fullName of the component, such as MyCustomObject\_\_c. For many metadata types, you can replace the value in members with the wildcard character \* (asterisk) instead of listing each member separately. For a list of metadata types that allow the wildcard character, see the “Allows Wildcard (\*)?” column in [Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_types_list.htm "Metadata API enables you to access some entities and feature settings that you can customize in the user interface.").
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    You specify Security in the <members\> element and Settings in the name element when retrieving the SecuritySettings component type.
- <name\> contains the metadata type, for example CustomObject or Profile. There’s one name defined for each metadata type in the directory. Any metadata type that extends [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) is a valid value. The name that’s entered must match a metadata type that’s defined in the Metadata API WSDL. See [Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_types_list.htm "Metadata API enables you to access some entities and feature settings that you can customize in the user interface.") for a list.
- <version\> is the API version number that’s used when the .zip file is deployed or retrieved. Currently the valid value is 68.0.

For more sample package.xml manifest files that show you how to work with different subsets of metadata, see [Sample package.xml Manifest Files](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/manifest_samples.htm "This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if you want to work with all the metadata in one batch.").

To delete components, see [Deleting Components from an Organization](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm "To delete components, perform a deployment with the deploy() call by using a destructive changes manifest file that lists the components to remove from your organization. You can perform a deployment that only deletes components, or a deployment that deletes and adds components. In API version 33.0 and later, you can specify components to delete before and after other components are added or updated. In earlier API versions, if deletions and additions are specified for the same deployment, the deploy() call performs the deletions first.").

<!-- document id=b2f312b881bc0ceedb50b5302a07b853700da27508b2f414fd70b6e8ef7c3f2b url=/legacydeveloper/current/en-us/api_meta/meta_restrictionrule.md -->

# RestrictionRule

Represents a restriction rule or a scoping rule. A restriction rule has enforcementType set to Restrict and controls the access that specified users have to designated records. A scoping rule has enforcementType set to Scoping and controls the default records that your users see without restricting access. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

RestrictionRule components have the suffix .rule and are stored in the restrictionRules folder.

## Version

RestrictionRule components are available in API version 52.0 and later.

## Special Access Rules

Only users with the View Restriction and Scoping Rules permission can view restriction rules and scoping rules via the API. Only users with the Manage Sharing permission can view, create, update, and delete restriction rules and scoping rules.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d826627e112">Field Name</th>

              <th class="featureTableHeader  " id="d826627e115">Field Type</th>

              <th class="featureTableHeader  " id="d826627e118">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d826627e112" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d826627e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d826627e118" data-title="Description">Indicates whether the rule is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d826627e112" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d826627e115" data-title="Field Type">string</td>

              <td class="entry" headers="d826627e118" data-title="Description">Required. The description of the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d826627e112" data-title="Field Name"><span class="keyword parmname">enforcementType</span></td>

              <td class="entry" headers="d826627e115" data-title="Field Type">EnforcementType (enumeration of type string)</td>

              <td class="entry" headers="d826627e118" data-title="Description">Required. The type of rule. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">FieldRestrict</samp>—Don’t use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Restrict</samp>—Restriction rule.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Scoping</samp>—Scoping rule.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d826627e112" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d826627e115" data-title="Field Type">string</td>

              <td class="entry" headers="d826627e118" data-title="Description">Required. The name of the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d826627e112" data-title="Field Name"><span class="keyword parmname">recordFilter</span></td>

              <td class="entry" headers="d826627e115" data-title="Field Type">string</td>

              <td class="entry" headers="d826627e118" data-title="Description">Required. The criteria that determine which records are accessible via the
                rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d826627e112" data-title="Field Name"><span class="keyword parmname">targetEntity</span></td>

              <td class="entry" headers="d826627e115" data-title="Field Type">string</td>

              <td class="entry" headers="d826627e118" data-title="Description">Required. The object for which you're creating the rule. We recommend that you
                don’t edit this field after the rule is created.<div class="p">If
                  <span class="keyword parmname">enforcementType</span> is set to <samp class="codeph nolang">Restrict</samp>, custom objects, external objects, and these objects are supported:<ul class="ul bulletList">
                    <li class="li">Contract</li>

                    <li class="li">Event</li>

                    <li class="li">Quote</li>

                    <li class="li">Task</li>

                    <li class="li">TimeSheet</li>

                    <li class="li">TimeSheetEntry</li>

                  </ul>
                </div>
                <div class="p">If <span class="keyword parmname">enforcementType</span> is set to <samp class="codeph nolang">Scoping</samp>, custom objects and these objects are
                  supported: <ul class="ul bulletList">
                    <li class="li">Account</li>

                    <li class="li">Case</li>

                    <li class="li">Contact</li>

                    <li class="li">Event</li>

                    <li class="li">Lead</li>

                    <li class="li">Opportunity</li>

                    <li class="li">Task</li>

                  </ul>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d826627e112" data-title="Field Name"><span class="keyword parmname">userCriteria</span></td>

              <td class="entry" headers="d826627e115" data-title="Field Type">string</td>

              <td class="entry" headers="d826627e118" data-title="Description">Required. The users that this rule applies to, such as all active users or
                users with a specified role or profile.</td>

            </tr>

            <tr>
              <td class="entry" headers="d826627e112" data-title="Field Name"><span class="keyword parmname">version</span></td>

              <td class="entry" headers="d826627e115" data-title="Field Type">int</td>

              <td class="entry" headers="d826627e118" data-title="Description">Required. The rule's version number.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a RestrictionRule component representing a restriction rule.

<?xml version="1.0" encoding="UTF-8"?>
<RestrictionRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <description\>Allows users with a specific profile to see only tasks that they own.</description\>
    <enforcementType\>Restrict</enforcementType\>
    <masterLabel\>Tasks You Own</masterLabel\>
    <recordFilter\>OwnerId = $User.Id</recordFilter\>
    <targetEntity\>Task</targetEntity\>
    <userCriteria\>$User.ProfileId = '00exxxxxxxxxxxx'</userCriteria\>
    <version\>1</version\>
</RestrictionRule\>

The following is an example of a RestrictionRule component representing a scoping rule.

<?xml version="1.0" encoding="UTF-8"?>
<RestrictionRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <active>true</active>
    <description>View tasks contacts from Department A.</description>
    <enforcementType>Scoping</enforcementType>
    <masterLabel>SR for Department A contacts</masterLabel>
    <recordFilter>Department=$User.Department</recordFilter>
    <targetEntity>Contact</targetEntity>
    <userCriteria>$User.UserRoleId = '00Exxxxxxxxxxxx'</userCriteria>
    <version>1</version>
</RestrictionRule>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>RestrictionRule</name\>
    </types\>
    <version\>55.0</version\>
</Package\>

<!-- document id=b573c1adce43241e4a4d58cbb60d0f8642e9f663acde750776187c6ac59b73ee url=/legacydeveloper/current/en-us/api_meta/meta_result_objects.md -->

# Result Objects

Use the following objects to get the results of your [file-based](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_file_based_calls_intro.htm "Use file-based calls to deploy or retrieve XML components.") or [CRUD-based](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects.") calls.

- **[AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm)**  
    Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.
- **[CancelDeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_canceldeployresult.htm)**  
    Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.
- **[DeployResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deployresult.htm)**  
    Contains information about the success or failure of the associated deploy() call.
- **[DescribeMetadataResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describemeta_result.htm)**  
    Contains information about the organization that is useful for developers working with declarative metadata.
- **[DescribeValueTypeResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describeValueTypeResult.htm)**  
    Contains information about a value type that’s useful for developers working with declarative metadata.
- **[ReadResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_readResult.htm)**  
    Contains result information for the readMetadata call.
- **[RetrieveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm)**  
    The retrieve() call returns an array of RetrieveResult objects.
- **[SaveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_saveResult.htm)**  
    Contains result information for the createMetadata, updateMetadata, or renameMetadata call.
- **[DeleteResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteResult.htm)**  
    Contains result information for the deleteMetadata call.
- **[UpsertResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_upsertResult.htm)**  
    Contains information about the result of the associated upsertMetadata() call.
- **[Error](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_error.htm)**  
    Represents an error that occurred during a synchronous CRUD (createMetadata(), updateMetadata(), or deleteMetadata()) operation.

<!-- document id=576d6aa1837266a15baf43edcf60e499de7226a1fc341f2868bd721f8c642c83 url=/legacydeveloper/current/en-us/api_meta/metadata_api_retexset.md -->

# RetailExecutionSettings

Represents settings to manage your inventory, promotions, planograms, and in-store activities.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details.

## File Suffix and Directory Location

RetailExecutionSettings are stored in a single file named RetailExecution.settings in the settings directory.

## Version

RetailExecutionSettings are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1084490e97">Field Name</th>

              <th class="featureTableHeader  " id="d1084490e100">Field Type</th>

              <th class="featureTableHeader  " id="d1084490e103">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1084490e97" data-title="Field Name"><span class="keyword parmname">enableProductHierarchy</span></td>

              <td class="entry" headers="d1084490e100" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1084490e103" data-title="Description">Indicates whether Product Hierarchy is enabled for your org (<samp class="codeph nolang">true</samp>) or not <samp class="codeph nolang">false</samp>). <p class="p">This field is available in API version 53.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1084490e97" data-title="Field Name"><span class="keyword parmname">enableRetailExecution</span></td>

              <td class="entry" headers="d1084490e100" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1084490e103" data-title="Description">Indicates whether Retail Execution is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1084490e97" data-title="Field Name"><span class="keyword parmname">enableVisitSharing</span></td>

              <td class="entry" headers="d1084490e100" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1084490e103" data-title="Description">Indicates whether Visit Share is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>
                <p class="p">This field is available in API version 55.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a RetailExecutionSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<RetailExecutionSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableRetailExecution\>true</enableRetailExecution\>
    <enableProductHierarchy\>true</enableProductHierarchy\>
    <enableVisitSharing\>false</enableVisitSharing\>
</RetailExecutionSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>RetailExecution</members\>
        <name\>Settings</name\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=aa17b2aa70cf058f442cc872c727643c47037e87a55c840a2184bbfde91cd7d4 url=/legacydeveloper/current/en-us/api_meta/meta_retrievalsummarydefinition.md -->

# RetrievalSummaryDefinition

Represents a metadata type that stores the header information of a retrieval definition. It enables the configuration of data retrieval patterns for summarizing related records across object relationships.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

RetrievalSummaryDefinition components have the suffix .retrievalSummaryDefinition and are stored in the .retrievalSummaryDefinitions folder.

## Version

RetrievalSummaryDefinition components are available in API version 61.0 and later. Individual fields may have specific minimum API version requirements as mentioned in the field descriptions.

## Fields

| Field Name | Description |
| --- | --- |
| masterLabel | 
Field Type

string

Description

Required.

A user-friendly name when RetrievalSummaryDefinition is created.





 |
| retrievalSummaryDefFields | 

Field Type

[RetrievalSummaryDefField\[\]](#RetrievalSummaryDefField)

Description

Collection of fields to retrieve from the root object of the retrieval definition. Each field definition specifies which field from the target object should be included in the retrieval and the order in which it should be processed.



 |
| retrievalSummaryDefObjects | 

Field Type

[RetrievalSummaryDefObject\[\]](#RetrievalSummaryDefObject)

Description

Collection of rollup definitions that aggregate data from related objects. Each object definition specifies a related object, the aggregation logic to apply, and the fields to retrieve from that object. This enables hierarchical data aggregation across object relationships.



 |
| rootObject | 

Field Type

string

Description

Required.

API name of the primary object that serves as the starting point for the retrieval definition. This object serves as the anchor point for all retrieval and rollup operations defined in this metadata. The value must be a valid Salesforce object API name.





 |

## RetrievalSummaryDefField

Represents a field definition that specifies a single field to retrieve from a target object. Each field definition includes the field API name and a sequence number that determines the processing order.

| Field Name | Description |
| --- | --- |
| field | 
Field Type

string

Description

Required.

API name of the field to retrieve from the target object. This must be a valid field API name on the specified object.



 |
| sequenceNumber | 

Field Type

int

Description

Required.

Processing order of the field in the retrieval operation. Fields are processed in ascending sequence number order. This allows you to control the order in which fields are displayed.



 |

## RetrievalSummaryDefObject

Represents a rollup definition that aggregates data from a related object. Each rollup definition specifies the aggregation logic, the fields to retrieve, and the processing order for summarizing data across object relationships.

| Field Name | Description |
| --- | --- |
| recordAggregationDefinition | 
Field Type

string

Description

Required.

Reference to the aggregation definition that specifies how data from the related object must be aggregated. This parameter references a RecordAggregationDefinition.



 |
| retrievalSummaryDefFields | 

Field Type

[RetrievalSummaryDefField\[\]](#RetrievalSummaryDefField)

Description

Collection of fields to retrieve from this related object. Each field definition specifies which field should be included and in what order. This is an optional array that allows you to specify additional fields beyond those defined in the aggregation definition.



 |
| sequenceNumber | 

Field Type

int

Description

Required.

Processing order of the rollup operation. Rollups are processed in ascending sequence number order, allowing you to control the hierarchy of data aggregation when multiple related objects are involved.



 |

## Usage

RetrievalSummaryDefinition is commonly used in Financial Services Cloud to define patterns for retrieving and summarizing data across related objects. Typical use cases include:

- Rollup Summarization: Aggregate data from child records to parent records, such as summing transaction amounts or counting related activities.
- Hierarchical Data Aggregation: Retrieve and summarize data across multiple levels of object relationships, enabling complex reporting and analytics.
- Data Consolidation: Combine information from multiple related objects into a single summary view for easier analysis and decision-making.
- Performance Optimization: Pre-define retrieval patterns to improve query performance when accessing related data across multiple objects.

## Declarative Metadata Sample Definition

The following is an example of a RetrievalSummaryDefinition component that retrieves data from an Account object and includes a rollup from related Opportunity records.

<?xml version="1.0" encoding="UTF-8"?>
<RetrievalSummaryDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
   <masterLabel\>Account Revenue Summary</masterLabel\>
   <rootObject\>Account</rootObject\>
   <retrievalSummaryDefFields\>
      <field\>Name</field\>
      <sequenceNumber\>1</sequenceNumber\>
   </retrievalSummaryDefFields\>
   <retrievalSummaryDefFields\>
      <field\>Industry</field\>
      <sequenceNumber\>2</sequenceNumber\>
   </retrievalSummaryDefFields\>
   <retrievalSummaryDefObjects\>
      <recordAggregationDefinition\>OpportunityRevenueRollup</recordAggregationDefinition\>
      <sequenceNumber\>1</sequenceNumber\>
      <retrievalSummaryDefFields\>
         <field\>Amount</field\>
         <sequenceNumber\>1</sequenceNumber\>
      </retrievalSummaryDefFields\>
      <retrievalSummaryDefFields\>
         <field\>CloseDate</field\>
         <sequenceNumber\>2</sequenceNumber\>
      </retrievalSummaryDefFields\>
   </retrievalSummaryDefObjects\>
</RetrievalSummaryDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>RetrievalSummaryDefinition</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=e35243c148918021a3243bff4c8526229e999ffb744875efb249419d02ff3d2e url=/legacydeveloper/current/en-us/api_meta/meta_retrieve.md -->

# retrieve()

The retrieve() call retrieves XML file representations of components in an organization.

## Syntax

AsyncResult = metadatabinding.retrieve([RetrieveRequest](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve_request.htm "The RetrieveRequest parameter specified on a retrieve() call encapsulates options for determining which packages or files are retrieved."))

## Usage

Use this call to retrieve file representations of components in an organization.

Here are the deploy limits. Limits can change without notice.

| Feature | Limit |
| --- | --- |
| Maximum compressed .zip folder size1 | Approximately 39 MB |
| Maximum uncompressed folder size2 | Approximately 600 MB |
| Maximum number of files in AppExchange packages | 35,000 |
| Maximum number of files in packages | 10,000 |

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can perform a **retrieve()** call for a big object only if its index is defined. If a big object is created in Setup and doesn’t yet have an index defined, you can’t retrieve it.

1 Metadata API base-64 encodes components after they’re compressed. The resulting .zip file can't exceed 50 MB. Base-64 encoding increases the size of the payload by approximately 22%, so your compressed payload can't exceed approximately 39 MB before encoding.

2 When deploying an unzipped project, all files in the project are compressed first. The maximum size of uncompressed components in an uncompressed project is 600 MB or less, depending on the files’ compression ratio. If the files have a high compression ratio, you can migrate a total of approximately 600 MB because the compressed size would be under 39 MB. However, if the components can't be compressed much, like binary static resources, you can migrate less than 600 MB.

In API version 31.0 and later, the process of making a retrieve() call has been simplified. You no longer have to call [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") after a retrieve() call to obtain the status of the retrieve operation. Instead, make calls to [checkRetrieveStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkretrievestatus.htm "Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.") only. If the retrieve operation is in progress, call checkRetrieveStatus() again until the retrieve operation is completed. The checkStatus() call is still supported in versions API version 30.0 or earlier, but isn’t available in API version 31.0 and later.

For API version 31.0 or later, retrieve packaged or unpackaged components by using the following steps.

1. Issue a retrieve() call to start the asynchronous retrieval. An [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is returned. Note the value in the id field, and use it for the next step.
2. Issue a checkRetrieveStatus() call, and pass in the id value from the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object from the first step. Check the value of the done field of the returned [RetrieveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm#meta_retrieveresult "The retrieve() call returns an array of RetrieveResult objects."). If it’s true, the call is completed, and you proceed to the next step. Otherwise, repeat this step to call checkRetrieveStatus() again until the done field is true.
3. Retrieve the zip file field and other desired fields from RetrieveResult, which the final call to checkRetrieveStatus() returned in the previous step.

For API version 30.0 or earlier, retrieve packaged or unpackaged components by using the following steps.

1. Issue a retrieve() call to start the asynchronous retrieval. An [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is returned. If the call is completed, the done field contains true. Most often, the call isn’t completed quickly enough to be noted in the result. If it’s completed, note the value in the id field returned, and skip the next step.
2. If the call isn’t completed, issue a checkStatus() call in a loop using the value in the id field of the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object, returned by the retrieve() call in the previous step. Check the [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object returned until the done field contains true. The time taken to complete a retrieve() call depends on the size of the zip file being deployed, so use a longer wait time between iterations as the size of the zip file increases.
3. Issue a checkRetrieveStatus() call to obtain the results of the retrieve() call, using the id value returned in the first step.

For examples of manifest files, see [Sample package.xml Manifest Files](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/manifest_samples.htm "This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if you want to work with all the metadata in one batch.").

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Arguments

### retrieveRequest

- **Type**: [RetrieveRequest](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve_request.htm "The RetrieveRequest parameter specified on a retrieve() call encapsulates options for determining which packages or files are retrieved.")
- **Description**: Encapsulates options for determining which packages or files are retrieved.

## Response

[AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")

## Sample Code—Java

This sample shows how to retrieve components into a zip file. See the deploy() sample code for details on how to deploy a zip file.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This sample requires API version 34.0 or later.

package com.doc.samples;

import java.io.\*;
import java.util.\*;
import java.nio.ByteBuffer;
import java.nio.channels.\*;
import java.rmi.RemoteException;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

import com.sforce.soap.metadata.AsyncResult;
import com.sforce.soap.metadata.MetadataConnection;
import com.sforce.soap.enterprise.EnterpriseConnection;
import com.sforce.soap.metadata.RetrieveMessage;
import com.sforce.soap.metadata.RetrieveRequest;
import com.sforce.soap.metadata.RetrieveResult;
import com.sforce.soap.metadata.RetrieveStatus;
import com.sforce.soap.enterprise.LoginResult;
import com.sforce.ws.ConnectionException;
import com.sforce.ws.ConnectorConfig;
import com.sforce.soap.metadata.PackageTypeMembers;

public class RetrieveSample {

    // Binding for the metadata WSDL used for making metadata API calls
    private MetadataConnection metadataConnection;
    
    static BufferedReader rdr = new BufferedReader(new InputStreamReader(System.in));

    // one second in milliseconds
    private static final long ONE\_SECOND = 1000;
    // maximum number of attempts to retrieve the results
    private static final int MAX\_NUM\_POLL\_REQUESTS = 50; 

    // manifest file that controls which components get retrieved
    private static final String MANIFEST\_FILE = "package.xml"; 

    private static final double API\_VERSION = 31.0; 

    public static void main(String\[\] args) throws Exception {
        final String USERNAME = "user@company.com";
        // This is only a sample. Hard coding passwords in source files is a bad practice.
        final String PASSWORD = "password"; 
        final String URL = "https://login.salesforce.com/services/Soap/c/31.0";
        
        RetrieveSample sample = new RetrieveSample(USERNAME, PASSWORD, URL);
        sample.retrieveZip();
    }
    
    public RetrieveSample(String username, String password, String loginUrl) 
            throws ConnectionException {
        createMetadataConnection(username, password, loginUrl);
    }

    
    private void retrieveZip() throws RemoteException, Exception
    {
        RetrieveRequest retrieveRequest = new RetrieveRequest();
        // The version in package.xml overrides the version in RetrieveRequest
        retrieveRequest.setApiVersion(API\_VERSION);
        setUnpackaged(retrieveRequest);

        // Start the retrieve operation
        AsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);
        String asyncResultId = asyncResult.getId();
        
        // Wait for the retrieve to complete
        int poll = 0;
        long waitTimeMilliSecs = ONE\_SECOND;
        RetrieveResult result = null;
        do {
            Thread.sleep(waitTimeMilliSecs);
            // Double the wait time for the next iteration
            waitTimeMilliSecs \*= 2;
            if (poll++ > MAX\_NUM\_POLL\_REQUESTS) {
                throw new Exception("Request timed out.  If this is a large set " +
                "of metadata components, check that the time allowed " +
                "by MAX\_NUM\_POLL\_REQUESTS is sufficient.");
            }
            result = metadataConnection.checkRetrieveStatus(
                    asyncResultId, true);
            System.out.println("Retrieve Status: " + result.getStatus());
        } while (!result.isDone());

        if (result.getStatus() == RetrieveStatus.Failed) {
            throw new Exception(result.getErrorStatusCode() + " msg: " +
                    result.getErrorMessage());
        } else if (result.getStatus() == RetrieveStatus.Succeeded) {      
            // Print out any warning messages
            StringBuilder buf = new StringBuilder();
            if (result.getMessages() != null) {
                for (RetrieveMessage rm : result.getMessages()) {
                    buf.append(rm.getFileName() + " - " + rm.getProblem());
                }
            }
            if (buf.length() > 0) {
                System.out.println("Retrieve warnings:\\n" + buf);
            }
    
            // Write the zip to the file system
            System.out.println("Writing results to zip file");
            ByteArrayInputStream bais = new ByteArrayInputStream(result.getZipFile());
            File resultsFile = new File("retrieveResults.zip");
            FileOutputStream os = new FileOutputStream(resultsFile);
            try {
                ReadableByteChannel src = Channels.newChannel(bais);
                FileChannel dest = os.getChannel();
                copy(src, dest);
                
                System.out.println("Results written to " + resultsFile.getAbsolutePath());
            } finally {
                os.close();
            }
        }
    }
    
    /\*\*
     \* Helper method to copy from a readable channel to a writable channel,
     \* using an in-memory buffer.
     \*/
    private void copy(ReadableByteChannel src, WritableByteChannel dest)
        throws IOException
    {
        // Use an in-memory byte buffer
        ByteBuffer buffer = ByteBuffer.allocate(8092);
        while (src.read(buffer) != -1) {
            buffer.flip();
            while(buffer.hasRemaining()) {
                dest.write(buffer);
            }
            buffer.clear();
        }
    }
    
    private void setUnpackaged(RetrieveRequest request) throws Exception
    {
        // Edit the path, if necessary, if your package.xml file is located elsewhere
        File unpackedManifest = new File(MANIFEST\_FILE);
        System.out.println("Manifest file: " + unpackedManifest.getAbsolutePath());
        
        if (!unpackedManifest.exists() || !unpackedManifest.isFile())
            throw new Exception("Should provide a valid retrieve manifest " +
                    "for unpackaged content. " +
                    "Looking for " + unpackedManifest.getAbsolutePath());

        // Note that we populate the \_package object by parsing a manifest file here.
        // You could populate the \_package based on any source for your
        // particular application.
        com.sforce.soap.metadata.Package p = parsePackage(unpackedManifest);
        request.setUnpackaged(p);
    }

    private com.sforce.soap.metadata.Package parsePackage(File file) throws Exception {
        try {
            InputStream is = new FileInputStream(file);
            List<PackageTypeMembers> pd = new ArrayList<PackageTypeMembers>();
            DocumentBuilder db =
                DocumentBuilderFactory.newInstance().newDocumentBuilder();
            Element d = db.parse(is).getDocumentElement();
            for (Node c = d.getFirstChild(); c != null; c = c.getNextSibling()) {
                if (c instanceof Element) {
                    Element ce = (Element)c;
                    //
                    NodeList namee = ce.getElementsByTagName("name");
                    if (namee.getLength() == 0) {
                        // not
                        continue;
                    }
                    String name = namee.item(0).getTextContent();
                    NodeList m = ce.getElementsByTagName("members");
                    List<String\> members = new ArrayList<String\>();
                    for (int i = 0; i < m.getLength(); i++) {
                        Node mm = m.item(i);
                        members.add(mm.getTextContent());
                    }
                    PackageTypeMembers pdi = new PackageTypeMembers();
                    pdi.setName(name);
                    pdi.setMembers(members.toArray(new String\[members.size()\]));
                    pd.add(pdi);
                }
            }
            com.sforce.soap.metadata.Package r = new com.sforce.soap.metadata.Package();
            r.setTypes(pd.toArray(new PackageTypeMembers\[pd.size()\]));
            r.setVersion(API\_VERSION + "");
            return r;
        } catch (ParserConfigurationException pce) {
            throw new Exception("Cannot create XML parser", pce);
        } catch (IOException ioe) {
            throw new Exception(ioe);
        } catch (SAXException se) {
            throw new Exception(se);
        }
    }
    
 
    private void createMetadataConnection(final String username,
            final String password, final String loginUrl)
            throws ConnectionException {

        final ConnectorConfig loginConfig = new ConnectorConfig();
        loginConfig.setAuthEndpoint(loginUrl);
        loginConfig.setServiceEndpoint(loginUrl);
        loginConfig.setManualLogin(true);
        LoginResult loginResult = (new EnterpriseConnection(loginConfig)).login(
                username, password);

        final ConnectorConfig metadataConfig = new ConnectorConfig();
        metadataConfig.setServiceEndpoint(loginResult.getMetadataServerUrl());
        metadataConfig.setSessionId(loginResult.getSessionId());
        this.metadataConnection = new MetadataConnection(metadataConfig);
    }
    
    //The sample client application retrieves the user's login credentials.
    // Helper function for retrieving user input from the console
    String getUserInput(String prompt) {
        System.out.print(prompt);
        try {
            return rdr.readLine();
        }
        catch (IOException ex) {
            return null;
        }
    }

}

<!-- document id=7a97004160fa230407a5460fd5f4aa2993b281a64a5490c07a77c1c7f28dee88 url=/legacydeveloper/current/en-us/api_meta/meta_retrieve_request.md -->

# RetrieveRequest

The RetrieveRequest parameter specified on a retrieve() call encapsulates options for determining which packages or files are retrieved.

## Fields

The RetrieveRequest object consists of the following properties:

### apiVersion

- **Type**: double
- **Description**: Required. The API version for the retrieve request. The API version determines the fields retrieved for each metadata type. For example, an icon field was added to the [CustomTab](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_tab.htm) for API version 14.0. If you retrieve components for version 13.0 or earlier, the components don't include the icon field. In API version 31.0 and later, the API version that’s specified in package.xml is used for the retrieve() call and overrides the version in the apiVersion field. If the version isn't specified in package.xml, the version in this field is used.

### packageNames

- **Type**: string\[\]
- **Description**: A list of package names to be retrieved. If you're retrieving only unpackaged components, don't specify a name here. You can retrieve packaged and unpackaged components in the same retrieve. This field is for reference only, don't use it to retrieve packaged metadata for development.

### rootTypesWithDependencies

- **Type**: string\[\]
- **Description**: A list of component types to retrieve dependencies for. Currently, the only allowed value for this parameter is Bot.
    
    Use this parameter if any requested metadata components are of type Bot.
    
    Make up to 25 retrieve requests using this parameter per day. A single retrieve request using this parameter can request dependencies for up to 100 components.
    
    This field is available in API version 64.0 and later.

### singlePackage

- **Type**: boolean
- **Description**: Specifies whether only a single package is being retrieved (true) or not (false). If false, then more than one package is being retrieved.

### specificFiles

- **Type**: string\[\]
- **Description**: A list of file names to be retrieved. If a value is specified for this property, packageNames must be set to null and singlePackage must be set to true.

### unpackaged

- **Type**: [Package](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_package.htm)
- **Description**: A list of components to retrieve that aren't in a package.

<!-- document id=f15b793c3c30981d31bd786e679eae2136000a24c095a1cdadc25acb73510aa1 url=/legacydeveloper/current/en-us/api_meta/meta_retrieveresult.md -->

# RetrieveResult

The retrieve() call returns an array of RetrieveResult objects.

#### See Also

- [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.")

## Fields

A RetrieveResult object has these fields.

### done

- **Type**: boolean
- **Description**: Required. Indicates whether the retrieve() call is completed (true) or not (false). This field is available in API version 31.0 and later.

### errorMessage

- **Type**: string
- **Description**: If an error occurs during the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") call, this field contains a descriptive message about this error. This field is available in API version 31.0 and later.

### errorStatusCode

- **Type**: StatusCode
- **Description**: If an error occurs during the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") call, this field contains the status code for this error. This field is available in API version 31.0 and later.
    
    For a description of each StatusCode value, see [StatusCode](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_concepts_core_data_objects.htm#statuscode_topic) in the [SOAP API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/ "HTML (New Window)").

### fileProperties

- **Type**: [FileProperties](#meta_retrieveresult_fileproperties)\[\]
- **Description**: Contains information about the properties of each component in the .zip file, and the manifest file package.xml. One object per component is returned.

### id

- **Type**: ID
- **Description**: ID of the component being retrieved.

### messages

- **Type**: [RetrieveMessage](#meta_retrieveresult_retrievemessage)\[\]
- **Description**: Contains information about the success or failure of the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") call.

### status

- **Type**: RetrieveStatus ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string)
- **Description**: The status of the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") call.
    
    This field is available in API version 31.0 and later.
- **Possible values**:
    - Pending
    - InProgress
    - Succeeded
    - Failed

### success

- **Type**: boolean
- **Description**: Indicates whether the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") call was successful (true) or not (false). This field is available in API version 31.0 and later.

### zipFile

- **Type**: base64Binary
- **Description**: The zip file returned by the retrieve request. Base 64-encoded binary data. Before making an API call, client applications must encode the binary attachment data as base64. Upon receiving a response, client applications must decode the base64 data to binary. This conversion is handled for you by a SOAP client.

## FileProperties

This component contains information about the properties of each component in the .zip file, and the manifest file package.xml. One object per component is returned. This component doesn’t contain information about any associated metadata files in the .zip file, only the component files and manifest file. FileProperties contains the following properties:

### createdById

- **Type**: string
- **Description**: Required. ID of the user who created the file.

### createdByName

- **Type**: string
- **Description**: Required. Name of the user who created the file.

### createdDate

- **Type**: dateTime
- **Description**: Required. Date and time when the file was created.

### fileName

- **Type**: string
- **Description**: Required. Name of the file.

### fullName

- **Type**: string
- **Description**: Required. The file developer name used as a unique identifier for API access. The value is based on the fileNamebut the characters allowed are more restrictive. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

### id

- **Type**: string
- **Description**: Required. ID of the file.

### lastModifiedById

- **Type**: string
- **Description**: Required. ID of the user who last modified the file.

### lastModifiedByName

- **Type**: string
- **Description**: Required. Name of the user who last modified the file.

### lastModifiedDate

- **Type**: dateTime
- **Description**: Required. Date and time that the file was last modified.

### manageableState

- **Type**: ManageableState (enumeration of type string)
- **Description**: Indicates the manageable state of the specified component if it’s contained in a package:
    - beta
    - deleted
    - deprecated
    - deprecatedEditable
    - installed
    - installedEditable
    - released
    - unmanaged

### namespacePrefix

- **Type**: string
- **Description**: If any, the namespace prefix of the component.

### type

- **Type**: string
- **Description**: Required. The metadata type, such as CustomObject, CustomField, or ApexClass.

## RetrieveMessage

[RetrieveResult](#meta_retrieveresult "The retrieve() call returns an array of RetrieveResult objects.") returns this object, which contains information about the success or failure of the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") call. One object per problem is returned:

### fileName

- **Type**: string
- **Description**: The name of the file in the retrieved .zip file where a problem occurred.

### problem

- **Type**: string
- **Description**: A description of the problem that occurred.

<!-- document id=2f1dc5c4872bdc8f879b713c8abee40c7df5d1bbf00a8ef5833ad5d251edc805 url=/legacydeveloper/current/en-us/api_meta/meta_role.md -->

# Role

Represents a role in your organization.

## Declarative Metadata File Suffix and Directory Location

The file suffix for role components is .role and components are stored in the roles directory of the corresponding package directory.

## Version

Role components are available in API version 24.0 and later.

## Fields

This metadata type extends to subtype [RoleOrTerritory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_roleorterritory.htm#meta_roleorterritory "Represents the common base type and valid values for role or territory.").

| Field Name | Field Type | Description |
| --- | --- | --- |
| fullName | string | The unique identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") component. Corresponds to **Role Name** in the user interface. |
| parentRole | string | The role above this role in the hierarchy. |

## Declarative Metadata Sample Definition

The following is the definition of a role.

<?xml version="1.0" encoding="UTF-8"?>
<Role xmlns="http://soap.sforce.com/2006/04/metadata">
    <caseAccessLevel\>Edit</caseAccessLevel\>
    <contactAccessLevel\>Edit</contactAccessLevel\>
    <description\>Sample Role</description\>
    <mayForecastManagerShare\>false</mayForecastManagerShare\>
    <name\>R22</name\>
    <opportunityAccessLevel\>Read</opportunityAccessLevel\>
</Role\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=431302f1ac786b98c364e1868726b6e85acb6333345d1c0cc53f3252da82a311 url=/legacydeveloper/current/en-us/api_meta/meta_roleorterritory.md -->

# RoleOrTerritory

Represents the common base type and valid values for role or territory.

## Version

RoleOrTerritory components are available in API version 24.0 and later.

You can’t create a RoleOrTerritory component directly. Use the Role or Territory metadata types instead.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d828805e65">Field Name</th>

              <th class="featureTableHeader  " id="d828805e68">Field Type</th>

              <th class="featureTableHeader  " id="d828805e71">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d828805e65" data-title="Field Name"><span class="keyword parmname">caseAccessLevel</span></td>

              <td class="entry" headers="d828805e68" data-title="Field Type">string</td>

              <td class="entry" headers="d828805e71" data-title="Description">Specifies whether a user can access other users’ cases that are associated with
                accounts the user owns. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph apex_code">Read</samp></li>

                  <li class="li"><samp class="codeph apex_code">Edit</samp></li>

                  <li class="li"><samp class="codeph apex_code">None</samp></li>

                </ul>
                <p class="p">This field is not visible if your organization’s sharing model for cases is Public
                  Read/Write.</p>
                <p class="p" id="default_value"><a name="default_value"><!-- --></a>If no value is set for this field, this field value
                  uses the default access level that is specified in the Manage Territory page in
                  Setup.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d828805e65" data-title="Field Name"><span class="keyword parmname">contactAccessLevel</span></td>

              <td class="entry" headers="d828805e68" data-title="Field Type">string</td>

              <td class="entry" headers="d828805e71" data-title="Description">Specifies whether a user can access other users’ contacts that are associated with
                accounts the user owns. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph apex_code">Read</samp></li>

                  <li class="li"><samp class="codeph apex_code">Edit</samp></li>

                  <li class="li"><samp class="codeph apex_code">None</samp></li>

                </ul>
                <p class="p">This field is not visible if your organization’s sharing model for contacts is
                  Public Read/Write or Controlled by Parent.</p>
                <p class="p">If no value is set for this field, this
                  field value uses the default access level that is specified in the Manage Territory page in
                  Setup.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d828805e65" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d828805e68" data-title="Field Type">string</td>

              <td class="entry" headers="d828805e71" data-title="Description">The description of the role or territory.</td>

            </tr>

            <tr>
              <td class="entry" headers="d828805e65" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d828805e68" data-title="Field Type">string</td>

              <td class="entry" headers="d828805e71" data-title="Description">The unique identifier for API access. The <span class="keyword parmname">fullName</span> can contain
                only underscores and alphanumeric characters. It must be unique, begin with a letter, not
                include spaces, not end with an underscore, and not contain two consecutive underscores.
                This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d828805e65" data-title="Field Name"><span class="keyword parmname">mayForecastManagerShare</span></td>

              <td class="entry" headers="d828805e68" data-title="Field Type">boolean</td>

              <td class="entry" headers="d828805e71" data-title="Description">Indicates whether the forecast manager can manually share their own forecast.</td>

            </tr>

            <tr>
              <td class="entry" headers="d828805e65" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d828805e68" data-title="Field Type">string</td>

              <td class="entry" headers="d828805e71" data-title="Description">Required. The name of the role or territory.</td>

            </tr>

            <tr>
              <td class="entry" headers="d828805e65" data-title="Field Name"><span class="keyword parmname">opportunityAccessLevel</span></td>

              <td class="entry" headers="d828805e68" data-title="Field Type">string</td>

              <td class="entry" headers="d828805e71" data-title="Description">Specifies whether a user can access other users’ opportunities that are associated
                with accounts the user owns. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph apex_code">Read</samp></li>

                  <li class="li"><samp class="codeph apex_code">Edit</samp></li>

                  <li class="li"><samp class="codeph apex_code">None</samp></li>

                </ul>
                <p class="p">This field is not visible if your organization’s sharing model for opportunities is
                  Public Read/Write.</p>
                <p class="p">If no value is set for this field, this field value uses the
                  default access level that is specified in the Manage Territory page in Setup.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of a role.

<?xml version="1.0" encoding="UTF-8"?>
<Role xmlns="http://soap.sforce.com/2006/04/metadata">
    <caseAccessLevel\>Edit</caseAccessLevel\>
    <contactAccessLevel\>Edit</contactAccessLevel\>
    <description\>Sample Role</description\>
    <mayForecastManagerShare\>false</mayForecastManagerShare\>
    <name\>R22</name\>
    <opportunityAccessLevel\>Read</opportunityAccessLevel\>
</Role\>

The following is the definition of a territory.

<?xml version="1.0" encoding="UTF-8"?>
<Territory xmlns="http://soap.sforce.com/2006/04/metadata">
    <accountAccessLevel\>Edit</accountAccessLevel\>
    <caseAccessLevel\>Edit</caseAccessLevel\>
    <contactAccessLevel\>Edit</contactAccessLevel\>
    <description\>Sample Territory</description\>
    <mayForecastManagerShare\>false</mayForecastManagerShare\>
    <name\>T22name</name\>
    <opportunityAccessLevel\>Read</opportunityAccessLevel\>
</Territory\>

#### See Also

- [Role](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_role.htm "Represents a role in your organization.")
- [Territory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_territory.htm "Represents a territory.")

<!-- document id=0ada9bfd0201b295346bc87f1dee97b7cd95bc422b4a314181dfc5486d6235be url=/legacydeveloper/current/en-us/api_meta/meta_rparobotpoolmetadata.md -->

# RpaRobotPoolMetadata

Reserved for future use.

<!-- document id=810b60295e3ccf9472bc4be4671576491dc733c95561a1793da4a6ae2dea5b87 url=/legacydeveloper/current/en-us/api_meta/meta_deploy_run_relevant_tests.md -->

# Run Relevant Apex Tests in a Deployment (Beta)

Use the RunRelevantTests (beta) test level to run only the Apex tests that are relevant to your deployment. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

The RunRelevantTests test level and the associated @IsTest() annotations are pilot or beta services that are subject to the Beta Services Terms at Agreements — Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of these pilot or beta services are at the Customer’s sole discretion.

## Why Use RunRelevantTests

Compared to the default RunLocalTests test level set for production deployments, using RunRelevantTests can significantly shorten deployment time. Whereas the RunLocalTests test level runs all Apex tests in the org except the ones that originate from installed managed and unlocked packages, RunRelevantTests runs only Apex tests relevant to the deployment payload. In orgs with extensive test suites, RunLocalTests causes long deployment times even for minor code changes, but with RunRelevantTests, the number of tests that are run are proportionally scaled to deployment size. In other words, smaller deployments result in the inclusion of fewer relevant tests compared to larger deployments.

Compared to the RunSpecifiedTests test level, where only a specified subset of Apex tests are run, RunRelevantTests requires less DevOps overhead. For RunSpecifiedTests, you must manually determine the tests that are applicable to the changes, which often requires custom DevOps tooling. In contrast, the RunRelevantTests test engine analyzes the deployment payload and automatically runs a subset of tests based on that analysis.

When you set the deployment test level to RunRelevantTests, you must still meet at least 75% test coverage for every class and trigger included in the deployment package. This coverage is computed for each class and trigger individually and is different from the overall coverage percentage. If your deployment package doesn’t meet code coverage requirements when RunRelevantTests is set, you can use test class annotations to augment your test suite. See the “Apply Test Class Overrides to RunRelevantTests” section.

## Set the Test Level to RunRelevantTests

To run relevant tests, set the RunRelevantTests test level on the DeployOptions object. Then pass DeployOptions as an argument to the deploy() call.

// Create the DeployOptions object.
DeployOptions deployOptions = new DeployOptions();

// Set the appropriate test level.
deployOptions.setTestLevel(TestLevel.RunRelevantTests);

// Call deploy() by passing the deployment options object as an argument. 
AsyncResult asyncResult = metadatabinding.deploy(zipBytes,deployOptions);

You can [Deploy Metadata with Apex Testing Using REST](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_rest_deploy.htm "Deploy using the deployRequest REST resource to initiate a request that handles all operations for the deployment."). Set the RunRelevantTests test level on the deployOptions object in the request body.

You can deploy metadata from a local project by using the Salesforce CLI. Set the \--test-level flag on one of the [supported project commands](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm#cli_reference_project_deploy_start_unified) to RunRelevantTests.

## Apply Test Class Overrides to RunRelevantTests

For fine-grained control of the tests run with the RunRelevantTests level, you can use @IsTest annotations.

Add the @IsTest(critical=true) annotation to a test class so that it always runs during deployments, regardless of the classes or triggers in the deployment payload. Add the @IsTest(testFor='...') annotation to a test class so that its tests run whenever specified classes or triggers are new or changed in the deployment payload.

For implementation instructions, see [@IsTest(critical=true)](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm#isCriticalTrue) and [@IsTest(testFor='...')](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm#isTestFor) in the Apex Developer Guide.

#### See Also

- [_Apex Developer Guide_: @IsTest Annotation](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm)

<!-- document id=aa0b367948f4aafdba7217f0d6a36218e15a34e4a15df52786da8bde3fcb4a95 url=/legacydeveloper/current/en-us/api_meta/meta_deploy_run_local_tests.md -->

# Run the Same Tests in Sandbox and Production Deployments

Starting in API version 34.0, you can choose which tests to run in your development environment, such as only local tests, to match the tests run in production. In earlier versions, if you enabled tests in your sandbox deployment, you couldn’t exclude managed package tests.

By default, no tests are run in a deployment to a non-production organization, such as a sandbox or a Developer Edition organization. To specify tests to run in your development environment, set a [testLevel deployment option](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm#meta_deploy "Uses file representations of components to create, update, or delete those components in a Salesforce org."). For example, to run local tests in a deployment and to exclude managed package tests, set testLevel on the DeployOptions object to TestLevel.RunLocalTests. Next, pass this object as an argument to the deploy() call as follows.

// Create the DeployOptions object.
DeployOptions deployOptions = new DeployOptions();

// Set the appropriate test level.
**deployOptions.setTestLevel(TestLevel.RunLocalTests);**

// Call deploy() by passing the deployment options object as an argument. 
AsyncResult asyncResult = metadatabinding.deploy(zipBytes,deployOptions);

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The RunLocalTests test level is enforced regardless of the contents of the deployment package. In contrast, tests are executed by default in production only if your deployment package contains Apex classes or triggers. You can use RunLocalTests for sandbox and production deployments.

<!-- document id=9615c1cb04bf59e0783500b23eea6a16866ac11869e2a59af667703a9a82db3f url=/legacydeveloper/current/en-us/api_meta/meta_deploy_run_specific_tests.md -->

# Running a Subset of Tests in a Deployment

Test levels enable you to have more control over which tests are run in a deployment. To shorten deployment time to production, run a subset of tests when deploying Apex components. The default test execution behavior in production has also changed. By default, if no test level is specified, no tests are executed, unless your deployment package contains Apex classes or triggers.

If the code coverage of an Apex component in the deployment is less than 75%, the deployment fails. If one of the specified tests fails, the deployment also fails. We recommend that you test your deployment in sandbox first to ensure that the specified tests cover each component sufficiently. Even if your organization’s overall code coverage is 75% or more, the individual coverage of the Apex components being deployed can be less. If the code coverage requirement isn’t met, write more tests and include them in the deployment.

To run a subset of tests, set the RunSpecifiedTests test level on the DeployOptions object. Next, specify each test class to run in DeployOptions. Finally, pass DeployOptions as an argument to the deploy() call. The following example performs those steps to run only the specified test classes.

// Create the DeployOptions object.
DeployOptions deployOptions = new DeployOptions();

// Set the appropriate test level.
**deployOptions.setTestLevel(TestLevel.RunSpecifiedTests);**

// Specify the test classes to run.
// String array contains test class names.
String\[\] tests = {"TestClass1", "TestClass2", "TestClass3"};
// Add the test class names array to the deployment options.
**deployOptions.setRunTests(tests);**

// Call deploy() by passing the deployment options object as an argument. 
AsyncResult asyncResult = metadatabinding.deploy(zipBytes,deployOptions);

**Notes About Running Specific Tests**

- You can specify only test classes. You can’t specify individual test methods.
- We recommend that you refactor test classes to include the minimum number of tests that meet code coverage requirements. Refactoring your test classes can contribute to shorter test execution times, and as a result, shorter deployment times.
- You can deactivate a trigger in the target organization by deploying it with an inactive state. However, the trigger must have been previously deployed with an active state.

#### See Also

- [Run Relevant Apex Tests in a Deployment (Beta)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_run_relevant_tests.htm "Use the RunRelevantTests (beta) test level to run only the Apex tests that are relevant to your deployment. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies.")

<!-- document id=7eb81b6694bd3f766a599ee9e05d5b6694d2bb096d104c76a3e2dffb3452c772 url=/legacydeveloper/current/en-us/api_meta/meta_deploy_running_tests.md -->

# Running Tests in a Deployment

Learn default test execution rules for Salesforce production deployments, including API version differences and Apex test requirements.

## Default Test Execution in Production

When no test level is specified in the deployment options, the default test execution behavior depends on the contents of your deployment package. When deploying to production, all tests, except those that originate from managed packages, are executed if your deployment package contains Apex classes or triggers. If your package doesn’t contain Apex components, no tests are run by default.

In API version 33.0 and earlier, tests were run for components that required tests, such as custom objects, and not only for Apex components. For example, if your package contains a custom object, all tests are run in API version 33.0 and earlier. In contrast, starting with API version 34.0, no tests are run for this package. The API version corresponds to the version of your API client or the version of the tool you’re using (Ant Migration Tool).

You can run tests for a deployment of non-Apex components. You can override the default test execution behavior by setting the test level in your deployment options. Test levels are enforced regardless of the types of components present in your deployment package. We recommend that you run all local tests in your development environment, such as sandbox, before deploying to production. Running tests in your development environment reduces the number of tests needed to run in a production deployment.

## Default Test Execution in Production for API Version 33.0 and Earlier

For deployment to a production organization, all local tests in your organization are run by default. Tests that originate from installed managed packages aren’t run by default. If any test fails, the entire deployment is rolled back.

If the deployment includes components for the following metadata types, all local tests are run.

- ApexClass
- ApexComponent
- ApexPage
- ApexTrigger
- ArticleType
- BaseSharingRule
- CriteriaBasedSharingRule
- CustomField
- CustomObject
- DataCategoryGroup
- Flow
- InstalledPackage
- NamedFilter
- OwnerSharingRule
- PermissionSet
- Profile
- Queue
- RecordType
- RemoteSiteSetting
- Role
- SharingReason
- Territory
- Validation Rules
- Workflow

For example, no tests are run for the following deployments:

- 1 CustomApplication component
- 100 Report components and 40 Dashboard components

But all local tests are run for any of the following example deployments, because they include at least one component from the list above:

- 1 CustomField component
- 1 ApexComponent component and 1 ApexClass component
- 5 CustomField components and 1 ApexPage component
- 100 Report components, 40 Dashboard components, and 1 CustomField component

#### See Also

- [deploy()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy.htm "Uses file representations of components to create, update, or delete those components in a Salesforce org.")
- [Run Relevant Apex Tests in a Deployment (Beta)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_run_relevant_tests.htm "Use the RunRelevantTests (beta) test level to run only the Apex tests that are relevant to your deployment. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies.")

<!-- document id=f4b0c4bf43dbff4b036ac571d3e642643a2e67eab08640e378740dd6fe1e7a1c url=/legacydeveloper/current/en-us/api_meta/mfg_salesagreementsettings_metadata_api.md -->

# SalesAgreementSettings

Represents settings that control the display of agreement terms metrics in sales agreements and the calculation of the actual quantity of products in sales agreements. These settings also control the approval of sales agreements.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details.

## File Suffix and Directory Location

SalesAgreementSettings values are stored in the SalesAgreementSettings.salesAgreementSetting file in the salesAgreementSettings directory.

## Version

SalesAgreementSettings components are available in API version 47.0 and later.

## Fields

### actualsCalculationMode

- **Field Type**: ActualsCalculationMode([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string)
- **Description**: Required. Source from which the actual ordered quantity of a product in a sales agreement is calculated.
- **Possible values**:
    - DataProcessingEngine—Available in API version 63.0 and later.
    - Manual: Default
    - Orders
    - OrdersThroughContracts

### arePredfndStatusValOveride

- **Field Type**: boolean
- **Description**: Indicates whether predefined status validations are overridden (true) or not (false) when the Override Predefined Status Validations feature is enabled. Available in API version 65.0 and later.
- **Default value**: false

### decimalScale

- **Field Type**: int
- **Description**: Required. Number of decimal places applied to values in sales agreements. Available in API version 62.0 and later.

### displayGroups

- **Field Type**: [AdvAcctFrcstDisplayGroup](#mfg_salesagreementsettings_metadata_api_advacctfrcstdisplaygroup)
- **Description**: Represents information about the groups for the advanced account forecast set measures or dimensions. Available in API version 56.0 and later.

### displayedAgreementTermsMetrics

- **Field Type**: string
- **Description**: Required. Metrics that are selected for display in the sales agreement terms in the specified sequence. There can be a maximum of 10 comma-separated metric names in this list.

### futureActCalcSchedules

- **Field Type**: int
- **Description**: Required. Number of future schedules to include in actuals calculations in the sales agreement. Available in API version 63.0 and later.

### measureDefinitions

- **Field Type**: [AdvAcctForecastMeasureDef](#mfg_salesagreementsettings_metadata_api_advacctforecastmeasuredef)
- **Description**: Represents information about the measures to be displayed in the advanced account forecasts grid for the forecast set. Available in API version 56.0 and later.

### objectMapping

- **Field Type**: [ObjectMapping](#mfg_salesagreementsettings_metadata_api_objectmapping)
- **Description**: Foreign key to [ObjectMapping](#mfg_salesagreementsettings_metadata_api_objectmapping) that maps fields from the input object of SalesAgreementSettings to fields in the output object of SalesAgreementSettings.

### primaryNotifEmailAddress

- **Field Type**: string
- **Description**: The email address to which notifications are sent.

### renewalPeriodDayCount

- **Field Type**: int
- **Description**: The number of days before the end date of a sales agreement from when the agreement can be renewed. Available in API version 50.0 and later.

### secondaryNotifEmailAddress

- **Field Type**: string
- **Description**: The second email address to which notifications are sent.

## AdvAcctFrcstDisplayGroup

Represents information about the groups for the advanced account forecast set measures or dimensions. Available in API version 56.0 and later.

### advAcctFrcstDisplayGroupName

- **Field Type**: string
- **Description**: Required. Name of the advanced account forecast display group.

### displayGroupItems

- **Field Type**: [AdvAcctFrcstDplyGroupItem](#mfg_salesagreementsettings_metadata_api_advacctfrcstdplygroupitem)
- **Description**: Represents information about the items associated with a display group for an advanced account forecast set.

### displayGroupType

- **Field Type**: AdvAcctFrcstDisplayGroupType([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string)
- **Description**: Category for the display group.
- **Possible values**:
    - MEASURE

### isDefault

- **Field Type**: boolean
- **Description**: Indicates whether the display group is the default group (true) or not (false).
- **Default value**: false

### userProfileName

- **Field Type**: string
- **Description**: Profile for which the display group is applicable.

## AdvAcctFrcstDplyGroupItem

Represents information about the items associated with a display group for an advanced account forecast set. Available in API version 56.0 and later.

### advAcctFrcstDplyGroupItemName

- **Field Type**: string
- **Description**: Required. Name of the advanced account forecast display group item.

### displayOrder

- **Field Type**: string
- **Description**: Required. Display order of the display group item.

### measureReferenceName

- **Field Type**: string
- **Description**: Name of the measure associated with the display group item.

## AdvAcctForecastMeasureDef

Represents information about the measures to be displayed in the advanced account forecasts grid for the forecast set. Available in API version 56.0 and later.

### advAcctForecastMeasureDefName

- **Field Type**: string
- **Description**: Required. Name for the measure.

### aggregationType

- **Field Type**: AdvAcctFcstAggregationType([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string)
- **Description**: Required. Type of aggregation used for calculating advanced account forecast values.
- **Possible values**:
    - AVERAGE
    - MAXIMUM
    - MINIMUM
    - SUM

### computationMethod

- **Field Type**: AdvAcctFcstComputationMethod[enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string)
- **Description**: Required. Method used for calculating advanced account forecast values.
- **Possible values**:
    - CUSTOM
    - DATA\_PROCESSING\_ENGINE\_DEFINITION
    - FORMULA

### forecastDataMeasureName

- **Field Type**: string
- **Description**: Required. Field of the facts object used for this measure.

### forecastMeasureName

- **Field Type**: string
- **Description**: Required. Name for the measure to show on UI.

### forecastMeasureType

- **Field Type**: AdvAcctFcstMeasureType([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string)
- **Description**: Required. Measure type used for the generated advanced forecast values.
- **Possible values**:
    - QUANTITY
    - REVENUE

### isAdjustmentTracked

- **Field Type**: boolean
- **Description**: Indicates whether the adjustments made to the advanced account forecast values for this metric are tracked (true) or not (false).
- **Default value**: false

## ObjectMapping

Represents a map of fields in the input object of SalesAgreementSettings to fields in the output object of SalesAgreementSettings. The input object is SalesAgreementProductSchedule. The output object is SalesAgreementProduct.

### inputObject

- **Field Type**: string
- **Description**: Required. The input object for the SalesAgreementSettings. SalesAgreementProductSchedule is the input object for the SalesAgreementSettings.

### mappingFields

- **Field Type**: [ObjectMappingField](#mfg_salesagreementsettings_metadata_api_objectmappingfield)
- **Description**: The mapping of source object fields to target object fields for SalesAgreementSettings.

### outputObject

- **Field Type**: string
- **Description**: Required. The output object for the SalesAgreementSettings. SalesAgreementProduct is the output object for the SalesAgreementSettings.

## ObjectMappingField

A field name in the SalesAgreementProductSchedule object and the corresponding field name in the SalesAgreementProduct object.

For example, you can create a field named Revenue on the SalesAgreementProductSchedule object and a field named Total Revenue on the SalesAgreementProduct object. To view these field values in the agreement terms of a sales agreement, select the input object as SalesAgreementProductSchedule and the output object as SalesAgreementProduct. In this case, the input field is Revenue and the output field is Total Revenue.

### inputField

- **Field Type**: string
- **Description**: Required. Field in the object specified by the inputObject field in [ObjectMapping](#mfg_salesagreementsettings_metadata_api_objectmapping). This field is mapped to the field in outputField, which is a field in the object specified by the outputObject field in [ObjectMapping](#mfg_salesagreementsettings_metadata_api_objectmapping).

### outputField

- **Field Type**: string
- **Description**: Required. Field in the object specified by the outputObject field in [ObjectMapping](#mfg_salesagreementsettings_metadata_api_objectmapping). This field is mapped to the field name in inputField, which is a field in the object specified by the inputObject field in [ObjectMapping](#mfg_salesagreementsettings_metadata_api_objectmapping).

## Declarative Metadata Sample Definition

The following is an example of SalesAgreementSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<SalesAgreementSettings
	xmlns="http://soap.sforce.com/2006/04/metadata"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<actualsCalculationMode>Orders</actualsCalculationMode>
	<arePredfndStatusValOveride>false</arePredfndStatusValOveride>
      <decimalScale>0.2</decimalScale>
	<displayGroups>
		<advAcctFrcstDisplayGroupName>Test Measure Group</advAcctFrcstDisplayGroupName>
		<displayGroupItems>
			<advAcctFrcstDplyGroupItemName>PlannedQuantity</advAcctFrcstDplyGroupItemName>
			<displayOrder>1</displayOrder>
			<measureReferenceName>PlannedQuantity</measureReferenceName>
		</displayGroupItems>
		<displayGroupType>MEASURE</displayGroupType>
		<isDefault>false</isDefault>
		<userProfileName xsi:nil="true"/>
	</displayGroups>
	<displayedAgreementTermsMetrics>PlannedQuantity,ActualQuantity,SalesPrice,DiscountPercentage,DerivedPlannedAmount</displayedAgreementTermsMetrics>
      <futureActCalcSchedules>10</futureActCalcSchedules>
	<isOnlyApprovalProcessUsed>false</isOnlyApprovalProcessUsed>
	<measureDefinitions>
		<advAcctForecastMeasureDefName>PlannedQuantity</advAcctForecastMeasureDefName>
		<aggregationType>MINIMUM</aggregationType>
		<computationMethod>DATA\_PROCESSING\_ENGINE\_DEFINITION</computationMethod>
		<forecastDataMeasureName>PlannedQuantity</forecastDataMeasureName>
		<forecastMeasureName>PlannedQuantity</forecastMeasureName>
		<forecastMeasureType>QUANTITY</forecastMeasureType>
		<isAdjustmentTracked>true</isAdjustmentTracked>
	</measureDefinitions>
	<secondaryNotifEmailAddress>abc@salesforce.com</secondaryNotifEmailAddress>
	<primaryNotifEmailAddress>abc@salesforce.com</primaryNotifEmailAddress>
	<renewalPeriodDayCount>50</renewalPeriodDayCount>
	<objectMapping>
		<inputObject>SalesAgreementProductSchedule</inputObject>
		<mappingFields>
			<inputField>SAPS1\_\_c</inputField>
			<outputField>SAP1\_\_c</outputField>
		</mappingFields>
		<outputObject>SalesAgreementProduct</outputObject>
	</objectMapping>
</SalesAgreementSettings>

The following is an example package.xml that references the previous definition.

## Additional information

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
     <types\>   
         <members\>SalesAgreementProduct.SAP1\_\_c</members\>
         <members\>SalesAgreementProductSchedule.SAPS1\_\_c</members\>
         <name\>CustomField</name\>
     </types\>
     <types\>
         <members\>\*</members\>
         <name\>SalesAgreementSettings</name\>
     </types\>
     <version\>68.0</version\>
</Package\>

## Wildcard Support in the Manifest File

### 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=fe43dfa0f8132515d0dd36783084c1489b551e8123ac16a4699946aa2f64bae3 url=/legacydeveloper/current/en-us/api_meta/meta_salesworkqueuesettings.md -->

# SalesWorkQueueSettings

Represents settings used to customize work queue options for third-party scoring. In Sales Engagement, you can add a custom number field on person accounts, contacts, or leads. Then, use the custom number field to sort the work queue. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

SalesWorkQueueSettings components have the suffix .salesworkqueuesetting and are stored in the salesworkqueuesettings folder.

## Version

SalesWorkQueueSettings components are available in API version 49.0 and later.

## Special Access Rules

You must be a Sales Engagement customer to access this metadata type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d829598e93">Field Name</th>

              <th class="featureTableHeader  " id="d829598e96">Field Type</th>

              <th class="featureTableHeader  " id="d829598e99">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d829598e93" data-title="Field Name"><span class="keyword parmname">featureName</span></td>

              <td class="entry" headers="d829598e96" data-title="Field Type">string</td>

              <td class="entry" headers="d829598e99" data-title="Description">The feature that the SalesWorkQueueSettings record is configuring. The allowed
                value is <samp class="codeph nolang">ThirdPartyScore</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d829598e93" data-title="Field Name"><span class="keyword parmname">targetEntity</span></td>

              <td class="entry" headers="d829598e96" data-title="Field Type">string</td>

              <td class="entry" headers="d829598e99" data-title="Description">The type that the SalesWorkQueueSettings record is configuring. Possible
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Contact</samp></li>

                  <li class="li"><samp class="codeph nolang">Lead</samp></li>

                  <li class="li"><samp class="codeph nolang">PersonAccount</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d829598e93" data-title="Field Name"><span class="keyword parmname">targetField</span></td>

              <td class="entry" headers="d829598e96" data-title="Field Type">string</td>

              <td class="entry" headers="d829598e99" data-title="Description">The developer name or ID of the custom number field that is used to sort the
                work queue. Custom fields must have a custom number data type.<ul class="ul bulletList">
                  <li class="li">To use Einstein Intelligence Score for lead scoring, use <samp class="codeph nolang">ScoreIntelligence.Score</samp> for the developer
                    name.</li>

                  <li class="li">To remove custom number fields from the work queue, use <samp class="codeph nolang">None</samp>.</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SalesWorkQueueSettings component. The value for targetField is set to 00NRM000001g55D as an example of a custom field ID. Replace this value with the ID of your custom field.

<?xml version="1.0" encoding="UTF-8"?>
<SalesWorkQueueSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <featureName\>ThirdPartyScore</featureName\>
    <targetEntity\>Contact</targetEntity\>
    <targetField\>00NRM000001g55D</targetField\>
</SalesWorkQueueSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>SalesWorkQueueSettings</name\>
    </types\>
    <version\>49.0</version\>
</Package\>

## Usage

Create one SalesWorkQueueSettings record for each type. For example, suppose that you want to create a work queue to sort leads by your custom field called customLeadScore. Create a SalesWorkQueueSettings record and set featureName to ThirdPartyScore, targetEntity to Lead, and targetField to customLeadScore.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=44b1664a5ff37b0a94d9bbe1862469ecec5de4d14bb4cb47135d668d36c9465b url=/legacydeveloper/current/en-us/api_meta/meta_samlssoconfig.md -->

# SamlSsoConfig

Represents a SAML Single Sign-On configuration. This type extends the Metadata metadata type and inherits its fullName field. Single sign-on (SSO) is an authentication method that enables users to access multiple applications with one login and one set of credentials. For example, after users log in to your org, they can automatically access all apps from the App Launcher. You can set up your Salesforce org to trust a third-party identity provider to authenticate users. Or you can configure a third-party app to rely on your org for authentication.

## File Suffix and Directory Location

SamlSsoConfig components have the suffix .samlssoconfig and are stored in the samlssoconfigs folder.

## Version

SamlSsoConfig components are available in API version 28.0 and later.

## Special Access Rules

As of Summer ’20 and later, only users with the View Setup and Configuration permission or both the Customize Application and Modify All Data permissions can access this type.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d830131e92">Field Name</th>

              <th class="featureTableHeader  " id="d830131e95">Field Type</th>

              <th class="featureTableHeader  " id="d830131e98">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">attributeNameIdFormat</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">For SAML 2.0, only and when <span class="keyword parmname">identityLocation</span> is set to
                <samp class="codeph nolang">Attribute</samp>. <span class="ph" id="saml_sso_name_id_format"><a name="saml_sso_name_id_format"><!-- --></a>Possible values include <samp class="codeph nolang">unspecified</samp>, <samp class="codeph nolang">emailAddress</samp>, or <samp class="codeph nolang">persistent</samp>. All legal values can be found in the “Name
                  Identifier Format Identifiers” section of the <a class="xref" href="http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf" target="_blank" title="Adobe Acrobat PDF (New Window)">Assertions and Protocols SAML 2.0
                    specification</a>.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">attributeName</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">The name of the identity provider’s application. Get this name from your
                identity provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">decryptionCertificate</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">
                <span class="ph" id="decrypt_cert_desc"><a name="decrypt_cert_desc"><!-- --></a>The name of the certificate to use for decrypting
                  incoming SAML assertions. This certificate is saved in the organization’s
                  Certificate and Key Management list.</span> Available in API version 30.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">errorUrl</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">When there's an error during login, specify the URL of the page where users are
                directed. It must be publicly accessible, such as a public site Visualforce page.
                The URL can be absolute or relative.</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">executionUserId</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description"><span class="ph" id="execution_userid_desc"><a name="execution_userid_desc"><!-- --></a>The user that runs the Apex handler class. The
                  user must have the Manage Users permission. If you specify a SAML JIT handler
                  class, a user is required.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">identityLocation</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">SamlIdentityLocationType (enumeration of type string)</td>

              <td class="entry" headers="d830131e98" data-title="Description">The location in the assertion where a user is identified. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">SubjectNameId</samp> — The identity is in
                    the <samp class="codeph nolang">&lt;Subject&gt;</samp> statement of the
                    assertion.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Attribute</samp> — The identity is
                    specified in an <samp class="codeph nolang">&lt;AttributeValue&gt;</samp>,
                    located in the <samp class="codeph nolang">&lt;Attribute&gt;</samp> of the
                    assertion.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">identityMapping</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">SamlIdentityType (enumeration of type string)</td>

              <td class="entry" headers="d830131e98" data-title="Description">The identifier the service provider uses for the user during <a class="xref" href="#saml_sso_user_provisioning">Just-in-Time user
                  provisioning</a>. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Username</samp> — The user’s
                    Salesforce username.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FederationId</samp> — The federation ID
                    from the user object; the identifier used by the service provider for the
                    user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UserId</samp> — The user ID from the
                    user’s Salesforce organization.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">issuer</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">The identification string for the Identity Provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">loginUrl</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">For SAML 2.0 only: The URL where Salesforce sends a SAML request to start the
                login sequence.</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">logoutUrl</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">For SAML 2.0 only: The URL to direct the user to when they click the Logout
                link. The default is <span class="ph filepath">https://salesforce.com</span>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">The unique name used by the API and managed packages. The name must begin with
                a letter and use only alphanumeric characters and underscores. The name cannot end
                with an underscore or have two consecutive underscores.</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">oauthTokenEndpoint</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">For SAML 2.0 only: The ACS URL used with enabling Salesforce as an identity
                provider in the web single sign-on OAuth assertion flow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">redirectBinding</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">boolean</td>

              <td class="entry" headers="d830131e98" data-title="Description">Choose the binding mechanism your identity provider requests for your SAML
                messages. Values are:<ul class="ul bulletList">
                  <li class="li">
                    <span class="keyword parmname">HTTP POST</span> — HTTP POST binding sends SAML messages
                    using base64-encoded HTML forms.
                  </li>

                  <li class="li">
                    <span class="keyword parmname">HTTP Redirect</span> — HTTP Redirect binding sends
                    base64-encoded and URL-encoded SAML messages within URL parameters.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">requestSignatureMethod</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description"><span class="ph" id="requestsignaturemethod_desc"><a name="requestsignaturemethod_desc"><!-- --></a>The method that’s used to sign the SAML
                  request. Valid values are <samp class="codeph nolang">RSA-SHA1</samp> and
                  <samp class="codeph nolang">RSA-SHA256</samp>.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">requestSigningCertId</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description"><span class="ph" id="requestSigningCertId_desc"><a name="requestSigningCertId_desc"><!-- --></a>The 18-digit ID for the certificate used to
                  generate the signature on a SAML request to the identity provider. The certificate
                  is saved in the Certificate and Key Management page in Setup.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">salesforceLoginUrl</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">The URL associated with login for the web single sign-on
                flow.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>When encryption is
                            enabled, the URL has a parameter containing the ID of the SAML configuration,
                            <samp class="codeph apex_code">sc=<var class="keyword varname">samlSsoConfigId</var></samp>.
                            For example,
                            <span class="ph filepath">https://mycompany.my.salesforce.com?sc=0LEB0000000CCC</span>. This
                            change applies to API Version 47.0 and later.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">samlEntityId</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">The issuer in SAML requests generated by Salesforce, and is also the expected
                audience of any inbound SAML Responses. Salesforce recommends that you use your My
                Domain login URL.</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">samlJitHandlerId</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description"><span class="ph" id="samljithandlerid_desc"><a name="samljithandlerid_desc"><!-- --></a>The name of an existing Apex class that
                  implements the <samp class="codeph nolang">Auth.SamlJitHandler</samp>
                  interface.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">samlVersion</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">SamlType (enumeration of type string)</td>

              <td class="entry" headers="d830131e98" data-title="Description">The SAML version in use. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">SAML1_1</samp> — SAML 1.1
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SAML2_0</samp> — SAML 2.0
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname" id="singleLogoutBinding"><a name="singleLogoutBinding"><!-- --></a>singleLogoutBinding</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">SamlSpSLOBinding (enumeration of type string)</td>

              <td class="entry" headers="d830131e98" data-title="Description">The HTTP binding type. This value determines where to put the LogoutRequest or
                LogoutResponse in the SAML request during single logout (SLO). The value is base64
                encoded. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">RedirectBinding</samp> — Sent in the
                    query string, deflated.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PostBinding</samp> — Sent in the POST
                    body, not deflated.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname" id="singleLogoutUrl"><a name="singleLogoutUrl"><!-- --></a>singleLogoutUrl</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">The SAML single logout endpoint. This URL is the endpoint where Salesforce
                sends LogoutRequests (when Salesforce initiates a logout), or LogoutResponses (when
                the identity provider initiates a logout).</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname" id="useConfigRequestMethod"><a name="useConfigRequestMethod"><!-- --></a>useConfigRequestMethod</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">boolean</td>

              <td class="entry" headers="d830131e98" data-title="Description">If <samp class="codeph nolang">true</samp>, applies the selected Request
                Signature Method (RSM) during single logout. If <samp class="codeph nolang">false</samp>, the default RSM (RSA-SHA1) is applied.</td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname" id="useSameDigestAlgoForSigning"><a name="useSameDigestAlgoForSigning"><!-- --></a>useSameDigestAlgoForSigning</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">boolean</td>

              <td class="entry" headers="d830131e98" data-title="Description">If <samp class="codeph nolang">true</samp>, uses a digest algorithm based on
                the selected Request Signature Method (RSM). For example, if the selected RSM is
                <samp class="codeph nolang">RSA-SHA256</samp>, the digest algorithm is set to
                <samp class="codeph nolang">SHA-256</samp>. <p class="p">If <samp class="codeph nolang">false</samp>, uses the default digest algorithm (<samp class="codeph nolang">SHA-1</samp>), regardless of the selected RSM.</p>
                <p class="p">This field is available
                  in API version 55.0 and later. You can edit this field only for legacy SAML
                  configurations created before Spring ’22. For configurations created after Spring
                  ’22, this field is <samp class="codeph nolang">true</samp> by
                  default.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname" id="saml_sso_user_provisioning"><a name="saml_sso_user_provisioning"><!-- --></a>userProvisioning</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">boolean</td>

              <td class="entry" headers="d830131e98" data-title="Description">If <samp class="codeph nolang">true</samp>, Just-in-Time user provisioning is
                enabled, which creates users the first time they log in. Specify <samp class="codeph nolang">Federation ID</samp> for the
                <span class="keyword parmname">identityMapping</span> value to use this feature.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d830131e92" data-title="Field Name"><span class="keyword parmname">validationCert</span></td>

              <td class="entry" headers="d830131e95" data-title="Field Type">string</td>

              <td class="entry" headers="d830131e98" data-title="Description">The certificate used to validate the request. Get this certificate from your
                identity provider.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SamlSsoConfig component. The validation certificate string has been truncated for readability.

<?xml version="1.0" encoding="UTF-8"?>
<SamlSsoConfig xmlns="http://soap.sforce.com/2006/04/metadata">
  <identityLocation\>SubjectNameId</identityLocation\>
  <identityMapping\>FederationId</identityMapping\>
  <issuer\>https://my-idp.my.salesforce.com</issuer\>
  <loginUrl\>
    https://my-idp.my.salesforce.com/idp/endpoint/HttpRedirect
  </loginUrl\>
  <logoutUrl\>https://www.salesforce.com</logoutUrl\>
  <name\>SomeCompany</name\>
  <oauthTokenEndpoint\>
    https://login.salesforce.com/services/oauth2/token?so=00DD0000000
  </oauthTokenEndpoint\>
  <redirectBinding\>true</redirectBinding\>
  <requestSignatureMethod\>RSA-SHA1</requestSignatureMethod\>
  <salesforceLoginUrl\>
    https://login.salesforce.com?so=00DD0000000JxeI
  </salesforceLoginUrl\>
  <samlEntityId\>
    https://saml.salesforce.com/customPath
  </samlEntityId\>
  <samlVersion\>SAML2\_0</samlVersion\>
  <useConfigRequestMethod\>true</useConfigRequestMethod\>
  <userProvisioning\>false</userProvisioning\>
  <validationCert\>
    MIIEojCCA4qgAwIBAgIOATtxsoBFAAAAAD4...
  </validationCert\>
</SamlSsoConfig\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b2cdeb876935f5b8879ddf302697a04debc613b61ce4a2df6433f924cddc57bf url=/legacydeveloper/current/en-us/api_meta/manifest_samples.md -->

# Sample package.xml Manifest Files

This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if you want to work with all the metadata in one batch.

The following samples are listed:

- [Standard Objects](#manifest_standard_objects)
- [All Custom Objects](#manifest_all_custom_objects)
- [Standard Picklist Fields](#manifest_standard_picklists)
- [Custom and Standard Fields](#manifest_custom_fields)
- [List Views for Standard Objects](#manifest_list_view_standard)
- [Packages](#manifest_packages)
- [Security Settings](#manifest_security_settings)
- [Assignment Rules, Auto-Response Rules, Escalation Rules](#assignment_rules)
- [Sharing Rules](#manifest_sharing)
- [Managed Component Access](#ManagedComponentAccess_intro)

For more information about the structure of a manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

## Standard Objects

This sample package.xml manifest file illustrates how to work with the standard Account object. Retrieving or deploying a standard object includes all custom and standard fields except for standard fields that aren’t customizable. All custom fields are supported. Only standard fields that you can customize are supported, that is, standard fields to which you can add help text or enable history tracking or Chatter feed tracking. Other standard fields aren't supported, including system fields (such as CreatedById or LastModifiedDate) and autonumber fields.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Account</members\>
        <name\>CustomObject</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

Note how you work with the standard Account object by specifying it as a member of a CustomObject type. However, you can’t use an asterisk wildcard to work with all standard objects; each standard object must be specified by name.

## All Custom Objects

This sample package.xml manifest file illustrates how to work with all custom objects.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>CustomObject</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

This manifest file can be used to retrieve or deploy all custom objects, but not all standard objects.

## Standard Picklist Fields

In API version 38.0 and later, the StandardValueSet type represents standard picklists. Picklists are no longer represented by fields as in earlier versions. This sample package.xml represents the Industry standard picklist as a StandardValueSet type.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Industry</members\>
        <name\>StandardValueSet</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The name of a standard value set is case-sensitive.

The Industry standard value set corresponds to the Account.Industry or Lead.Industry field in API version 37.0 and earlier. This example shows a package.xml sample for the Account.Industry picklist.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Account.Industry</members\>
        <name\>CustomField</name\>
    </types\>
    <version\>37.0</version\>
</Package\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The name of a picklist field is case-sensitive.

Note the objectName.picklistField syntax in the <members\> field where objectName is the name of the object, such as Account, and picklistField is the name of the standard picklist field, such as Industry.

This next package.xml sample represents opportunity team roles in API version 38.0 and later. Specify opportunity team roles as a SalesTeamRole standard value set. Opportunity team roles have the same picklist values as the account team roles.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>SalesTeamRole</members\>
        <name\>StandardValueSet</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

The SalesTeamRole standard value set corresponds to one of these field names in API version 37.0 and earlier: OpportunityTeamMember.TeamMemberRole, UserAccountTeamMember.TeamMemberRole, UserTeamMember.TeamMemberRole, and AccountTeamMember.TeamMemberRole. Opportunity team roles are represented in this sample package.xml as the OpportunityTeamMember.TeamMemberRole field.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>OpportunityTeamMember.TeamMemberRole</members\>
        <name\>CustomField</name\>
    </types\>
    <version\>37.0</version\>
</Package\>

To learn about the names of standard value sets and how they map to picklist field names, see [StandardValueSet Names and Standard Picklist Fields](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/standardvalueset_names.htm "In API version 38.0 and later, standard picklists are represented by the StandardValueSet type. In previous versions, standard picklists are represented by the CustomField type. This table lists the names of standard picklists as standard value sets and their corresponding field names.").

## Custom and Standard Fields

This sample package.xml manifest file illustrates how to work with custom fields in custom and standard objects and standard fields in a standard object.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyCustomObject\_\_c.MyCustomField\_\_c</members\>
        <name\>CustomField</name\>
    </types\>
    <types\>
        <members\>Account.SLA\_\_c</members\>
        <members\>Account.Phone</members\>
        <name\>CustomField</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

Note the objectName.field syntax in the <members\> field where objectName is the name of the object, such as Account, and field is the name of the custom or standard field, such as an SLA picklist field representing a service-level agreement option. The MyCustomField custom field in the MyCustomObject custom object is uniquely identified by its full name MyCustomObject\_\_c.MyCustomField\_\_c. Similarly, the Phone standard field in the Account standard object is uniquely identified by its full name Account.Phone.

All custom fields are supported. Only standard fields that you can customize are supported, that is, standard fields to which you can add help text or enable history tracking or Chatter feed tracking. Other standard fields aren't supported, including system fields (such as CreatedById or LastModifiedDate) and autonumber fields.

## List Views for Standard Objects

The easiest way to retrieve list views for a standard object is to retrieve the object. The list views are included in the retrieved component. See the section of this topic on Standard Objects.

You can also work with individual list views if you don’t want to retrieve all the details for the object. This sample package.xml manifest file illustrates how to work with a list view for the standard Account object.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Account.AccountTeam</members\>
        <name\>ListView</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

Note the objectName.listViewUniqueName syntax in the <members\> field where objectName is the name of the object, such as Account, and listViewUniqueName is the View Unique Name for the list view. If you retrieve this list view, the component is stored in objects/Account.object.

## Packages

To retrieve a package, set the name of the package in the [packageNames](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve_request.htm#meta_retrieve_request "The RetrieveRequest parameter specified on a retrieve() call encapsulates options for determining which packages or files are retrieved.") field in [RetrieveRequest](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve_request.htm "The RetrieveRequest parameter specified on a retrieve() call encapsulates options for determining which packages or files are retrieved.") when you call retrieve(). The package.xml manifest file is automatically populated in the retrieved .zip file. The <fullName\> element in package.xml contains the name of the retrieved package.

If you use an asterisk wildcard in a <members\> element to retrieve all the components of a particular metadata type, the retrieved contents don’t include components in managed packages.

For more information about managed packages, see the [Second-Generation Managed Packaging Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev_dev2gp.htm).

The easiest way to retrieve a component in a managed package is to retrieve the complete package by setting the name of the package in the [packageNames](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve_request.htm#meta_retrieve_request "The RetrieveRequest parameter specified on a retrieve() call encapsulates options for determining which packages or files are retrieved.") field in [RetrieveRequest](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve_request.htm "The RetrieveRequest parameter specified on a retrieve() call encapsulates options for determining which packages or files are retrieved."), as described earlier. The following sample package.xml manifest file illustrates an alternative to retrieve an individual component in a package.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>myns\_\_MyCustomObject\_\_c</members\>
        <name\>CustomObject</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

Note the namespacePrefix\_\_objectName syntax in the <members\> field where namespacePrefix is the namespace prefix of the package and objectName is the name of the object. A namespace prefix is a 1-character to 15-character alphanumeric identifier that distinguishes your package and its contents from other publishers’ packages. For more information, see [Create and Register Your Namespace for Second-Generation Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev_dev2gp_create_namespace.htm).

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The namespace prefix is important to help identify the source of items like fields, custom objects, and more from different managed packages. For example, when working with FlexiPages in your org, we recommend against removing namespaces for object fields, because it can cause unexpected results such as name collisions.

## Security Settings

This sample package.xml manifest file illustrates how to work with an org’s security settings. You specify Security in the <members\> element and Settings in the name element when retrieving the SecuritySettings component type.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Security</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

## Assignment Rules, Auto-Response Rules, Escalation Rules

Assignment rules, auto-response rules, and escalation rules use different package.xml type names to access sets of rules or individual rules for object types. For example, this sample package.xml manifest file illustrates how to access an org’s assignment rules for just Cases and Leads.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Case</members\>
        <members\>Lead</members\>
        <name\>AssignmentRules</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

The following sample package.xml manifest file illustrates how to access just the “samplerule” Case assignment rule and the “newrule” Lead assignment rule. Notice that the type name is AssignmentRule and not AssignmentRules.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Case.samplerule</members\>
        <members\>Lead.newrule</members\>
        <name\>AssignmentRule</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

Similarly, for accessing individual auto-response rules and escalation rules, use AutoResponseRule and EscalationRule instead of AutoResponseRules and EscalationRules.

## Sharing Rules

In API version 33.0 and later, you can retrieve and deploy sharing rules for all standard and custom objects. This sample package.xml manifest file illustrates how to work with an org’s sharing rules, such as retrieving a specific criteria-based sharing rule for the lead object, retrieving all ownership-based sharing rules for all objects, and retrieving all territory-based sharing rules for the account object.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Lead.testShareRule</members\> 
         <name\>SharingCriteriaRule</name\>
    </types\>
    <types\>
        <members\>\*</members\> 
        <name\>SharingOwnerRule</name\>
    </types\>
    <types\>
        <members\>Account.\*</members\>
        <name\>SharingTerritoryRule</name\>
    </types\>
    <version\>33.0</version\>
</Package\>

## Managed Component Access

In API version 29.0 and later, you can retrieve and deploy access settings for these managed components in profiles and permission sets:

- Apex classes
- Apps
- Custom field permissions
- Custom object permissions
- Custom tab settings
- External data sources
- Record types
- Visualforce pages

In API version 51.0 and later, you can retrieve and deploy access settings for login flows.

When retrieving and deploying managed component permissions, specify the namespace followed by two underscores. Wildcards aren’t supported.

For example, let’s say you install a managed package with the namespace MyNamespace and the custom object JobRequest\_\_c. To set object permissions for JobRequest\_\_c in the package to the custom profile MyProfile, you would add the following to the .profile file.

To deploy:

<objectPermissions\>
    <allowCreate\>true</allowCreate\>
    <allowDelete\>true</allowDelete\>
    <allowEdit\>true</allowEdit\>
    <allowRead\>true</allowRead\>
    <viewAllRecords\>false</viewAllRecords\>
    <modifyAllRecords\>false</modifyAllRecords\>
    <object\>MyNamespace\_\_JobRequest\_\_c</object\>
</objectPermissions\>

To retrieve:

<types\>
    <members\>MyNamespace\_\_JobRequest\_\_c</members\>
    <name\>CustomObject</name\>
</types\>
<types\>
    <members\>MyProfile</members\>
    <name\>Profile</name\>
</types\>

When retrieving permission sets and profiles, make sure that you also retrieve any components that are related to the permissions and settings. For example, when retrieving app visibilities, you must also retrieve the associated app, and when retrieving object or field permissions, you must also retrieve the associated object.

<!-- document id=d61f02546d80a5dc0bf3aa329a427e9f16918a12ddcdd45850e3e1463b821ee7 url=/legacydeveloper/current/en-us/api_meta/meta_sandboxsettings.md -->

# SandboxSettings

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

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

SandboxSettings values are stored in the Sandbox.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

SandboxSettings are available in API version 56.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| disableSandboxExpirationEmails | boolean | Indicates whether to disable sandbox expiration email notifications for the source (production) org: true or false. When disabled in the source (production) org, users no longer receive email notifications for impending deletions of sandboxes that have been inactive for 180 days or longer. |

## Declarative Metadata Sample Definition

The following is an example of a SandboxSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<SandboxSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <disableSandboxExpirationEmails\>true</disableSandboxExpirationEmails\>
</SandboxSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=1b8db1602eb28aea02f10307f7e7b3af47706eb7ee7ada84995f1449e38ca7be url=/legacydeveloper/current/en-us/api_meta/meta_saveResult.md -->

# SaveResult

Contains result information for the createMetadata, updateMetadata, or renameMetadata call.

## Version

Available in API version 30.0 and later.

## errors

- **Type**: [Error](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_error.htm "Represents an error that occurred during a synchronous CRUD (createMetadata(), updateMetadata(), or deleteMetadata()) operation.")\[\]
- **Description**: An array of errors returned if the operation wasn't successful.

## fullName

- **Type**: string
- **Description**: The full name of the component processed.

## success

- **Type**: boolean
- **Description**: Indicates whether the operation was successful (true) or not (false).

<!-- document id=13fda8f8cb84da451385f58dce8545afbbb218669c80004a6713117fa277d773 url=/legacydeveloper/current/en-us/api_meta/meta_schedulingobjective.md -->

# SchedulingObjective

Represents a scheduling objective in Workforce Engagement. Scheduling objectives define business goals that the scheduling tools consider when identifying agents for shifts.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

SchedulingObjective components have the suffix .SchedulingObjective and are stored in the SchedulingObjective folder.

## Version

SchedulingObjective components are available in API version 55.0 and later.

## Special Access Rules

This type is available only if Workforce Engagement is enabled in your org. To view, create, edit, and delete records, the user requires the Workforce Engagement Planner permission set.

## Fields

| Field Name | Description |
| --- | --- |
| isProtected | 
Field Type

boolean

Description

Indicates whether the component is protected (true) or not (false). The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. The name of the objective.



 |
| schedulingCategory | 

Field Type

SchedulingCategory (enumeration of type string)

Description

Required. What the scheduling logic applies the objective to. The valid values are:

- A—Service Appointment
- B—Shift





 |
| schedulingObjectiveParameters | 

Field Type

[SchedulingObjectiveParameter\[\]](#schedulingObjectiveParameterID)

Description

Parameters associated with a scheduling objective, such as the number of days before and after a shift that the logic considers when balancing assignments.



 |
| schedulingObjectiveType | 

Field Type

SchedulingObjectiveType (enumeration of type string)

Description

Required. Specifies the type of objective. Possible values are:

- AgentPreference—In the UI, this value appears as Maximized Preferences.
- BalanceNonStandardShifts
- BalanceShifts





 |

## SchedulingObjectiveParameter

Represents a parameter that’s associated with a scheduling objective.

| Field Name | Description |
| --- | --- |
| parameterKey | 
Field Type

ObjectiveParameterKey (enumeration of type string)

Description

Required. The scheduling objective parameter key. Possible values are:

- DaysAhead
- DaysBack





 |
| value | 

Field Type

string

Description

The scheduling objective parameter value.



 |

## Declarative Metadata Sample Definition

The following is an example of a SchedulingObjective component.

<?xml version="1.0" encoding="UTF-8"?>
<SchedulingObjective xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>Balance Shifts</masterLabel\>
    <schedulingCategory\>B</schedulingCategory\>
    <schedulingObjectiveType\>BalanceShifts</schedulingObjectiveType\>
    <schedulingObjectiveParameters\>
        <parameterKey\>DaysAhead</parameterKey\>
        <value\>30</value\>
    </schedulingObjectiveParameters\>
</SchedulingObjective\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <name\>SchedulingObjective</name\>
	<members\>Balance Shifts</members\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=ee3d38dd89cfb449a917b8b585946332d16b5ec8e256ef1a3d38de4bec4accd9 url=/legacydeveloper/current/en-us/api_meta/meta_schedulingrule.md -->

# SchedulingRule

Represents a scheduling rule in Workforce Engagement Management. Scheduling rules determine when agents are assigned to shifts.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

SchedulingRule components have the suffix .schedulingRule and are stored in the SchedulingRules folder.

## Version

SchedulingRule components are available in API version 53.0 and later.

## Special Access Rules

This type is available only if Workforce Engagement is enabled in your org. To view, create, edit, and delete records, the user requires the Workforce Engagement Planner permission set.

## Fields

| Field Name | Description |
| --- | --- |
| isProtected | 
Field Type

boolean

Description

Indicates whether the component is protected (true) or not (false). The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. The name of the rule.



 |
| schedulingCategory | 

Field Type

SchedulingCategory (enumeration of type string)

Description

Required. What the scheduling logic applies the rule to. The valid values are:

- A—Service Appointment
- B—Shift





 |
| schedulingRuleParameters | 

Field Type

[SchedulingRuleParameter\[\]](#schedulingRuleParameterID)

Description

Parameters associated with a scheduling rule, such as work limits.



 |
| schedulingRuleType | 

Field Type

SchedulingRuleType (enumeration of type string)

Description

Required. Specifies the type of rule. The valid values are:

- A—Active Resources
- B—Match Skills
- C—Availability
- M—Match Territory
- Q—Match Queue
- RestTimeMinutes—Rest Time in Minutes. Available in API version 56.0 and later.
- W—Work Limit
- LimitNonstandardShifts—Specifies a rule type that limits how many non-standard shifts can be assigned to each agent. Available in API version 54.0 and later.





 |

## SchedulingRuleParameter

Represents a scheduling rule parameter, such as a work limit, that’s associated with a scheduling rule.

| Field Name | Description |
| --- | --- |
| schedulingParameterKey | 
Field Type

SchedulingParameterKey (enumeration of type string)

Description

Required. The scheduling rule parameter key.

- C—Constraint Field Name
- L—Limit Type
- R—Resolution
- T—Time Resolution
- W—Work Unit
- ConsiderAbsence—Consider resource absences when evaluating availability. Available in API version 56.0 and later.
- ConsiderSTM—Consider service territory membership, which defines working hours, when evaluating availability. Available in API version 56.0 and later.





 |
| value | 

Field Type

string

Description

The scheduling rule parameter value.



 |

## Declarative Metadata Sample Definition

The following is an example of a SchedulingRule component.

<?xml version="1.0" encoding="UTF-8"?>
<SchedulingRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>Max Shifts Per Week</masterLabel\>
    <schedulingCategory\>B</schedulingCategory\>
    <schedulingRuleParameters\>
        <schedulingParameterKey\>C</schedulingParameterKey\>
        <value\>MaxShiftsPerWeek</value\>
    </schedulingRuleParameters\>
    <schedulingRuleParameters\>
        <schedulingParameterKey\>W</schedulingParameterKey\>
        <value\>Shifts</value\>
    </schedulingRuleParameters\>
    <schedulingRuleParameters\>
        <schedulingParameterKey\>R</schedulingParameterKey\>
        <value\>Week</value\>
    </schedulingRuleParameters\>
    <schedulingRuleParameters\>
        <schedulingParameterKey\>L</schedulingParameterKey\>
        <value\>Max</value\>
    </schedulingRuleParameters\>
    <schedulingRuleType\>W</schedulingRuleType\>
</SchedulingRule\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <name\>SchedulingRule</name\>
	<members\>MaxShiftsPerWeek</members\>
    </types\>
    <version\>53.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=44759b57858a7dda409fa92fd20323726233448e52e91739c9a4469f16c22f71 url=/legacydeveloper/current/en-us/api_meta/meta_schemasettings.md -->

# SchemaSettings

Represents an org’s schema settings, which manage the availability of custom settings and custom metadata type values. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

SchemaSettings values are stored in the Schema.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

SchemaSettings

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableAdvancedCMTSecurity | boolean | Indicates whether custom metadata type values are available only to Apex, flow, and formula operations (true) or exposed in other contexts such as through the Enterprise WSDL or SOAP API (false). This field has a default value of false. |
| enableAdvancedCSSecurity | boolean | Indicates whether custom settings type values are available only to Apex, flow, and formula operations (true) or exposed in other contexts such as through the Enterprise WSDL or SOAP API (false). This field has a default value of false. |
| enableListCustomSettingCreation | boolean | Indicates whether you can create custom settings when using application-level data definitions (true) or not (false). This field has a default value of false. |
| enableSOSLOnCustomSettings | boolean | Indicates whether custom settings values are returned in Salesforce Object Search language (SOSL) queries (true) or not (false). This field has a default value of false. |

## Declarative Metadata Sample Definition

The following is an example of a SchemaSettings

<?xml version="1.0" encoding="UTF-8"?>
<SchemaSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAdvancedCMTSecurity\>true</enableAdvancedCMTSecurity\>
    <enableAdvancedCSSecurity\>true</enableAdvancedCSSecurity\>
    <enableListCustomSettingCreation\>false</enableListCustomSettingCreation\>
    <enableSOSLOnCustomSettings\>true</enableSOSLOnCustomSettings\>
</SchemaSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Schema</members\>
        <name\>Settings</name\>
    </types\>   
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=942fb22364d4128a01b39ad2d946f1f115111a09d276b838c323520b4017c7f6 url=/legacydeveloper/current/en-us/api_meta/meta_scndtelephprvdotbddtl.md -->

# ScndTelephPrvdOtbdDtl

Represents the outbound SIP routing configuration for a secondary telephony provider in Agentforce Contact Center BYOC.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ScndTelephPrvdOtbdDtl components have the suffix .scndTelephPrvdOtbdDtl and are stored in the scndTelephPrvdOtbdDtls folder.

## Version

ScndTelephPrvdOtbdDtl components are available in API version 68.0 and later.

## Special Access Rules

To access ScndTelephPrvdOtbdDtl, you must have the Agentforce Contact Center Admin (Salesforce Voice) permission set assigned.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| customHeader | string | Specifies the custom SIP headers for outbound calls. |
| fullName | string | Required. The unique name of the ScndTelephPrvdOtbdDtl component. Inherited from the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type. |
| hostConfig | string | Specifies key-value pair of IP address and port, up to 5 per record. |
| id | string | Specifies the ID of the outbound detail for a secondary telephony provider. |
| masterLabel | string | Required. The master label for the ScndTelephPrvdOtbdDtl. |
| outboundAuthEnabled | boolean | Indicates whether outbound authentication is enabled (true) or not (false). |
| secondaryTelephonyProvider | string | Specifies the associated secondary telephony provider for the outbound detail. |

## Declarative Metadata Sample Definition

A sample XML definition of a ScndTelephPrvdOtbdDtl component is shown here.

<scndTelephPrvdOtbdDtl>
    <fullName>MyScndTelephPrvdOtbdDtl</fullName>
    <customHeader>sampleValue</customHeader>
    <hostConfig>sampleValue</hostConfig>
    <id>sampleValue</id>
    <masterLabel>sampleValue</masterLabel>
    <outboundAuthEnabled>true</outboundAuthEnabled>
    <secondaryTelephonyProvider>sampleValue</secondaryTelephonyProvider>
</scndTelephPrvdOtbdDtl>

The following package.xml manifest retrieves the ScndTelephPrvdOtbdDtl component.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   ~ Copyright 2020 Salesforce, Inc.
   ~ All Rights Reserved
   ~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types>
      <members>\*</members>
      <name>ScndTelephPrvdOtbdDtl</name>
   </types>
   <version>XX.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=519605e9d23d8fa8f68bc80622409a20a5f2c23eb38c49454971da3b1da39499 url=/legacydeveloper/current/en-us/api_meta/meta_scontrol.md -->

# Scontrol

Deprecated. Represents an Scontrol component, corresponding to an s-control in the Salesforce user interface.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Visualforce pages supersede s-controls. Organizations that haven't previously used s-controls can’t create them. Existing s-controls are unaffected and can still be edited.

This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

## Declarative Metadata File Suffix and Directory Location

The file suffix is .scf for the s-control file. The accompanying metadata file is named ScontrolName\-meta.xml.

Scontrol components are stored in the scontrols folder in the corresponding package directory.

## Version

Scontrols are available in API version 10.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d835533e117">Field Name</th>

              <th class="featureTableHeader  " id="d835533e120">Field Type</th>

              <th class="featureTableHeader  " id="d835533e123">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d835533e117" data-title="Field Name"><span class="keyword parmname" id="content"><a name="content"><!-- --></a>content</span></td>

              <td class="entry" headers="d835533e120" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d835533e123" data-title="Description">Content of the s-control. Base 64-encoded binary data. Before making an API call,
                client applications must encode the binary attachment data as base64. Upon receiving
                a response, client applications must decode the base64 data to binary. This
                conversion is handled for you by a SOAP client. This field is inherited from the
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm" title="MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.">MetadataWithContent</a> component.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d835533e117" data-title="Field Name"><span class="keyword parmname" id="contentsource"><a name="contentsource"><!-- --></a>contentSource</span></td>

              <td class="entry" headers="d835533e120" data-title="Field Type">SControlContentSource <span class="ph" id="enum_link_component"><a name="enum_link_component"><!-- --></a>(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</span>
              </td>

              <td class="entry" headers="d835533e123" data-title="Description">Required. Determines how you plan to use the s-control:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">HTML</samp>: Select this option if you want to enter the
                    content for your s-control in <a class="xref" href="#content"><span class="keyword parmname">content</span></a>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">URL</samp>: Select this option if you want to enter the
                    link or URL of an external website in <a class="xref" href="#content"><span class="keyword parmname">content</span></a>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Snippet</samp>: Snippets are s-controls that are designed
                    to be included in other s-controls. Select this option if you want to enter the content
                    for your s-control snippet in <a class="xref" href="#content"><span class="keyword parmname">content</span></a>.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d835533e117" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d835533e120" data-title="Field Type">string</td>

              <td class="entry" headers="d835533e123" data-title="Description">Optional text that describes the s-control. This only displays to users with View All
                Data permission (administrator).</td>

            </tr>

            <tr>
              <td class="entry" headers="d835533e117" data-title="Field Name"><span class="keyword parmname">encodingKey</span></td>

              <td class="entry" headers="d835533e120" data-title="Field Type">Encoding
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d835533e123" data-title="Description">Required. The default encoding setting is Unicode: <samp class="codeph xml">UTF-8</samp>. Change it if you’re passing information to a URL that requires data in a
                different format. This option is available when you select <samp class="codeph nolang">URL</samp> as the value for <a class="xref" href="#contentsource"><span class="keyword parmname">contentSource</span></a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d835533e117" data-title="Field Name"><span class="keyword parmname" id="filecontent"><a name="filecontent"><!-- --></a>fileContent</span></td>

              <td class="entry" headers="d835533e120" data-title="Field Type">base64</td>

              <td class="entry" headers="d835533e123" data-title="Description">File contents displayed if you add this s-control to a custom link. The file can
                contain a Java applet, Active-X control, or any other type of content you want. This option
                only applies to s-controls with a value of <samp class="codeph nolang">HTML</samp> for
                <a class="xref" href="#contentsource"><span class="keyword parmname">contentSource</span></a>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d835533e117" data-title="Field Name"><span class="keyword parmname">fileName</span></td>

              <td class="entry" headers="d835533e120" data-title="Field Type">string</td>

              <td class="entry" headers="d835533e123" data-title="Description">The unique name for the s-control. This name can contain only underscores and
                alphanumeric characters, and must be unique in your org. It must begin with a
                letter, not include spaces, not end with an underscore, and not contain two
                consecutive underscores. This field can’t be changed for components installed
                by a managed package. It’s only relevant if the <a class="xref" href="#filecontent"><span class="keyword parmname">fileContent</span></a> field also has a value. This field is
                available in API version 14.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d835533e117" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d835533e120" data-title="Field Type">string</td>

              <td class="entry" headers="d835533e123" data-title="Description">The s-control developer name used as a unique identifier for API access. The
                <span class="keyword parmname">fullName</span> can contain only underscores and alphanumeric
                characters. It must be unique, begin with a letter, not include spaces, not end
                with an underscore, and not contain two consecutive underscores. If this
                field contained characters before version 14.0 that are no longer allowed, the
                characters were stripped out of this field, and the previous value of the field was
                saved in the <a class="xref" href="#field_name">name</a> field. This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d835533e117" data-title="Field Name"><span class="keyword parmname" id="field_name"><a name="field_name"><!-- --></a>name</span></td>

              <td class="entry" headers="d835533e120" data-title="Field Type">string</td>

              <td class="entry" headers="d835533e123" data-title="Description">Required. The unique name for the s-control. It must contain alphanumeric characters
                only and begin with a letter. For example <samp class="codeph nolang">example_s_control</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d835533e117" data-title="Field Name"><span class="keyword parmname">supportsCaching</span></td>

              <td class="entry" headers="d835533e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d835533e123" data-title="Description">Required. Indicates whether the s-control supports caching (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Caching optimizes the
                page so that it remembers which s-controls are on the page when it reloads. This option only
                applies to HTML s-controls.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following sample creates the Myriad\_Publishing.scf s-control, which creates a link to the website specified in the s-control. The corresponding Myriad\_Publishing.scf-meta.xml metadata file follows the s-control file.

Myriad\_Publishing.scf file:

http://www.myriadpubs.com

Myriad\_Publishing.scf-meta.xml:

<?xml version="1.0" encoding="UTF-8"?>
<Scontrol xmlns="http://soap.sforce.com/2006/04/metadata">
    <contentSource\>URL</contentSource\>
    <description\>s-control to open Myriad Publishing website.</description\>
    <encodingKey\>UTF-8</encodingKey\>
    <name\>Myriad Publishing</name\>
    <supportsCaching\>true</supportsCaching\>
</Scontrol\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=5f0f41cf19bff65e0a23b59b3626d0a3f358e1ce95951fece1777651bb038105 url=/legacydeveloper/current/en-us/api_meta/meta_searchcustomization.md -->

# SearchCustomization

Represents the configuration of search settings created in Search Manager. The configuration includes the search channel, searchable objects and fields, and rules to filter search results.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

SearchCustomization components have the suffix .searchCustomization and are stored in the searchCustomizations folder.

## Version

SearchCustomization components are available in API version 61.0 and later.

## Special Access Rules

Only users with the View Setup and Configuration permission can access this object, and only users with the Customize Application permission can edit it.

## Fields

| Field Name | Description |
| --- | --- |
| channel | 
Field Type

string

Description

Required.

The search channel that the configuration applies to.





 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the configuration.





 |
| objectOverride | 

Field Type

[SearchCustomizationObjectOverride\[\]](#SearchCustomizationObjectOverride)

Description

A list of object configurations.



 |
| objectToAlwaysSearch | 

Field Type

string\[\]

Description

A list of the objects that are always searched for the user profile if the search channel is Einstein Global Search Bar. 



 |
| profile | 

Field Type

string

Description

Specifies user profile if the search channel is Einstein Global Search Bar. Removed in API version 62.0 and later.



 |
| selectedObject | 

Field Type

string\[\]

Description

A list of the objects that are selected in the configuration if the search channel is LWR Experience Sites.



 |
| selectedProfile | 

Field Type

string\[\]

Description

Specifies all user profiles that are associated with a Search configuration if the search channel is Einstein Global Search Bar. This field is available in API version 62.0 and later.



 |

## SearchCustomizationObjectOverride

Represents the configuration for a specific object.

| Field Name | Description |
| --- | --- |
| fieldOverride | 
Field Type

[SearchCustomizationFieldOverride\[\]](#SearchCustomizationFieldOverride)

Description

A list of field configurations.



 |
| objectApiName | 

Field Type

string

Description

Required.

The API name of the object that the configuration is applied to.





 |
| rule | 

Field Type

[SearchCustomizationRule\[\]](#SearchCustomizationRule)

Description

A list of rules applied to filter search results. 



 |
| searchable | 

Field Type

boolean

Description

Indicates whether the object is searchable (true) or not (false).



 |

## SearchCustomizationFieldOverride

Represents the configuration for a specific field within an object.

| Field Name | Description |
| --- | --- |
| fieldApiName | 
Field Type

string

Description

Required.

The API name of the field that the configuration is applied to.





 |
| searchable | 

Field Type

boolean

Description

Required.

Indicates whether the field is searchable (true) or not (false).





 |

## SearchCustomizationRule

Represents the rules defined in an object to filter search results.

| Field Name | Description |
| --- | --- |
| fieldApiName | 
Field Type

string

Description

Required.

The field that the rule applies to. 





 |
| operator | 

Field Type

string

Description

Required.

The operator for the rule.





 |
| ruleValue | 

Field Type

[SearchCustomizationRuleValue\[\]](#SearchCustomizationRuleValue)

Description

A list of rule values. 



 |

## SearchCustomizationRuleValue

Represents the value of a rule used to filter search results.

| Field Name | Description |
| --- | --- |
| targetObjectApiName | 
Field Type

string

Description

The API name of the target object, in case the rule applies to a lookup field.



 |
| value | 

Field Type

string

Description

Required.

The value of the rule.





 |

## Declarative Metadata Sample Definition

The following is an example of a SearchCustomization component.

<?xml version="1.0" encoding="UTF-8"?>
<SearchCustomization xmlns="http://soap.sforce.com/2006/04/metadata">
    <channel\>GlobalSearch</channel\>
    <masterLabel\>My\_Standard\_User\_Configuration</masterLabel\>
    <objectOverride\>
        <fieldOverride\>
            <fieldApiName\>Description</fieldApiName\>
            <searchable\>false</searchable\>
        </fieldOverride\>
        <fieldOverride\>
            <fieldApiName\>Rating</fieldApiName\>
            <searchable\>true</searchable\>
        </fieldOverride\>
        <objectApiName\>Account</objectApiName\>
        <rule\>
            <fieldApiName\>My\_Custom\_Field\_\_c</fieldApiName\>
            <operator\>ne</operator\>
            <ruleValue\>
                <value\>Other</value\>
            </ruleValue\>
        </rule\>
        <rule\>
            <fieldApiName\>Rating</fieldApiName\>
            <operator\>in</operator\>
            <ruleValue\>
                <value\>Hot</value\>
            </ruleValue\>
            <ruleValue\>
                <value\>Warm</value\>
            </ruleValue\>
        </rule\>
    </objectOverride\>
    <objectOverride\>
        <objectApiName\>Asset</objectApiName\>
        <searchable\>false</searchable\>
    </objectOverride\>
    <objectOverride\>
        <objectApiName\>Contact</objectApiName\>
        <rule\>
            <fieldApiName\>AccountId</fieldApiName\>
            <operator\>ne</operator\>
            <ruleValue\>
                <targetObjectApiName\>Account</targetObjectApiName\>
                <value\>A Company</value\>
            </ruleValue\>
        </rule\>
        <rule\>
            <fieldApiName\>DoNotCall</fieldApiName\>
            <operator\>eq</operator\>
            <ruleValue\>
                <value\>false</value\>
            </ruleValue\>
        </rule\>
    </objectOverride\>
    <objectToAlwaysSearch\>Account</objectToAlwaysSearch\>
    <objectToAlwaysSearch\>Contact</objectToAlwaysSearch\>
    <objectToAlwaysSearch\>My\_Custom\_Object\_\_c</objectToAlwaysSearch\>
    <objectToAlwaysSearch\>Product2</objectToAlwaysSearch\>
    <profile\>standard</profile\>
</SearchCustomization\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>SearchCustomization</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=a4e614f488178f4b81da0f6abf35fcdccf633a25e470751e92df223d7aa58aa6 url=/legacydeveloper/current/en-us/api_meta/meta_searchlayouts.md -->

# SearchLayouts

Represents the metadata associated with the search layouts for an object. You can customize which fields to display for users in search results, search filter fields, lookup dialogs, and recent record lists on tab home pages. You can access SearchLayouts only by accessing its encompassing CustomObject.

For more information, see [Customize Layouts for Search Results](https://help.salesforce.com/articleView?id=ai.customizing_search_layouts.htm&type=5&language=en_US "HTML (New Window)") and [Customize Search Layouts for Custom Objects](https://help.salesforce.com/articleView?id=ai.customizing_search_layouts.htm&type=5&language=en_US) in Salesforce Help.

## Version

Search layouts for custom objects are available in API version 14.0 and later. The ability to modify search layouts for standard objects (except events and tasks) is available in API version 27.0 and later.

## Fields

When defining metadata for search layouts:

- Any Name field defined as a text type is mandatory; it’s always displayed as the first column in the search results page. When you query for a list of fields; the name field isn’t returned but all other fields are. If you define the Name field as an autonumber type, it’s not mandatory and you can remove it from the list, but when you import the search layout with Metadata API, it will always add the Name field back. These rules apply to customTabListAdditionalFields, lookupDialogsAdditionalFields, lookupPhoneDialogsAdditionalFields, and searchResultsAdditionalFields
- For custom objects, the search layout uses the API name, for example, MyCustomField\_\_c instead of the field name My Custom Field.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d838295e107">Field</th>

              <th class="featureTableHeader  " id="d838295e110">Field Type</th>

              <th class="featureTableHeader  " id="d838295e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">customTabListAdditionalFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields displayed in the Recent <var class="keyword varname">Object
                  Name</var> list view for an object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">excludedStandardButtons</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of standard buttons excluded from the search
                layout.</td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">listViewButtons</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of buttons available in list views for an object.<p class="p">This
                  field is equivalent to the Buttons Displayed value in the
                  <span class="keyword parmname"><var class="keyword varname">Object Name</var> List
                    View</span> in the related list of the object detail
                  page in the UI.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">lookupDialogsAdditionalFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields displayed in a lookup dialog for the
                object.<p class="p">Salesforce objects often include one or more
                  <dfn class="term">lookup fields</dfn> that allow users to associate two
                  records together in a relationship. For example, a contact
                  record includes an <span class="keyword parmname">Account</span> lookup field
                  that represents the relationship between the contact and the
                  organization with which the contact is associated. A lookup
                  search dialog helps you search for the record associated with
                  the one being edited. Lookup filter fields allow you to filter
                  your lookup search by a customized list of fields in the
                  object.
                </p>
                <p class="p">This field is equivalent to the <span class="keyword parmname">Lookup
                    Dialogs</span> related list on the object detail page in
                  the UI.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">lookupFilterFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields that can be used to filter enhanced lookups
                for an object. Enhanced lookups are optionally enabled by your
                administrator.<p class="p">This field is equivalent to the
                  <span class="keyword parmname">Lookup Filter Fields</span> related list on
                  the object detail page in the application user interface.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">lookupPhoneDialogsAdditionalFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of phone-related fields displayed in a lookup dialog for
                the object.<p class="p">This list enables integration of the fields with a
                  softphone dial pad.</p>
                <p class="p">This field is equivalent to the
                  <span class="keyword parmname">Lookup Phone Dialogs</span> related list on
                  the object detail page in the application user
                  interface.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">massQuickActions</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of actions that you can use to perform mass quick action
                on records. Use this field to add an existing create or update
                action.<p class="p">You can perform mass quick actions on custom objects
                  and all standard objects that support quick actions and have a
                  search layout in Lightning Experience. This includes but isn’t
                  limited to cases, leads, accounts, campaigns, contacts,
                  opportunities, and work orders.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">searchFilterFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields that can be used to filter a search for the
                object.<p class="p">This field is equivalent to the <span class="keyword parmname">Search
                    Filter Fields</span> related list on the object detail
                  page in the application user interface.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">searchResultsAdditionalFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields displayed in a search result for the
                object.<p class="p">This field is equivalent to the <span class="keyword parmname">Search
                    Results</span> related list on the object detail page in
                  the application user interface.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">searchResultsCustomButtons</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of custom buttons available in a search result for the
                object. The actions associated with the buttons can be applied to
                any of the records returned in the search result.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample definition of object’s search layout is shown..

<?xml version="1.0" encoding="UTF-8"?>
                <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
                . . .
                <searchLayouts\>
                <listViewButtons\>New</listViewButtons\>
                <listViewButtons\>Accept</listViewButtons\>
                <listViewButtons\>ChangeOwner</listViewButtons\>
                <lookupDialogsAdditionalFields\>firstQuote\_\_c</lookupDialogsAdditionalFields\>
                <lookupDialogsAdditionalFields\>finalQuote\_\_c</lookupDialogsAdditionalFields\>
                <massQuickActions\>Create\_MQA\_Contact</massQuickActions\>
                <searchResultsAdditionalFields\>CREATEDBY\_USER</searchResultsAdditionalFields\>
                </searchLayouts\>
                . . .
                </CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordtype.htm "RecordType")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsharingreason.htm "SharingReason")

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")
- [ProfileSearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profilesearchlayouts.htm "Represents a user profile’s search results layouts for an object. ProfileSearchLayouts are similar to SearchLayouts. However, with profile-specific layouts, each user profile can have a different search results layout for an object.")

<!-- document id=5026900edc745a3016568ccc56e90288d88b29cf1539020a400ccc139406a49d url=/legacydeveloper/current/en-us/api_meta/meta_searchorgwideobjectconfig.md -->

# SearchOrgWideObjectConfig

Represents an object in the search index. The search index contains org-wide search settings created in Search Manager. Each object in the search index includes searchable fields and fields protected by field-level security in search.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

SearchOrgWideObjectConfig components have the suffix .searchOrgWideObjectConfig and are stored in the searchOrgWideConfiguration folder.

## Version

SearchOrgWideObjectConfig components are available in API version 61.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| masterLabel | 
Field Type

string

Description

Required.

The name of the configuration.



 |
| objectReference | 

Field Type

string

Description

Required.

The API name of the object.



 |
| searchOrgWideFieldConfig | 

Field Type

[SearchOrgWideFieldConfig\[\]](#SearchOrgWideFieldConfig)

Description

A list of field configurations. 



 |

## SearchOrgWideFieldConfig

Represents the configuration in the search index for a field in an object.

| Field Name | Description |
| --- | --- |
| fieldReference | 
Field Type

string

Description

Required.

The API name of the field.



 |
| isSearchable | 

Field Type

boolean

Description

Indicates if the field is searchable (true) or not (false). If true, the field is shown in search results and used to match results. 



 |
| isSecure | 

Field Type

boolean

Description

Indicates if the field is protected by field-level security in search (true) or not (false). If true, the search engine uses this field to match results only for users with permissions. If false, the search engine uses this field to match results even if the user doesn’t have permissions to view this field.



 |

## Declarative Metadata Sample Definition

The following is an example of a SearchOrgWideObjectConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<SearchOrgWideObjectConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>CustomerLabel</masterLabel\>
    <objectReference\>Customer</objectReference\>
    <searchOrgWideFieldConfig\>
        <fieldReference\>Custom\_Field\_1\_\_c</fieldReference\>
        <isSearchable\>false</isSearchable\>
        <isSecure\>false</isSecure\>
    </searchOrgWideFieldConfig\>
    <searchOrgWideFieldConfig\>
        <fieldReference\>Custom\_Field\_2\_\_c</fieldReference\>
        <isSearchable\>true</isSearchable\>
        <isSecure\>true</isSecure\>
    </searchOrgWideFieldConfig\>
</SearchOrgWideObjectConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>SearchOrgWideObjectConfig</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=eb8d26969f74a03a27068fac00188536a9fbeeeae62b06b9bce742d330d4a642 url=/legacydeveloper/current/en-us/api_meta/meta_searchsettings.md -->

# SearchSettings

Represents an org's search settings.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

SearchSettings values are stored in a single file named Search.settings in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

SearchSettings is available in API version 37.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d840026e109">Field Name</th>

              <th class="featureTableHeader  " id="d840026e112">Field Type</th>

              <th class="featureTableHeader  " id="d840026e115">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">documentContentSearchEnabled</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether a full-text document search is
                performed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableAdvancedSearchInAlohaSidebar</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether advanced search is available in the search
                sidebar (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in Salesforce
                Classic only. Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableEinsteinSearchAssistantDialog</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether the Einstein search experience is enabled
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version
                50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableEinsteinSearchEs4kPilot</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether Einstein Search for Knowledge enhancements are
                enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version
                54.0 and later.<p class="p">This feature became generally available in Winter
                  '23. In API version 56.0 and later, the default value is <samp class="codeph nolang">true</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableEinsteinSearchNaturalLanguage</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether natural language search is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version
                50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableEinsteinSearchNLSFilters</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether the Natural Language Search Filters (Pilot)
                feature is enabled (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). Available in API
                version 54.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableEinsteinSearchPersonalization</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether search personalization is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in Lightning
                Experience only. Available in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enablePersonalTagging</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether users are allowed to group records from various
                objects by a common theme (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                Personal tags are visible to the user only. Available in Salesforce
                Classic only. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enablePublicTagging</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether users are allowed to group records from various
                objects by a common theme (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                Personal tags are visible to all users. Available in Salesforce
                Classic only. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableSalesforceGeneratedSynonyms</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether search synonyms are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version
                47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableSearchTermHistory</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether users are allowed to group records from various
                objects by a common theme (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                Public tags are visible to everyone in the organization. Available
                in Salesforce Classic only. Available in API version 48.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableSetupSearch</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether the search box in the Setup sidebar returns
                matching custom fields, custom objects, and other supported setup
                items when you press Enter (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp> in Developer, Performance, Professional,
                Enterprise, and Unlimited editions, and <samp class="codeph nolang">false</samp> in all other editions. Available in API version
                47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableSuggestArticlesLinksOnly</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether links are provided to knowledge articles from
                Cases similar to the current Case (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 48.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">enableUseDefaultSearchEntity</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Indicates whether to use the admin-specified default entity in
                sidebar search (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). Available in
                Salesforce Classic only. Available in API version 48.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">optimizeSearchForCJKEnabled</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Required. Indicates whether the search is optimized for the
                Japanese, Chinese, and Korean languages (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This setting affects sidebar search and the
                account search for <strong class="ph uicontrol">Find Duplicates</strong> on a lead
                record in sidebar search and global search. Enable this option if
                users are searching mostly in Japanese, Chinese, or Korean, and if
                the text in searchable fields is mostly in those languages.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">recentlyViewedUsersForBlankLookupEnabled</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Required. Indicates whether the list of records that are returned
                from a user autocomplete lookup and from a blank user lookup is
                taken from the user’s recently viewed user records (<samp class="codeph nolang">true</samp>). Otherwise this setting is
                <samp class="codeph nolang">false</samp> if the lookup shows a
                list of recently accessed user records from across your org (<samp class="codeph nolang">false</samp>). Only applies to User object
                blank lookup searches.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">searchSettingsByObject</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type"><a class="xref" href="#searchsettingsbyobject">SearchSettingsByObject</a></td>

              <td class="entry" headers="d840026e115" data-title="Description">Required. Represents a list of search settings for each
                object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">sidebarAutoCompleteEnabled</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Required. Indicates whether autocomplete is enabled for sidebar
                search (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Autocomplete is when users
                start typing search terms and sidebar search displays a matching
                list of recently viewed records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">sidebarDropDownListEnabled</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Required. Indicates whether a dropdown list appears in the
                sidebar search section (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). From this list,
                users can select to search within tags, within a specific object, or
                across all objects.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">sidebarLimitToItemsIOwnCheckboxEnabled</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Required. Indicates whether the <strong class="ph uicontrol">Limit to Items I
                  Own</strong> checkbox appears (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The checkbox allows your users to include only
                records for which they are the record owner when entering search
                queries in the sidebar.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">singleSearchResultShortcutEnabled</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Required. Indicates whether a shortcut is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). With the shortcut, users
                skip the search results page and go directly to the record’s detail
                page when their search returns only a single item. This setting
                doesn't apply to tags, case comments (in advanced search), and
                global search.</td>

            </tr>

            <tr>
              <td class="entry" headers="d840026e109" data-title="Field Name"><span class="keyword parmname">spellCorrectKnowledgeSearchEnabled</span></td>

              <td class="entry" headers="d840026e112" data-title="Field Type">boolean</td>

              <td class="entry" headers="d840026e115" data-title="Description">Required. Indicates whether spell check is enabled for Knowledge
                search (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

          </tbody>

        </table>

## SearchSettingsByObject

| Field Name | Field Type | Description |
| --- | --- | --- |
| searchSettingsByObject | [ObjectSearchSetting](#objectsearchsettings) | Contains a list of search settings for each object. |

## ObjectSearchSetting

A list of search settings for each object.

| Field Name | Field Type | Description |
| --- | --- | --- |
| enhancedLookupEnabled | boolean | Required. Indicates whether enhanced lookups is enabled for the object (true) or not (false). |
| lookupAutoCompleteEnabled | boolean | Required. Indicates whether autocomplete is enabled for lookup search (true) or not (false). Autocomplete is when users edit the lookup field inline by choosing an autosuggestion. |
| name | string | Required. The entity name of the object being configured. |
| resultsPerPageCount | int | Required. The number of search results per page. |

## Declarative Metadata Sample Definition

The following is an example of the Search.settings file.

<?xml version="1.0" encoding="UTF-8"?>
    <SearchSettings xmlns="http://soap.sforce.com/2006/04/metadata">
        <enableSetupSearch\>false</enableSetupSearch\>
        <enableAdvancedSearchInAlohaSidebar\>false</enableAdvancedSearchInAlohaSidebar\>
        <enableQuerySuggestionPigOn\>false</enableQuerySuggestionPigOn\>
        <enableSalesforceGeneratedSynonyms\>false</enableSalesforceGeneratedSynonyms\>
        <enableSearchTermHistory\>false</enableSearchTermHistory\>
        <enablePublicTagging\>false</enablePublicTagging\>
        <enablePersonalTagging\>false</enablePersonalTagging\>
        <enableSuggestArticlesLinksOnly\>false</enableSuggestArticlesLinksOnly\>
        <enableUseDefaultSearchEntity\>false</enableUseDefaultSearchEntity\>
            <documentContentSearchEnabled\>true</documentContentSearchEnabled\>
            <optimizeSearchForCJKEnabled\>true</optimizeSearchForCJKEnabled\>
            <recentlyViewedUsersForBlankLookupEnabled\>true</recentlyViewedUsersForBlankLookupEnabled\>
            <searchSettingsByObject\>
            <searchSettingsByObject\>
                <enhancedLookupEnabled\>false</enhancedLookupEnabled\>
                <lookupAutoCompleteEnabled\>false</lookupAutoCompleteEnabled\>
                <name\>Account</name\>
                <resultsPerPageCount\>25</resultsPerPageCount\>
            </searchSettingsByObject\>
            <searchSettingsByObject\>
                <enhancedLookupEnabled\>false</enhancedLookupEnabled\>
                <lookupAutoCompleteEnabled\>false</lookupAutoCompleteEnabled\>
                <name\>Activity</name\>
                <resultsPerPageCount\>25</resultsPerPageCount\>
            </searchSettingsByObject\>
            <searchSettingsByObject\>
                <enhancedLookupEnabled\>false</enhancedLookupEnabled\>
                <lookupAutoCompleteEnabled\>false</lookupAutoCompleteEnabled\>
                <name\>Asset</name\>
                <resultsPerPageCount\>25</resultsPerPageCount\>
            </searchSettingsByObject\>
            </searchSettingsByObject\>
            <sidebarAutoCompleteEnabled\>true</sidebarAutoCompleteEnabled\>
            <sidebarDropDownListEnabled\>true</sidebarDropDownListEnabled\>
            <sidebarLimitToItemsIOwnCheckboxEnabled\>true</sidebarLimitToItemsIOwnCheckboxEnabled\>
            <singleSearchResultShortcutEnabled\>true</singleSearchResultShortcutEnabled\>
            <spellCorrectKnowledgeSearchEnabled\>true</spellCorrectKnowledgeSearchEnabled\>
        <enableEinsteinSearchPersonalization\>true</enableEinsteinSearchPersonalization\>
    </SearchSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Search settings metadata for an organization.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Search</members\>
        <name\>Settings</name\>
    </types\>
    <version\>37.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=6a8d70c911b0aad8208c18100b54a83db6d8c2762a80888549462ccd43630e80 url=/legacydeveloper/current/en-us/api_meta/meta_secondarytelephonyprovider.md -->

# SecondaryTelephonyProvider

Represents the SIP configuration for secondary telephony providers in Agentforce Contact Center BYOC.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

SecondaryTelephonyProvider components have the suffix .secondaryTelephonyProvider and are stored in the secondaryTelephonyProviders folder.

## Version

SecondaryTelephonyProvider components are available in API version 68.0 and later.

## Special Access Rules

To access SecondaryTelephonyProvider, you must have the Agentforce Contact Center Admin (Salesforce Voice) permission set assigned.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| fullName | string | Required. The unique name of the SecondaryTelephonyProvider component. Inherited from the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type. |
| id | string | Specifies the ID of the secondary telephony provider. |
| inboundAuthEnabled | boolean | Indicates whether inbound authentication is enabled for the secondary telephony provider (true) or not (false). |
| inboundIpAllowlist | string | Specifies the inbound IP allowlist of the secondary telephony provider. |
| masterLabel | string | Required. The master label for the SecondaryTelephonyProvider. |
| telephonyProvider | string | Specifies the associated telephony provider for the secondary telephony provider. |

## Declarative Metadata Sample Definition

A sample XML definition of a SecondaryTelephonyProvider component is shown here.

<secondaryTelephonyProvider>
    <fullName>MySecondaryTelephonyProvider</fullName>
    <id>sampleValue</id>
    <inboundAuthEnabled>true</inboundAuthEnabled>
    <inboundIpAllowlist>sampleValue</inboundIpAllowlist>
    <masterLabel>sampleValue</masterLabel>
    <telephonyProvider>sampleValue</telephonyProvider>
</secondaryTelephonyProvider>

The following package.xml manifest retrieves the SecondaryTelephonyProvider component.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   ~ Copyright 2020 Salesforce, Inc.
   ~ All Rights Reserved
   ~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types>
      <members>\*</members>
      <name>SecondaryTelephonyProvider</name>
   </types>
   <version>XX.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=45bb4fdf0fd38cfaf2637812c2ba31364432a7f719ae889102d2b79463d3976d url=/legacydeveloper/current/en-us/api_meta/meta_securitysettings.md -->

# SecuritySettings

Represents an org’s security settings. For example, settings define trusted IP ranges for network access, password and login requirements, session expiration, and single sign-on settings.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

SecuritySettings values are stored in a single file named Security.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

Security settings are available in API version 27.0 and later. API versions 26 and earlier are no longer available.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d842977e113">Field Name</th>

              <th class="featureTableHeader  " id="d842977e116">Field Type</th>

              <th class="featureTableHeader  " id="d842977e119">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">canUsersGrantLoginAccess</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">
                <p class="p">If <samp class="codeph nolang">true</samp>, users can grant
                  login access to Support. If <samp class="codeph nolang">false</samp>, only an admin can grant login access.</p>

                <p class="p">Users can’t grant login access to managed packages that are
                  licensed to your entire Salesforce org. Only admins with the
                  Manage Users permission enabled on their profiles can grant
                  access to these publishers. Also, some managed packages don’t
                  have login access. If a package isn’t listed on the Login Access
                  Policies page, login access isn’t available for that
                  package.</p>


              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">enableAdminLoginAsAnyUser</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">
                <span class="ph" id="enableAdminLoginAsAnyUser"><a name="enableAdminLoginAsAnyUser"><!-- --></a>If <samp class="codeph nolang">true</samp>, the <strong class="ph uicontrol">Administrators Can Log in as
                    Any User</strong> field is enabled. </span>The default
                isn’t enabled (<samp class="codeph nolang">false</samp>).
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">enableAuditFieldsInactiveOwner</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">If <samp class="codeph nolang">true</samp>, this setting
                enables audit fields and updating the owner for records that are
                owned by inactive users. The default value is <samp class="codeph nolang">false</samp>. This field is available in
                API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">enableAuraSecureEvalPref</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">If <samp class="codeph nolang">true</samp>, this setting
                prevents the creation of function expressions in dynamically created
                Aura components. The default is <samp class="codeph nolang">false</samp>. This field is available in API version 47.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">enableCoepHeader</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">Indicates whether the Cross-Origin Embedder Policy (COEP)
                response header is applied to this org’s custom Visualforce pages
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If <samp class="codeph nolang">true</samp>, externally sourced embedded
                content loads only when the external origin allows it via CORS or
                CORP. The default value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version 55.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">enableCoopHeader</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">Indicates whether the Cross-Origin Opener Policy (COOP) response
                header is applied to this org’s custom Visualforce pages (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If <samp class="codeph nolang">true</samp>, each custom Visualforce page
                opens in a new browsing context group. The default value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version
                  55.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">enableCrossOrgRedirects</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">Indicates whether redirections to other Salesforce orgs are
                allowed (<samp class="codeph nolang">true</samp>) or blocked
                (<samp class="codeph nolang">false</samp>). In Summer ’24 and
                later, this field is always <samp class="codeph nolang">false</samp>.<p class="p">This setting applies to user redirections to
                  another Salesforce org via a direct link, a post-action URL, or
                  a post-login URL in Salesforce. An example of a direct link with
                  a redirection is <samp class="codeph html"><span class="tag">&lt;a</span>
                    <span class="attribute"> href=</span><span class="string">"/?startURL=</span><var class="keyword varname">targetUrl</var><span class="string">"&gt;</span><var class="keyword varname">linkText</var><span class="string">"&gt;</span><var class="keyword varname">linkText</var><span class="tag">&lt;/a</span>&gt;</samp>.
                  Post-action URLs and post-login URLs use a protected URL
                  redirect parameter, such as <samp class="codeph nolang">retURL</samp>, <samp class="codeph nolang">startURL</samp>, <samp class="codeph nolang">saveURL</samp>, <samp class="codeph nolang">cancelURL</samp>, and <samp class="codeph nolang">targetURL</samp>. Subsequent redirections can’t be
                  verified because they occur outside Salesforce.</p>
                <p class="p">To allow
                  cross-org redirections, add the URLs for the Salesforce orgs
                  that you own to <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_redirectwhitelisturl.htm" title="Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true. This type extends the Metadata metadata type and inherits its fullName field.">RedirectWhitelistUrl</a>.</p>
                <p class="p">Available in API version 59.0 to
                  60.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">enableGraphQLApiGuestUserAccess</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">Indicates whether unauthenticated guest users can access GraphQL
                API (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>.<p class="p">Available in API
                  version 68.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">enablePermissionsPolicy</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">Indicates whether the pages that Salesforce serves for this org
                include the <samp class="codeph nolang">Permissions-Policy</samp>
                HTTP header. This HTTP header controls access to browser features
                such as cameras and microphones. When this field is <samp class="codeph nolang">false</samp>, access to the browser
                features is always permitted. The default value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version
                  59.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">enableRequireHttpsConnection</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">Deprecated in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">grantCameraAccess</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">PermissionsPolicy (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a>)</td>

              <td class="entry" headers="d842977e119" data-title="Description">When <span class="keyword parmname">enablePermissionsPolicy</span> is <samp class="codeph nolang">true</samp>, indicates when apps and
                websites loaded from Salesforce can access the user’s
                camera.<p class="p">Possible values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Always</samp>—All apps
                    and websites loaded from Salesforce can access the user’s
                    camera.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Never</samp>—No apps or
                    websites, including scripts from Salesforce domains, can
                    access the user’s camera.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TrustedUrls</samp>—Only
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_csptrustedsite.htm" title="Represents a trusted URL. For each CspTrustedSite component, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite components included only CSP directives and were referred to as CSP Trusted Sites.">CspTrustedSite</a>
                    entries with <span class="keyword parmname">canAccessCamera</span> set to
                    <samp class="codeph nolang">true</samp> can access the
                    user’s camera.
                  </li>

                </ul>
                <p class="p">If <span class="keyword parmname">enablePermissionsPolicy</span> is <samp class="codeph nolang">false</samp>, this field has no
                  effect.</p>
                <p class="p">This field is available in API version 59.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">grantMicrophoneAccess</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">Permissions Policy (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a>)</td>

              <td class="entry" headers="d842977e119" data-title="Description">When <span class="keyword parmname">enablePermissionsPolicy</span> is <samp class="codeph nolang">true</samp>, indicates when apps and
                websites loaded from Salesforce can access the user’s
                microphone.<p class="p">Possible values are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Always</samp>—All apps
                    and websites loaded from Salesforce can access the user’s
                    microphone.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Never</samp>—No apps or
                    websites, including scripts from Salesforce domains, can
                    access the user’s microphone.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TrustedUrls</samp>—Only
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_csptrustedsite.htm" title="Represents a trusted URL. For each CspTrustedSite component, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite components included only CSP directives and were referred to as CSP Trusted Sites.">CspTrustedSite</a>
                    entries with <span class="keyword parmname">canAccessMicrophone</span> set to
                    <samp class="codeph nolang">true</samp> can access the
                    user’s microphone.
                  </li>

                </ul>
                <p class="p">If <span class="keyword parmname">enablePermissionsPolicy</span> is <samp class="codeph nolang">false</samp>, this field has no
                  effect.</p>
                <p class="p">This field is available in API version 59.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">isTLSv12Required</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">Indicates whether connections to or from your Salesforce org must
                use TLS 1.2 or higher (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). This field has a
                default value of <samp class="codeph nolang">false</samp>. Removed
                in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">isTLSv12RequiredCommunities</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">Indicates whether connections with your Salesforce sites and
                portals or Experience Cloud sites must use TLS 1.2 or higher
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default
                value of <samp class="codeph nolang">false</samp>. Removed in API
                version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname" id="field_networkaccess"><a name="field_networkaccess"><!-- --></a>networkAccess</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type"><a class="xref" href="#SecuritySettingsNetworkAccess">NetworkAccess</a></td>

              <td class="entry" headers="d842977e119" data-title="Description"><span class="ph" id="trustedIPRange_descr"><a name="trustedIPRange_descr"><!-- --></a>The trusted IP address ranges from
                  which users can always log in without requiring computer
                  activation.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname" id="field_passwordpolicies"><a name="field_passwordpolicies"><!-- --></a>passwordPolicies</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type"><a class="xref" href="#SecuritySettingsPasswordPolicies">PasswordPolicies</a></td>

              <td class="entry" headers="d842977e119" data-title="Description"><span class="ph" id="passwordPolicies_descr"><a name="passwordPolicies_descr"><!-- --></a>The requirements for passwords
                  and logins, and assistance with retrieving forgotten
                  passwords.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname">sendCspForUncommonClients</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e119" data-title="Description">
                <p class="p">In rare cases, Salesforce can’t identify whether the requesting
                  app or specialized browser supports the <samp class="codeph nolang">Content-Security-Policy:
                    frame-ancestors</samp> HTTP header directive. In those
                  cases, this field indicates whether that directive is included
                  in (<samp class="codeph nolang">true</samp>) or omitted from
                  (<samp class="codeph nolang">false</samp>) the HTTP
                  response header for pages that Salesforce serves for this org.
                  The default value is <samp class="codeph nolang">false</samp>.</p>

                <p class="p">When <span class="keyword parmname">sendCspForUncommonClients</span> is <samp class="codeph nolang">true</samp>, users who access
                  Salesforce via an app or browser that doesn’t support the
                  <samp class="codeph nolang">Content-Security-Policy:
                    frame-ancestors</samp> HTTP header directive can
                  experience errors if that lack of support is unclear.
                </p>

                <p class="p">This field is available in API version 59.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname" id="field_sessionsettings"><a name="field_sessionsettings"><!-- --></a>sessionSettings</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type"><a class="xref" href="#SecuritySettingsSessionSettings">SessionSettings</a></td>

              <td class="entry" headers="d842977e119" data-title="Description"><span class="ph" id="sessionSettings_descr"><a name="sessionSettings_descr"><!-- --></a>The settings for session
                  expiration and security.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e113" data-title="Field Name"><span class="keyword parmname" id="field_singlesignonsettings"><a name="field_singlesignonsettings"><!-- --></a>singleSignOnSettings</span></td>

              <td class="entry" headers="d842977e116" data-title="Field Type"><a class="xref" href="#SecuritySettingsSingleSignOnSettings">SingleSignOnSettings</a></td>

              <td class="entry" headers="d842977e119" data-title="Description">The settings for single sign-on (SSO).</td>

            </tr>

          </tbody>

        </table>

## NetworkAccess

Represents your org’s trusted IP address ranges for network access.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d842977e719">Field</th>

              <th class="featureTableHeader  " id="d842977e722">Field Type</th>

              <th class="featureTableHeader  " id="d842977e725">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d842977e719" data-title="Field"><span class="keyword parmname" id="field_ipranges"><a name="field_ipranges"><!-- --></a>ipRanges</span></td>

              <td class="entry" headers="d842977e722" data-title="Field Type">
                <a class="xref" href="#SecuritySettingsIpRanges">IpRange</a>[]
              </td>

              <td class="entry" headers="d842977e725" data-title="Description">The trusted IP address ranges from which users can always log in
                without requiring computer activation.<p class="p">To add an IP range, deploy
                  all existing IP ranges, including the one you want to add.
                  Otherwise, the existing IP ranges are replaced with the ones you
                  deploy. To remove all the IP ranges, leave the networkAccess
                  field blank (&lt;networkAccess&gt;&lt;/networkAccess&gt;).</p>
              </td>

            </tr>

          </tbody>

        </table>

## IpRange

Defines a range of trusted IP addresses for network access.

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The description of the trusted IP range. Use this field to identify the range, such as which corporate network corresponds to this range. Available in API version 34.0 and later. |
| end | string | The IP address that defines the high end of a range of trusted addresses. |
| start | string | The IP address that defines the low end of a range of trusted addresses. |

## PasswordPolicies

Represents your org’s password and login policies, which show up under **Security Controls | Password Policies**.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d842977e862">Field</th>

              <th class="featureTableHeader  " id="d842977e865">Field Type</th>

              <th class="featureTableHeader  " id="d842977e868">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_alternativehomepage"><a name="field_alternativehomepage"><!-- --></a>apiOnlyUserHomePageURL</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">string</td>

              <td class="entry" headers="d842977e868" data-title="Description"><span class="ph" id="alternativeHomePage_descr"><a name="alternativeHomePage_descr"><!-- --></a>The URL to which users with
                  the API Only User permission are redirected instead of the login
                  page.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_complexity"><a name="field_complexity"><!-- --></a>complexity</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">Complexity (enumeration of type string)</td>

              <td class="entry" headers="d842977e868" data-title="Description">
                <p class="p" id="complexity_descr"><a name="complexity_descr"><!-- --></a>The types of characters that must be used
                  in a user’s password. Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">NoRestriction</samp>—Has no requirements and is
                    the least secure option.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AlphaNumeric</samp>—The
                    default setting. Requires at least one alphabetic character
                    and one number. <span class="ph" id="default_value"><a name="default_value"><!-- --></a>This value is the
                      default value.</span>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SpecialCharacters</samp>—Requires at least one
                    alphabetic character, one number, and one of the following
                    characters: <kbd class="ph userinput">! " # $ % &amp; ' ( ) * + , - . / : ;
                      &lt; = &gt; ? @ [ \ ] ^ _ ` { | } ~</kbd>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UpperLowerCaseNumeric</samp>—Requires at least one
                    number, one uppercase letter, and one lowercase letter. This
                    value is available in API version 31.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UpperLowerCaseNumericSpecialCharacters</samp>—Requires
                    at least one number, one uppercase letter, one lowercase
                    letter, and one of the following characters: <kbd class="ph userinput">! "
                      # $ % &amp; ' ( ) * + , - . / : ; &lt; = &gt; ? @ [ \ ] ^ _
                      ` { | } ~</kbd>. This value is available in API
                    version 31.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Any3UpperLowerCaseNumericSpecialCharacters</samp>—Requires
                    at least three of the following options: one number, one
                    uppercase letter, one lowercase letter, and one special
                    character (<kbd class="ph userinput">! " # $ % &amp; ' ( ) * + , - . / : ;
                      &lt; = &gt; ? @ [ \ ] ^ _ ` { | } ~</kbd>). This
                    value is available in API version 46.0 and later.
                  </li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname">enableSetPasswordInApi</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e868" data-title="Description">Deprecated in API version 51.0. Removed in API version
                52.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_expiration"><a name="field_expiration"><!-- --></a>expiration</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">Expiration (enumeration of type string)</td>

              <td class="entry" headers="d842977e868" data-title="Description">
                <p class="p" id="expiration_descr"><a name="expiration_descr"><!-- --></a>The length of time until a user password
                  expires and must be changed. Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Never</samp></li>

                  <li class="li"><samp class="codeph nolang">ThirtyDays</samp></li>

                  <li class="li"><samp class="codeph nolang">SixtyDays</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">NinetyDays</samp>. This value
                    is the default value.
                  </li>

                  <li class="li"><samp class="codeph nolang">SixMonths</samp></li>

                  <li class="li"><samp class="codeph nolang">OneYear</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_historyrestriction"><a name="field_historyrestriction"><!-- --></a>historyRestriction</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">string</td>

              <td class="entry" headers="d842977e868" data-title="Description">
                <span class="ph" id="historyRestriction_descr"><a name="historyRestriction_descr"><!-- --></a>The number of previous
                  passwords saved for users so that they must always reset a new,
                  unique password. Valid values are <samp class="codeph nolang">0</samp> through <samp class="codeph nolang">24</samp>
                  passwords remembered.</span> The maximum value of 24 applies to
                API version 31.0 and later. In earlier versions, the maximum value
                is 16. The default value is <samp class="codeph nolang">3</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_lockoutinterval"><a name="field_lockoutinterval"><!-- --></a>lockoutInterval</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">LockoutInterval (enumeration of type string)</td>

              <td class="entry" headers="d842977e868" data-title="Description">
                <p class="p" id="lockoutInterval_descr"><a name="lockoutInterval_descr"><!-- --></a>The duration of the login lockout.
                  Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">FifteenMinutes</samp>. This
                    value is the default value.
                  </li>

                  <li class="li"><samp class="codeph nolang">ThirtyMinutes</samp></li>

                  <li class="li"><samp class="codeph nolang">SixtyMinutes</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Forever</samp> (must be reset
                    by admin)
                  </li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_maxloginattempts"><a name="field_maxloginattempts"><!-- --></a>maxLoginAttempts</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">MaxLoginAttempts (enumeration of type string)</td>

              <td class="entry" headers="d842977e868" data-title="Description">
                <p class="p" id="maxLoginAttempts_descr"><a name="maxLoginAttempts_descr"><!-- --></a>The number of login failures allowed
                  for a user before the user is locked out. Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">NoLimit</samp></li>

                  <li class="li"><samp class="codeph nolang">ThreeAttempts</samp></li>

                  <li class="li"><samp class="codeph nolang">FiveAttempts</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">TenAttempts</samp>. This value
                    is the default value.
                  </li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_minpasswordlength"><a name="field_minpasswordlength"><!-- --></a>minimumPasswordLength</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type"> string</td>

              <td class="entry" headers="d842977e868" data-title="Description">
                <p class="p" id="minPasswordLength_descr"><a name="minPasswordLength_descr"><!-- --></a>The minimum number of characters
                  required for a password. The number can contain from 5 to 50
                  characters (default is 8). Available in API version 35.0 and
                  later.</p>

                <p class="p">Before API version 35.0, specify minimum password length with the
                  enumeration <samp class="codeph nolang">minPasswordLength</samp>, with valid values <samp class="codeph nolang">FiveCharacters</samp>, <samp class="codeph nolang">EightCharacters</samp> (default),
                  <samp class="codeph nolang">TenCharacters</samp>, <samp class="codeph nolang">TwelveCharacters</samp> (API version
                  31.0 and later), and <samp class="codeph nolang">FifteenCharacters</samp> (API version 34.0 and
                  later).
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname">minimumPasswordLifetime</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e868" data-title="Description">
                <span class="ph" id="minPasswordLife_descr"><a name="minPasswordLife_descr"><!-- --></a>If <strong class="ph uicontrol">Require a minimum 1
                    day password lifetime</strong> is enabled (<samp class="codeph nolang">true</samp>), passwords can’t be
                  changed more than one time during a 24-hour period.</span> The
                default is <samp class="codeph nolang">false</samp>. Available in
                API version 31.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field">
                <span class="keyword parmname" id="obscureSecretAnswer"><a name="obscureSecretAnswer"><!-- --></a>obscureSecretAnswer</span>
              </td>

              <td class="entry" headers="d842977e865" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e868" data-title="Description">
                <span class="ph" id="obscureSecretAnswer_descr"><a name="obscureSecretAnswer_descr"><!-- --></a>If enabled (<samp class="codeph nolang">true</samp>), hide answers to security
                  questions as the user types. The default is <samp class="codeph nolang">false</samp>.</span>
                <p class="p">If your org uses
                  the Microsoft Input Method Editor (IME) with the input mode set
                  to Hiragana, when you type ASCII characters, they’re
                  converted in to Japanese characters in normal text fields.
                  However, the IME doesn’t work properly in fields with obscured
                  text. If your org’s users can’t properly enter their
                  passwords or other values after enabling this feature, disable
                  the feature.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_forgotpasswordmessage"><a name="field_forgotpasswordmessage"><!-- --></a>passwordAssistanceMessage</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">string</td>

              <td class="entry" headers="d842977e868" data-title="Description"><span class="ph" id="forgotPasswordMessage_descr"><a name="forgotPasswordMessage_descr"><!-- --></a>The text that appears in the
                  Account Lockout email and at the bottom of the Confirm Identity
                  screen for users resetting their passwords.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_forgotpasswordlink"><a name="field_forgotpasswordlink"><!-- --></a>passwordAssistanceURL</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">string</td>

              <td class="entry" headers="d842977e868" data-title="Description"><span class="ph" id="forgotPasswordLink_descr"><a name="forgotPasswordLink_descr"><!-- --></a>The URL that users can click to
                  retrieve forgotten passwords.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e862" data-title="Field"><span class="keyword parmname" id="field_questionrestriction"><a name="field_questionrestriction"><!-- --></a>questionRestriction</span></td>

              <td class="entry" headers="d842977e865" data-title="Field Type">QuestionRestriction (enumeration of type string)</td>

              <td class="entry" headers="d842977e868" data-title="Description">
                <p class="p" id="questionRestriction_descr"><a name="questionRestriction_descr"><!-- --></a>The restriction on whether the
                  answer to the password hint question can contain the password
                  itself. Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">DoesNotContainPassword</samp>.
                    This value is the default value.
                  </li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## SessionSettings

Represents your org’s session expiration and security settings.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d842977e1274">Field</th>

              <th class="featureTableHeader  " id="d842977e1277">Field Type</th>

              <th class="featureTableHeader  " id="d842977e1280">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">allowUserAuthenticationByCertificate</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If enabled (<samp class="codeph nolang">true</samp>), users can
                authenticate with a PEM-encoded X.509 digital certificate. Not
                enabled by default. Available in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">allowUserCertBasedAuthenticationWithOcspValidation</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If enabled (<samp class="codeph nolang">true</samp>),
                authentication certificates are validated using the Online
                Certificate Status Protocol (OCSP) or a Certificate Revocation List
                (CRL).</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">auraBoxcarReductionPref</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If <samp class="codeph nolang">true</samp>, dynamic boxcar
                optimization for the Aura framework is disabled. With dynamic boxcar
                optimization, a limited number of server-side Aura actions are
                grouped in a single network request, which improves the performance
                of Lightning components and apps. For more information, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.lightning.meta/lightning/controllers_server_actions_boxcar_dynamic.htm" target="_blank">Boxcar Grouping and
                  Optimization</a> in the <cite class="cite">Lightning Aura Components
                  Developer Guide</cite>.<p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">canConfirmEmailChangeInLightningCommunities</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If <strong class="ph uicontrol">Require email confirmations for email address
                  changes</strong> is enabled (<samp class="codeph nolang">true</samp>), when users change their email address, they
                receive an email at the new address with a link. After they click
                the link, their new email address takes effect. For orgs created
                before Winter ’20, the field isn’t enabled by default. For new orgs,
                this field is always enabled. To disable the field (not
                recommended), contact Salesforce Customer Support. Available in API
                version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="ph" id="canConfirmIdentityBySmsOnly"><a name="canConfirmIdentityBySmsOnly"><!-- --></a><span class="keyword parmname">canConfirmIdentityBySmsOnly</span></span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Prevents identity verification by email for users who have
                registered other verification methods, such as SMS or Salesforce
                Authenticator. If no other verification methods are configured,
                users are verified by email.<p class="p">By default, this setting is disabled
                  (<samp class="codeph nolang">false</samp>) for existing
                  orgs. For new orgs, this setting is enabled (<samp class="codeph nolang">true</samp>) by default. Available in
                  API version 48.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_disabletimeoutwarning"><a name="field_disabletimeoutwarning"><!-- --></a>disableTimeoutWarning</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description"><span class="ph" id="disableTimeoutWarning_descr"><a name="disableTimeoutWarning_descr"><!-- --></a>Indicates whether the
                  session timeout warning popup is disabled (<samp class="codeph nolang">true</samp>) or enabled (<samp class="codeph nolang">false</samp>).</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableBuiltInAuthenticator</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates whether users can verify their identity with a built-in
                authenticator that's already on their device (<samp class="codeph nolang">true</samp>), such as Touch ID or Windows
                Hello, or not (<samp class="codeph nolang">false</samp>). The
                default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableCSPOnEmail</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates whether a content security policy is enabled for the
                email template. A content security policy helps prevent cross-site
                scripting attacks by listing allowed sources of images and other
                content.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableCSRFOnGet</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates whether Cross-Site Request Forgery (CSRF) protection on
                GET requests on non-setup pages is enabled (<samp class="codeph nolang">true</samp>) or disabled (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableCSRFOnPost</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates whether Cross-Site Request Forgery (CSRF) protection on
                POST requests on non-setup pages is enabled (<samp class="codeph nolang">true</samp>) or disabled (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_enablecacheandautocomplete"><a name="field_enablecacheandautocomplete"><!-- --></a>enableCacheAndAutocomplete</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description"><span class="ph" id="enableCacheAndAutocomplete_descr"><a name="enableCacheAndAutocomplete_descr"><!-- --></a>Indicates whether the
                  user’s browser is allowed to store usernames and auto-fill the
                  <span class="keyword parmname">User Name</span> field on the login page
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableClickjackNonsetupSFDC</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates whether clickjack protection for non-setup Salesforce
                pages is enabled (<samp class="codeph nolang">true</samp>) or
                disabled (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableClickjackNonsetupUser</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates whether clickjack protection for customer Visualforce
                pages with standard headers turned on is enabled (<samp class="codeph nolang">true</samp>) or disabled (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableClickjackNonsetupUserHeaderless</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <span class="ph" id="rn196_enableClickjackNonsetupUserHeaderless_description"><a name="rn196_enableClickjackNonsetupUserHeaderless_description"><!-- --></a>Indicates whether clickjack protection for customer Visualforce
                  pages with standard headers turned off is enabled (<samp class="codeph nolang">true</samp>) or disabled (<samp class="codeph nolang">false</samp>).</span> Available in API
                version 34.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableClickjackSetup</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates whether clickjack protection for setup pages is enabled
                (<samp class="codeph nolang">true</samp>) or disabled (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="enableContentSniffingProtection"><a name="enableContentSniffingProtection"><!-- --></a>enableContentSniffingProtection</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p" id="enableContentSniffingProtection_desc"><a name="enableContentSniffingProtection_desc"><!-- --></a>Indicates whether the
                  browser is prevented from inferring the MIME type from the
                  document content and from executing malicious files (JavaScript,
                  Style sheet) as dynamic content.</p>

                <p class="p">This field is available in API version 39.0 and later. In API
                  version 58.0 and later,
                  <span class="keyword parmname">enableContentSniffingProtection</span> is
                  always <samp class="codeph nolang">true</samp>.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableLightningLogin</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If enabled (<samp class="codeph nolang">true</samp>), users can
                use Lightning Login (Salesforce Authenticator) to log in instead of
                a password. Available in API Version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableLightningLoginOnlyWithUserPerm</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If enabled (<samp class="codeph nolang">true</samp>), only
                users with the Lightning Login User permission can log in with
                Salesforce Authenticator instead of a password. Available in API
                version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableMFADirectUILoginOptIn</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Requires all users in your Salesforce org to provide an
                additional verification method when logging in directly to the UI
                with their username and password. Users who are already enabled via
                the Multi-Factor Authentication for User Interface Logins user
                permission experience no change. The Waive Multi-Factor
                Authentication for Exempt Users user permission overrides this
                setting.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">enableOauthCorsPolicy</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p">If set to <samp class="codeph nolang">true</samp>, enables
                  Cross-Origin Resource Sharing (CORS) for these OAuth
                  endpoints:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">/services/oauth2/token</samp></li>

                  <li class="li"><samp class="codeph nolang">/services/oauth2/revoke</samp></li>

                  <li class="li"><samp class="codeph nolang">/services/oauth2/introspect</samp></li>

                </ul>

                <p class="p">Default setting is <samp class="codeph nolang">false</samp>.
                  Available in API version 50.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_postForSessions"><a name="field_postForSessions"><!-- --></a>enablePostForSessions</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <span class="ph" id="field_postForSessions_desc"><a name="field_postForSessions_desc"><!-- --></a>Indicates whether
                  cross-domain session information is exchanged using a POST
                  request instead of a GET request, such as when a user is using a
                  Visualforce page. In this context, POST requests are more secure
                  than GET requests.</span> Available in API version 31.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_enablesmsidentity"><a name="field_enablesmsidentity"><!-- --></a>enableSMSIdentity</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description"><span class="ph" id="enableSMSIdentity_descr"><a name="enableSMSIdentity_descr"><!-- --></a>If enabled (<samp class="codeph nolang">true</samp>), the default, users can
                  receive a one-time password in a text message (SMS) to verify
                  their identity. Users must verify their mobile phone number
                  before they can receive SMS messages.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_enableu2f"><a name="field_enableu2f"><!-- --></a>enableU2F</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If enabled (<samp class="codeph nolang">true</samp>), users can
                use a physical U2F-compatible security key for multi-factor
                authentication (MFA) and identity verification. The default is
                <samp class="codeph nolang">false</samp>. Available in API
                version 47.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="enableUpgradeInsecureRequests"><a name="enableUpgradeInsecureRequests"><!-- --></a>enableUpgradeInsecureRequests</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p" id="enableUpgradeInsecureRequests_desc"><a name="enableUpgradeInsecureRequests_desc"><!-- --></a>Indicates whether HTTPS
                  is required for connecting to third-party domains.</p>

                <p class="p">This setting is enabled by default on accounts created after the
                  Summer ’17 release.</p>

                <p class="p">This field is available in API version 42.0 to 60.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="enableXssProtection"><a name="enableXssProtection"><!-- --></a>enableXssProtection</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p">Indicates whether the HTTP <samp class="codeph nolang">X-XSS-Protection</samp> response header is enabled to
                  protect against reflected cross-site scripting attacks.</p>

                <p class="p">This field is available in API version 39.0 to 59.0. The HTTP
                  <samp class="codeph nolang">X-XSS-Protection</samp>
                  response header is deprecated. To help prevent cross-site
                  scripting (XSS) and other code injection attacks, use the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_csptrustedsite.htm" target="_blank">CSPTrustedSite</a>
                  metadata type.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_enableContinuousIP"><a name="field_enableContinuousIP"><!-- --></a>enforceIpRangesEveryRequest</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <span class="ph" id="enableContinuousIP_descr"><a name="enableContinuousIP_descr"><!-- --></a>If <samp class="codeph nolang">true</samp>, the IP addresses in Login IP Ranges are
                  enforced when a user accesses Salesforce (on every page
                  request), including access from a client app. If <samp class="codeph nolang">false</samp>, the IP addresses in
                  Login IP Ranges are enforced only when a user logs in. This
                  field affects all user profiles with login IP restrictions.</span>
                Available in API version 34.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_UserDeviceRevoked"><a name="field_UserDeviceRevoked"><!-- --></a>enforceUserDeviceRevoked</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p" id="enforceUserDeviceRevoked_desc"><a name="enforceUserDeviceRevoked_desc"><!-- --></a>If enabled, and a UserDevice’s
                  status is set to revoked, that device can’t log in from a
                  Salesforce app. Logins from browsers aren’t affected.</p>

                <p class="p">This field is available in API version 50.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">forceLogoutOnSessionTimeout</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If enabled (<samp class="codeph nolang">true</samp>), the
                default, when sessions time out for inactive users, current sessions
                become invalid. The browser refreshes and returns to the login page.
                To access the org, the user must log in again. Available in API
                version 31.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_forcerelogin"><a name="field_forcerelogin"><!-- --></a>forceRelogin</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description"><span class="ph" id="forceRelogin_descr"><a name="forceRelogin_descr"><!-- --></a>If <samp class="codeph nolang">true</samp>, an admin who is logged in as another user
                  must log in again to their original session, after logging out
                  as the secondary user. If <samp class="codeph nolang">false</samp>, the admin isn’t required to log in
                  again.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">hasRetainedLoginHints</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If you enable <strong class="ph uicontrol">Remember me until logout</strong>
                (<samp class="codeph nolang">true</samp>), usernames (login
                hints) are cached until the user logs out. If a session times out,
                usernames appear on the Switcher as inactive. If <samp class="codeph nolang">false</samp> (default), usernames aren't
                cached for SSO sessions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">hasUserSwitching</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If <strong class="ph uicontrol">Enable user switching</strong> is<samp class="codeph nolang">true</samp> (default), users can log in to
                other orgs by selecting their profile picture and using the
                Switcher. You must also enable the <strong class="ph uicontrol">Enable caching and
                  autocomplete on login page</strong> setting. <p class="p">If <samp class="codeph nolang">false</samp>, the Switcher isn’t
                  enabled and your org doesn’t appear in Switchers on other
                  orgs.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">hstsOnForcecomSites</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates whether Visualforce, Salesforce sites, or Experience
                Cloud sites must use HTTPS. Available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="identityConfirmationOnEmailChange"><a name="identityConfirmationOnEmailChange"><!-- --></a>identityConfirmationOnEmailChange</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p" id="identityConfirmationOnEmailChange_desc"><a name="identityConfirmationOnEmailChange_desc"><!-- --></a>Indicates whether a
                  user’s identity is confirmed when changing their email address,
                  instead of requiring a relogin.</p>

                <p class="p">This field is available in API version 42.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="IdentityConfirmationOnTwoFactorRegistrationEnabled"><a name="IdentityConfirmationOnTwoFactorRegistrationEnabled"><!-- --></a>identityConfirmationOnTwoFactorRegistrationEnabled</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p" id="IdentityConfirmationOnTwoFactorRegistrationEnabled_desc"><a name="IdentityConfirmationOnTwoFactorRegistrationEnabled_desc"><!-- --></a>Indicates whether users are required to confirm their
                  identities when adding a verification method such as Salesforce
                  Authenticator for multi-factor authentication (MFA), instead of
                  requiring a relogin. (Multi-factor authentication was formerly
                  called two-factor authentication.)</p>

                <p class="p">This field is available in API version 40.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_locksessionstodomain"><a name="field_locksessionstodomain"><!-- --></a>lockSessionsToDomain</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <span class="ph" id="lockSessionsToDomain_desc"><a name="lockSessionsToDomain_desc"><!-- --></a>Indicates whether the current
                  UI session for a user is associated with a specific domain. This
                  check helps prevent unauthorized use of the session ID in
                  another domain. The value is <samp class="codeph nolang">true</samp> by default for orgs created with the Spring
                  ’15 release or later.</span> Available in API version 33.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_locksessionstoip"><a name="field_locksessionstoip"><!-- --></a>lockSessionsToIp</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description"><span class="ph" id="lockSessionsToIP_descr"><a name="lockSessionsToIP_descr"><!-- --></a>Indicates whether user sessions
                  are locked to the IP address from which the user logged in
                  (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">lockerServiceAPIVersion</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">string</td>

              <td class="entry" headers="d842977e1280" data-title="Description">The API version that Lightning Locker enforces for security of
                custom Lightning components. The default value matches the
                Salesforce API version of the current release. Only valid Salesforce
                API versions between 46.0 and the current release can be specified.
                The version must be specified as a string in the format <samp class="codeph nolang">"<var class="keyword varname">nn</var>.0"</samp>, such as <samp class="codeph nolang">"48.0"</samp>. This setting has
                no effect on the <span class="keyword parmname">lockerServiceNext</span> setting,
                which enables Lightning Web Security.<p class="p">This field is available in
                  API version 47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">lockerServiceCSP</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If <samp class="codeph nolang">true</samp>, a stricter
                Content Security Policy is enabled to disallow the <samp class="codeph nolang">unsafe-inline</samp> source for the
                <samp class="codeph nolang">script-src</samp> CSP
                directive. Script tags can’t be used to load JavaScript, and
                event handlers can’t use inline JavaScript. Lightning Locker and
                Lightning Web Security depend on this setting to be enabled to
                protect Lightning components.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">lockerServiceNext</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If <samp class="codeph nolang">true</samp>, Lightning Web
                Security is used instead of Lightning Locker to protect
                Lightning web components. Lightning Locker continues to protect
                Aura components. If <samp class="codeph nolang">false</samp>,
                Lightning Locker protects Lightning web components and Aura
                components. Available in API version 53.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">lockerServiceNextControl</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">lockerTrustedMode</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">lockerTrustedResources</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">string</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_logoutURL"><a name="field_logoutURL"><!-- --></a>logoutURL</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">string</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <span class="ph" id="logoutURL_desc"><a name="logoutURL_desc"><!-- --></a>The URL to which users are redirected
                  when they log out of Salesforce.</span> If no value is specified,
                the default is
                <span class="ph filepath">https://<var class="keyword varname">MyDomainName</var>.my.salesforce.com</span>.
                Available in API version 34.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">redirectBlockModeEnabled</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If <samp class="codeph nolang">true</samp>, users can’t access
                untrusted URLs outside the Salesforce domains via links in URL or
                Long Text Area fields. When a user who accesses Salesforce via
                Salesforce Classic clicks the link, a message informs the user that
                they can’t access the page because the external site isn’t trusted.
                The default is <samp class="codeph nolang">false</samp>.<p class="p">To
                  specify the URLs that you trust, use the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_redirectwhitelisturl.htm" title="Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true. This type extends the Metadata metadata type and inherits its fullName field.">RedirectWhitelistUrl</a>
                  Metadata type.</p>
                <p class="p">The
                  <span class="keyword parmname">redirectBlockModeEnabled</span> and
                  <span class="keyword parmname">redirectionWarning</span> fields are mutually
                  exclusive. Only one of those fields can be <samp class="codeph nolang">true</samp>.
                </p>
                <p class="p">Available in API
                  56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">redirectionWarning</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If <samp class="codeph nolang">true</samp>, users who accesses
                Salesforce via Salesforce Classic see an alert when they click a
                link in a URL or Long Text Area field that redirects them to an
                untrusted URL outside the Salesforce domains. The default is <samp class="codeph nolang">true</samp> in orgs created in Spring ’18
                and later and <samp class="codeph nolang">false</samp> in orgs
                created in Winter ’18 and earlier.<p class="p">To specify the URLs that you
                  trust, use the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_redirectwhitelisturl.htm" title="Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true. This type extends the Metadata metadata type and inherits its fullName field.">RedirectWhitelistUrl</a> Metadata type.</p>
                <p class="p">The
                  <span class="keyword parmname">redirectBlockModeEnabled</span> and
                  <span class="keyword parmname">redirectionWarning</span> fields are mutually
                  exclusive. Only one of those fields can be <samp class="codeph nolang">true</samp>.
                </p>
                <p class="p">Available in API
                  version 42.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">referrerPolicy</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description"> If <samp class="codeph nolang">true</samp>, pages served by
                Salesforce for this org include the <samp class="codeph nolang">referrer-policy</samp> HTTP header with the directive defined
                by <span class="keyword parmname">referrerPolicyDirective</span>. If <samp class="codeph nolang">false</samp>, that HTTP header isn’t
                included and requests can always see the full URL of the Salesforce
                page. The default is <samp class="codeph nolang">true</samp>.
                Available in API version 42.0 and later.<p class="p">In API version
                  42.0–57.0, if <span class="keyword parmname">referrerPolicy</span> is
                  <samp class="codeph nolang">true</samp>, pages served by
                  Salesforce for this org include the <samp class="codeph nolang">referrer-policy</samp> HTTP header with the <samp class="codeph nolang">origin-when-cross-origin</samp>
                  directive.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">referrerPolicyDirective</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">ReferrerPolicy (enumeration of type string)</td>

              <td class="entry" headers="d842977e1280" data-title="Description">The HTTP referrer policy directive for pages served by
                Salesforce. The default is <samp class="codeph nolang">strict-origin-when-cross-origin</samp>. If
                <span class="keyword parmname">referrerPolicy</span> is <samp class="codeph nolang">false</samp>, this value has no effect.
                Available in API version 58.0 and later.<p class="p">Valid current values
                  are:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">no-referrer</samp>—Never include the
                    referrer.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">origin</samp>—Always
                    send the origin only.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">same-origin</samp>—Omit
                    the referrer for cross-origin requests.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">strict-origin</samp>—For requests with the same
                    protocol level (HTTPS to HTTPS), send the origin only. Omit
                    the referrer when the target website is on a downgraded
                    protocol. An example of a downgraded protocol is a request
                    made from an HTTPS URL to an HTTP site.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">strict-origin-when-cross-origin</samp>—For
                    same-origin requests, send the full referrer URL. For
                    cross-origin requests with the same protocol level (HTTPS to
                    HTTPS), send the origin only. Omit the referrer when the
                    target website is on a downgraded protocol. This is the
                    default.
                  </li>

                </ul>
                <p class="p">These policies are deprecated. Although the values are
                  valid, they aren’t recommended.</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <p class="p"><samp class="codeph nolang">no-referrer-when-downgrade</samp>—Omit the
                      referrer when the target website is on a downgraded
                      protocol. For example, when making a request to an HTTP
                      site from an HTTPS URL.</p>

                    <p class="p">This <span class="keyword parmname">referrerPolicyDirective</span> isn’t
                      recommended because this policy exposes the full URL of
                      the page to cross-origin requests to the same or a
                      higher protocol level. For example, requests from HTTPS
                      to HTTPS and requests from HTTP to either HTTP or
                      HTTPS.</p>

                  </li>

                  <li class="li">
                    <p class="p"><samp class="codeph nolang">origin-when-cross-origin</samp>—Send the
                      origin only for cross-domain requests or when the target
                      website is on a downgraded protocol. An example of a
                      downgraded protocol is a request made from an HTTPS URL
                      to an HTTP site.</p>

                    <p class="p">This <span class="keyword parmname">referrerPolicyDirective</span> isn’t
                      recommended because multiple browsers no longer support
                      it. Use <samp class="codeph nolang">strict-origin-when-cross-origin</samp>
                      instead.</p>

                  </li>

                  <li class="li">
                    <samp class="codeph nolang">unsafe-url</samp>—Always include the full referrer
                    URL.<p class="p">This <span class="keyword parmname">referrerPolicyDirective</span>
                      isn’t recommended because this policy exposes the full
                      URL of the page to requests from insecure
                      origins.</p>
                  </li>

                </ul>
                <p class="p">For more information on HTTP referrer policy directives,
                  including examples, see the <a class="xref" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy" target="_blank" title="HTML (New Window)">Referrer-Policy</a> entry in the
                  <cite class="cite">MDN Docs HTTP Guide</cite>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_requireHttpOnly"><a name="field_requireHttpOnly"><!-- --></a>requireHttpOnly</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <span class="ph" id="requireHttpOnly_desc"><a name="requireHttpOnly_desc"><!-- --></a>Sets the <samp class="codeph nolang">HttpOnly</samp> attribute on session
                  cookies, making them inaccessible via JavaScript. If <samp class="codeph nolang">true</samp>, session ID cookie access
                  is restricted. If <samp class="codeph nolang">false</samp>,
                  access isn’t restricted.</span>
                <p class="p">If you have a custom or packaged
                  application that uses JavaScript to access session ID cookies,
                  your application breaks if <span class="keyword parmname">requireHttpOnly</span>
                  is set to <samp class="codeph nolang">true</samp>. The
                  application can't access the cookie.</p>
                This field is available
                in API version 40.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_requireHttps"><a name="field_requireHttps"><!-- --></a>requireHttps</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p" id="requireHttps_desc"><a name="requireHttps_desc"><!-- --></a>Determines whether HTTPS is required to
                  log in to or access Salesforce. This option is enabled by
                  default for security reasons and can’t be disabled. To change to
                  HTTP, contact Salesforce Customer Support.</p>

                <p class="p"> This field is available in API version 40.0 to 60.0.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_securitycentralkillsession"><a name="field_securitycentralkillsession"><!-- --></a>securityCentralKillSession</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Deprecated in API version 36.0 to 50.0. Removed in API version
                51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname" id="field_sessiontimeout"><a name="field_sessiontimeout"><!-- --></a>sessionTimeout</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">SessionTimeout (enumeration of type string)</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p" id="sessionTimeout_descr"><a name="sessionTimeout_descr"><!-- --></a>The length of time after which users
                  without activity are prompted to log out or continue working.
                  Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FifteenMinutes</samp></li>

                  <li class="li"><samp class="codeph nolang">ThirtyMinutes</samp></li>

                  <li class="li"><samp class="codeph nolang">SixtyMinutes</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">NinetyMinutes</samp>—Available in API version 58.0
                    and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">TwoHours</samp></li>

                  <li class="li"><samp class="codeph nolang">FourHours</samp></li>

                  <li class="li"><samp class="codeph nolang">EightHours</samp></li>

                  <li class="li"><samp class="codeph nolang">TwelveHours</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">TwentyFourHours</samp>—Available in API version
                    38.0 and later.
                  </li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">sidToken3rdPartyAuraApp</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">If <samp class="codeph nolang">true</samp>, a Lightning app
                replaces the authentication cookie with a session token when the
                Lightning app is in a third-party context, such as Lightning
                Out.<p class="p">Browsers are restricting the use of third-party cookies.
                  This org setting is an alternative for the authentication cookie
                  to requiring that users disable browser settings, such as
                  Safari’s <span class="keyword parmname">Prevent cross-site tracking</span>
                  setting.</p>
                <p class="p">This field is available in API version 59.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">skipSFAWhenMFADirectUILogin</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates which screen users see first when they're prompted to
                register a verification method for multi-factor authentication
                (MFA).&nbsp;<p class="p">If <samp class="codeph nolang">true</samp>, users
                  see a list of all supported verification methods.&nbsp;</p>
                <p class="p">If
                  <samp class="codeph nolang">false</samp>, users see only
                  the Salesforce Authenticator option. To see a list of all
                  supported verification methods, users must navigate to a new
                  page.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">terminateUserSessionsWhenAdminResetsPassword</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates what happens to a user's UI sessions when an admin
                resets that user's password. If <samp class="codeph nolang">true</samp>, all of the user's UI sessions are terminated. If
                <samp class="codeph nolang">false</samp>, no UI sessions are
                terminated.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">unescapedHtmlSanitization</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Indicates whether to disable HTML sanitization when using the
                <samp class="codeph nolang">aura:unescapedHtml</samp>
                component.<p class="p">Available in API version 67.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">untrustedRedirect</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">untrustedRedirect (enumeration of type string)</td>

              <td class="entry" headers="d842977e1280" data-title="Description">
                <p class="p">The redirection behavior when a user who accesses Salesforce via
                  Lightning Experience clicks a hyperlink in a URL field with a
                  target URL that isn’t trusted. Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">AlwaysAllowed</samp></li>

                  <li class="li"><samp class="codeph nolang">NeverAllowed</samp></li>

                  <li class="li"><samp class="codeph nolang">WithUserPermission</samp></li>

                </ul>

                <p class="p">To specify the URLs that you trust, use the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_redirectwhitelisturl.htm" title="Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true. This type extends the Metadata metadata type and inherits its fullName field.">RedirectWhitelistUrl</a>
                  Metadata type.</p>

                <p class="p">Available in API version 64.0 and later.</p>

                <p class="p">Secure redirections to untrusted URLs in Lightning Experience is
                  a pilot or beta service that is subject to the Beta Services
                  Terms at <a class="xref" href="https://www.salesforce.com/company/legal/agreements/" target="_blank">Agreements -
                    Salesforce.com</a> or a written Unified Pilot Agreement
                  if executed by Customer, and applicable terms in the <a class="xref" href="https://ptd.salesforce.com/" target="_blank">Product Terms Directory</a>. Use of this
                  pilot or beta service is at the Customer's sole discretion. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">useLocalStorageForLogoutUrl</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Redirects all expired tabs in your browser to your custom logout
                URL (<samp class="codeph nolang">true</samp>). By default, this
                option is enabled for all new orgs and is available in API version
                52.0 and later.<p class="p">For orgs created prior to the Summer ’21 release,
                  the default setting is <samp class="codeph nolang">false</samp>. Before enabling this setting, review these
                  considerations.</p>

                <ul class="ul bulletList">
                  <li class="li">This setting uses the browser’s local storage to store the
                    custom logout URL.</li>

                  <li class="li">Verify that this setting doesn’t interfere with your custom
                    login integrations.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">vfInlineScriptInjection</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">VfInlineScriptInjection (enumeraion of type string)</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Reserved for future use. The default value is <samp class="codeph nolang">allow</samp>.<p class="p">Available in API version
                  67.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e1274" data-title="Field"><span class="keyword parmname">welcomeEmailTemplateId</span></td>

              <td class="entry" headers="d842977e1277" data-title="Field Type">string</td>

              <td class="entry" headers="d842977e1280" data-title="Description">Custom email template for the welcome email that new internal
                users receive when they're registered. This field supports only
                Classic email templates.<p class="p">Available in API version 63.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## SingleSignOnSettings

Represents your org’s single sign-on (SSO) settings. These settings are available API version 47.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d842977e2773">Field Name</th>

              <th class="featureTableHeader  " id="d842977e2776">Field Type</th>

              <th class="featureTableHeader  " id="d842977e2779">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d842977e2773" data-title="Field Name"><span class="keyword parmname">enableCaseInsensitiveFederationID</span></td>

              <td class="entry" headers="d842977e2776" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e2779" data-title="Description">If you enable <strong class="ph uicontrol">Make Federation ID
                  case-insensitive</strong> (<samp class="codeph nolang">true</samp>), the Federation ID field on a user object isn’t
                case-sensitive. If disabled (<samp class="codeph nolang">false</samp>), the Federation ID field remains
                case-sensitive. The default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e2773" data-title="Field Name"><span class="keyword parmname">enableForceDelegatedCallout</span></td>

              <td class="entry" headers="d842977e2776" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e2779" data-title="Description">If you enable <strong class="ph uicontrol">Force Delegated Authentication
                  Callout</strong> (<samp class="codeph nolang">true</samp>),
                a callout to the SSO endpoint occurs regardless of login restriction
                failures. If disabled (<samp class="codeph nolang">false</samp>),
                the default, and if a user’s first login attempt fails due to login
                restrictions within the Salesforce org, a call isn’t made to the SSO
                endpoint.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e2773" data-title="Field Name"><span class="keyword parmname">enableMultipleSamlConfigs</span></td>

              <td class="entry" headers="d842977e2776" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e2779" data-title="Description">If <samp class="codeph nolang">true</samp> (default), you can
                configure multiple SAML providers. After enabling the setting, it
                can’t be disabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e2773" data-title="Field Name"><span class="keyword parmname">enableSamlJitProvisioning</span></td>

              <td class="entry" headers="d842977e2776" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e2779" data-title="Description">If you enable <strong class="ph uicontrol">User Provisioning Enabled</strong>
                (<samp class="codeph nolang">true</samp>), you can provision
                users through a SAML assertion (called just-in-time provisioning).
                Requires <span class="keyword parmname">EnableSamlLogin</span> to be <samp class="codeph nolang">true</samp> and
                <span class="keyword parmname">enableMultipleSamlConfigs</span> to be <samp class="codeph nolang">false</samp>. The default is enabled
                (<samp class="codeph nolang">false</samp>).
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e2773" data-title="Field Name"><span class="keyword parmname">enableSamlLogin</span></td>

              <td class="entry" headers="d842977e2776" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e2779" data-title="Description">If you enable <strong class="ph uicontrol">SAML Enabled </strong> (<samp class="codeph nolang">true</samp>), users can SSO into
                Salesforce from providers via SAML. The default isn’t enabled
                (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d842977e2773" data-title="Field Name"><span class="keyword parmname">isLoginWithSalesforceCredentialsDisabled</span></td>

              <td class="entry" headers="d842977e2776" data-title="Field Type">boolean</td>

              <td class="entry" headers="d842977e2779" data-title="Description">If <strong class="ph uicontrol">Disable login with Salesforce
                  credentials</strong> is <samp class="codeph nolang">true</samp>, users are redirected to third-party identity
                providers for authentication. The default is enabled (<samp class="codeph nolang">false</samp>). <p class="p">If you enabled this
                  feature prior to the Summer ’20 release and want to disable it
                  prior to July 27, 2020, contact Customer Support. </p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s a sample security.settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>
<SecuritySettings xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <canUsersGrantLoginAccess\>true</canUsersGrantLoginAccess\>
    <enableAdminLoginAsAnyUser xsi:nil="true"/>
    <enableAuditFieldsInactiveOwner xsi:nil="true"/>
    <enableAuraSecureEvalPref xsi:nil="true"/>
    <enableCoopHeader\>true</enableCoopHeader\>
    <enableCoepHeader\>false</enableCoepHeader\>
    <enableCrossOrgRedirects\>false</enableCrossOrgRedirects\>
    <enablePermissionsPolicy\>true</enablePermissionsPolicy\>
    <grantCameraAccess\>TrustedUrls</grantCameraAccess\>
    <grantMicrophoneAccess\>TrustedUrls</grantMicrophoneAccess\>
    <networkAccess/\>
    <passwordPolicies\>
        <complexity\>NoRestriction</complexity\>
        <expiration\>Never</expiration\>
        <historyRestriction\>0</historyRestriction\>
        <lockoutInterval\>FifteenMinutes</lockoutInterval\>
        <maxLoginAttempts\>TenAttempts</maxLoginAttempts\>
        <minimumPasswordLength\>5</minimumPasswordLength\>
        <minimumPasswordLifetime\>false</minimumPasswordLifetime\>
        <obscureSecretAnswer\>false</obscureSecretAnswer\>
        <questionRestriction\>DoesNotContainPassword</questionRestriction\>
    </passwordPolicies\>
    <redirectBlockModeEnabled\>false</redirectBlockModeEnabled\>
    <sendCspForUncommonClients\>false</sendCspForUncommonClients\>
    <sessionSettings\>
        <allowUserAuthenticationByCertificate\>false</allowUserAuthenticationByCertificate\>
        <disableTimeoutWarning\>false</disableTimeoutWarning\>
        <enableBuiltInAuthenticator\>false</enableBuiltInAuthenticator\>
        <enableCSPOnEmail\>true</enableCSPOnEmail\>
        <enableCSRFOnGet\>true</enableCSRFOnGet\>
        <enableCSRFOnPost\>true</enableCSRFOnPost\>
        <enableCacheAndAutocomplete\>true</enableCacheAndAutocomplete\>
        <enableClickjackNonsetupSFDC\>true</enableClickjackNonsetupSFDC\>
        <enableClickjackNonsetupUser\>false</enableClickjackNonsetupUser\>
        <enableClickjackNonsetupUserHeaderless\>false</enableClickjackNonsetupUserHeaderless\>
        <enableClickjackSetup\>true</enableClickjackSetup\>
        <enableContentSniffingProtection\>true</enableContentSniffingProtection\>
        <enableLightningLogin\>true</enableLightningLogin\>
        <enableLightningLoginOnlyWithUserPerm\>false</enableLightningLoginOnlyWithUserPerm\>
        <useLocalStorageForLogoutUrl\>false</useLocalStorageForLogoutUrl\>
        <enableOauthCorsPolicy\>false</enableOauthCorsPolicy\>
        <enablePostForSessions\>false</enablePostForSessions\>
        <enableSMSIdentity\>true</enableSMSIdentity\>
        <enableU2F\>false</enableU2F\>
        <enforceIpRangesEveryRequest\>false</enforceIpRangesEveryRequest\>
        <enforceUserDeviceRevoked\>false</enforceUserDeviceRevoked\>
        <forceLogoutOnSessionTimeout\>true</forceLogoutOnSessionTimeout\>
        <forceRelogin\>true</forceRelogin\>
        <hasRetainedLoginHints\>false</hasRetainedLoginHints\>
        <hasUserSwitching\>true</hasUserSwitching\>
        <hstsOnForcecomSites\>false</hstsOnForcecomSites\>
        <identityConfirmationOnEmailChange\>true</identityConfirmationOnEmailChange\>
        <identityConfirmationOnTwoFactorRegistrationEnabled\>true</identityConfirmationOnTwoFactorRegistrationEnabled\>
        <lockSessionsToDomain\>true</lockSessionsToDomain\>
        <lockSessionsToIp\>false</lockSessionsToIp\>
        <lockerServiceAPIVersion\>56.0</lockerServiceAPIVersion\>
        <lockerServiceCSP\>true</lockerServiceCSP\>
        <lockerServiceNext\>true</lockerServiceNext\>
        <logoutURL\>https://mycompany.com</logoutUrl\>
        <redirectionWarning\>true</redirectionWarning\>
        <referrerPolicy\>true</referrerPolicy\>
        <referrerPolicyDirective\>strict-origin-when-cross-origin</referrerPolicyDirective\>
        <requireHttpOnly\>true</requireHttpOnly\>
        <sessionTimeout\>TwoHours</sessionTimeout\>
        <untrustedRedirect\>WithUserPermission</untrustedRedirect\>
        <useLocalStorageForLogoutUrl\>true</useLocalStorageForLogoutUrl\>
        <vfInlineScriptInjection\>allow</vfInlineScriptInjection\>
        <welcomeEmailTemplateId\>X000000000000</welcomeEmailTemplateId\>
    </sessionSettings\>
    <singleSignOnSettings\>
        <enableCaseInsensitiveFederationID\>false</enableCaseInsensitiveFederationID\>
        <enableForceDelegatedCallout\>false</enableForceDelegatedCallout\>
        <enableMultipleSamlConfigs\>true</enableMultipleSamlConfigs\>
        <enableSamlJitProvisioning\>false</enableSamlJitProvisioning\>
        <enableSamlLogin\>false</enableSamlLogin\>
        <isLoginWithSalesforceCredentialsDisabled\>true</isLoginWithSalesforceCredentialsDisabled\>
    </singleSignOnSettings\>
</SecuritySettings\>

The following is an example package.xml manifest that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Security</members\>
        <name\>Settings</name\>
    </types\>
    <version\>67.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=07fb13d21a49a2f370fc23873b7437972ebb2a5495e7ab3e8f3151aeccce18b2 url=/legacydeveloper/current/en-us/api_meta/meta_serviceAIsetupdefinition.md -->

# ServiceAISetupDefinition

Represents settings for an Einstein for Service feature such as Einstein Article Recommendations. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

ServiceAISetupDefinition components have the suffix .serviceAISetupDescription and are stored in the serviceAISetupDescriptions folder.

## Version

ServiceAISetupDefinition components are available in API version 51.0 and later.

## Special Access Rules

This type is available only when an org is configured to access the application in the appSourceType field. For example, if appSourceType is set to ARTICLE\_RECOMMENDATION, this type is available only if Einstein Article Recommendations is enabled in the org and the Main Services Agreement has been accepted.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d851989e99">Field Name</th>

              <th class="featureTableHeader  " id="d851989e102">Field Type</th>

              <th class="featureTableHeader  " id="d851989e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d851989e99" data-title="Field Name"><span class="keyword parmname">appSourceType</span></td>

              <td class="entry" headers="d851989e102" data-title="Field Type">ApplicationSourceType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d851989e105" data-title="Description">Required. The target application for the configuration. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">REPLY_RECOMMENDATION</samp>—Einstein Reply
                    Recommendations
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ARTICLE_RECOMMENDATION</samp>—Einstein Article
                    Recommendations
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UTTERANCE_RECOMMENDATION</samp>—Einstein Bot
                    utterances
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FAQ</samp>—Einstein Bot frequently asked
                    questions
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d851989e99" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d851989e102" data-title="Field Type">string</td>

              <td class="entry" headers="d851989e105" data-title="Description">Required. A reference to the configuration.</td>

            </tr>

            <tr>
              <td class="entry" headers="d851989e99" data-title="Field Name"><span class="keyword parmname">setupStatus</span></td>

              <td class="entry" headers="d851989e102" data-title="Field Type">ServiceAISetupDefStatus (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d851989e105" data-title="Description">Required. The status of the configuration. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FIELDS_SELECTED</samp></li>

                  <li class="li"><samp class="codeph nolang">TRAINING</samp></li>

                  <li class="li"><samp class="codeph nolang">READY_TO_ACTIVATE</samp></li>

                  <li class="li"><samp class="codeph nolang">SERVING</samp></li>

                  <li class="li"><samp class="codeph nolang">RETIRED</samp></li>

                  <li class="li"><samp class="codeph nolang">ARCHIVED</samp></li>

                  <li class="li"><samp class="codeph nolang">READY_FOR_REVIEW</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d851989e99" data-title="Field Name"><span class="keyword parmname">supportedLanguages</span></td>

              <td class="entry" headers="d851989e102" data-title="Field Type">string</td>

              <td class="entry" headers="d851989e105" data-title="Description">Required when <span class="keyword parmname">appSourceType</span> is <samp class="codeph nolang">ARTICLE_RECOMMENDATION</samp>. Language codes for selected and supported
                languages. </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s an example of a ServiceAISetupDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<ServiceAISetupDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <appSourceType\>ARTICLE\_RECOMMENDATION</appSourceType\>
    <name\>SA1601228426202</name\>
    <setupStatus\>ARCHIVED</setupStatus\>
    <supportedLanguages\>en,de,fr,it,es,pt,nl</supportedLanguages\>
</ServiceAISetupDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ServiceAISetupDefinition</name\>
    </types\>
</Package\>

## Usage

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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=8704d24c2117b6f1e16ff574750ba62ec98a18f61bcacc76cd9b6d928d7eb32a url=/legacydeveloper/current/en-us/api_meta/meta_serviceAIsetupfield.md -->

# ServiceAISetupField

Represents a field on cases or knowledge articles that Einstein uses to identify relevant articles in Einstein Article Recommendations. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

ServiceAISetupField components have the suffix .serviceAiSetupField and are stored in the serviceAiSetupFields folder.

## Version

ServiceAISetupField components are available in API version 51.0 and later.

## Special Access Rules

This type is available only if Einstein Article Recommendations is enabled in your org and the Main Services Agreement has been accepted.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d852625e93">Field Name</th>

              <th class="featureTableHeader  " id="d852625e96">Field Type</th>

              <th class="featureTableHeader  " id="d852625e99">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d852625e93" data-title="Field Name"><span class="keyword parmname">entity</span></td>

              <td class="entry" headers="d852625e96" data-title="Field Type">string</td>

              <td class="entry" headers="d852625e99" data-title="Description">Required. The Case or KnowledgeArticle object for the field. </td>

            </tr>

            <tr>
              <td class="entry" headers="d852625e93" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d852625e96" data-title="Field Type">string</td>

              <td class="entry" headers="d852625e99" data-title="Description">Required. The API name of the field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d852625e93" data-title="Field Name"><span class="keyword parmname">fieldMappingType</span></td>

              <td class="entry" headers="d852625e96" data-title="Field Type">ServiceAISetupFieldType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d852625e99" data-title="Description">Required. The field type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">CASE_DESC</samp></li>

                  <li class="li"><samp class="codeph nolang">CASE_SUBJ</samp></li>

                  <li class="li"><samp class="codeph nolang">ARTICLE_TITLE</samp></li>

                  <li class="li"><samp class="codeph nolang">ARTICLE_CONTENT</samp></li>

                  <li class="li"><samp class="codeph nolang">ARTICLE_SUMMARY</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d852625e93" data-title="Field Name"><span class="keyword parmname">fieldPosition</span></td>

              <td class="entry" headers="d852625e96" data-title="Field Type">int</td>

              <td class="entry" headers="d852625e99" data-title="Description">Required. A positive number used to rank the field’s importance. The value 1 is
                most important; higher numbers indicate less important fields. Einstein considers
                fields in the order of importance.</td>

            </tr>

            <tr>
              <td class="entry" headers="d852625e93" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d852625e96" data-title="Field Type">string</td>

              <td class="entry" headers="d852625e99" data-title="Description">Required. A reference to the field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d852625e93" data-title="Field Name"><span class="keyword parmname">setupDefinition</span></td>

              <td class="entry" headers="d852625e96" data-title="Field Type">string</td>

              <td class="entry" headers="d852625e99" data-title="Description">Required. A reference to the parent <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_serviceAIsetupdefinition.htm" title="Represents settings for an Einstein for Service feature such as Einstein Article Recommendations. This type extends the Metadata metadata type and inherits its fullName field.">ServiceAISetupDefinition.</a>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ServiceAISetupField component.

<?xml version="1.0" encoding="UTF-8"?>
<ServiceAISetupField xmlns="http://soap.sforce.com/2006/04/metadata">
    <entity\>Case</entity\>
    <field\>Subject</field\>
    <fieldMappingType\>CASE\_SUBJ</fieldMappingType\>
    <fieldPosition\>1</fieldPosition\>
    <name\>SF16039900475920</name\>
    <setupDefinition\>4hQRM0000004CDK</setupDefinition\>
</ServiceAISetupField\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ServiceAISetupField</name\>
    </types\>
</Package\>

## Usage

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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=7da4ef6e552b204b9a614f1d1e16fee0d1ef5ede870686d35060f802f132eac6 url=/legacydeveloper/current/en-us/api_meta/meta_servicechannel.md -->

# ServiceChannel

Represents a channel of work items that are received from your organization—for example, cases, chats, or leads.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ServiceChannel components have the suffix .serviceChannel and are stored in the serviceChannels folder.

## Version

ServiceChannel components are available in API version 44.0 and later.

## Special Access Rules

This type is available only if Omni-Channel is enabled in your org.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d853296e107">Field Name</th>

              <th class="featureTableHeader  " id="d853296e110">Field Type</th>

              <th class="featureTableHeader  " id="d853296e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">acwExtensionDuration</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">int</td>

              <td class="entry" headers="d853296e113" data-title="Description">The maximum length of time, measured in seconds, an agent can spend on After
                Conversation Work (ACW) each time they extend the timer. You must set this field if
                <span class="keyword parmname">hasAcwExtensionEnabled</span> is set to <samp class="codeph nolang">true</samp>. Specify a value from 10 through 3600. Available only for service
                channels of type Messaging or Voice.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">afterConvoWorkMaxTime</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">int</td>

              <td class="entry" headers="d853296e113" data-title="Description">The maximum length of time, measured in seconds, an agent has to complete After
                Conversation Work (ACW). You must set this field if
                <span class="keyword parmname">hasAfterConvoWorkTimer</span> is set to <samp class="codeph nolang">true</samp>. Specify a value from 10 through 3600. Available only for service
                channels of type Messaging or Voice.<p class="p">For service channels of type Voice, this
                  field is available in API version 52.0 and later. For service channels of type
                  Messaging, this field is available in API version 56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">capacityModel</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">picklist</td>

              <td class="entry" headers="d853296e113" data-title="Description">The method that determines when an agent's capacity for a work item is
                released. With the status-based capacity routing model, work remains assigned and
                applied to an agent’s capacity until the work is completed or reassigned to a
                different agent. In contrast, the tab-based capacity routing model releases an
                agent’s capacity when a work tab is closed in the service console. This field is
                available in API version 65.0 and later.<p class="p">Values are:</p>
                <a name="ul_hww_bqc_1hc"><!-- --></a>
                <ul class="ul bulletList" id="ul_hww_bqc_1hc">
                  <li class="li"><samp class="codeph nolang">STATUS_BASED</samp></li>

                  <li class="li"><samp class="codeph nolang">TAB_BASED</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">doesCheckCapOnOwnerChange</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d853296e113" data-title="Description">Indicates whether the override for capacity check is on (true) or not (false).
                If it is on, when work is reassigned to another agent it overrides it and keeps the
                work assigned to the specific agent. The default value is false.This field is
                available in API version 65.0 and later.
</td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">doesCheckCapOnStatusChange</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d853296e113" data-title="Description">Indicates whether the override for capacity check is on (true) or not (false).
                If it is on, when work is reopened it is re-assigned to a specific agent. The
                default value is false. This field is available in API version 65.0 and
                later.
</td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">doesMinimizeWidgetOnAccept</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d853296e113" data-title="Description">Automatically minimizes the Omni-Channel widget when an agent accepts work.
                This field is available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">hasAcwExtensionEnabled</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d853296e113" data-title="Description">If set to <samp class="codeph nolang">true</samp>, agents can extend their
                After Conversation Work (ACW) time. Available only if
                <span class="keyword parmname">hasAfterConvoWorkTimer</span> is set to <samp class="codeph nolang">true</samp>. If set to <samp class="codeph nolang">true</samp>, you must also
                set the <span class="keyword parmname">acwExtensionDuration</span> and
                <span class="keyword parmname">maxExtensions</span> fields. The default value is <samp class="codeph nolang">false</samp>. Available only for service channels of type
                Messaging or Voice. This field is available in API version 56.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">hasAfterConvoWorkTimer</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d853296e113" data-title="Description">If set to <samp class="codeph nolang">true</samp>, After Conversation Work
                (ACW) time can be configured for the channel. If set to <samp class="codeph nolang">true</samp>, you must also set the <span class="keyword parmname">afterConvoWorkMaxTime</span>
                field. The default value is <samp class="codeph nolang">false</samp>. Available
                only for service channels of type Messaging or Voice.<p class="p">For service channels of type
                  Voice, this field is available in API version 52.0 and later. For service channels
                  of type messaging, this field is available in API version 56.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">hasAutoAcceptEnabled</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d853296e113" data-title="Description">Work items in a service channel open automatically in the agent’s workspace so
                that the agent doesn’t have to manually accept them. </td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">interactionComponent</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">string</td>

              <td class="entry" headers="d853296e113" data-title="Description">The custom console component to open in the footer when an agent accepts a work
                item from this service channel.</td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">isInterruptible</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d853296e113" data-title="Description">Indicates whether a work item consumes interruptible or primary capacity. The
                default value is false. Available in API version 57.0 and later when the
                Interruptible Capacity feature is enabled. </td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">string</td>

              <td class="entry" headers="d853296e113" data-title="Description">Required. The label of the service channel.</td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">maxExtensions</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">picklist</td>

              <td class="entry" headers="d853296e113" data-title="Description">The maximum number of times an agent can extend their After Work Conversation
                (ACW) time. Specify a value from 1 through 10. You must set this field if
                <span class="keyword parmname">hasAcwExtensionEnabled</span> is set to <samp class="codeph nolang">true</samp>. Available only for service channels of type Messaging or Voice.
                This field is available in API version 56.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">relatedEntityType</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">string</td>

              <td class="entry" headers="d853296e113" data-title="Description">Required. The type of object that’s associated with this service
                channel.</td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">secondaryRoutingPriorityField</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">string</td>

              <td class="entry" headers="d853296e113" data-title="Description">The name of the standard field or the ID of the custom field that is used for
                secondary routing priority. This field is available in API version 47.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">serviceChannelStatusFieldMappings</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type"><a class="xref" href="#ServiceChannelFieldPriority">ServiceChannelFieldPriority</a></td>

              <td class="entry" headers="d853296e113" data-title="Description">Represents the value to indicate completed and in-progress work item status in
                the Status-Based Capacity routing model. This field is available in API version 65.0
                and later.

</td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">serviceChannelFieldPriorities</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">
                <a class="xref" href="#ServiceChannelFieldPriority">ServiceChannelFieldPriority</a>[]
              </td>

              <td class="entry" headers="d853296e113" data-title="Description">Required. A set of mappings between secondary routing priority field values and
                priorities. This field is available in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d853296e107" data-title="Field Name"><span class="keyword parmname">statusField</span></td>

              <td class="entry" headers="d853296e110" data-title="Field Type">picklist</td>

              <td class="entry" headers="d853296e113" data-title="Description">The field that you use to track work status in the Status-Based capacity
                routing model. Use <span class="keyword parmname">ServiceChannelStatusField</span> to specify the
                values that indicate completed and in-progress work-item status. This field is
                available in API version 65.0 and later.</td>

            </tr>

          </tbody>

        </table>

## ServiceChannelFieldPriority

Represents a secondary routing priority field value mapping. Available in API version 47.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| priority | int | Required. The priority number assigned to the mapped field value. |
| type | picklist | Required. The work item status assigned to the mapped field value. Possible types are IN\_PROGRESS, PAUSED, COMPLETED.
 |
| value | string | Required. The value of Status Field defined in the parent ServiceChannel. |
| value | string | Required. The value of the secondaryRoutingPriorityField field defined in the parent ServiceChannel. |

## Declarative Metadata Sample Definition

The following is an example of a ServiceChannel component.

<?xml version="1.0" encoding="UTF-8"?>
<ServiceChannel xmlns="http://soap.sforce.com/2006/04/metadata">
    <doesMinimizeWidgetOnAccept\>true</doesMinimizeWidgetOnAccept\>
    <interactionComponent\>ConsoleComponent</interactionComponent\>
    <label\>Case</label\>
    <relatedEntityType\>Case</relatedEntityType\>
    <secondaryRoutingPriorityField\>Status</secondaryRoutingPriorityField\>
    <serviceChannelFieldPriorities\>
        <priority\>1</priority\>
        <value\>Escalated</value\>
    </serviceChannelFieldPriorities\>
    <serviceChannelFieldPriorities\>
        <priority\>2</priority\>
        <value\>On Hold</value\>
    </serviceChannelFieldPriorities\>
</ServiceChannel\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ServiceChannel</name\>
    </types\>
    <version\>44.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=152d0d156c813d2a547e1e919acf3c6651c63c0c767a683c887159cec9e84dae url=/legacydeveloper/current/en-us/api_meta/meta_servicecloudvoicesettings.md -->

# ServiceCloudVoiceSettings

Represents an organization’s Service Cloud Voice settings.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

ServiceCloudVoiceSettings values are stored in the ServiceCloudVoice.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ServiceCloudVoiceSettings is available in API versions 52.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d855086e108">Field Name</th>

              <th class="featureTableHeader  " id="d855086e111">Field Type</th>

              <th class="featureTableHeader  " id="d855086e114">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">disableSCVTaskCreationForHVS</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to prevent the Sales Engagement automatic task creation
                feature from generating tasks from voice calls except click-to-dial calls initiated
                from Sales Engagements, To Do List, and Work Queue. The default value is <samp class="codeph nolang">false</samp>. Available in API version 61.0 and later. This
                field is optional. </td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableAmazonQueueManagement</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to enable the Amazon Connect queue management integration for
                Service Cloud Voice. When enabled, the system automatically synchronizes contact
                center queues across Salesforce and Amazon Connect, including voice groups and
                users. The default value is <samp class="codeph nolang">false</samp>. Available in
                API version 55.0 and later. This field is optional.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableDefaultChannelForSCV</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether Service Cloud Voice uses the default phone channel for all
                end user identification. The default value is <samp class="codeph nolang">false</samp>. Available in API version 53.0 and later. This field is
                optional.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableDigitalVoiceWhatsapp</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Reserved for internal use. Removed in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableEndUserForSCV</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether Service Cloud Voice matches callers to end user records. The
                default value is <samp class="codeph nolang">false</samp>. Available in API
                version 53.0 and later. This field is optional.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableOmniCapacityForSCV</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to enable Omni-Channel capacity management for Service Cloud
                Voice. If enabled, Service Cloud Voice Agentwork honors Omni-Channel capacity. The
                default value is <samp class="codeph nolang">false</samp>. Available in API
                version 54.0 and later. This field is optional.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enablePhoneNumberMaskingForSCV</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to enable phone number masking functionality in Service Could
                Voice to protect sensitive data by redacting inbound and outbound phone numbers.
                When enabled, phone numbers are masked in Omni-Channel views, call recordings, and
                call transcripts. Masking doesn't apply to numbers used in rep-to-rep calls managed
                by partner telephony providers. The default value is <samp class="codeph nolang">false</samp>. Available in API version 61.0 and later. This field is
                optional.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enablePTQueueManagement</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to enable queue management for Service Cloud Voice with
                Partner Telephony. When enabled, the system automatically synchronizes contact
                center queues across Salesforce and partner telephony services, including groups and
                users. The default value is <samp class="codeph nolang">false</samp>. Available in
                API version 56.0 and later. This field is optional.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableRZoneCloudVoiceOptIn</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">
                <p class="p">Indicates whether you agree to the terms of using Service Cloud Voice with Amazon
                  Connect in a Salesforce Government Cloud environment. The default value is <samp class="codeph nolang">false</samp>. This field is optional.</p>

                <p class="p">Amazon Connect is a third-party Amazon service that sits outside the Salesforce
                  Government Cloud FedRAMP environment. Amazon Connect is a separate service offered
                  by Amazon and not a FedRAMP authorized service. Therefore, Amazon Connect’s
                  processing environment falls outside the Government Cloud FedRAMP authorization
                  boundary. To learn more, see <a class="xref" href="https://aws.amazon.com/connect/" target="_blank">Amazon Connect</a>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableSCVBYOT</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type"></td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to enable Service Cloud Voice with Partner Telephony. The
                default value is <samp class="codeph nolang">false</samp>. This field is optional.
                For API version 52.0 and later, we recommend using <samp class="codeph nolang">enableSCVExternalTelephony</samp> instead.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableSCVExternalTelephony</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to enable a third-party telephony service to work with
                Service Cloud Voice with Partner Telephony. The default value is <samp class="codeph nolang">false</samp>. This field is optional. </td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableSCVOpenVCAsNewTabHVS</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to open the Service Cloud Voice Console in a new tab for
                Sales Engagement scenarios. The default value is <samp class="codeph nolang">false</samp>. Available in API version 62.0 and later. This field is
                optional.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableSCVSupportBannerDisplayed</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to display the Service Cloud Voice support banner. The
                default value is <samp class="codeph nolang">false</samp>. Available in API
                version 59.0 and later. This field is optional.</td>

            </tr>

            <tr>
              <td class="entry" headers="d855086e108" data-title="Field Name"><span class="keyword parmname">enableServiceCloudVoice</span></td>

              <td class="entry" headers="d855086e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d855086e114" data-title="Description">Indicates whether to enable Service Cloud Voice with Amazon Connect. The
                default value is <samp class="codeph nolang">false</samp>. This field is
                optional.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a ServiceCloudVoice.settings component.

<?xml version="1.0" encoding="UTF-8"?>
<ServiceCloudVoiceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableServiceCloudVoice\>true</enableServiceCloudVoice\>
</ServiceCloudVoiceSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ServiceCloudVoice</members\>
        <name\>Settings</name\>
    </types\>
    <version\>52.0</version\>
</Package\>

<!-- document id=cb1c241a848f40f7c86d174f168182bb2f82a5a78e0a9b27dd06a6e415b90683 url=/legacydeveloper/current/en-us/api_meta/meta_servicepresencestatus.md -->

# ServicePresenceStatus

Represents a presence status that can be assigned to a service channel. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

ServicePresenceStatus components have the suffix .servicePresenceStatus and are stored in the servicePresenceStatuses folder.

## Version

ServicePresenceStatus components are available in API version 44.0 and later.

## Special Access Rules

This type is available only if Omni-Channel is enabled in your org.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| channels | [ServiceChannelStatus](#ServiceChannelStatus) | Represents the service channels assigned to the presence status. If no service channels are included, the presence status is automatically marked as 'Away' (where IsAway is set to true.) |
| label | string | The label of the presence status. |

## ServiceChannelStatus

| Field Name | Field Type | Description |
| --- | --- | --- |
| channel | string | Represents the channels assigned to the presence status. |

## Declarative Metadata Sample Definition

The following is an example of a ServicePresenceStatus component.

<?xml version="1.0" encoding="UTF-8"?>
<ServicePresenceStatus xmlns="http://soap.sforce.com/2006/04/metadata">
    <channels\>
        <channel\>Case</channel\>
    </channels\>
    <label\>Available for Cases</label\>
</ServicePresenceStatus\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ServicePresenceStatus</name\>
    </types\>
    <version\>44.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=86313e74e94ea90631645d8fedba96a4c6d650f4226a4a57134a499dc25b396a url=/legacydeveloper/current/en-us/api_meta/meta_serviceprocess.md -->

# ServiceProcess

Represents a process created in Service Process Studio and its associated attributes.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ServiceProcess components have the suffix .serviceprocess and are stored in the .serviceprocess folder.

## Version

ServiceProcess components are available in API version 57.0 and later.

## Special Access Rules

Access to the ServiceProcess type requires the AccessToServiceProcess permission.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

A meaningful explanation of the service process.



 |
| processLabel | 

Field Type

string

Description

Required.

A meaningful name for the service process.



 |
| serviceProcessAttributes | 

Field Type

[ServiceProcessAttribute\[\]](#ServiceProcessAttribute)

Description

Custom attributes that store the data associated with the service process.



 |
| serviceProcessDependencies | 

Field Type

[ServiceProcessDependency\[\]](#ServiceProcessDependency)

Description

Dependent components of the service process, such as OmniScripts or flows.



 |
| serviceProcessItemGroups | 

Field Type

[ServiceProcessItemGroup\[\]](#ServiceProcessItemGroup)

Description

Groups of related ServiceProcessAttribute records.



 |
| shortDescription | 

Field Type

string

Description

A brief meaningful explanation of the service process.



 |
| usageType | 

Field Type

SvcCatalogItemUsageType (enumeration of type string)

Description

Required.

The Cloud that uses this service process.

Values are:

- CustomerService
- Employee
- FinancialServices
- Industry (available in version 58.0 and later)





 |

## ServiceProcessAttribute

A custom attribute that stores data associated with a service process. For example, a service process that reverses a fee can have a Fee Type attribute.

| Field Name | Description |
| --- | --- |
| attributeType | 
Field Type

SvcCtlgItemAttrAttributeType (enumeration of type string)

Description

A Base attribute corresponds to a SvcCatalogRequest field, which is subject to field-level security. An Extended attribute is only a ServiceProcessAttribute object record, which isn't subject to field-level security.

Values are:

- Base
- Extended

The default is Extended.





 |
| dataType | 

Field Type

SvcCatalogItemAttrDataType (enumeration of type string)

Description

The data type of the attribute.

Values are:

- Attachment
- Checkbox
- Currency
- Date
- Datetime
- DisplayText
- Email
- IPAddress
- Integer
- ListOfAttachment(available in API version 65.0 and later)
- ListOfBoolean
- ListOfDouble
- ListOfInteger
- ListOfMaps
- ListOfString
- Lookup
- Map
- MultilineText
- MultiSelectPicklist(available in API version 65.0 and later)
- Number
- NumericScale
- Password(available in API version 65.0 and later)
- Percentage
- Picklist
- Queue
- RadioButton(available in API version 65.0 and later)
- SingleCheckbox (available in API version 59.0 and later)
- SinglelineText
- Text
- Toggle (available in API version 59.0 and later)
- Url

The default is Text.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Selecting Currency doesn't cause an error, but currency conversions aren't supported.















 |
| description | 

Field Type

string

Description

A meaningful explanation of the attribute.



 |
| developerName | 

Field Type

string

Description

Required.

A system name for the attribute.



 |
| fieldIdentifier | 

Field Type

string

Description

For a Base attribute, the Developer Name of the SvcCatalogRequest field. This field can be standard or custom.



 |
| groupApiName | 

Field Type

string

Description

The apiName of the ServiceProcessItemGroup to which this attribute belongs.



 |
| inputVariableValue | 

Field Type

string

Description

The default value of the attribute.



 |
| isRequired | 

Field Type

boolean

Description

Specifies whether the attribute is required. The default is false.



 |
| label | 

Field Type

string

Description

Required.

A meaningful name for the attribute.



 |
| parentAttribute | 

Field Type

string

Description

The parent attribute of this attribute. For example, a Latitude attribute can have GeoLocation as a parent.



 |
| sortOrder | 

Field Type

int

Description

The position of the attribute in the payload relative to other attributes having no parent or the same parent.



 |

## ServiceProcessDependency

A dependent component of the service process, which can be a flow, an OmniScript, an Integration Definition, or a preprocessor Apex class.

| Field Name | Description |
| --- | --- |
| dependencyReference | 
Field Type

string

Description

Required.

The Developer Name of the flow, OmniScript, Integration Definition, or preprocessor Apex class.



 |
| processStepName | 

Field Type

SvcCtlgItemDpndProcType (enumeration of type string)

Description

Name of the step in a service process.

Values are:

- FulfillmentFlow
- IntegrationDefinition
- Preprocessor
- RequestForm





 |
| type | 

Field Type

SvcCatalogItemDependencyType (enumeration of type string)

Description

Required.

The type of dependent component.

Values are:

- FlowDefinition
- IntegrationProviderDef
- OmniScriptConfig
- PreprocessorApexClass





 |

## ServiceProcessItemGroup

A group of related ServiceProcessAttribute records.

| Field Name | Description |
| --- | --- |
| apiName | 
Field Type

string

Description

Required.

The API Name of the group.



 |
| groupName | 

Field Type

string

Description

Required.

The name of the group.



 |
| sortOrder | 

Field Type

int

Description

Required.

The group display order.



 |

## Declarative Metadata Sample Definition

The following is an example of a ServiceProcess component.

<?xml version="1.0" encoding="UTF-8"?>
<ServiceProcess xmlns="http://soap.sforce.com/2006/04/metadata">
   <processLabel\>EmailUpdate</processLabel\>
   <usageType\>FinancialServices</usageType\>
   <serviceProcessAttributes\>
      <label\>EmailAddress</label\>
      <developerName\>EmailAddress</developerName\>
      <dataType\>Text</dataType\>
      <groupApiName\>Info</groupApiName\>
   </serviceProcessAttributes\>
   <serviceProcessDependencies\>
      <dependencyReference\>EmailPreprocessor</dependencyReference\>
      <type\>PreprocessorApexClass</type\>
   </serviceProcessDependencies\>
   <serviceProcessItemGroups\>
        <apiName\>Info</apiName\>
        <groupName\>Info</groupName\>
        <sortOrder\>1</sortOrder\>
    </serviceProcessItemGroups\>
</ServiceProcess\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ServiceProcess</name\>
    </types\>
    <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

## Usage Type

We recommend that you review these considerations before you retrieve or deploy service process metadata.

- If you deploy metadata with the same name as the definition when your service process definition is active, you get an error message. Deactivate the service process definition and try again.
- When your service process definition is inactive, consider these guidelines.
    - If a service process definition contains service catalog requests and service catalog request extended attribute values and you deploy metadata with the same name as the definition, you get an error message. You can’t delete or change a service process that has service catalog requests with attribute values in it. Make sure that all records are deleted in service catalog requests and service catalog request extended attribute values before you deploy the metadata.
    - If a service process definition contains service catalog requests but doesn’t contain service catalog request extended attribute values and you deploy the metadata with the same name, the deployment works as expected.
    - If a service process definition doesn’t contain service catalog requests and you deploy the metadata with the same name, the deployment works as expected.

<!-- document id=612b7e0308dc9591e04eb27cacd93eaab4f40ba5a254dbe332a5819214d6ecd7 url=/legacydeveloper/current/en-us/api_meta/meta_servicesetupassistantsettings.md -->

# ServiceSetupAssistantSettings

Represents an organization’s Service Setup Assistant settings. The Service Setup Assistant can be used to set up a basic service console app.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

ServiceSetupAssistantSettings values are stored in the ServiceSetupAssistant.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ServiceSetupAssistantSettings components are available in API version 50.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableServiceSetupAssistant | boolean | Indicates whether the Service Setup Assistant is enabled (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example of a ServiceSetupAssistantSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<ServiceSetupAssistantSettings xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableServiceSetupAssistant\>true</enableServiceSetupAssistant\>
</ServiceSetupAssistantSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=5b8cf85de94fcd86b3340a80657fb1e29cf5f42a6ace4c0d2ea0d3d6115e2deb url=/legacydeveloper/current/en-us/api_meta/meta_sessionheader.md -->

# SessionHeader

Specifies the session ID that the login call returns. This session ID is used to authenticate all subsequent Metadata API calls.

## Version

This header is available in all API versions.

## Supported Calls

All Metadata API calls.

## Fields

### sessionId

- **Type**: string
- **Description**: The session ID that the login call returns.

## Sample Code—Java

Add the SessionHeader to the metadata connection before you perform a call as follows:

metadataConnection.setSessionHeader("<session\_ID>");

<!-- document id=76286f5194e4bf4555ff3f0d9cebe9eec72a3f9cf0c0a3eaf0706dd3630885a8 url=/legacydeveloper/current/en-us/api_meta/meta_settings.md -->

# Settings

Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.

Not all feature settings are available in the Metadata API. See [Unsupported Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_unsupported_types.htm "Some Salesforce features have metadata types that aren’t available in Metadata API. These metadata types can’t be retrieved or deployed with Metadata API. To make changes to these types, you must do it manually in each of your organizations.") for information on which feature settings are not available.

Settings can be accessed using the specific component member or via wildcard. For example, in the package manifest file you would use the following section to access SecuritySettings:

    <types\>
        <members\>Security</members\>
        <name\>Settings</name\>
    </types\>

The member format when used in the package manifest is the component metadata type name without the “Settings” suffix, so in the preceding example “Security” is used instead of “SecuritySettings”.

## File Suffix and Directory Location

Each settings component gets stored in a single file in the settings directory of the corresponding package directory. The filename uses the format Setting feature.settings. For example, the SecuritySettings file would be Security.settings. See “File Suffix and Directory Location” information for the individual settings components to determine the exact filename.

## Version

Settings is available in API version 27.0 and later. See the version information for the individual setting component to determine which API version the settings component became available.

## Declarative Metadata Sample Definition

The following is an example package manifest used to deploy or retrieve only the MobileSettings for an organization:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Mobile</members\>
        <name\>Settings</name\>
    </types\>
    <version\>27.0</version\>
</Package\>

The following is an example package manifest used to deploy or retrieve all the available settings metadata for an organization, using a wildcard:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>Settings</name\>
    </types\>
    <version\>27.0</version\>
</Package\>

- **[AccountPlanSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_accountplansettings.htm)**  
    Represents an org’s account plan settings. These settings control features that make it easy for sales reps to set objectives with actionable metrics and to store account research and analysis.
- **[AccountSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_accountsettings.htm)**  
    Represents an org’s account settings for account teams, account owner report, and the **View Hierarchy** link.
- **[AccountInsightsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_accountinsightssettings.htm)**  
    Represents an org’s Einstein Account Insights settings. This setting controls features that help your reps maintain their relationships with their customers.
- **[AccountIntelligenceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_accountintelligencesettings.htm)**  
    Represents an org’s Account Intelligence settings. These settings control features that make it easy for sales reps to create accounts, see relevant news articles, and add logos to account records. This type extends the Metadata metadata type and inherits its fullName field.
- **[AccountingSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_accountingsettings.htm)**  
    Represents the settings for the Accounting Subledger feature.
- **[ActionsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_actionssettings.htm)**  
    Represents an org’s actions settings for default quick actions, multi-dimensional publisher, and third-party actions. This type extends the Metadata metadata type and inherits its fullName field.
- **[ActivitiesSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_activitiessettings.htm)**  
    Represents an org's activity settings, and its user interface settings for the calendar. This type extends the Metadata metadata type and inherits its fullName field.
- **[AddressSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_addresssettings.htm)**  
    Represents the configuration of country/territory and state picklists. Use the AddressSettings component type to configure state and country/territory data in your organization so that you can convert text-based values into standard picklist values. To convert your state and country/territory values, from Setup, enter State and Country/Territory Picklists in the Quick Find box, then select **State and Country/Territory Picklists**.
- **[AIReplyRecommendationsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aireplyrecommendationssettings.htm)**  
    Represents the metadata used to manage settings for Einstein Reply Recommendations. This type extends the Metadata metadata type and inherits its fullName field.
- **[AgentPlatformSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_agentplatformsettings.htm)**  
    Represents settings for Agentforce.
- **[AgentforceAccountManagementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_agentforceaccountmanagementsettings.htm)**  
    Represents an org’s Agentforce Account Management settings.
- **[AgentforceForDevelopersSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_agentforcefordeveloperssettings.htm)**  
    Represents Agentforce for Developers settings.
- **[AnalyticsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_analyticssettings.htm)**  
    Represents Analytics settings in Salesforce. CRM Analytics lets you explore all your data quickly and easily by providing AI-powered advanced Analytics right inside Salesforce. Manage your datasets, query data with Salesforce Analytics Query Language (SAQL), and customize dashboards. You can use these settings to configure which Analytics features are available to users in your organization.
- **[ApexSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsettings.htm)**  
    Represents Apex-related org settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[AppAnalyticsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_appanalyticssettings.htm)**  
    Represents settings to retrieve AppExchange App Analytics usage data.
- **[AppExperienceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_appexperiencesettings.htm)**  
    Represents settings for the app experience.This type extends the Metadata metadata type and inherits its fullName field.
- **[AssociationEngineSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_associationenginesettings.htm)**  
    Represents the record association builder settings for an org. This type extends the Metadata metadata type and inherits its fullName field.
- **[AutomatedContactsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_automatedcontactssettings.htm)**  
    Represents an org’s Einstein Automated Contacts settings. These settings let you find new contacts and opportunity contact roles. This type extends the Metadata metadata type and inherits its fullName field.
- **[BotSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_botsettings.htm)**  
    Represents an organization’s Einstein Bot settings, such as whether or not Einstein Bots is enabled. This type extends the Metadata metadata type and inherits its fullName field.
- **[BranchManagementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_branchmanagementsettings.htm)**  
    Represents the branch management settings for an org. This type extends the Metadata metadata type and inherits its fullName field.
- **[BusinessHoursSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_businesshourssettings.htm)**  
    Represents the metadata used to manage settings for business hours and holidays in entitlements, entitlement templates, campaigns, and cases. This type extends the Metadata metadata type and inherits its fullName field.
- **[CampaignSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_campaignsettings.htm)**  
    Represents an org’s Campaign Influence, Einstein Attribution, Einstein Key Accounts, and campaign member settings. These features help you understand how your campaigns and accounts are affecting your opportunity pipeline.
- **[CaseSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_casesettings.htm)**  
    Represents an organization’s case settings, such as the default case owner, which case-related features are enabled, and which Classic email templates are used for various case activities. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.
- **[ChatterAnswersSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_chatteranswerssettings.htm)**  
    Represents the metadata used to manage settings for Chatter Answers.
- **[ChatterEmailsMDSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_chatteremailmdsettings.htm)**  
    Represents an org’s settings for Chatter email when Chatter is enabled. This type extends the Metadata metadata type and inherits its fullName field.
- **[ChatterSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_chattersettings.htm)**  
    Represents an org’s settings for their Chatter instance when Chatter is enabled for the org. This type extends the Metadata metadata type and inherits its fullName field.
- **[CodeBuilderSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_codebuildersettings.htm)**  
    Represents Code Builder settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[CollectionsDashboardSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_collectionsdashboardsettings.htm)**  
    Represents an org’s settings to add the Collections Dashboard application to an org.
- **[CommunitiesSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_communitiessettings.htm)**  
    Represents community settings for an org. Enable digital experiences and workspaces. Manage moderation, guest user and partner settings, and more. This type extends the Metadata metadata type and inherits its fullName field.
- **[CompanySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_companyprofilesettings.htm)**  
    Represents global settings that affect multiple features in your organization. This type extends the Metadata metadata type and inherits its fullName field.
- **[ConnectedAppSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_connectedappsettings.htm)**  
    Represents settings for connected apps. This type extends the Metadata metadata type and inherits its fullName field.
- **[ContentSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_contentsettings.htm)**  
    Represents content settings for an org. This type extends the Metadata metadata type and inherits its fullName field.
- **[ContractSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_contractsettings.htm)**  
    Represents contract settings.
- **[ConversationalIntelligenceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_conversationalintelligencesettings.htm)**  
    Represents the org's Einstein Conversation Insights settings, such as whether Einstein Conversation Insights is enabled. Einstein Conversation Insights lets you analyze your rep's call recordings, and gives you the insights you need to optimize every call.
- **[ConversationChannelDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_conversationchanneldefinition.htm)**  
    Represents the conversation channel definition that’s implemented for Interaction Service for Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS messaging channels. This object is available in API version 60.0 and later.
- **[CurrencySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_currencysettings.htm)**  
    Represents an organization's currency settings, including turning on multiple currencies, configuring active currencies, setting the corporate currency, and enabling currency effective dates. This type extends the Metadata metadata type and inherits its fullName field.
- **[CustomAddressFieldSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customaddressfieldsettings.htm)**  
    Represents the settings for custom address fields.
- **[DataDotComSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datadotcomsettings.htm)**  
    Represents the org's Data.com settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[DataImportManagementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dataimportmanagementsettings.htm)**  
    Represents an org's contact and leads import settings.
- **[DeploymentSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploymentsettings.htm)**  
    Represents the settings affecting how deployments behave in the org. This type extends the Metadata metadata type and inherits its fullName field.
- **[DevHubSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_devhubsettings.htm)**  
    Represents Dev Hub settings.
- **[DocumentGenerationSetting](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_documentgenerationsetting.htm)**  
    Represents an org's settings for automatic document generation from templates. This type extends the Metadata metadata type and inherits its fullName field.
- **[DynamicFormsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dynamicformssettings.htm)**  
    Represents the settings related to Dynamic Forms.
- **[EACSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eacsettings.htm)**  
    Represents the Einstein Activity Capture metadata type. Use Einstein Activity Capture to add emails and events from your Microsoft or Google account to the activity timeline of related Salesforce records. Automatically sync contact and event data between your Microsoft or Google account and Salesforce. This type extends the Metadata metadata type and inherits its fullName field.
- **[EinsteinAISettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_einsteinaisettings.htm)**  
    Represents Einstein AI settings, including AI feedback integration with Data 360 and PII masking for AI trust features.
- **[EinsteinAgentSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_einsteinagentsettings.htm)**  
    Represents settings for Einstein classification apps, Einstein Case Classification and Einstein Case Wrap-Up, in an org. This type extends the Metadata metadata type and inherits its fullName field.
- **[EinsteinGptSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_einsteingptsettings.htm)**  
    Represents settings for Einstein Generative AI features in an org. This type extends the Metadata metadata type and inherits its fullName field
- **[EmailAdministrationSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailadministrationsettings.htm)**  
    Represents an organization’s email administration settings, including email deliverability, security compliance, relay configurations, and system notifications. This type extends the Metadata metadata type and inherits its fullName field.
- **[EmailAuthorizationSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailauthorizationsettings.htm)**  
    Represents your org’s email authorization settings. This type extends the MetadataForSettings metadata type and inherits its fullName field.
- **[EmailIntegrationSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailintegrationsettings.htm)**  
    Represents an org’s settings for the Outlook integration, Gmail integration, and Salesforce Inbox. This type extends the Metadata metadata type and inherits its fullName field.
- **[EmailTemplateSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailtemplatesettings.htm)**  
    Represents an org’s email template settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[EmployeeUserSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_employeeusersettings.htm)**  
    Represents the employee-user settings used for automatically creating or syncing employee and user data in work.com orgs. This type extends the Metadata metadata type and inherits its fullName field.
- **[EnhancedNotesSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_enhancednotessettings.htm)**  
    Represents an org’s enhanced note settings, such as enabling enhanced notes and enabling tasks in enhanced notes.This type extends the Metadata metadata type and inherits its fullName field.
- **[EncryptionKeySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_encryptionkeysettings.htm)**  
    Represents an org’s encryption key settings, such as customer-supplied keys options and key derivation settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[EntitlementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_entitlementsettings.htm)**  
    Represents an organization’s entitlement settings.
- **[EventSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eventsettings.htm)**  
    Represents an org's platform event settings for Event Monitoring.
- **[ExperienceBundleSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencebundlesettings.htm)**  
    Represents the org setting that enables the ExperienceBundle metadata type for Aura sites in Experience Cloud. The setting doesn’t affect LWR sites, which use ExperienceBundle by default. This type extends the Metadata metadata type and inherits its fullName field.
- **[ExternalClientAppSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalclientappsettings.htm)**  
    Represents settings to enable external client app features.
- **[ExternalServicesSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalservicessettings.htm)**  
    Represents settings for an External Services registration.
- **[FieldServiceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fieldservicesettings.htm)**  
    Represents an organization’s Field Service settings.
- **[FilesConnectSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_filesconnectsettings.htm)**  
    Represents the settings that modify the Files Connect feature.This type extends the Metadata metadata type and inherits its fullName field.
- **[FileUploadAndDownloadSecuritySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_fileuploadanddownloadsecuritysettings.htm)**  
    Represents the security settings for uploading and downloading files. This type extends the Metadata metadata type and inherits its fullName field.
- **[FlowSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_flowsettings.htm)**  
    Represents the Salesforce settings for processes and flows, such as whether Lightning runtime for flows is enabled.
- **[ForecastingObjectListSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingobjectlistsettings.htm)**  
    Represents an org’s forecasting object list settings. Use these settings to control which object types and field types appear in the list of object details on the forecasts page. For example, pipeline forecasts use the Opportunity object, and the object list settings specify which fields from that object are available in the opportunity list section of the forecasts page. This type extends the Metadata metadata type and inherits its fullName field.
- **[ForecastingSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingsettings.htm)**  
    Represents the Forecasts settings options. This type extends the Metadata metadata type and inherits its fullName field.
- **[HelpSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_helpsettings.htm)**  
    Represents the org setting that changes the destination of help.salesforce.com to an alternative URL. Use this setting to deploy and retrieve the alternative Help URL.
- **[HighVelocitySalesSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_highvelocitysalessettings.htm)**  
    Represents an org’s Sales Engagement settings. With Sales Engagement, you can make your inside sales team as effective as possible.
- **[IdeasSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ideassettings.htm)**  
    Represents the metadata used to manage settings for Ideas.
- **[IdentityProviderSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_identityprovidersettings.htm)**  
    Represents the settings used to enable or disable Salesforce as a SAML identity provider for single sign-on (SSO).
- **[IframeWhiteListUrlSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_iframewhitelisturlsettings.htm)**  
    Represents settings related to the list of trusted external domains that you allow to frame your Visualforce pages or surveys. This type extends the Metadata metadata type and inherits its fullName field.
- **[IncidentMgmtSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_incidentmgmtsettings.htm)**  
    Represents settings for Customer Service Incident Management and Broadcast Communications.
- **[IndustriesEinsteinFeatureSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/industrieseinsteinfeaturesettings_metadata_api.htm)**  
    Represents the settings for enabling the Industries Einstein feature.
- **[IndustriesLoyaltySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/industriesloyaltysettings_metadata_api.htm)**  
    Represents the settings to enable capabilities of Loyalty Management.
- **[IndustriesSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_industriessettings.htm)**  
    Represents settings for industries verticals such as Financial Services Cloud, Consumer Goods Cloud, Public Sector Solutions, Education Cloud, Salesforce Scheduler, Life Sciences Cloud, and Health Cloud.
- **[InterestTaggingSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_interesttaggingsettings.htm)**  
    Represents settings for Interest Tags, which your users can add to client records to capture client needs, interests, and prospecting opportunities.
- **[InventorySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_inventorysettings.htm)**  
    Represents options for the Salesforce Omnichannel Inventory product.This type extends the Metadata metadata type and inherits its fullName field.
- **[InvLatePymntRiskCalcSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_invlatepymntriskcalcsettings.htm)**  
    Represents the org’s settings to identify the level of risks associated with payment of invoices.
- **[InvocableActionSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_invocableactionsettings.htm)**  
    Represents the org’s invocable action settings, such as whether partial save is allowed.This type extends the Metadata metadata type and inherits its fullName field.
- **[KnowledgeSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_knowledgesettings.htm)**  
    Represents the metadata used to manage settings for Salesforce Knowledge.
- **[LanguageSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_languagesettings.htm)**  
    Represents an organization’s language settings. Language settings control end-user language selection, locale formats, and translation options. This type extends the Metadata metadata type and inherits its fullName field.
- **[LeadConfigSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_leadconfigsettings.htm)**  
    Represents configuration settings for Leads that control how they are converted and displayed, and what actions are available. This type extends the Metadata metadata type and inherits its fullName field.
- **[LeadConvertSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_leadconvertsettings.htm)**  
    Represents an organization’s custom field mappings for lead conversion. Custom fields can be mapped from Leads to Accounts, Contacts, and Opportunities. Options for creating opportunities during lead conversion can also be specified. This type extends the Metadata metadata type and inherits its fullName field.
- **[LiveAgentSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_liveagentsettings.htm)**  
    Represents an organization’s Chat settings, such as whether Chat is enabled. This type extends the Metadata metadata type and inherits its fullName field.
- **[LightningExperienceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningexperiencesettings.htm)**  
    Represents the settings that modify an org’s Lightning Experience configuration. This type extends the Metadata metadata type and inherits its fullName field.
- **[LiveMessageSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_livemessagesettings.htm)**  
    Represents an org’s LiveMessage settings.
- **[MacroSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_macrosettings.htm)**  
    Represents an organization’s Macro settings, such as whether or not folders is enabled. This type extends the Metadata metadata type and inherits its fullName field.
- **[MailMergeSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mailmergesettings.htm)**  
    Represents the settings for Extended Mail Merge functionality.
- **[MapAndLocationSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mapandlocationsettings.htm)**  
    Represents an org’s map and location settings.
- **[MktPlanningOpsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mktplanningopssettings.htm)**  
    Represents the settings for Marketing Planning and Operations.
- **[MeetingsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_meetingssettings.htm)**  
    Represents the settings to enable Salesforce Meetings and the integration with Zoom video conferencing.
- **[MCETransformationsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mcetransformationssettings.htm)**  
    Controls Flow Builder's integration with Marketing Cloud Engagement (MCE), including sending contacts to MCE emails and journeys. This type extends the Metadata metadata type and inherits its fullName field.
- **[MobileSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mobilesettings.htm)**  
    Represents an organization’s mobile settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[MyDomainSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mydomainsettings.htm)**  
    Represents your org’s My Domain settings. With My Domain, you can include your company name in your URLs, for example, https://yourcompanyname.my.salesforce.com. This type extends the Metadata metadata type and inherits its fullName field.
- **[MfgServiceConsoleSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/mfg_mfgserviceconsolesettings_metadata_api.htm)**  
    Represents the settings to access the Service Console for Manufacturing.
- **[NameSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_namesettings.htm)**  
    Enables or disables the formal name, middle name, and suffix attributes for these person objects: Contact, Lead, Person Account, and User. This type extends the Metadata metadata type and inherits its fullName field.
- **[NotificationsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_notificationssettings.htm)**  
    Represents an organization’s mobile settings.
- **[OauthOidcSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_oauthoidcsettings.htm)**  
    Represents org settings for disabling OAuth OpenID Connect authorization flows.
- **[ObjectHierarchyRelationship](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/mfg_objecthierarchyrelationshipsettings_metadata_api.htm)**  
    Represents an organization’s custom field mappings for sales agreement conversion. Fields can be mapped from Opportunity and Quotes to SalesAgreement and SalesAgreementProduct.
- **[ObjectLinkingSettings (Beta)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objectlinkingsettings.htm)**  
    Represents the channel-object linking settings for an org. This type extends the Metadata metadata type and inherits its fullName field.
- **[OmniChannelSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_omnichannelsettings.htm)**  
    Represents the Omni-Channel settings for an org.
- **[OpportunityInsightsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_opportunityinsightssettings.htm)**  
    Represents an org’s Einstein Opportunity Insights settings. This setting controls features that give you relevant updates about your opportunities.
- **[OpportunitySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_opportunityssettings.htm)**  
    Represents org preferences for features such as automatic opportunity updates and similar-opportunity filters.
- **[OpportunityScoreSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_opportunityscoresettings.htm)**  
    Represents an org’s Einstein Opportunity Scoring settings, such as whether or not Einstein Opportunity Scoring is enabled. Einstein Opportunity Scoring helps determine the likelihood of an opportunity being won. This type extends the Metadata metadata type and inherits its fullName field.
- **[OrderManagementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ordermanagementsettings.htm)**  
    Represents options for the Salesforce Order Management product. This type extends the Metadata metadata type and inherits its fullName field.
- **[OrderSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ordersettings.htm)**  
    Represents order settings.
- **[OrgPreferenceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_orgpreferencesettings.htm)**  
    Removed in API version 48.0. Represents the unique org preference settings in a Salesforce org.
- **[OrgSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_orgsettings.htm)**  
    Represents the settings for org-wide functionality that isn’t associated with any specific feature.This type extends the Metadata metadata type and inherits its fullName field.
- **[PartyDataModelSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_partydatamodelsettings.htm)**  
    Represents an organization’s party data model settings, including options around the Individual object and consent enablement. This type extends the Metadata metadata type and inherits its fullName field.
- **[PardotSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pardotsettings.htm)**  
    Represents Marketing Cloud Account Engagement settings in your Salesforce org. Account Engagement, formerly known as Pardot, is a B2B marketing automation solution that helps you create meaningful connections, generate more pipeline, and close more deals. Use these settings to configure how Account Engagement collects and displays data.
- **[PardotEinsteinSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pardoteinsteinsettings.htm)**  
    Represents PardotEinsteinSettings. Use these settings to learn what factors drive your campaign performance, and get the best possible engagement score for your prospects. This type extends the Metadata metadata type and inherits its fullName field.
- **[PathAssistantSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pathassistantsettings.htm)**  
    Represents the Path preference setting. This type extends the Metadata metadata type and inherits its fullName field.
- **[PaymentsSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_paymentssettings.htm)**  
    Represents the Salesforce Payments settings when this feature is enabled for the org.
- **[PicklistSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_picklistsettings.htm)**  
    Represents an org’s picklist settings. These settings control the behavior of a picklist. This type extends the Metadata metadata type and inherits its fullName field.
- **[PlatformEncryptionSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformencryptionsettings.htm)**  
    Represents an org’s Platform Encryption settings, such as settings for available encryption schemes, permissions, encryption policy access, and which fields can be encrypted. This type extends the Metadata metadata type and inherits its fullName field.
- **[PlatformEventSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_platformeventsettings.htm)**  
    Represents settings for platform events and change data capture events.
- **[PredictionBuilderSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_predictionbuildersettings.htm)**  
    Represents the settings that determine how a user can interact with Einstein Prediction Builder. This type extends the Metadata metadata type and inherits its fullName field.
- **[PrivacySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_privacysettings.htm)**  
    Represents an organization’s settings for data privacy and consent management. This type extends the Metadata metadata type and inherits its fullName field.
- **[ProcessFlowMigration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_processflowmigration.htm)**  
    Represents a process's migrated criteria and the resulting migrated flow.
- **[ProductSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_productsettings.htm)**  
    Represents organization preferences for quantity schedules, revenue schedules, and active flag interaction with prices. This type extends the Metadata metadata type and inherits its fullName field.
- **[QuoteSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quotessettings.htm)**  
    Represents an org’s quotes settings, such as enabling quotes or creating quotes without an associated opportunity. This type extends the Metadata metadata type and inherits its fullName field.
- **[RealTimeEventSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_realtimeeventsettings.htm)**  
    Represents the list of Real-Time Event entities that you want to enable or disable. This type extends the Metadata metadata type and inherits its fullName field.
- **[RecordPageSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordpagesettings.htm)**  
    Represents an org’s record page settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[RetailExecutionSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata_api_retexset.htm)**  
    Represents settings to manage your inventory, promotions, planograms, and in-store activities.
- **[SalesAgreementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/mfg_salesagreementsettings_metadata_api.htm)**  
    Represents settings that control the display of agreement terms metrics in sales agreements and the calculation of the actual quantity of products in sales agreements. These settings also control the approval of sales agreements.
- **[SandboxSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sandboxsettings.htm)**  
    Represents Sandbox settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[SchemaSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_schemasettings.htm)**  
    Represents an org’s schema settings, which manage the availability of custom settings and custom metadata type values. This type extends the Metadata metadata type and inherits its fullName field.
- **[SearchSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_searchsettings.htm)**  
    Represents an org's search settings.
- **[SecuritySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_securitysettings.htm)**  
    Represents an org’s security settings. For example, settings define trusted IP ranges for network access, password and login requirements, session expiration, and single sign-on settings.
- **[ServiceCloudVoiceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_servicecloudvoicesettings.htm)**  
    Represents an organization’s Service Cloud Voice settings.
- **[ServiceSetupAssistantSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_servicesetupassistantsettings.htm)**  
    Represents an organization’s Service Setup Assistant settings. The Service Setup Assistant can be used to set up a basic service console app.
- **[SharingSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingsettings.htm)**  
    Represents an organization’s sharing, visibility, and data access settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[SiteSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sitesettings.htm)**  
    Represents the settings for Experience Cloud sites and for [Salesforce Sites](https://help.salesforce.com/articleView?id=sites_overview.htm&type=5&language=en_US "HTML (New Window)").
- **[SocialCustomerServiceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_socialcustomerservicesettings.htm)**  
    Represents Social Customer Service settings such as how to format inbound content from social posts to cases. This type extends the Metadata metadata type and inherits its fullName field.
- **[SocialProfileSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_socialprofilesettings.htm)**  
    Represents org preferences for social media features such as enabling Twitter and Facebook.Represents org preferences for social media features such as enabling Twitter and Facebook. This type extends the Metadata metadata type and inherits the fullName field.
- **[SourceTrackingSettings (Beta)](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sourcetrackingsettings.htm)**  
    Represents settings for source tracking, so that changes you make in your Developer and Developer Pro sandboxes or local workspace can be tracked. This type extends the Metadata metadata type and inherits its fullName field.
- **[SubscriptionManagementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_subscriptionmanagementsettings.htm)**  
    Represents the settings used to manage recurring subscriptions.
- **[SurveySettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_surveysettings.htm)**  
    Represents an org’s survey settings. Use the SurveySettings component to enable Salesforce Surveys, enable Customer Lifecycle Maps, and choose whether the owner of a survey can manage the responses.
- **[Territory2Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_territory2settings.htm)**  
    Represents an org’s Territory2 settings. Use Territory2 settings to set the access level that Sales Territories users have to records associated with sales territories, and to enable features. The standard record access settings apply to accounts and opportunities. With Private default internal access for contacts or cases, you can also set access for those records.
- **[TrailheadSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_trailheadsettings.htm)**  
    Represents an org’s integration with Trailhead for Learning Paths or Enablement programs, including access to enablement sites (formerly myTrailhead).
- **[TrialOrgSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_trialorgsettings.htm)**  
    Represents the settings in a trial user’s org. This type extends the Metadata metadata type and inherits its fullName field.
- **[UserEngagementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_userengagementsettings.htm)**  
    Represents the metadata associated with various feature settings around Lightning Experience transition and adoption, user engagement and adoption assistance, and adoption apps.
- **[UserInterfaceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_userinterfacesettings.htm)**  
    Represents the settings that modify the behavior of the org’s user interface.
- **[UserManagementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_usermanagementsettings.htm)**  
    Represents a selection of user management options that appear on the User Management Settings Setup page. This type extends the Metadata metadata type and inherits its fullName field.
- **[VoiceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_voicesettings.htm)**  
    Represents an org’s Sales Dialer settings, such as call recording, conferencing, and voicemail.
- **[WarrantyLifeCycleMgmtSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mfg_warrantylifecyclemgmtsettings.htm)**  
    Represents settings that control the Warranty Administration for your org.
- **[WorkDotComSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_WorkDotComSettings.htm)**  
    Represents WorkDotCom settings. This type extends the Metadata metadata type and inherits its fullName field.
- **[WorkforceEngagementSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_workforceengagementsettings.htm)**  
    Represents settings for Workforce Engagement Management.

<!-- document id=6fbcdcc4c0242899f26f1465d337b43e6291dbd3c21c3cefea0c453c0922c819 url=/legacydeveloper/current/en-us/api_meta/meta_sharedto.md -->

# SharedTo

SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.

See [Sharing Considerations](https://help.salesforce.com/s/articleView?id=platform.security_sharing_considerations.htm&type=5&language=en_US) and [Public and Personal Groups](https://help.salesforce.com/s/articleView?id=platform.user_groups.htm&type=5&language=en_US) in Salesforce Help.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

[SharedTo](#meta_sharedto "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.") is included in the metadata for shared and private list views. [SharedTo](#meta_sharedto "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.") isn’t in the metadata for public list views.

## Declarative Metadata File Suffix and Directory Location

[SharedTo](#meta_sharedto "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.") is used with [ListView](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listview.htm "ListView allows you to see a filtered list of records, such as contacts, accounts, or custom objects."), [Folder](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_folder.htm "Represents a folder. This type extends the Metadata metadata type and inherits its fullName field."), and [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm "Represents the base container for sharing rules, which can be criteria-based, ownership-based, territory-based, or for guest user access. SharingRules enables you to share records with a set of users, using rules that specify the access level for the target user group.").

## Version

[SharedTo](#meta_sharedto "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.") is available in API version 17.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d861905e142">Field</th>

              <th class="featureTableHeader  " id="d861905e145">Field Type</th>

              <th class="featureTableHeader  " id="d861905e148">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">allCustomerPortalUsers</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string</td>

              <td class="entry" headers="d861905e148" data-title="Description">A group containing all customer portal users.<p class="p">This field is available in API
                  version 24.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">allInternalUsers</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string</td>

              <td class="entry" headers="d861905e148" data-title="Description">A group containing all internal and nonportal users. <p class="p">This field is available
                  in API version 24.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">allPartnerUsers</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string</td>

              <td class="entry" headers="d861905e148" data-title="Description">A group containing all partner users. <p class="p">This field is available in API version
                  24.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">allRestrictedEmployeeUsers</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string</td>

              <td class="entry" headers="d861905e148" data-title="Description">A group containing only employee users with the Unified Employee license. Use
                to extend these users’ access.<p class="p">This field is available in API version 68.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">channelProgramGroup</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string</td>

              <td class="entry" headers="d861905e148" data-title="Description">A system-managed group with sharing access containing all partner members of
                the corresponding channel program or level. <p class="p">This field is available in API
                  version 41.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">channelProgramGroups</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of system-managed groups with sharing access containing all partner
                members of the corresponding channel programs or levels. <p class="p">This field is available
                  in API version 41.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_group"><a name="field_group"><!-- --></a>group</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of groups with sharing access. Use this field instead of the groups<p class="p"> field.This field is available in API
                  version 22.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">guestUser</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of guest user nicknames with sharing access. This field can be used only
                with SharingGuestRule.<p class="p">This field is available in API version 47.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_groups"><a name="field_groups"><!-- --></a>groups</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of groups with sharing access. <p class="p">Use the group field instead for API version 22.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">managerSubordinates</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of users whose direct and indirect subordinates receive sharing access.
                This field is available in API version 24.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">managers</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of users whose direct and indirect managers receive sharing access. This
                field is available in API version 24.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">portalRole</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of groups with sharing access containing all users in a portal role.
                <p class="p">This field is available in API version 24.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">portalRoleandSubordinates</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of groups with sharing access containing all users in a portal role or
                any users under that role. <p class="p">This field is available in API version 24.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_role"><a name="field_role"><!-- --></a>role</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of roles with sharing access. Use this field instead of the roles<p class="p"> field.This field is available in API
                  version 22.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_roleAndSubordinates"><a name="field_roleAndSubordinates"><!-- --></a>roleAndSubordinates</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of roles with sharing access. All roles below each of these roles in the
                role hierarchy also have sharing access. If portal accounts are enabled, then all
                roles and portal accounts below each of these roles in the role hierarchy also have
                sharing access. Use this field instead of the rolesAndSubordinates<p class="p"> field.This field is
                  available in API version 22.0 and later and is only available when digital
                  experiences is enabled for your org and Experience Cloud site users are created
                  with external account roles other than a shared person account role.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">roleAndSubordinatesInternal</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of roles with sharing access. All roles below each of these roles in the
                role hierarchy also have sharing access.<p class="p">This field is available in API version
                  22.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_roles"><a name="field_roles"><!-- --></a>roles</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of roles with sharing access. <p class="p">Use the role field instead for API version 22.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_rolesAndSubordinates"><a name="field_rolesAndSubordinates"><!-- --></a>rolesAndSubordinates</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of roles with sharing access. All roles below each of these roles in the
                role hierarchy also have sharing access. If portal accounts are enabled, then all
                roles and portal accounts below each of these roles in the role hierarchy also have
                sharing access. <p class="p">Use the roleAndSubordinates field instead for API
                  version 22.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_territories"><a name="field_territories"><!-- --></a>territories</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of territories with sharing access. <p class="p">Use the territory field instead for API version 22.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_territoriesAndSubordinates"><a name="field_territoriesAndSubordinates"><!-- --></a>territoriesAndSubordinates</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of territories with sharing access. All territories below each of these
                territories in the territory hierarchy also have sharing access. <p class="p">Use the
                  territoryAndSubordinates field instead
                  for API version 22.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_territory"><a name="field_territory"><!-- --></a>territory</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of territories with sharing access. Use this field instead of the
                territories<p class="p"> field. If you’re using
                  Sales Territories, use <var class="keyword varname">modelName.territoryName</var> for the
                  shared-to and shared-from <span class="keyword parmname">territory</span> values, where: </p>

                <ul class="ul bulletList">
                  <li class="li">
                    <var class="keyword varname">modelName</var> equals the name of the active territory model in
                    the API.
                  </li>

                  <li class="li">
                    <var class="keyword varname">territoryName</var> equals the territory’s name in the API.
                  </li>

                </ul>
                <p class="p">This field is available in API version 22.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname" id="field_territoryAndSubordinates"><a name="field_territoryAndSubordinates"><!-- --></a>territoryAndSubordinates</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of territories with sharing access. All territories below each of these
                territories in the territory hierarchy also have sharing access. Use this field
                instead of the territoriesAndSubordinates<p class="p">
                  field. If you’re using Sales Territories, use
                  <var class="keyword varname">modelName.territoryName</var> for the shared-to and shared-from
                  <span class="keyword parmname">territoryAndSubordinates</span> values, where:
                </p>

                <ul class="ul bulletList">
                  <li class="li">
                    <var class="keyword varname">modelName</var> equals the name of the active territory model in
                    the API.
                  </li>

                  <li class="li">
                    <var class="keyword varname">territoryName</var> equals the territory’s name in the API.
                  </li>

                </ul>
                <p class="p">This field is available in API version 22.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d861905e142" data-title="Field"><span class="keyword parmname">queue</span></td>

              <td class="entry" headers="d861905e145" data-title="Field Type">string[]</td>

              <td class="entry" headers="d861905e148" data-title="Description">A list of queues with sharing access. Applies only to lead, case, and
                CustomObject sharing rules. <p class="p">This field is available in API version 24.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

<!-- document id=b664f3c0bcadf7de28708f2e3af7ce12339533805d66fabe70bf4c1f957da732 url=/legacydeveloper/current/en-us/api_meta/meta_sharingbaserule.md -->

# SharingBaseRule

Represents sharing rule settings such as access level and to whom access is granted.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

You can’t create a [SharingBaseRule](#meta_sharingbaserule "Represents sharing rule settings such as access level and to whom access is granted.") component directly. Use the components under [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm "Represents the base container for sharing rules, which can be criteria-based, ownership-based, territory-based, or for guest user access. SharingRules enables you to share records with a set of users, using rules that specify the access level for the target user group.") instead.

## Version

[SharingBaseRule](#meta_sharingbaserule "Represents sharing rule settings such as access level and to whom access is granted.") replaces [BaseSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_basesharingrule.htm "This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingBaseRule instead. Represents the base container for criteria-based and owner-based sharing rules.") and is available in API version 33.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| accessLevel | string | Required. The access level that the sharing rule grants. |
| accountSettings | [AccountSharingRuleSettings](#AccountSharingRuleSettings)\[\] | The access level for the account’s children (case, contact, and opportunity). |
| description | string | Describes the sharing rule. Maximum of 1000 characters. |
| label | string | Required. Label for the sharing rule. |
| sharedTo | [SharedTo](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.") | Required. Specifies who the record is shared with. |

## AccountSharingRuleSettings

Defines the access level for the case, contact, and opportunity associated with the account.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d863681e229">Field</th>

              <th class="featureTableHeader  " id="d863681e232">Field Type</th>

              <th class="featureTableHeader  " id="d863681e235">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d863681e229" data-title="Field"><span class="keyword parmname">caseAccessLevel</span></td>

              <td class="entry" headers="d863681e232" data-title="Field Type">string</td>

              <td class="entry" headers="d863681e235" data-title="Description">Required. The access level that the user or group has to cases associated with the
                account. Possible values are:<ul class="ul bulletList">
                  <li class="li">None</li>

                  <li class="li">Read</li>

                  <li class="li">Edit</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d863681e229" data-title="Field"><span class="keyword parmname">contactAccessLevel</span></td>

              <td class="entry" headers="d863681e232" data-title="Field Type">string</td>

              <td class="entry" headers="d863681e235" data-title="Description">Required. The access level that the user or group has to contacts associated with the
                account. Possible values are:<ul class="ul bulletList">
                  <li class="li">None</li>

                  <li class="li">Read</li>

                  <li class="li">Edit</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d863681e229" data-title="Field"><span class="keyword parmname">opportunityAccessLevel</span></td>

              <td class="entry" headers="d863681e232" data-title="Field Type">string</td>

              <td class="entry" headers="d863681e235" data-title="Description">Required. The access level that the user or group has to opportunities associated with
                the account. Possible values are:<ul class="ul bulletList">
                  <li class="li">None</li>

                  <li class="li">Read</li>

                  <li class="li">Edit</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=20e2a5dd680bb6f68a013ff795df84c72e22f74c3ef505be98e67daa97591cb4 url=/legacydeveloper/current/en-us/api_meta/meta_apexsharingreason.md -->

# SharingReason

Represents an Apex sharing reason, which is used to indicate why sharing was implemented for a standard or custom object. Apex managed sharing allows developers to use Apex to programmatically share custom objects. When you use Apex managed sharing to share an object, only users with the “Modify All Data” permission can add or change the sharing on the object's record, and the sharing access is maintained when the record owner changes or is deactivated. Sharing reasons for standard objects are available for objects that have a corresponding share object (for example, AccountShare, OpportunityShare) and whose org-wide default can be set to Private or Public Read-Only. Objects on the detail side of a master-detail relationship, which have no share object of their own, aren't supported.

Use SharingReason to create, update, or delete sharing reason definitions for a custom object. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Version

Sharing reasons for custom objects are available in API version 14.0 and later. Sharing reasons for standard objects are available in API version 68.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d139017e85">Field</th>

              <th class="featureTableHeader  " id="d139017e88">Field Type</th>

              <th class="featureTableHeader  " id="d139017e91">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d139017e85" data-title="Field"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm#meta_fullname">fullName</a></td>

              <td class="entry" headers="d139017e88" data-title="Field Type">string</td>

              <td class="entry" headers="d139017e91" data-title="Description">Required. Sharing reason name. The __c suffix is appended to
                custom sharing reasons.<p class="p">Inherited from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for this
                  metadata type. It must be specified when creating, updating, or
                  deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a> to see an example of
                  this field specified for a call.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d139017e85" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d139017e88" data-title="Field Type">string</td>

              <td class="entry" headers="d139017e91" data-title="Description">Required. Descriptive label for the sharing reason. Maximum of 40
                characters.</td>

            </tr>

          </tbody>

        </table>

## Usage

## Example

- A maximum of 10 custom sharing reasons can be created per standard object.
- Reserved row cause names (for example, Manual, Team, Sharing Rule, Record Collection) can't be used as sharing reason names.
- Deleting a sharing reason deletes all share records on that object that use the reason. This can revoke access for users, so treat deletion as a destructive change.

## Declarative Metadata Sample Definition

The definition of a sharing reason in a custom object:

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
. . .
    <sharingReasons\>
        <fullName\>recruiter\_\_c</fullName\>
        <label\>Recruiter</label\>
    </sharingReasons\>
 . . .
</CustomObject\>

## Managed Package Support

Sharing reasons for standard and custom objects can be included in second-generation managed packages. On install, the fullName is prefixed with the package namespace (for example, myns\_\_Compliance\_Team). Packaged sharing reasons are locked in the subscriber org, so subscribers can't edit the label or developer name, or delete the reason directly. Uninstalling a package that contains sharing reasons deletes those reasons and all associated shares.

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_searchlayouts.htm "SearchLayouts")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsharingrecalculation.htm "SharingRecalculation")

<!-- document id=43e5c97d1a68f07916c6f4d1869d94ec79415f119d0e4a6fbd19dcc2f5ae2b71 url=/legacydeveloper/current/en-us/api_meta/meta_apexsharingrecalculation.md -->

# SharingRecalculation

Represents Apex classes that recalculate the Apex managed sharing for a specific custom object.

## Version

Sharing recalculations are available in API version 14.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| className | string | Required. The Apex class that recalculates the Apex sharing for a custom object. This class must implement the Database.Batchable interface. |

## Declarative Metadata Sample Definition

The definition of a sharing recalculation in a custom object:

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
. . .
    <sharingRecalculations\>
        <className\>RecruiterRecalculation</className\>
    </sharingRecalculations\>
 . . .
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsharingreason.htm "SharingReason")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_validationformulas.htm "ValidationRule")

<!-- document id=a9fb30d7f8eb9a31ebf8d3e36cce4e4c5eb666f22fb6fac55b4532b297c93fcd url=/legacydeveloper/current/en-us/api_meta/meta_sharingrules.md -->

# SharingRules

Represents the base container for sharing rules, which can be criteria-based, ownership-based, territory-based, or for guest user access. SharingRules enables you to share records with a set of users, using rules that specify the access level for the target user group.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. For more information, see “Sharing Rules” in Salesforce Help.

In API version 33.0 and later, retrieving, deleting, or deploying of all sharing rules in an organization is available. Wildcard support is also available. You can’t retrieve, delete, or deploy manual sharing rules or sharing rules by their type (owner, criteria-based, territory, or guest user).

## Declarative Metadata File Suffix and Directory Location

In API version 33.0 and later, components are stored in the sharingRules folder and their file name matches the object name with the suffix .sharingRules. Criteria-based, owner-based, territory-based, and guest user sharing rules are all contained in a object.sharingRule file.

Before API version 33.0, SharingRules components are stored in their corresponding object directory and the file name matches the object name. For example, the accountSharingRules directory contains an Account.sharingRules file for account sharing rules. SharingRules for custom objects are stored in the customObjectSharingRules directory, which contains files with the .sharingRules extension such as ObjA\_\_c.sharingRules, where ObjA refers to the developer name of a custom object type.

## Version

SharingRules components are available in API version 24.0 and later, but these components are no longer available in API version 33.0 and later: AccountSharingRules, CampaignSharingRules, CaseSharingRules, ContactSharingRules, LeadSharingRules, OpportunitySharingRules, AccountTerritorySharingRules, CustomObjectSharingRules, UserSharingRules.

In API version 33.0 and later, use [SharingCriteriaRule](#SharingCriteriaRule), [SharingOwnerRule](#SharingOwnerRule) and [SharingTerritoryRule](#SharingTerritoryRule).

## Special Access Rules

As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object, and only users with the Manage Sharing permission can edit this object.

## Fields

The following information assumes that you’re familiar with implementing sharing rules for standard objects and custom objects. For more information on these fields, see “Sharing Settings” in Salesforce Help.

| Field | Field Type | Description |
| --- | --- | --- |
| sharingCriteriaRules | [SharingCriteriaRule](#SharingCriteriaRule)\[\] | An array of criteria-based sharing rules. Available in API version 33.0 and later. |
| sharingGuestRules | [SharingGuestRule](#SharingGuestRule)\[\] | An array of guest user sharing rules. Available in API version 47.0 and later. |
| sharingOwnerRules | [SharingOwnerRule](#SharingOwnerRule)\[\] | An array of ownership-based sharing rules. Available in API version 33.0 and later. |
| sharingTerritoryRules | [SharingTerritoryRule](#SharingTerritoryRule)\[\] | An array of territory-based sharing rules. Available in API version 33.0 and later. |

## SharingCriteriaRule

Defines a criteria-based sharing rule. It extends [SharingBaseRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingbaserule.htm "Represents sharing rule settings such as access level and to whom access is granted.") and inherits all its fields. Available in API version 33.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d864512e258">Field</th>

              <th class="featureTableHeader  " id="d864512e261">Field Type</th>

              <th class="featureTableHeader  " id="d864512e264">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d864512e258" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d864512e261" data-title="Field Type">string</td>

              <td class="entry" headers="d864512e264" data-title="Description">Advanced filter conditions that are specified for the sharing
                rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d864512e258" data-title="Field"><span class="keyword parmname">criteriaItems</span></td>

              <td class="entry" headers="d864512e261" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a>[]
              </td>

              <td class="entry" headers="d864512e264" data-title="Description">An array of the boolean criteria (conditions) for the sharing
                rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d864512e258" data-title="Field"><span class="keyword parmname">includeRecordsOwnedByAll</span></td>

              <td class="entry" headers="d864512e261" data-title="Field Type">boolean</td>

              <td class="entry" headers="d864512e264" data-title="Description">Required. Indicates whether records owned by users who can’t have
                an assigned role are included in the records shared (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Examples of users who can’t
                have an assigned role are high-volume users and system users such as
                automated process users.or Salesforce system users.
                <p class="p">You can’t edit this field after the sharing rule is created.</p>
              </td>

            </tr>

          </tbody>

        </table>

## SharingGuestRule

Defines a guest user sharing rule. It extends [SharingBaseRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingbaserule.htm "Represents sharing rule settings such as access level and to whom access is granted.") and inherits all its fields, except accountSettings. Available in API version 47.0 and later.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

For SharingGuestRule, the accessLevel field can be set only to Read.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d864512e367">Field</th>

              <th class="featureTableHeader  " id="d864512e370">Field Type</th>

              <th class="featureTableHeader  " id="d864512e373">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d864512e367" data-title="Field"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d864512e370" data-title="Field Type">string</td>

              <td class="entry" headers="d864512e373" data-title="Description">Advanced filter conditions that are specified for the sharing
                rule. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d864512e367" data-title="Field"><span class="keyword parmname">criteriaItems</span></td>

              <td class="entry" headers="d864512e370" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a>[]
              </td>

              <td class="entry" headers="d864512e373" data-title="Description">An array of the boolean criteria (conditions) for the sharing
                rule. Available in API version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d864512e367" data-title="Field"><span class="keyword parmname">includeHVUOwnedRecords</span></td>

              <td class="entry" headers="d864512e370" data-title="Field Type">boolean</td>

              <td class="entry" headers="d864512e373" data-title="Description">Required. Indicates whether records owned by high-volume
                community or site users are included in the records shared (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). By default, only records
                owned by authenticated users, guest users, and queues are included
                in sharing rules. This field has a default value of <samp class="codeph nolang">false</samp>. Available in API version
                52.0 and later.
                <p class="p">You can’t edit this field
                  after the sharing rule is created.</p>
              </td>

            </tr>

          </tbody>

        </table>

## SharingOwnerRule

Defines an ownership-based sharing rule. It extends [SharingBaseRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingbaserule.htm "Represents sharing rule settings such as access level and to whom access is granted.") and inherits all its fields. Available in API version 33.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d864512e467">Field</th>

              <th class="featureTableHeader  " id="d864512e470">Field Type</th>

              <th class="featureTableHeader  " id="d864512e473">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d864512e467" data-title="Field"><span class="keyword parmname">sharedFrom</span></td>

              <td class="entry" headers="d864512e470" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm" title="SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.">SharedTo</a></td>

              <td class="entry" headers="d864512e473" data-title="Description">Required. Specifies the record owners. <p class="p">If you’re using Sales
                  Territories, use <var class="keyword varname">modelName.territoryName</var> for
                  the shared-to and shared-from <span class="keyword parmname">territory</span> and
                  <span class="keyword parmname" id="field_territoryAndSubordinates"><a name="field_territoryAndSubordinates"><!-- --></a>territoryAndSubordinates</span> values on the SharedTo
                  type, where:
                </p>

                <ul class="ul bulletList">
                  <li class="li">
                    <var class="keyword varname">modelName</var> equals the name of the active
                    territory model in the API.
                  </li>

                  <li class="li">
                    <var class="keyword varname">territoryName</var> equals the territory’s name
                    in the API.
                  </li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## SharingTerritoryRule

Defines a territory-based sharing rule. It extends [SharingOwnerRule](#SharingOwnerRule) and inherits all its fields. Available in API version 33.0 and later.

## AccountSharingRules

Represents the sharing rules for accounts. It extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

| Field | Field Type | Description |
| --- | --- | --- |
| criteriaBasedRules | [AccountCriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm#AccountCriteriaBasedSharingRule-BA7CB418)\[\] | List that defines user criteria-based rules. |
| ownerRules | [AccountOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#AccountOwnerSharingRule)\[\] | List that defines user membership-based rules. |

## CampaignSharingRules

Represents the sharing rules for campaigns. It extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

| Field | Field Type | Description |
| --- | --- | --- |
| criteriaBasedRules | [CampaignCriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm#CampaignCriteriaBasedRule-BA7DF3F4)\[\] | List that defines user criteria-based rules. |
| ownerRules | [CampaignOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#CampaignOwnerSharingRule)\[\] | List that defines user membership-based rules. |

## CaseSharingRules

Represents the sharing rules for cases. It extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

| Field | Field Type | Description |
| --- | --- | --- |
| criteriaBasedRules | [CaseCriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm#CaseCriteriaBasedSharingRule-BA7F0AE0)\[\] | List that defines user criteria-based rules. |
| ownerRules | [CaseOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#CaseOwnerSharingRule)\[\] | List that defines user membership-based rules. |

## ContactSharingRules

Represents the sharing rules for contacts. It extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

| Field | Field Type | Description |
| --- | --- | --- |
| criteriaBasedRules | [ContactCriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm#ContactCriteriaBasedSharingRule-BA7FB5C9)\[\] | List that defines user criteria-based rules. |
| ownerRules | [ContactOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#ContactOwnerSharingRule)\[\] | List that defines user membership-based rules. |

## LeadSharingRules

Represents the sharing rules for leads. It extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

| Field | Field Type | Description |
| --- | --- | --- |
| criteriaBasedRules | [LeadCriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm#LeadCriteriaBasedSharingRule-BA7FDBAF)\[\] | List that defines user criteria-based rules. |
| ownerRules | [LeadOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#LeadOwnerSharingRule)\[\] | List that defines user membership-based rules. |

## OpportunitySharingRules

Represents the sharing rules for opportunities. It extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

| Field | Field Type | Description |
| --- | --- | --- |
| criteriaBasedRules | [OpportunityCriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm#OpportunityCriteriaBasedSharingRule-BA801C92)\[\] | List that defines user criteria-based rules. |
| ownerRules | [OpportunityOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#OpportunityOwnerSharingRule)\[\] | List that defines user membership-based rules. |

## AccountTerritorySharingRules

Represents the sharing rules for account territories in the original territory management feature. It extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d864512e1010">Field</th>

              <th class="featureTableHeader  " id="d864512e1013">Field Type</th>

              <th class="featureTableHeader  " id="d864512e1016">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d864512e1010" data-title="Field"><span class="keyword parmname">rules</span></td>

              <td class="entry" headers="d864512e1013" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#AccountTerritorySharingRule">AccountTerritorySharingRule</a>[]
              </td>

              <td class="entry" headers="d864512e1016" data-title="Description">List that defines user membership-based rules. The list of
                acceptable values for the <span class="keyword parmname">sharedFrom</span> fields
                are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">territory</samp></li>

                  <li class="li"><samp class="codeph nolang">territoryAndSubordinates</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## CustomObjectSharingRules

Represents the sharing rules for custom objects. It extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

| Field | Field Type | Description |
| --- | --- | --- |
| criteriaBasedRules | [CustomObjectCriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm#CustomObjectCriteriaBasedSharingRul-BA809B38)\[\] | List that defines user criteria-based rules. |
| ownerRules | [CustomObjectOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#CustomObjectOwnerSharingRule)\[\] | List that defines user membership-based rules. |

## UserSharingRules

Represents the sharing rules for users. With user sharing rules, you can share members of a group with members of another group. It extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

| Field | Field Type | Description |
| --- | --- | --- |
| criteriaBasedRules | [UserCriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm#UserCBSRule)\[\] | List that defines user criteria-based rules. |
| membershipRules | [UserMembershipSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#UserMembershipSharingRule)\[\] | List that defines user membership-based rules. |

## Declarative Metadata Sample Definition

For retrieving sharing rules, see package.xml sample at SharingRules.

The following sample XML definition represents a criteria-based sharing rule in API version 33.0.

<?xml version="1.0" encoding="UTF-8"?>
<SharingRules xmlns="http://soap.sforce.com/2006/04/metadata">
    <sharingCriteriaRules\>
        <fullName\>AccountCriteriaShareWithCEO</fullName\>
        <accessLevel\>Edit</accessLevel\>
        <accountSettings\>
            <caseAccessLevel\>Read</caseAccessLevel\>
            <contactAccessLevel\>Edit</contactAccessLevel\>
            <opportunityAccessLevel\>Edit</opportunityAccessLevel\>
        </accountSettings\>
        <criteriaItems\>
            <field\>Name</field\>
            <operation\>startsWith</operation\>
            <value\>Test</value\>
        </criteriaItems\>
        <description\>my account criteria rule description</description\>
        <label\>AccountCriteriaShareWithCEO</label\>
        <sharedTo\>
            <role\>CEO</role\>
        </sharedTo\>
    </sharingCriteriaRules\>
</SharingRules\>

The following sample XML definition represents an ownership-based sharing rule in API version 33.0.

<?xml version="1.0" encoding="UTF-8"?>
<SharingRules xmlns="http://soap.sforce.com/2006/04/metadata">
    <sharingOwnerRules\>
        <fullName\>MyCase</fullName\>
        <accessLevel\>Edit</accessLevel\>
        <description\>my case test owner sharing rule desc</description\>
        <label\>MyCase</label\>
        <sharedFrom\>
            <role\>COO</role\>
        </sharedFrom\>
        <sharedTo\>
            <role\>CEO</role\>
        </sharedTo\>
    </sharingOwnerRules\>
</SharingRules\>

The following sample XML definition represents a territory-based sharing rule in API version 33.0.

<?xml version="1.0" encoding="UTF-8"?>
<SharingRules xmlns="http://soap.sforce.com/2006/04/metadata">
    <sharingTerritoryRules\>
        <fullName\>MyAccountTerritoryRule</fullName\>
        <accessLevel\>Read</accessLevel\>
        <accountSettings\>
            <caseAccessLevel\>None</caseAccessLevel\>
            <contactAccessLevel\>Read</contactAccessLevel\>
            <opportunityAccessLevel\>None</opportunityAccessLevel\>
        </accountSettings\>
        <description\>MyAccountTerritoryRule desc</description\>
        <label\>MyAccountTerritoryRule</label\>
        <sharedFrom\>
            <territory\>My\_territory</territory\>
        </sharedFrom\>
        <sharedTo\>
            <role\>CEO</role\>
        </sharedTo\>
    </sharingTerritoryRules\>
</SharingRules\>

The following is the definition of two account owner-based sharing rules in API version 32.0 and earlier. The file name corresponds to Account.sharingRules under the accountSharingRules directory. In this definition, ownerRules corresponds to [AccountOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm#AccountOwnerSharingRule).

<?xml version="1.0" encoding="UTF-8"?>
<AccountSharingRules xmlns="http://soap.sforce.com/2006/04/metadata">
    <ownerRules\>
        <fullName\>G1Dev\_G2New</fullName\>
        <sharedFrom\>
            <group\>G1Dev</group\>
        </sharedFrom\>
        <sharedTo\>
            <group\>G2New</group\>
        </sharedTo\>
        <accountAccessLevel\>Read</caseAccessLevel\>
        <caseAccessLevel\>None</caseAccessLevel\>
        <contactAccessLevel\>Read</contactAccessLevel\>
        <name\>G1Dev\_G2New</name\>
        <opportunityAccessLevel\>Edit</opportunityAccessLevel\>
    </ownerRules\>
    <ownerRules\>
        <fullName\>G2New\_R1New</fullName\>
        <sharedFrom\>
            <group\>G2New</group\>
        </sharedFrom\>
        <sharedTo\>
            <roleAndSubordinates\>R1New</roleAndSubordinates\>
        </sharedTo\>
        <accountAccessLevel\>Edit</accountAccessLevel\>
        <caseAccessLevel\>Read</caseAccessLevel\>
        <contactAccessLevel\>Edit</contactAccessLevel\>
        <name\>G2New\_R1New</name\>
        <opportunityAccessLevel\>None</opportunityAccessLevel\>
    </ownerRules\>
</AccountSharingRules\>

The following is the definition of a user criteria-based sharing rule and a user membership-based sharing rule in API version 32.0 and earlier. The file name corresponds to User.sharingRules under the userSharingRules directory.

<?xml version="1.0" encoding="UTF-8"?>
<UserSharingRules xmlns="http://soap.sforce.com/2006/04/metadata">
    <criteriaBasedRules\>
        <fullName\>shareUsers2</fullName\>
        <sharedTo\>
            <group\>Asia\_Division</group\>
        </sharedTo\>
        <criteriaItems\>
            <field\>FirstName</field\>
            <operation\>equals</operation\>
            <value\>John</value\>
        </criteriaItems\>
        <name\>shareUsers2</name\>
        <userAccessLevel\>Read</userAccessLevel\>
    </criteriaBasedRules\>
    <membershipRules\>
        <fullName\>shareUsers1</fullName\>
        <sharedTo\>
            <group\>South\_America\_Division</group\>
        </sharedTo\>
        <sharedFrom\>
            <group\>Asia\_Division</group\>
        </sharedFrom\>
        <name\>shareUsers1</name\>
        <userAccessLevel\>Read</userAccessLevel\>
    </membershipRules\>
</UserSharingRules\>

The following shows a sample package.xml file.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>ObjA\_\_c.\*</members\>
        <name\>SharingCriteriaRule</name\>
    </types\>
    <types\>
        <members\>ObjA\_\_c.\*</members\>
        <name\>SharingOwnerRule</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

1. [BaseSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_basesharingrule.htm)  
    This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingBaseRule instead. Represents the base container for criteria-based and owner-based sharing rules.
2. [CriteriaBasedSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm)  
    This component is removed as of API version 33.0 and is available in earlier versions only. Use [SharingRules](# "Represents the base container for sharing rules, which can be criteria-based, ownership-based, territory-based, or for guest user access. SharingRules enables you to share records with a set of users, using rules that specify the access level for the target user group.") instead. Represents a criteria-based sharing rule. CriteriaBasedSharingRule enables you to share records based on specific criteria.
3. [OwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm)  
    Represents an ownership-based sharing rule. OwnerSharingRule enables you to share records owned by a set of users with another set, using rules that specify the access level of the target user group. This component is removed as of API version 33.0 and is available in earlier versions only.

<!-- document id=7ee9af2d60bb7e69dc7e2b7d93262f6f969bb69fcac4c6f09ebc3a70c710831e url=/legacydeveloper/current/en-us/api_meta/meta_sharingset.md -->

# SharingSet

Represents a sharing set. A sharing set defines an access mapping that grants portal or community users access to objects that are associated with their accounts or contacts.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

For example, you can grant portal or community users access to all cases related to their account record. Similarly, you can grant portal or community users access to all cases related to a parent account that is identified on the user’s account record.

## File Suffix and Directory Location

SharingSet components have the suffix .sharingSet and are stored in the sharingSets folder.

## Version

SharingSet components are available in API version 30.0 and later.

## Special Access Rules

As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object, and only users with the Manage Sharing permission can edit this object. To create or update sharing sets, you need the Customize Application permission.

Sharing sets are available with these licenses.

- Authenticated Website
- Customer Community Login
- Customer Community Plus
- Partner Community
- Customer Community User
- High Volume Customer Portal
- High Volume Portal
- Overage Authenticated Website User
- Overage High Volume Customer Portal User

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| accessMappings | [AccessMapping](#SubTypeID)\[\] | A list of access mappings on a sharing set. |
| description | string | The sharing set description. Limit: 255 characters. |
| name | string | Required. The unique identifier for API access. Corresponds to **Sharing Set Name** on the user interface. |
| profiles | string\[\] | The profiles of users that are granted access to the target objects. Profiles must be associated with a license that can use sharing sets. See [Special Access Rules](#Special_Access_Rules) for more information. |

## AccessMapping

AccessMapping

You can grant portal users access to a target object, or to both a target object and its associated objects, such as an account and its contacts and cases.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d867894e255">Field Name</th>

              <th class="featureTableHeader  " id="d867894e258">Field Type</th>

              <th class="featureTableHeader  " id="d867894e261">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d867894e255" data-title="Field Name"><span class="keyword parmname">accessLevel</span></td>

              <td class="entry" headers="d867894e258" data-title="Field Type">string</td>

              <td class="entry" headers="d867894e261" data-title="Description">Required. The target object access level granted to the portal user. Valid
                values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d867894e255" data-title="Field Name"><span class="keyword parmname">objectField</span></td>

              <td class="entry" headers="d867894e258" data-title="Field Type">string</td>

              <td class="entry" headers="d867894e261" data-title="Description">Required. A lookup to the target object, which supports standard or custom
                fields, or an ID. For accounts or cases associated with entitlements, use <samp class="codeph nolang">Entitlement.Account</samp> or <samp class="codeph nolang">Entitlement.Case</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d867894e255" data-title="Field Name"><span class="keyword parmname">object</span></td>

              <td class="entry" headers="d867894e258" data-title="Field Type">string</td>

              <td class="entry" headers="d867894e261" data-title="Description">Required. The target object to which the portal user is gaining access, and
                refers to one of the following:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Account</samp></li>

                  <li class="li"><samp class="codeph nolang">Campaign</samp></li>

                  <li class="li"><samp class="codeph nolang">Contact</samp></li>

                  <li class="li"><samp class="codeph nolang">Case</samp></li>

                  <li class="li">Custom Objects (for example, <samp class="codeph nolang">ObjA__c</samp>)</li>

                  <li class="li"><samp class="codeph nolang">Opportunity</samp></li>

                  <li class="li"><samp class="codeph nolang">Order</samp></li>

                  <li class="li"><samp class="codeph nolang">ServiceContract</samp></li>

                  <li class="li"><samp class="codeph nolang">User</samp></li>

                  <li class="li"><samp class="codeph nolang">WorkOrder</samp></li>

                </ul>
                <p class="p">Portal users gain access to all order entitlements and order items under an
                  account to which they have access. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d867894e255" data-title="Field Name"><span class="keyword parmname">userField</span></td>

              <td class="entry" headers="d867894e258" data-title="Field Type">string</td>

              <td class="entry" headers="d867894e261" data-title="Description">Required. The user’s lookup to an account, contact, or a standard or
                custom field derived from an account or contact. Either the user or the
                user’s manager can be used in the lookup. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Account</samp></li>

                  <li class="li"><samp class="codeph nolang">Account.<var class="keyword varname">Field</var></samp></li>

                  <li class="li"><samp class="codeph nolang">Contact</samp></li>

                  <li class="li"><samp class="codeph nolang">Contact.<var class="keyword varname">Field</var></samp></li>

                  <li class="li"><samp class="codeph nolang">Contact.RelatedAccount</samp></li>

                  <li class="li"><samp class="codeph nolang">Manager.Account</samp></li>

                  <li class="li"><samp class="codeph nolang">Manager.Contact</samp></li>

                </ul>
                <p class="p"><samp class="codeph nolang"><var class="keyword varname">Field</var></samp> refers to a
                  standard or custom field based on an account or contact.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SharingSet component that grants users access to all contacts whose ReportsTo fields match the users’ contacts.

<?xml version="1.0" encoding="UTF-8"?>
<SharingSet xmlns="http://soap.sforce.com/2006/04/metadata">
  <accessMappings\>
    <accessLevel\>Read</accessLevel\>
    <objectField\>ReportsTo</objectField\>
    <object\>Contact</object\>
    <userField\>Contact</userField\>
  </accessMappings\>
  <description\>User Access Mapping</description\>
  <name\>User</name\>
  <profiles\>customer community user</profiles\>
</SharingSet\>

The following is an example of a SharingSet component that grants users access to all cases that are related to an entitlement, which is associated with the user’s account.

<?xml version="1.0" encoding="UTF-8"?>
<SharingSet xmlns="http://soap.sforce.com/2006/04/metadata">
  <name\>Case</name\>
   <accessMappings\>
    <accessLevel\>Edit</accessLevel\>
    <objectField\>Entitlement.Account</objectField\>
    <object\>Case</object\>
    <userField\>Account</userField\>
  </accessMappings\>
</SharingSet\>

The following is an example of a SharingSet component with a list of access mappings.

<?xml version="1.0" encoding="UTF-8"?>
<SharingSet xmlns="http://soap.sforce.com/2006/04/metadata">
  <description\>This is a basic sharing set with several access mappings.</description\>
  <name\>Basic</name\>
  <profiles\>customer community user</profiles\>
  <accessMappings\>
    <accessLevel\>Read</accessLevel\>
    <objectField\>Id</objectField\>
    <object\>Account</object\>
    <userField\>Account</userField\>
  </accessMappings\>
  <accessMappings\>
    <accessLevel\>Edit</accessLevel\>
    <objectField\>Account</objectField\>
    <object\>Contact</object\>
    <userField\>Account</userField\>
  </accessMappings\>
  <accessMappings\>
    <accessLevel\>Edit</accessLevel\>
    <objectField\>Contact</objectField\>
    <object\>Case</object\>
    <userField\>Contact</userField\>
  </accessMappings\>
  <accessMappings\>
    <accessLevel\>Read</accessLevel\>
    <objectField\>AccountLookup\_\_c</objectField\>
    <object\>HVPUAccessible\_\_c</object\>
    <userField\>Account</userField\>
  </accessMappings\>
</SharingSet\>

The following is an example package.xml that references the previous definition.

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <fullName\>SharingSetBasic</fullName\>
  <types\>
    <members\>HVPUAccessible\_\_c.AccountLookup\_\_c</members\>
    <members\>HVPUAccessible\_\_c.ContactLookup\_\_c</members\>
    <name\>CustomField</name\>
  </types\>
  <types\>
    <members\>HVPUAccessible\_\_c</members\>
    <name\>CustomObject</name\>
  </types\>
  <types\>
    <members\>Basic</members\>
    <name\>SharingSet</name\>
  </types\>
  <version\>30.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=3f14f71014eb9adf928239095eefaf980b2eac9ce8a6f8f4f2025760be1faa11 url=/legacydeveloper/current/en-us/api_meta/meta_sharingsettings.md -->

# SharingSettings

Represents an organization’s sharing, visibility, and data access settings. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

SharingSettings values are stored in the Sharing.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

SharingSettings

## Special Access Rules

To use SharingSettings, you need the Manage Sharing permission.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d869036e112">Field Name</th>

              <th class="featureTableHeader  " id="d869036e115">Field Type</th>

              <th class="featureTableHeader  " id="d869036e118">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">deferGroupMembership</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether group membership calculations are suspended (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>. This field is available in API version 49.0 and later.<div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                        <div class="mediaBd">
                          <h4 class="mbs">Important</h4>
                          <p>
                          </p><ul class="ul bulletList">
                            <li class="li">The defer sharing calculation feature isn't enabled by default. To enable it
                              for your Salesforce org, contact Salesforce Customer Support.</li>

                            <li class="li">When you change the value of this field from <samp class="codeph nolang">true</samp> to <samp class="codeph nolang">false</samp>, group
                              membership is automatically recalculated. Sharing rules are also automatically
                              recalculated, unless the <span class="keyword parmname">deferSharingRules</span> field is set
                              to <samp class="codeph nolang">true</samp> prior to modifying
                              <span class="keyword parmname">deferGroupMembership</span>. Depending on your org, these
                              recalculations can take a significant amount of time to complete.
                            </li>

                            <li class="li">If the <span class="keyword parmname">deferGroupMembership</span> field is set to <samp class="codeph nolang">true</samp>, you can’t change the value of
                              <span class="keyword parmname">deferSharingRules</span>. Sharing rule calculations are
                              suspended regardless of the value of
                              <span class="keyword parmname">deferSharingRules</span>.
                            </li>

                          </ul>

                          <p></p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">deferSharingRules</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether sharing rule calculations are suspended (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>. This field is available in API version 49.0 and later.<div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                        <div class="mediaBd">
                          <h4 class="mbs">Important</h4>
                          <p>
                          </p><ul class="ul bulletList">
                            <li class="li">The defer sharing calculation feature isn't enabled by default. To enable it
                              for your Salesforce org, contact Salesforce Customer Support.</li>

                            <li class="li">When you change the value of this field from <samp class="codeph nolang">true</samp> to <samp class="codeph nolang">false</samp>, sharing rules
                              are automatically recalculated. Depending on your org, this recalculation can
                              take a significant amount of time to complete. </li>

                            <li class="li">If the <span class="keyword parmname">deferGroupMembership</span> field is set to <samp class="codeph nolang">true</samp>, you can’t change the value of
                              <span class="keyword parmname">deferSharingRules</span>. Sharing rule calculations are
                              suspended regardless of the value of
                              <span class="keyword parmname">deferSharingRules</span>.
                            </li>

                          </ul>

                          <p></p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableAccountRoleOptimization</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether person roles are assigned to new site users in accounts
                without existing users (<samp class="codeph nolang">true</samp>) or if regular
                site roles are created for new users (<samp class="codeph nolang">false</samp>).
                This field has a default value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableAssetSharing</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether sharing is enabled for assets (<samp class="codeph nolang">true</samp>) or asset access is determined by the parent object’s sharing rules
                (<samp class="codeph nolang">false</samp>). This field has a default value of
                <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableCommunityUserVisibility</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether site users in the same site can see each other regardless of
                the organization-wide defaults (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). This field has a default value of
                <samp class="codeph nolang">false</samp>. In orgs created in API version 47.0
                and later, this setting doesn’t apply to guest users.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableExternalSharingModel</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether the external sharing model is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">true</samp> if Salesforce Experiences are enabled, and a default value of
                <samp class="codeph nolang">false</samp> if not. To use this field, you need the
                Customize Application permission.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableKeepManualSharesOnTransfer</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether manual shares on a record are retained (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) when the record is transferred to a new owner. This field is
                available in API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableManagerGroups</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether users can share records with their managers and manager
                subordinates groups (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>. To use this field, you need the View and
                Manage Users permission.</td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableManualUserRecordSharing</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether users can share their own user record (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enablePartnerSuperUserAccess</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether you can grant super user access to partners in sites (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>. To use this field, you need the Customize Application
                permission</td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enablePortalUserCaseSharing</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether portal users can access related contacts for cases that they
                own (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enablePortalUserVisibility</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether portal users in the same customer or partner portal account
                can see each other regardless of the organization-wide defaults (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>. To enable this field, contact Salesforce Support.</td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableRemoveTMGroupMembership</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>


              <td class="entry" headers="d869036e118" data-title="Description">Removes group membership info for the original territory management feature
                after migrating to Sales Territories when set to <samp class="codeph nolang">true</samp>. This field has a default value of <samp class="codeph nolang">false</samp>. Once this field is set to <samp class="codeph nolang">true</samp>, it can't be set to <samp class="codeph nolang">false</samp>
                again.</td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableRestrictAccessLookupRecords</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether users must have read access to a record to see the record’s
                name in lookup and system fields (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). This field has a default value of
                <samp class="codeph nolang">true</samp> in Salesforce orgs created in Spring ’20
                or later and a default value of <samp class="codeph nolang">false</samp> in all
                other orgs. This field is available in API version 48.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableSecureGuestAccess</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">When <samp class="codeph nolang">true</samp>, guest users have org-wide
                defaults set to Private. To share records with them, you must use guest user sharing
                rules.<p class="p">As of API version 50.0, this field's value is always <samp class="codeph nolang">true</samp>, regardless of the value that you set.
                  Changing its value has no effect on Salesforce, even if it reads <samp class="codeph nolang">false</samp>.</p>
                <p class="p">This change applies retroactively back
                  to API version 47.0, when this field was first introduced. Previously, in API
                  version 47.0 to 49.0, this field indicated whether guest users’ record access is
                  secured (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>), and the field's default value was <samp class="codeph nolang">false</samp>. Now, in all API versions, this field's value
                  is always <samp class="codeph nolang">true</samp>, even if it reads <samp class="codeph nolang">false</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableStandardReportVisibility</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether users can view reports based on standard report types that
                may expose data of users to whom they don't have access (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field
                has a default value of <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d869036e112" data-title="Field Name"><span class="keyword parmname">enableTerritoryForecastManager</span></td>

              <td class="entry" headers="d869036e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d869036e118" data-title="Description">Indicates whether forecast managers can act as delegated administrators for
                territories below them in the hierarchy (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). This field has a default value
                of <samp class="codeph nolang">false</samp>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SharingSettings

<?xml version="1.0" encoding="UTF-8"?>
<SharingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <deferGroupMembership\>false</deferGroupMembership\>
    <deferSharingRules\>false</deferSharingRules\>
    <enableAccountRoleOptimization\>false</enableAccountRoleOptimization\>
    <enableAssetSharing\>false</enableAssetSharing\>
    <enableCommunityUserVisibility\>false</enableCommunityUserVisibility\>
    <enableExternalSharingModel\>true</enableExternalSharingModel\>
    <enableKeepManualSharesOnTransfer\>true</enableKeepManualSharesOnTransfer\>
    <enableManagerGroups\>false</enableManagerGroups\>
    <enableManualUserRecordSharing\>true</enableManualUserRecordSharing\>
    <enablePartnerSuperUserAccess\>false</enablePartnerSuperUserAccess\>
    <enablePortalUserCaseSharing\>false</enablePortalUserCaseSharing\>
    <enablePortalUserVisibility\>true</enablePortalUserVisibility\>
    <enableRemoveTMGroupMembership\>false</enableRemoveTMGroupMembership\>
    <enableRestrictAccessLookupRecords\>true</enableRestrictAccessLookupRecords\>
    <enableSecureGuestAccess\>true</enableSecureGuestAccess\>
    <enableStandardReportVisibility\>false</enableStandardReportVisibility\>
    <enableTerritoryForecastManager\>false</enableTerritoryForecastManager\>
</SharingSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Sharing</members\>
        <name\>Settings</name\>
    </types\>   
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=d624659a6d3928a2b74806ef9aef347450050ff432559d59705d7b8d2f0b5687 url=/legacydeveloper/current/en-us/api_meta/meta_sitedotcom.md -->

# SiteDotCom

Represents a site for deployment.

SiteDotCom extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") type and inherits its fullName and content fields.

## Declarative Metadata File Suffix and Directory Location

SiteDotCom components are stored in the siteDotComSites directory of the corresponding package directory.

The file name for the metadata .xml file is \[sitename\]1.site-meta.xml. The file name for the site file is \[sitename\]1.site.

When a Lightning site is created, two sites are made behind the scenes: CustomSite (of type ChatterNetwork) and SiteDotComSite (of type ChatterNetworkPicasso). These sites are named, respectively, _<site\_name>_ and _<site\_name>1_. The corresponding MDAPI file names are _<site\_name>._site-meta.xml and _<site\_name>_1.site-meta.xml. 1 is appended to the SiteDotComSite type to keep the name unique from the corresponding CustomSite site.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

There is a file size limitation when using the Metadata API to deploy a site from sandbox to production. The assets in the .site file can't be larger than 40 MB. The site gets created, but the assets show in the new site as broken. To fix the assets, export the assets from the sandbox environment separately and then import them into your new site.

## Version

SiteDotCom components are available in API version 30.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | The name of the site that you’re deploying. |
| siteType | ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | Required. Identifies whether the site is a ChatterNetworkPicasso site for Experience Cloud Sites, or a Siteforce site for Site.com sites. |

## Declarative Metadata Sample Definition

Here are two examples of a SiteDotCom XML definition.

<?xml version="1.0" encoding="UTF-8"?>
<SiteDotCom xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>testsite</label\>
    <siteType\>Siteforce</siteType\>
</SiteDotCom\>

<?xml version="1.0" encoding="UTF-8"?>
<SiteDotCom xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>testCommunity</label\>
    <siteType\>ChatterNetworkPicasso</siteType\>
</SiteDotCom\>

## Usage

You can only deploy a .site file retrieved in Summer ’19 or later. Older files aren’t supported.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=dc757d79bd0a941bbf5c24710fa6ab50b58bdb6c17cb848f8ae640261a934397 url=/legacydeveloper/current/en-us/api_meta/meta_sitesettings.md -->

# SiteSettings

Represents the settings for Experience Cloud sites and for [Salesforce Sites](https://help.salesforce.com/articleView?id=sites_overview.htm&type=5&language=en_US "HTML (New Window)").

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

SiteSettings values are stored in a single file named Site.settings in the settings directory. The .settings files are different from other named components because there’s only one .settings file for each settings component.

## Version

SiteSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d875588e117">Field Name</th>

              <th class="featureTableHeader  " id="d875588e120">Field Type</th>

              <th class="featureTableHeader  " id="d875588e123">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d875588e117" data-title="Field Name"><span class="keyword parmname">enableEnhancedSitesAndContentPlatform</span></td>

              <td class="entry" headers="d875588e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d875588e123" data-title="Description">Indicates whether the enhanced sites and content platform for Experience Cloud is
                enabled for your org (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). The default is
                <samp class="codeph nolang">true</samp>. When <samp class="codeph nolang">true</samp>, new LWR sites and enhanced
                CMS workspaces are hosted together on a redesigned platform that
                offers partial deployment, site content search, and easy content
                management. <span class="ph">Enhanced LWR sites are
                  represented by the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm" title="Represents a text-based code structure of your organization’s workspaces, organized by workspace type, and each workspace’s content items.">DigitalExperienceBundle</a> and <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperienceconfig.htm" title="Represents details for your organization’s workspaces, such as the site label, site URL path prefix, and workspace type.">DigitalExperienceConfig</a>
                  types.</span> Available in API version 56.0 through 62.0. Removed
                in API version 63.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d875588e117" data-title="Field Name"><span class="keyword parmname">enableExpBuilderCopilot</span></td>

              <td class="entry" headers="d875588e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d875588e123" data-title="Description">Enables Agentforce (beta) in Experience Builder for enhanced LWR
                sites. The default value is <samp class="codeph nolang">false</samp>. Available in API 64.0 and later.<div class="p">
                  <div class="box message info">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p>Agentforce Experience Builder Agent is a pilot or beta
                              service that is subject to the Beta Services Terms at <a class="xref" href="https://www.salesforce.com/company/legal/" target="_blank">Agreements - Salesforce.com</a> or your written
                              Unified Pilot Agreement, and following terms in the <a class="xref" href="https://ptd.salesforce.com/?_ga=2.247987783.1372150065.1709219475-629000709.1639001992" target="_blank">Product
                                Terms Directory: Non-GA Agentforce</a>, the Non-GA
                              Open AI LLM Provider and the Non-GA Credit Consumption. Use
                              of this pilot or beta service consumes Einstein Requests and
                              is at the Customer’s sole discretion.</p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>

                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d875588e117" data-title="Field Name"><span class="keyword parmname">enableExperienceFriendlyUrls</span></td>

              <td class="entry" headers="d875588e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d875588e123" data-title="Description">Indicates whether SEO-friendly URL snippets, or “slugs,” are
                enabled for your org (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). The default is
                <samp class="codeph nolang">false</samp>. When <samp class="codeph nolang">true</samp>, available only in B2C
                Commerce LWR sites. Available only in API version 58.0. In API
                version 59.0 and later, use
                <span class="keyword parmname">expFriendlyUrlsAsDefault</span> in the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_network.htm" title="Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. If you want to create zones that contain Chatter Answers and Ideas, use the Community (Zone) component.">Network</a> type.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d875588e117" data-title="Field Name"><span class="keyword parmname">enableProxyLoginICHeader</span></td>

              <td class="entry" headers="d875588e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d875588e123" data-title="Description">Indicates whether security tokens for API logins from callouts
                (in API version 31.0 and earlier) are required (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d875588e117" data-title="Field Name"><span class="keyword parmname">enableSitesRecordReassignOrgPref</span></td>

              <td class="entry" headers="d875588e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d875588e123" data-title="Description">Deprecated in API version 63.0 and later. When <samp class="codeph nolang">true</samp>, indicates when the org
                assigns records created by guest users of a site to a default owner
                in the org. When <samp class="codeph nolang">false</samp>, the
                guest user remains the owner of the record. The default value is
                <samp class="codeph nolang">false</samp>. Available in API
                version 48.0 through 63.0.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d875588e117" data-title="Field Name"><span class="keyword parmname">enableTopicsInSites</span></td>

              <td class="entry" headers="d875588e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d875588e123" data-title="Description">Indicates whether guest and authenticated external users can view
                topics in Salesforce Sites and Salesforce portals (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is
                <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d875588e117" data-title="Field Name"><span class="keyword parmname">enableVisualforceApiAccessAllowed</span></td>

              <td class="entry" headers="d875588e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d875588e123" data-title="Description">Deprecated in API version 52.0 and later. Allow users of
                Visualforce pages to override API access control restrictions and
                access APIs when the
                <span class="keyword parmname">enableAdminApprovedAppsOnly</span> in
                ConnectedAppSettings is enabled (<samp class="codeph nolang">true</samp>). The default value is <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d875588e117" data-title="Field Name"><span class="keyword parmname">enableWebruntimeBYOTemplate</span></td>

              <td class="entry" headers="d875588e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d875588e123" data-title="Description">Indicates whether the Build Your Own (LWC) template is available
                in Experience Builder. The default value is <samp class="codeph nolang">false</samp>. Available in API version
                48.0 and later. Removed in API version 51.0.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SiteSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<SiteSettings xmlns="http://soap.sforce.com/2006/04/metadata">
     <enableProxyLoginICHeader\>true</enableProxyLoginICHeader\>
     <enableTopicsInSites\>false</enableTopicsInSites\>
</SiteSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Site</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=7a6a711dfb5848e2aadca6e8c9a42a75634efe344776384fa695441713f185fc url=/legacydeveloper/current/en-us/api_meta/meta_skills.md -->

# Skill

Represents the settings for a skill used for field service or to route chats to agents in Chat, such as the name of the skill and which agents the skills are assigned to.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

Skill values are stored in the <developer\_name>.skill file in the skills directory.

## Version

Skill is available in API version 28.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignments | [SkillAssignments](#skillassignments) | Specifies how skills are assigned to Chat users. Skills can be assigned to sets of users or sets of profiles. |
| description | string | Specifies the description of the skill. This field is available in API version 38.0 and later. |
| label | string | Specifies the name of the skill. |
| skillType | string | Specifies the skill type, such as language or department, associated with the skill. This field is available in API version 58.0 and later. |

## SkillAssignments

Represents which users and user profiles to whom specific skills are assigned.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| profiles | [SkillProfileAssignments](#skillprofileassignments) | Specifies the profiles that are associated with a specific skill. |
| users | [SkillUserAssignments](#skilluserassignments) | Specifies the users that are associated with a specific skill. |

## SkillProfileAssignments

Represents the profiles that are associated with a specific skill.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| profile | string | Specifies the custom name of the profile associated with a specific skill. |

## SkillUserAssignments

Represents the users that are associated with a specific skill.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| user | string | Specifies the username of the user associated with a specific skill. |

## Declarative Metadata Sample Definition

This is a sample of a skill file.

<?xml version="1.0" encoding="UTF-8"?>
<Skill xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>My Skill 1</label\>
    <assignments\>
        <profiles\>
            <profile\>LiveAgentOperator</profile\>
            <profile\>LiveAgentSupervisor</profile\>
        </profiles\>
        <users\>
            <user\>jdoe@acme.com</user\>
        </users\>
    </assignments\>
</Skill\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=96a7208ad16953dae695b1e35a838ff8133a75a0d1b226a9c33291b21d6ecc8f url=/legacydeveloper/current/en-us/api_meta/meta_deployment_service_upgrade.md -->

# Slow Deployments

If a file-based Metadata API deployment occurs during server downtime, such as a Salesforce service upgrade, the deployment can take longer than expected. This behavior happens because both component deployment and validation are retried from the beginning after the service is restored. However, if Apex tests were part of the deployment, only tests that weren’t run before the downtime are run.

This behavior affects file-based deployment and retrieval, change sets, some package installs and upgrades, second-generation managed package creation, and deploys and retrieves started from the Salesforce CLI or the Salesforce VS Code extensions. It doesn’t affect CRUD-based metadata operations.

If your instance is due for a planned service upgrade, avoid running deployments during the service upgrade. To check whether your Salesforce instance is due for an upgrade, check Salesforce Trust. Salesforce performs major service upgrades three times per year and other maintenance updates throughout the year.

<!-- document id=5ea9a9fae311e824e03b71526b5eb2d60abb5d49703730016f9acb4574786c86 url=/legacydeveloper/current/en-us/api_meta/meta_socialcustomerservicesettings.md -->

# SocialCustomerServiceSettings

Represents Social Customer Service settings such as how to format inbound content from social posts to cases. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

SocialCustomerServiceSettings components have the suffix settings and are stored in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

SocialCustomerServiceSettings is available in API version 41.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d877501e100">Field Name</th>

              <th class="featureTableHeader  " id="d877501e103">Field Type</th>

              <th class="featureTableHeader  " id="d877501e106">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d877501e100" data-title="Field Name"><span class="keyword parmname">caseSubjectOption</span></td>

              <td class="entry" headers="d877501e103" data-title="Field Type">CaseSubjectOption (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d877501e106" data-title="Description">Required. Specifies an option from which inbound social content
                is formatted to appear in case records’ <strong class="ph uicontrol">Case
                  Subject</strong> field. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">SocialPostSource</samp></li>

                  <li class="li"><samp class="codeph nolang">SocialPostContent</samp></li>

                  <li class="li"><samp class="codeph nolang">BuildCustom</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d877501e100" data-title="Field Name"><span class="keyword parmname">enableAllFBResponseAccounts</span></td>

              <td class="entry" headers="d877501e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d877501e106" data-title="Description">Indicates whether responses from all Facebook managed accounts
                are enabled. If this setting is disabled, responses to a Facebook
                post can only be sent from the account that the original customer
                post was directed to. The default value is <samp class="codeph nolang">true</samp>. Available in API version 56.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d877501e100" data-title="Field Name"><span class="keyword parmname">enableSocialApprovals</span></td>

              <td class="entry" headers="d877501e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d877501e106" data-title="Description">Indicates whether social approvals are enabled. To learn more,
                see <a class="xref" href="https://help.salesforce.com/articleView?id=social_customer_service_approvals.htm&amp;language=en_US" target="_blank">Enable Social Post
                  Approvals</a>.The default value is <samp class="codeph nolang">false</samp>. Available in API version
                47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d877501e100" data-title="Field Name"><span class="keyword parmname">enableSocialCaseAssignmentRules</span></td>

              <td class="entry" headers="d877501e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d877501e106" data-title="Description">Indicates whether case assignment rules are enabled. Use case
                assignment rules to determine how cases are assigned to users or put
                into queues as they are created. The default value is <samp class="codeph nolang">false</samp>. Available in API version
                47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d877501e100" data-title="Field Name"><span class="keyword parmname">enableSocialCustomerService</span></td>

              <td class="entry" headers="d877501e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d877501e106" data-title="Description">Indicates whether to enable the Social Customer Service feature.
                The default value is <samp class="codeph nolang">false</samp>.
                Available in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d877501e100" data-title="Field Name"><span class="keyword parmname">enableSocialPersonaHistoryTracking</span></td>

              <td class="entry" headers="d877501e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d877501e106" data-title="Description">Indicates whether to enable Social Persona history tracking.
                History tracking helps identify who made what changes when, and for
                differentiating between automatic and manual changes. The default
                value is <samp class="codeph nolang">false</samp>. Available in
                API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d877501e100" data-title="Field Name"><span class="keyword parmname">enableSocialPostHistoryTracking</span></td>

              <td class="entry" headers="d877501e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d877501e106" data-title="Description">Indicates whether to enable Social Post history tracking. History
                tracking helps identify who made what changes when, and for
                differentiating between automatic and manual changes. The default
                value is <samp class="codeph nolang">false</samp>. Available in
                API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d877501e100" data-title="Field Name"><span class="keyword parmname">enableSocialReceiveParentPost</span></td>

              <td class="entry" headers="d877501e103" data-title="Field Type">boolean</td>

              <td class="entry" headers="d877501e106" data-title="Description">Indicates whether to use the original social post that initiated
                the case as the parent record. The default value is <samp class="codeph nolang">false</samp>. Available in API version
                47.0 and later.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This is a sample of a SocialCustomerServiceSettings.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<SocialCustomerServiceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <caseSubjectOption\>SocialPostSource</caseSubjectOption\>
    <enableSocialApprovals\>true</enableSocialApprovals\>
    <enableSocialCaseAssignmentRules\>false</enableSocialCaseAssignmentRules\>
    <enableSocialCustomerService\>true</enableSocialCustomerService\>
    <enableSocialPersonaHistoryTracking\>false</enableSocialPersonaHistoryTracking\>
    <enableSocialPostHistoryTracking\>false</enableSocialPostHistoryTracking\>
    <enableSocialReceiveParentPost\>true</enableSocialReceiveParentPost\>
</SocialCustomerServiceSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>SocialCustomerService</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=cd6078458eb236b8a03d8add11f99c4e9ab0edfba7551084e700314004103d8e url=/legacydeveloper/current/en-us/api_meta/meta_socialprofilesettings.md -->

# SocialProfileSettings

Represents org preferences for social media features such as enabling Twitter and Facebook.Represents org preferences for social media features such as enabling Twitter and Facebook. This type extends the Metadata metadata type and inherits the fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

SocialProfileSettings values are stored in a single file named SocialProfile.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

SocialProfileSettings is available in API versions 47.0 through 58.0.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d878336e102">Field Name</th>

              <th class="featureTableHeader  " id="d878336e105">Field Type</th>

              <th class="featureTableHeader  " id="d878336e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d878336e102" data-title="Field Name"><span class="keyword parmname">isFacebookSocialProfilesDisabled</span></td>

              <td class="entry" headers="d878336e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d878336e108" data-title="Description">Prevents users from accessing Facebook in social CRM (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                <span class="keyword parmname">enableSocialProfiles</span> must be <samp class="codeph nolang">true</samp> to enable Facebook social
                profiles.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d878336e102" data-title="Field Name"><span class="keyword parmname">isLinkedInSocialProfilesDisabled</span></td>

              <td class="entry" headers="d878336e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d878336e108" data-title="Description">Prevents users from accessing LinkedIn in social CRM (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                <span class="keyword parmname">enableSocialProfiles</span> must be <samp class="codeph nolang">true</samp> to enable LinkedIn social
                profiles.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d878336e102" data-title="Field Name"><span class="keyword parmname">isTwitterSocialProfilesDisabled</span></td>

              <td class="entry" headers="d878336e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d878336e108" data-title="Description">Prevents users from accessing Twitter in social CRM (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                <span class="keyword parmname">enableSocialProfiles</span> must be <samp class="codeph nolang">true</samp> to enable Twitter social
                profiles.<p class="p">This setting is permanently set to True because
                  Twitter access was removed in API version 59.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d878336e102" data-title="Field Name"><span class="keyword parmname">isYouTubeSocialProfilesDisabled</span></td>

              <td class="entry" headers="d878336e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d878336e108" data-title="Description">Prevents users from accessing YouTube in social CRM (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).
                <span class="keyword parmname">enableSocialProfiles</span> must be <samp class="codeph nolang">true</samp> to enable YouTube social
                profiles.<p class="p">This setting is permanently set to True because
                  YouTube access was removed in API version 60.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d878336e102" data-title="Field Name"><span class="keyword parmname">enableSocialProfiles</span></td>

              <td class="entry" headers="d878336e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d878336e108" data-title="Description">Indicates whether users can access social media profiles in
                social CRM (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=e85f26ae3238c75dd853597b114ff3afa3a86479ef45ea821756809f8eaeb007 url=/legacydeveloper/current/en-us/api_meta/meta_sourcetrackingsettings.md -->

# SourceTrackingSettings (Beta)

Represents settings for source tracking, so that changes you make in your Developer and Developer Pro sandboxes or local workspace can be tracked. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

SourceTrackingSettings values are stored in the SourceTracking.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

SourceTrackingSettings is available in API version 49.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d878955e102">Field Name</th>

              <th class="featureTableHeader  " id="d878955e105">Field Type</th>

              <th class="featureTableHeader  " id="d878955e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d878955e102" data-title="Field Name"><span class="keyword parmname">enableSourceTrackingSandboxes</span></td>

              <td class="entry" headers="d878955e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d878955e108" data-title="Description">Indicates whether to enable source tracking automatically when Developer or
                Developer Pro sandboxes are created or refreshed (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                value is <samp class="codeph nolang">false</samp>.<p class="p">If you set
                  <span class="keyword parmname">enableSourceTrackingSandboxes</span> back to <samp class="codeph nolang">false</samp> after it was enabled, a sandbox that is
                  tracking source changes continues to do so until it is refreshed.
                </p>
                <div class="p">
                  <div class="box message info">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p>You don't need to have the Developer Hub (DevHub) enabled in the same org to
                              enable source tracking.</p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>

                </div>
                <p class="p">This field applies to production orgs only; in other orgs, this field is
                  ignored.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SourceTrackingSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<SourceTrackingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableSourceTrackingSandboxes\>true</enableSourceTrackingSandboxes\>
</SourceTrackingSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=7e792f1804f89284745b423d512dc241bc106c46a2fcc6c443837a1c463d786b url=/legacydeveloper/current/en-us/api_meta/meta_special_behavior.md -->

# Special Behavior in Metadata API Deployments

Important considerations for specific types and contents of a deployment.

Use the information here to determine what to include in your deployment and how the changes appear in the destination.

[Special Behavior in Deployments](https://help.salesforce.com/s/articleView?id=platform.deploy_special_behavior.htm&type=5&language=en_US)

<!-- document id=b04ffd4443973c0929ed2d94c7063e92f2b7c265ba510a0e6499a09d57b29f8c url=/legacydeveloper/current/en-us/api_meta/meta_stageassignment.md -->

# StageAssignment

Represents a collection of fields to automatically assign stage definitions to records based on rule criteria.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

StageAssignment components have the suffix .stageAssignment and are stored in the stageAssignments folder.

## Version

StageAssignment components are available in API version 64.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| active | 
Field Type

boolean

Description

Required. Indicates whether the stage assignment rule is active (true) or not (false). The default value is true. Active rules are evaluated when determining stage definition assignments.





 |
| description | 

Field Type

string

Description

Description for the stage assignment rule.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for the stage assignment rule, which is defined when the metadata component is created.





 |
| referenceObject | 

Field Type

string

Description

Required. Reference object that's associated with the stage assignment rule. This is the API name of the Salesforce object for which the stage assignment rule applies (for example, ApplicationForm or Order).





 |
| referenceObjectRecordType | 

Field Type

string

Description

Record type of a reference object that's associated with the stage assignment rule. When specified, the assignment rule applies only to records of the specified record type.



 |
| ruleCriteria | 

Field Type

[StgAssignmentRuleCriteria\[\]](#StgAssignmentRuleCriteria)

Description

Collection of rule criteria to determine stage definition assignment. Rules are evaluated in priority order, and the first matching rule determines which stage definition is assigned to the record.



 |
| stageDefinition | 

Field Type

string

Description

Default stage definition to assign when no rule criteria match. This provides a fallback assignment when none of the defined rule criteria evaluate to true.



 |

## StgAssignmentRuleCriteria

Represents a collection of fields to define rule criteria for stage definition assignment. Rule criteria are evaluated in priority order, with lower priority numbers evaluated first.

| Field Name | Description |
| --- | --- |
| condition | 
Field Type

[StgAssignmentRuleCond\[\]](#StgAssignmentRuleCond)

Description

Collection of conditions to evaluate for this rule criteria. You can combine multiple conditions by using the criteriaType field to determine the overall evaluation result.



 |
| criteriaType | 

Field Type

StageCriteriaType (enumeration of type string)

Description

Required. Specifies the criteria type that's used to evaluate the rule conditions. Valid values are:

- AND
- CUSTOMLOGIC
- OR





 |
| logicalExpression | 

Field Type

string

Description

Formula to specify custom logic for evaluating conditions. It's used when criteriaType is set to CUSTOMLOGIC.



 |
| name | 

Field Type

string

Description

Required. Name of the rule criteria.





 |
| priority | 

Field Type

int

Description

Required. Priority order for evaluating this rule criteria when multiple criteria are defined.

Rules are evaluated in ascending priority order where lower numbers have higher priority. For example, a rule with priority 1 is evaluated before a rule with priority 2. The first rule that evaluates to true determines the stage definition assignment.





 |
| stageDefinition | 

Field Type

string

Description

Required. Stage definition to assign when this rule criteria matches. This must be the API name of a valid StageDefinition for the same reference object.





 |

## StgAssignmentRuleCond

Represents a collection of fields to define individual condition rules for stage assignment rule criteria. Each condition compares a field value against a specified value using a comparison operator.

| Field Name | Description |
| --- | --- |
| fieldName | 
Field Type

string

Description

Required. API name of the field to evaluate for this condition.





 |
| operator | 

Field Type

StageConditionOperator (enumeration of type string)

Description

Required. Operator that's used to evaluate the field value. Valid values are:

- Contains
- DoesNotContain
- Equals
- GreaterOrEqual
- GreaterThan
- LessOrEqual
- LessThan
- NotEqualTo
- StartsWith





 |
| sequenceNumber | 

Field Type

int

Description

Required. Specifies the sequence number of this condition for reference in logical expressions.

The sequence number is used in the logicalExpression field to create custom boolean logic. For example, a condition with sequenceNumber 1 is referenced as "1" in the expression "1 AND 2".





 |
| value | 

Field Type

string

Description

Required. Defines the value to compare against the field value.

The value is specified as a string regardless of the field type. For example, numeric values are specified as "10000", dates as "2025-10-27", and text values as "Approved".





 |

## Usage

StageAssignment works in conjunction with StageDefinition to provide automated stage management. While StageDefinition defines the stages, transitions, and workflows, StageAssignment determines which stage definition to apply to a record based on rule criteria.

Evaluation Process:

- When a record is created or updated, the system evaluates active StageAssignment rules for the object.
- Rule criteria are evaluated in priority order where lower numbers have higher priority.
- The first rule criteria that evaluates to true determines the stage definition assignment.
- If no rule criteria matches, the default stageDefinition from the StageAssignment is used.
- The assigned stage definition governs the stage behavior for that record.

Use Cases:

- Value-based Assignment—Assign different stage definitions based on transaction amounts. For example, premium stages for high-value applications.
- Type-based Assignment—Use different stage workflows for different record types.
- Status-based Assignment—Apply specific stage definitions based on record status or classification.
- Complex Criteria—Combine multiple conditions to create sophisticated assignment rules.

## Declarative Metadata Sample Definition

The following is an example of a StageAssignment component.

<?xml version="1.0" encoding="UTF-8"?>
<StageAssignment xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>true</active\>
    <description\>Assigns stage definitions to applications based on amount</description\>
    <masterLabel\>Application Stage Assignment</masterLabel\>
    <referenceObject\>ApplicationForm</referenceObject\>
    <ruleCriteria\>
        <name\>High Value Applications</name\>
        <priority\>1</priority\>
        <criteriaType\>AND</criteriaType\>
        <condition\>
            <fieldName\>Amount</fieldName\>
            <operator\>GreaterThan</operator\>
            <sequenceNumber\>1</sequenceNumber\>
            <value\>10000</value\>
        </condition\>
        <condition\>
            <fieldName\>Status</fieldName\>
            <operator\>Equals</operator\>
            <sequenceNumber\>2</sequenceNumber\>
            <value\>Approved</value\>
        </condition\>
        <stageDefinition\>Premium\_Application\_Stages</stageDefinition\>
    </ruleCriteria\>
    <ruleCriteria\>
        <name\>Standard Applications</name\>
        <priority\>2</priority\>
        <criteriaType\>AND</criteriaType\>
        <condition\>
            <fieldName\>Amount</fieldName\>
            <operator\>LessOrEqual</operator\>
            <sequenceNumber\>1</sequenceNumber\>
            <value\>10000</value\>
        </condition\>
        <stageDefinition\>Standard\_Application\_Stages</stageDefinition\>
    </ruleCriteria\>
    <stageDefinition\>Basic\_Application\_Stages</stageDefinition\>
</StageAssignment\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>StageAssignment</name\>
    </types\>
    <version\>64.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=f8309fb66cb61cda8d3315d40c627333ed9b8b432a3b0dc1fb632d946c6d2043 url=/legacydeveloper/current/en-us/api_meta/meta_stagedefinition.md -->

# StageDefinition

Represents a collection of fields to set up the states and transitions for Stage Management.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

StageDefinition components have the suffix .stageDefinition and are stored in the stageDefinitions folder.

## Version

StageDefinition components are available in API version 62.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| active | 
Field Type

boolean

Description

Required. Indicates whether the stage definition is active (true) or not (false).





 |
| description | 

Field Type

string

Description

The description of the stage definition.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for stage definition, which is defined when the metadata component is created.





 |
| referenceObject | 

Field Type

string

Description

Required. The reference object associated with the stage definition.





 |
| referenceObjectField | 

Field Type

string

Description

Required. The name of the field in the reference object used to define stages.





 |
| referenceObjectRecordType | 

Field Type

string

Description

The record type of a reference object associated with the stage definition.



 |
| stageTransition | 

Field Type

[StageTransition\[\]](#StageTransition)

Description

A collection of fields to set up transitions between two states.



 |
| stageValue | 

Field Type

[StageValue\[\]](#StageValue)

Description

A collection of fields to set up the field values of an object for which stages are defined.



 |

## StageTransition

Represents a collection of fields to set up transitions between two states.

| Field Name | Description |
| --- | --- |
| criteria | 
Field Type

[StageCriteria\[\]](#StageCriteria)

Description

A collection of fields to set up the criteria for the object stage transition and object stage change.



 |
| customPermission | 

Field Type

string

Description

The custom permission associated with the stage transition. The custom permission required to initiate a stage change.



 |
| fromStageValue | 

Field Type

string

Description

Required. The From Stage that's associated with the referenced object's stage transition.





 |
| stepGroup | 

Field Type

[StgFulfillmentStepDefGrp\[\]](#StgFulfillmentStepDefGrp)

Description

A collection of fields to set up the stage fulfillment step definition.



 |
| toStageValue | 

Field Type

string

Description

Required. The To Stagethat's associated with the referenced object's stage transition.





 |
| userPermission | 

Field Type

StageUserPermission (enumeration of type string)

Description

Specifies the type of user permission needed to initiate a stage change.

Values are:

- CoordinateClinicalTrials
- CoordinateClnclTrialExprcUsr
- ManageClinicalTrials
- ParticipateClinicalTrials
- ProcessOrder





 |

## StageCriteria

Represents a collection of fields to set up the criteria for the object stage transition and object stage change.

| Field Name | Description |
| --- | --- |
| condition | 
Field Type

[StageCondition\[\]](#StageCondition)

Description

A collection of fields to set up the rules in transition criteria and stage change, including the object state, logic, and values.



 |
| criteriaType | 

Field Type

StageCriteriaType (enumeration of type string)

Description

Specifies the criteria type used to execute the transition.

Values are:

- AND
- CUSTOMLOGIC
- OR





 |
| errorMessage | 

Field Type

string

Description

A custom error message that's displayed when stage transition criteria evaluation fails.

Available in API version 64.0 and later.





 |
| executionType | 

Field Type

StageCriteriaExecType (enumeration of type string)

Description

Required. Specifies the type of logic used to execute the criteria.

Values are:

- CONDITION
- FLOW





 |
| flowDefinitionName | 

Field Type

string

Description

Specifies the developer name of the Flow that executes when the criteria execution type is set to FLOW.

Available in API version 63.0 and later.





 |
| isChildObject | 

Field Type

boolean

Description

Indicates whether the target object in the stage criteria represents a child object in a parent-child relationship (true) or not (false).

Available in API version 63.0 and later.





 |
| logicalExpression | 

Field Type

string

Description

Formula to specify custom logic. Compares the Criteria field to the Value field.





 |
| targetFieldName | 

Field Type

string

Description

Specifies the field name on the target object that's used in the stage transition criteria evaluation.

Available in API version 63.0 and later.





 |
| targetObject | 

Field Type

string

Description

Object that's used in a Parent-Child object relationship condition.





 |

## StageCondition

Represents a collection of fields to set up the rules in transition criteria and stage change, including the object state, logic, and values.

| Field Name | Description |
| --- | --- |
| operator | 
Field Type

StageConditionOperator (enumeration of type string)

Description

Required. Specifies the operator used in the transition criteria.

Values are:

- Contains
- DoesNotContain
- Equals
- GreaterOrEqual
- GreaterThan
- LessOrEqual
- LessThan
- NotEqualTo
- StartsWith





 |
| sequenceNumber | 

Field Type

int

Description

Required. Specifies the order of the object state transition condition in a sequence.





 |
| sourceField | 

Field Type

string

Description

Required. The object field to define filter conditions.





 |
| value | 

Field Type

string

Description

Required. Value of the field used in the transition criteria.





 |

## StgFulfillmentStepDefGrp

Represents a collection of fields to set up the stage fulfillment step definition.

| Field Name | Description |
| --- | --- |
| name | 
Field Type

string

Description

Required. The name of the stage fulfillment step definition group.





 |
| step | 

Field Type

[StgFulfillmentStepDef\[\]](#StgFulfillmentStepDef)

Description

A collection of fields to set up fullfillment step definitions for stages and transitions.



 |

## StgFulfillmentStepDef

Represents a collection of fields to set up fullfillment step definitions for stages and transitions.

| Field Name | Description |
| --- | --- |
| apiName | 
Field Type

string

Description

Required. The developer name of the stage fulfillment step definition.





 |
| assignedToQueue | 

Field Type

string

Description

The queue associated with the stage fulfillment step definition.



 |
| assignedToUser | 

Field Type

string

Description

The user associated with the stage fulfillment step definition.



 |
| dependency | 

Field Type

[StgFulfillmentStepDpndDef\[\]](#StgFulfillmentStepDpndDef)

Description

A collection of fields to set up the stage fulfillment step dependency between two steps.



 |
| executeOnRule | 

Field Type

string

Description

Specifies the expression set for the fulfillment step. The step is executed only when the corresponding expression set is set to true.

Available in API version 62.0 and later.





 |
| flowDefinitionName | 

Field Type

string

Description

The name of the flow added to the step definition.



 |
| integrationDefinitionName | 

Field Type

string

Description

The ID associated with the integration provider definition.



 |
| name | 

Field Type

string

Description

Required. The name of the stage fulfillment step definition.





 |
| omniscriptName | 

Field Type

string

Description

The name of the Omniscript defined in step definition.



 |
| runAsUser | 

Field Type

string

Description

The ID of the user associated with the step definition. The user required to execute the step definition.



 |
| stepType | 

Field Type

string

Description

Required. Specifies the type of fulfillment step.





 |

## StgFulfillmentStepDpndDef

Represents a collection of fields to set up the stage fulfillment step dependency between two steps.

| Field Name | Description |
| --- | --- |
| step | 
Field Type

string

Description

Required. The step definition for the fulfillment step.





 |

## StageValue

Represents a collection of fields to set up the field values of an object for which stages are defined.

| Field Name | Description |
| --- | --- |
| criteria | 
Field Type

[StageCriteria\[\]](#StageCriteria)

Description

A collection of fields to set up the criteria for the object stage transition and object stage change.



 |
| stepGroup | 

Field Type

[StgFulfillmentStepDefGrp\[\]](#StgFulfillmentStepDefGrp)

Description

A collection of fields to set up the stage fulfillment step definition.



 |
| value | 

Field Type

string

Description

Required. The value of the field used in the transition criteria.





 |

## Declarative Metadata Sample Definition

The following is an example of a StageDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<StageDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <active\>false</active\>
    <description\>Application form Stage transitions</description\>
    <masterLabel\>basic</masterLabel\>
    <referenceObject\>ApplicationForm</referenceObject\>
    <referenceObjectField\>Stage</referenceObjectField\>
    <stageTransition\>
        <criteria\>
            <condition\>
                <operator\>Equals</operator\>
                <sequenceNumber\>1</sequenceNumber\>
                <sourceField\>ApplicationForm.Name</sourceField\>
                <value\>test</value\>
            </condition\>
            <criteriaType\>AND</criteriaType\>
            <executionType\>CONDITION</executionType\>
            <logicalExpression\>1</logicalExpression\>
            <targetObject\>ApplicationForm</targetObject\>
        </criteria\>
        <userPermission\>ProcessOrder</userPermission\>
        <fromStageValue\>Initiated</fromStageValue\>
        <toStageValue\>On Hold</toStageValue\>
        <stepGroup\>
            <name\>Initiated-On Hold</name\>
            <step\>
                <apiName\>Autotask\_step\_defn</apiName\>
                <flowDefinitionName\>disputemanagement\_\_InvokeAsyncAction</flowDefinitionName\>
                <name\>Autotask step defn</name\>
                <runAsUser\>testuser@salesforce.com</runAsUser\>
                <stepType\>AutoTask</stepType\>
            </step\>
            <step\>
                <apiName\>testScreenFlow</apiName\>
                <assignedToUser\>testuser@salesforce.com</assignedToUser\>
                <flowDefinitionName\>cms\_orch\_\_CMS\_NotifyRequester</flowDefinitionName\>
                <name\>testScreenFlow</name\>
                <stepType\>ManualTask</stepType\>
                <dependency\>
                   <step\>Autotask\_step\_defn</step\>
                </dependency\>
            </step\>
        </stepGroup\>
    </stageTransition\>
    <stageValue\>
        <value\>Initiated</value\>
        <criteria\>
            <condition\>
                <operator\>Equals</operator\>
                <sequenceNumber\>1</sequenceNumber\>
                <sourceField\>ApplicationForm.Name</sourceField\>
                <value\>test</value\>
            </condition\>
            <criteriaType\>AND</criteriaType\>
            <executionType\>CONDITION</executionType\>
            <logicalExpression\>1</logicalExpression\>
            <targetObject\>ApplicationForm</targetObject\>
        </criteria\>
        <stepGroup\>
            <name\>Initiated</name\>
            <step\>
                <apiName\>Autotask\_step\_defn</apiName\>
                <flowDefinitionName\>disputemanagement\_\_InvokeAsyncAction</flowDefinitionName\>
                <name\>Autotask step defn</name\>
                <runAsUser\>testuser@salesforce.com</runAsUser\>
                <stepType\>AutoTask</stepType\>
            </step\>
            <step\>
                <apiName\>testScreenFlow</apiName\>
                <assignedToUser\>testuser@salesforce.com</assignedToUser\>
                <flowDefinitionName\>cms\_orch\_\_CMS\_NotifyRequester</flowDefinitionName\>
                <name\>testScreenFlow</name\>
                <stepType\>ManualTask</stepType\>
                <dependency\>
                    <step\>Autotask\_step\_defn</step\>
                </dependency\>
            </step\>
        </stepGroup\>
    </stageValue\>
    <stageValue\>
        <value\>On Hold</value\>
    </stageValue\>
</StageDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>StageDefinition</name\>
    </types\>
    <version\>62.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=16189189fe299a2e363ffff832a2076443b6a1fcbc8143ee1371f4f2e420ce37 url=/legacydeveloper/current/en-us/api_meta/meta_standards.md -->

# Standards Compliance

Metadata API is implemented to comply with the following specifications:

| Standard Name | Website |
| --- | --- |
| Simple Object Access Protocol (SOAP) 1.1 | [http://www.w3.org/TR/2000/NOTE-SOAP-20000508/](http://www.w3.org/TR/2000/NOTE-SOAP-20000508/) |
| Web Service Description Language (WSDL) 1.1 | [http://www.w3.org/TR/2001/NOTE-wsdl-20010315](http://www.w3.org/TR/2001/NOTE-wsdl-20010315) |
| WS-I Basic Profile 1.1 | [http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html](http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html) |
| Extensible Markup Language (XML) 1.0 | [https://www.w3.org/TR/xml](https://www.w3.org/TR/xml) |

<!-- document id=8c602fb74752948c75382b53e2a1e2f795d6c75d5424c23c37fb8b64184f0cab url=/legacydeveloper/current/en-us/api_meta/meta_standardvalueset.md -->

# StandardValueSet

Represents the set of values in a standard picklist field. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

StandardValueSet components have the suffix .standardValueSet and are stored in the standardValueSets folder.

## Version

StandardValueSet components are available in API version 38.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d879295e84">Field Name</th>

              <th class="featureTableHeader  " id="d879295e87">Field Type</th>

              <th class="featureTableHeader  " id="d879295e90">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d879295e84" data-title="Field Name"><span class="keyword parmname" id="groupingStringEnum"><a name="groupingStringEnum"><!-- --></a>groupingStringEnum</span></td>

              <td class="entry" headers="d879295e87" data-title="Field Type">string</td>

              <td class="entry" headers="d879295e90" data-title="Description">Groups picklist and enumerated values. For example, for the picklist values of
                the <span class="keyword parmname">Status</span> field on the Service Appointment object, <samp class="codeph nolang">Done</samp> and <samp class="codeph nolang">Finished</samp> can both have a grouping string of <samp class="codeph nolang">Completed</samp>. Available in API version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d879295e84" data-title="Field Name"><span class="keyword parmname">sorted</span></td>

              <td class="entry" headers="d879295e87" data-title="Field Type">boolean</td>

              <td class="entry" headers="d879295e90" data-title="Description">Required. Indicates whether a global value set is sorted in alphabetical order.
                By default, this value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d879295e84" data-title="Field Name"><span class="keyword parmname" id="field_standardValue"><a name="field_standardValue"><!-- --></a>standardValue</span></td>

              <td class="entry" headers="d879295e87" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customvalue.htm#standardvalue">StandardValue[]</a></td>

              <td class="entry" headers="d879295e90" data-title="Description">Defines each value in a standard picklist’s value set. The
                <span class="keyword parmname">groupingString</span> value is available in API version 38.0 and
                later. <p class="p">When you deploy a StandardValueSet, this array must contain at least one
                  picklist value. Otherwise, you receive an error.</p>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>When setting
                            <span class="keyword parmname">standardValue</span> on Record Types, including person account
                            record types, new picklist values loaded into your organization through the
                            Metadata API don’t display in the picklist UI by default. For users to see the new
                            values, go to the Record Types list for the object containing the picklist field,
                            click <strong class="ph uicontrol">Edit</strong>, and add the new value to the Selected Fields
                            list.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following example shows a StandardValueSet component that’s defined as the Stage standard picklist on a customized opportunity object.

<?xml version="1.0" encoding="UTF-8"?>
<StandardValueSet xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName>OpportunityStage</fullName> <!-- Enum name -->
    <standardValue>
       <fullName>Closed Abandoned</fullName>
    </standardValue>
    <standardValue>
       <fullName>Closed Won</fullName>
    </standardValue>
    <standardValue>
       <fullName>Closed Lost</fullName>
    </standardValue>
</StandardValueSet>

<CustomObject>
    <fullName>Opportunity</fullName>
    <fields>
       <fullName>StageName</fullName> <!-- field name -->
       <label>Stage</label>
       <type>Picklist</type>
    </fields>
    <label>ObjectWithValueSet</label>
    <pluralLabel>ObjectWithValueSet</pluralLabel>
    <sharingModel>ReadWrite</sharingModel>
</CustomObject>

    

For a list of standard value set names for standard picklists, see [StandardValueSet Names and Standard Picklist Fields](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/standardvalueset_names.htm "In API version 38.0 and later, standard picklists are represented by the StandardValueSet type. In previous versions, standard picklists are represented by the CustomField type. This table lists the names of standard picklists as standard value sets and their corresponding field names.").

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=fc5720fb43f953ab960d836f087e6a0ba3e93c2c6be98dc571d1b6b6ec407365 url=/legacydeveloper/current/en-us/api_meta/standardvalueset_names.md -->

# StandardValueSet Names and Standard Picklist Fields

In API version 38.0 and later, standard picklists are represented by the StandardValueSet type. In previous versions, standard picklists are represented by the CustomField type. This table lists the names of standard picklists as standard value sets and their corresponding field names.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The names of standard value sets and picklist fields are case-sensitive.

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d3677e51">Standard Value Set Name (API version 38.0 and later)</th>

              <th class="featureTableHeader  " id="d3677e54">Field Name (API version 37.0 and earlier)</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccPlanObjectivePriority</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AccountPlanObjective.Priority</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccPlanObjectiveStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AccountPlanObjective.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AAccreditationRating<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Accreditation.AccreditationRating<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccountContactMultiRoles</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AccountContactRelation.Roles</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccountContactRole</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AccountContactRole.Role</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccountOwnership</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Account.Ownership<p class="p">AccountCleanInfo.Ownership</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccountPlanStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AccountPlan.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccountRating</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Account.Rating<p class="p">Lead.Rating</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccountType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Account.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccreditationAccreditingBody<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Accreditation.AccreditingBody<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccreditationStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Accreditation.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccreditationSubType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Accreditation.SubType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AccreditationType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Accreditation.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ACInitSumEmployeeType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AntiCorruptionInitSum.EmployeeType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ACInitSumInitiativeType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AntiCorruptionInitSum.InitiativeType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ACISumRecipientCategory<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AntiCorruptionInitSum.RecipientCategory<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ACorruptionInitSumCountry<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AntiCorruptionInitSum.Country<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ACorruptionInitSumRegion<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AntiCorruptionInitSum.Region<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ActivityTimeEnum<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ActivityTiming.ActivityTime<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AdmissionSource<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.AdmissionSource<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AdmissionType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.AdmissionType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AFSIType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormSellerItem.Type<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AFSIBuiltUpAreaUnit<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormSellerItem.BuiltUpAreaUnit<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AFSIConstructionStage<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormSellerItem.ConstructionStage<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AFSIIntendedUse<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormSellerItem.IntendedUse<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AFSIItemCondition<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormSellerItem.ItemCondition<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AllergyIntoleranceCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AllergyIntolerance.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AllergyIntoleranceSeverity<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AllergyIntolerance.Severity<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AllergyIntoleranceStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AllergyIntolerance.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AllergyIntoleranceType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AllergyIntolerance.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AllergyVerificationStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AllergyIntolerance.VerificationStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AppealRequestReasonType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.AppealRequestReasonType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AppFormProductDisbursement<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProduct.DisbursementMethod<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationActionItemType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationActionItem.Type<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationActionItemStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationActionItem.Status<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicantPhoneType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Applicant.PhoneType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicantStage<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Applicant.Stage<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicantRole<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Applicant.Role<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicantSalutation<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Applicant.Salutation<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicantBusinessEntityType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Applicant.BusinessEntityType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormStage<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationForm.Stage<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductApplicantVisibleStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProduct.ApplicantVisibleStatus<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormIntakeChannelType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationForm.IntakeChannelType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductFeeType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProductFee.FeeType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductLoanPurpose<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProduct.LoanPurpose<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductLoanType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProduct.LoanType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductOwnership<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProduct.OwnershipType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductPartnerVisibleStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProduct.PartnerVisibleStatus<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductProposalStage<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProductProposal.Stage<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductProposalSelectedBy<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProductProposal.SelectedBy<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductProposalInterestRateType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProductProposal.InterestRateType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormProductStage<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationFormProduct.Stage<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApplicationFormTierType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ApplicationForm.TierType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ApprovedLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.ApprovedLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">APTCategoryEnum</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ActionPlanTemplate.Category</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">APTSubcategoryEnum</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ActionPlanTemplate.Subcategory</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">APTSourceTypeEnum</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ActionPlanTemplate.SourceType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AQuestionQuestionCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AssessmentQuestion.QuestionCategory</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AReasonAppointmentReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AppointmentReason.AppointmentReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AssessmentRating</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Assessment.AssessmentRating</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AssessmentStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Assessment.AssessmentStatus</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AssetActionCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AssetAction.Category</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AssetRelationshipType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AssetRelationship.RelationshipType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AssetStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Asset.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AssociatedLocationType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AssociatedLocation.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">AuthorNoteRecipientType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">AuthorNote.RecipientType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">BarrierCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareBarrierType.CodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">BCCertificationType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BoardCertification.CertificationType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">BenefitProcessType<sup class="ph sup">5</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BenefitType.ProcessType<sup class="ph sup">5</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">BLicenseJurisdictionType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BusinessLicense.JurisdictionType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">BLicenseVerificationStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BusinessLicense.VerificationStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">BoardCertificationStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BoardCertification.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">BusinessLicenseStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BusinessLicense.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CampaignMemberStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CampaignMember.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CampaignStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Campaign.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CampaignType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Campaign.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CardType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CardPaymentMethod.CardType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareAmbulanceTransReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.AmbulanceTransportReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareAmbulanceTransType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.AmbulanceTransportType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareBarrierPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareBarrier.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareBarrierStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareBarrier.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareBenefitVerifyRequestStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareBenefitVerifyRequest.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareDeterminantPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareDeterminant.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareDeterminantTypeDomain<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareDeterminantType.Domain<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareDeterminantTypeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareDeterminantType.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareEpisodeStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareEpisode.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareEpisodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareEpisode.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareItemStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareItemStatusReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.StatusReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareMetricTargetType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareMetricTarget.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareObservationCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareObservation.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareObservationStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareObservation.ObservationStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CarePlanActivityStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlanActivity.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CarePlanAuthorizationType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlan.AuthorizationType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CarePlanDetailDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlanDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CarePreauthItemLaterality<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePreauthItem.Laterality<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CarePreauthStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePreauth.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareProgramEnrolleeStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramEnrollee.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareProgramGoalPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramGoal.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareProgramGoalStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramGoal.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareProgramProductStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramProduct.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareProgramProviderRole<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramProvider.Role<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareProgramProviderStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramProvider.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareProgramStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgram.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareProgramTeamMemberRole<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramTeamMember.Role<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareQuantityType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.QuantityType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRegisteredDeviceStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRegisteredDevice.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRequestExtensionAmbulanceTransportReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.AmbulanceTransportReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRequestExtensionAmbulanceTransportType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.AmbulanceTransportType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRequestExtensionNursingHomeResidentialStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.NursingHomeResidentialStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRequestExtensionRequestType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.RequestType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRequestExtensionServiceLevel<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.ServiceLevel<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRequestMemberGender<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.MemberGender<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRequestMemberPrognosis<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.MemberPrognosis<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRequestQuantityType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.QuantityType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareRequestReviewerStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestReviewer.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareSpecialtySpecialtyType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareSpecialty.SpecialtyType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareSpecialtySpecialtyUsage<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareSpecialty.SpecialtyUsage<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareTaxonomyTaxonomyType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareTaxonomy.TaxonomyType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CareTeamStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareTeam.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CaseContactRole</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CaseContactRole.Role</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CaseEpisodeSubType<sup class="ph sup">5</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CaseEpisode.Subtype<sup class="ph sup">5</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CaseEpisodeType<sup class="ph sup">5</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CaseEpisode.Type<sup class="ph sup">5</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CaseOrigin</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Case.Origin</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CasePriority</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Case.Priority</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CaseReason</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Case.Reason</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CaseServicePlanStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlan.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CaseStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Case.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CaseType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Case.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CBCoverageType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CoverageBenefit.CoverageType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CBenefitItemLimitTermType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CoverageBenefitItemLimit.TermType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CBItemLimitCoverageLevel<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CoverageBenefitItemLimit.CoverageLevel<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CBItemLimitNetworkType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CoverageBenefitItemLimit.NetworkType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CCFALineOfBusiness<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CategorizedCareFeeAgreement.LineofBusiness<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CCPAdditionalBenefits<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CrbnCreditProject.AdditionalBenefits<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CCProjectMitigationType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CrbnCreditProject.MitigationType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CCPStandardsAgencyName<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CrbnCreditProject.StandardsAgencyName<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CCreditProjectProjectType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CrbnCreditProject.ProjectType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CDPresentOnAdmission<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareDiagnosis.PresentOnAdmission<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CEIdentifierIdUsageType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalEncounterIdentifier.IdUsageType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CEncounterAdmissionSource<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalEncounter.AdmissionSource<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CEncounterCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalEncounter.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CEncounterDietPreference<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalEncounter.DietPreference<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CEncounterFacilityStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalEncounterFacility.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CEncounterServiceType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalEncounter.ServiceType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CEncounterSpecialCourtesy<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalEncounter.SpecialCourtesy<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CEncounterStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalEncounter.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CEpisodeDetailDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareEpisodeDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ChangeRequestRelatedItemImpactLevel</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ChangeRequestRelatedItem.ImpactLevel</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ChangeRequestBusinessReason</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ChangeRequest.BusinessReason</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ChangeRequestCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ChangeRequest.Category</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ChangeRequestImpact</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ChangeRequest.Impact</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ChangeRequestPriority</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ChangeRequest.Priority</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ChangeRequestRiskLevel</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ChangeRequest.RiskLevel</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ChangeRequestStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ChangeRequest.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ClassRankReportingFormat<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonEducation.ClassRankReportingFormat<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ClassRankWeightingType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonEducation.ClassRankWeightingType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ClinicalAlertCategories<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalAlert.Categories<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ClinicalAlertStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalAlert.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ClinicalCaseType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.ClinicalCaseType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ClinicalDetectedIssueSeverityLevel<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalDetectedIssue.SeverityLevel<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ClinicalDetectedIssueStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalDetectedIssue.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">COComponentValueType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareObservationComponent.ValueType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">COCValueInterpretation<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareObservationComponent.ValueInterpretation<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CodeSetCodeSetType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CodeSet.CodeSetType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CommunicationChannel<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EngagementInteraction.CommunicationChannel<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CompanyRelationshipType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Supplier.CompanyRelationshipType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ComplaintSourceType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PublicComplaint.SourceType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ConsequenceOfFailure</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Asset.ConsequenceOfFailure</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ContactPointAddressType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ContactPointAddress.AddressType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ContactPointUsageType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ContactPointAddress.UsageType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ContactRequestReason</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ContactRequest.RequestReason</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ContactRequestStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ContactRequest.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ContactRole</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OpportunityContactRole.Role</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ContractContactRole</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ContractContactRole.Role</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ContractLineItemStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ContractLineItem.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ContractStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Contract.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">COProcessingResult<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareObservation.ProcessingResult<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">COValueInterpretation<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareObservation.ValueInterpretation<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPAActivityType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlanActivity.ActivityType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPADetailDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlanActivityDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPADetailDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlanActivityDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPAdverseActionActionType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProviderAdverseAction.ActionType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPAdverseActionStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProviderAdverseAction.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPAgreementAgreementType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ContractPaymentAgreement.AgreementType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPAgreementLineofBusiness<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ContractPaymentAgreement.LineofBusiness<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPAProhibitedActivity<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlanActivity.ProhibitedActivity<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPDProblemPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlanDetail.ProblemPriority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPEligibilityRuleStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramEligibilityRule.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPEnrolleeProductStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramEnrolleeProduct.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPEnrollmentCardStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramEnrollmentCard.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPFSpecialtySpecialtyRole<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProviderFacilitySpecialty.SpecialtyRole<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPPRole<sup class="ph sup">5</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CaseProceedingParticipant.Role<sup class="ph sup">5</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CProgramProductAvailability<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramProduct.Availability<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CPTemplateProblemPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlanTemplateProblem.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRDDrugAdministrationSetting<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestDrug.DrugAdministrationSetting<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRDNameType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRegisteredDevice.NameType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CCRDPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestDrug.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CCRDPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestDrug.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRDRequestType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestDrug.RequestType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRDStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestDrug.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRDStatusReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestDrug.StatusReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRECaseSubStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.CaseSubStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRECaseSubStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.CaseSubStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CREDocumentAttachmentStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.DocumentAttachmentStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CREIndependentReviewDetermination<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.IndependentReviewDetermination<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CREPriorAuthRequestIdentifier<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.AuthorizationRefIdentifier<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CREPriorDischargeStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.PriorDischargeStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CREReopenRequestOutcome<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.ReopenRequestOutcome<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CREReopenRequestType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.ReopenRequestType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRERequestOutcome<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestExtension.RequestOutcome<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRIApprovedLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.ApprovedLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRIClinicalDetermination<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.ClinicalDetermination<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRICurrentLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.CurrentLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRIDeniedLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.DeniedLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRIModifiedLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.ModifiedLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRIPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRIRequestedLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.RequestedLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRIRequestType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.RequestType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CRReviewerReviewerType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestReviewer.ReviewerType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CSBundleUsageType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CodeSetBundle.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CServiceRequestIntent<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalServiceRequest.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CServiceRequestPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalServiceRequest.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CServiceRequestStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalServiceRequest.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CSRequestDetailDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalServiceRequestDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">CurrentLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.CurrentLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DChecklistItemStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DocumentChecklistItem.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DecisionReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.DecisionReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DeniedLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.DeniedLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DiagnosisCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareDiagnosis.CodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DiagnosticSummaryCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DiagnosticSummary.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DiagnosticSummaryStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DiagnosticSummary.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DigitalAssetStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Asset.DigitalAssetStatus</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DEInclSumDiversityType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DivrsEquityInclSum.DiversityType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DEInclSumEmployeeType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DivrsEquityInclSum.EmployeeType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DEInclSumEmploymentType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DivrsEquityInclSum.EmploymentType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DEInclSumGender<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DivrsEquityInclSum.Gender<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DEISumDiversityCategory<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DivrsEquityInclSum.DiversityCategory<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DischargeDiagnosisCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareDiagnosis.DischargeCodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DIssueDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ClinicalDetectedIssueDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DivrsEquityInclSumLocation<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DivrsEquityInclSum.Location<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DivrsEquityInclSumRace<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DivrsEquityInclSum.Race<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DrugClinicalDetermination<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestDrug.ClinicalDetermination<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DSDDocumentRelationType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DiagnosticSummaryDetail.DocumentRelationType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DSDocumentStage<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DiagnosticSummary.DocumentStage<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DSummaryDetailDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DiagnosticSummaryDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">DSummaryUsageType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">DiagnosticSummary.UsageType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ECTypeContactPointType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EngagementChannelType.ContactPointType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EducationLevel<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonEducation.EducationLevel<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EEligibilityCriteriaStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EnrollmentEligibilityCriteria.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EmploymentOccupation<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonEmployment.Occupation<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EmploymentStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonEmployment.EmploymentStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EngagementAttendeeRole<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EngagementAttendee.Role<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EngagementSentimentEnum<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EngagementInteraction.Sentiment<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EngagementStatusEnum<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EngagementInteraction.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EngagementTypeEnum<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EngagementInteraction.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EnrolleeOptOutReasonType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProgramEnrollee.OptOutReasonType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EnrollmentStatus<sup class="ph sup">5</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BenefitAssignment.Status<sup class="ph sup">5</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EntitlementType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Entitlement.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EBSEmployeeBenefitType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmpBenefitSummary.EmployeeBenefitType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EBSPercentageCalcType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmpBenefitSummary.PercentageCalcType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EBSummaryBenefitUsage<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmpBenefitSummary.BenefitUsage<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EBSummaryEmploymentType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmpBenefitSummary.EmploymentType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EBSEmployeeBenefitType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmpBenefitSummary.EmployeeBenefitType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EBSPercentageCalcType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmpBenefitSummary.PercentageCalcType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EDemographicSumAgeGroup<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmployeeDemographicSum.AgeGroup<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EDemographicSumGender<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmployeeDemographicSum.Gender<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EDemographicSumRegion<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmployeeDemographicSum.Region<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EDemographicSumReportType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmployeeDemographicSum.ReportType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EDemographicSumWorkType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmployeeDemographicSum.WorkType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EDevelopmentSumGender<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmployeeDevelopmentSum.Gender<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EDSumEmployeeType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmployeeDevelopmentSum.EmployeeType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EDSumEmploymentType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmployeeDemographicSum.EmploymentType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EDSumProgramCategory<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmployeeDevelopmentSum.ProgramCategory<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EPSumMarket<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EconomicPerformanceSum.Market<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EPSumPerformanceCategory<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EconomicPerformanceSum.PerformanceCategory<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EPSumPerformanceType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EconomicPerformanceSum.PerformanceType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EPSumRegion<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EconomicPerformanceSum.Region<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ERCompanyBusinessRegion<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmssnRdctnCommitment.CompanyBusinessRegion<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ERCompanySector<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmssnRdctnCommitment.CompanySector<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EReductionTargetTargetType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmssnReductionTarget.TargetType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ERTargetOtherTargetKpi<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmssnReductionTarget.OtherTargetKpi<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ERTTargetSettingMethod<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EmssnReductionTarget.TargetSettingMethod<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EventSubject</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Event.Subject</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">EventType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Event.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FacilityRoomBedType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.FacilityRoomBedType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FinalLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.FinalLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FinanceEventAction</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">FinanceTransaction.EventAction</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FinanceEventType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">FinanceBalanceSnapshot.EventType<p class="p">FinanceTransaction.EventType</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FiscalYearPeriodName</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Period.PeriodLabel</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FiscalYearPeriodPrefix</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">FiscalYearSettings.PeriodPrefix</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FiscalYearQuarterName</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Period.QuarterLabel</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FiscalYearQuarterPrefix</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">FiscalYearSettings.QuarterPrefix</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ForecastingItemCategory<sup class="ph sup">2</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">n/a</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FreightHaulingMode<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">FrgtHaulingEmssnFctr.FreightHaulingMode<sup class="ph sup">4</sup>
                <p class="p">FrgtHaulingEnrgyUse.FreightHaulingMode<sup class="ph sup">4</sup></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FtprntAuditApprovalStatus<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Scope3CrbnFtprnt.AuditApprovalStatus<sup class="ph sup">4</sup>
                <p class="p">StnryAssetCrbnFtprnt.AuditApprovalStatus<sup class="ph sup">4</sup></p>
                <p class="p">VehicleAssetCrbnFtprnt.AuditApprovalStatus<sup class="ph sup">4</sup></p>
                <p class="p">WasteFootprint.AuditApprovalStatus<sup class="ph sup">4</sup></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FulfillmentStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">FulfillmentOrder.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">FulfillmentType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">FulfillmentOrder.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">GADetailDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">GoalAssignmentDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">GCMRelationshipType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">GroupCensusMember.RelationshipToPrimaryMember</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">GoalAssignmentProgressionStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">GoalAssignment.ProgressionStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">GoalAssignmentStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">GoalAssignment.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">GoalDefinitionCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">GoalDefinition.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">GoalDefinitionUsageType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">GoalDefinition.UsageType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">GovtFinancialAsstSumType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">GovtFinancialAsstSum.Type<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">GpaWeightingType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonEducation.GpaWeightingType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">GrievanceType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.GrievanceType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HCFacilityLocationType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcareFacility.LocationType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HcpCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthCareProcedure.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HcpCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthCareProcedure.CodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HealthCareDiagnosisCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthCareDiagnosis.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HealthCareDiagnosisCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthCareDiagnosis.CodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HealthCareDiagnosisGender<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthCareDiagnosis.Gender<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HealthcareProviderStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcareProvider.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HealthConditionDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthConditionDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HealthConditionSeverity<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthCondition.Severity<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HealthConditionStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthCondition.ConditionStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HealthConditionType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthCondition.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HealthDiagnosticStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthCondition.DiagnosticStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HFNetworkGenderRestriction<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcareFacilityNetwork.GenderRestriction<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HFNetworkPanelStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcareFacilityNetwork.PanelStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HPayerNetworkNetworkType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcarePayerNetwork.NetworkType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HPayerNwkLineOfBusiness<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcarePayerNetwork.LineofBusiness<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HPFGenderRestriction<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcarePractitionerFacility.GenderRestriction<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HPFTerminationReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcarePractitionerFacility.TerminationReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HProviderNpiNpiType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcareProviderNpi.NpiType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HProviderProviderClass<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcareProvider.ProviderClass<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HProviderProviderType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcareProvider.ProviderType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HPSpecialtySpecialtyRole<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthcareProviderSpecialty.SpecialtyRole<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">HSActionLogActionStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">HealthScoreActionLog.ActionStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IaApplnStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IndividualApplication.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IaAuthCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IndividualApplication.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IaInternalStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IndividualApplication.InternalStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IAItemStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IndividualApplicationItem.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IARejectionReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IndividualApplication.RejectionReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IAServiceType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IndividualApplication.ServiceType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IdeaCategory<sup class="ph sup">3</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IdeaTheme.Categories<sup class="ph sup">3</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IdeaMultiCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Idea.Categories</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IdeaStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Idea.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IdeaThemeStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IdeaTheme.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IdentifierIdUsageType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Identifier.IdUsageType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IFnolChannel<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.FnolChannel<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Incident.Category</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentImpact</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Incident.Impact</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentPriority</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Incident.Priority</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentRelatedItemImpactLevel</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IncidentRelatedItem.ImpactLevel</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentRelatedItemImpactType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">IncidentRelatedItem.ImpactType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentReportedMethod</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Incident.ReportedMethod</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Incident.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentSubCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Incident.SubCategory</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Incident.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IncidentUrgency</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Incident.Urgency</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">Industry</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Account.Industry<p class="p">AccountCleanInfo.Industry</p>
                <p class="p">Lead.Industry</p>
                <p class="p">LeadCleanInfo.Industry</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">InterventionCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareInterventionType.CodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPCancelationReasonType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.CancellationReasonType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPCBenefitPaymentFrequency<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyCoverage.BenefitPaymentFrequency<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPCCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyCoverage.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPCCategoryGroup<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyCoverage.CategoryGroup<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPCDeathBenefitOptionType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyCoverage.DeathBenefitOptionType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPCIncomeOptionType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyCoverage.IncomeOptionType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPCLimitRange<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyCoverage.LimitRange<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyAuditTerm<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.AuditTerm<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyChangeSubType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.ChangeSubtype<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyChangeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.ChangeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyChannel<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.RenewalChannel<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyPlanTier<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.PlanTier<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyPlanType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.PlanType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyPolicyType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.PolicyType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyPremiumCalcMethod<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.PremiumCalculationMethod<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyPremiumFrequency<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.PremiumFrequency<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyPremiumPaymentType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.PremiumPaymentType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicySubStatusCode<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.Substatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyTerm<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicy.PolicyTerm<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyTransactionStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyTransaction.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPolicyTransactionType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyTransaction.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPOwnerPOwnerType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyOwner.PolicyOwnerType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPParticipantRole<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyParticipant.Role<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">IPPRelationshipToInsured<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">InsurancePolicyParticipant.RelationshipToInsured<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LeadSource</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Account.AccountSource<p class="p">CampaignMember.LeadSource</p>
                <p class="p">Contact.LeadSource</p>
                <p class="p">Lead.LeadSource</p>
                <p class="p">Opportunity.LeadSource</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LeadStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Lead.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LicenseClassType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BusinessLicense.LicenseClass<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LineOfAuthorityType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BusinessLicense.LineOfAuthority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LocationType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Location.LocationType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LPEVerificationStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyExpense.VerificationStatus<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LPIApplnCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BusinessLicenseApplication.ApplicationCategory<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LPIApplnStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BusinessLicenseApplication.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LPIIncomeType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIncome.IncomeType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LPIIncomeStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIncome.IncomeStatus<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LPIIncomeFrequency<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIncome.IncomeFrequency<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">LPIVerificationStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIncome.VerificationStatus<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MedicationCategoryEnum<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Medication.MedicationCategory<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MedicationDispenseMedAdministrationSettingCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationDispense.MedAdministrationSettingCategory<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MedicationDispenseStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationDispense.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MedicationDispenseSubstitutionReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationDispense.SubstitutionReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MedicationDispenseSubstitutionType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationDispense.SubstitutionType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MedicationStatementStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationStatement.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MedicationStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Medication.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MedReviewRepresentativeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationTherapyReview.SurrogateType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MedTherapyReviewSubtype<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationTherapyReview.ReviewSubtype<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MemberPlanPrimarySecondaryTertiary<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MemberPlan.PrimarySecondaryTertiary<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MemberPlanRelToSub<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MemberPlan.RelationshipToSubscriber<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MemberPlanStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MemberPlan.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MemberPlanVerificStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MemberPlan.VerificationStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MilitaryService</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Individual.MilitaryService</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ModifiedCareCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.ModifiedCodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ModifiedDiagnosisCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareDiagnosis.ModifiedCodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ModifiedDrugCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestDrug.ModifiedCodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ModifiedLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.ModifiedLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MRequestPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationRequest.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MRequestStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationRequest.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MRequestTherapyDuration<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationRequest.TherapyDuration<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MRequestType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationRequest.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MStatementDeliverySetting<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationStatement.DeliverySetting<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">MStatementDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">MedicationStatementDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OcrService<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OcrDocumentScanResult.OcrService<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OcrStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OcrDocumentScanResult.OcrStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OIncidentSummaryHazardType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OrgIncidentSummary.HazardType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OISCorrectiveActionType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OrgIncidentSummary.CorrectiveActionType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OISummaryIncidentSubtype<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OrgIncidentSummary.IncidentSubtype<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OISummaryIncidentType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OrgIncidentSummary.IncidentType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OISummaryPenaltyType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OrgIncidentSummary.PenaltyType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OpportunityCompetitor</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OpportunityCompetitor.CompetitorName</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OpportunityStage</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Opportunity.StageName</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OpportunityType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Opportunity.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OrderItemSummaryChgRsn</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OrderItemSummaryChange.Reason</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OrderStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Not available in 37.0 and earlier</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OrderSummaryRoutingSchdRsn</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OrderSummaryRoutingSchedule.Reason</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OrderSummaryStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OrderSummary.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">OrderType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Order.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ParProvider<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.ParProvider<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PERecurrenceInterval<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyExpense.RecurrenceInterval<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyExpenseStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyExpense.Status<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyExpenseType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyExpense.Type<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartnerRole</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartnerRole.ReverseRole</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyProfileCountryofBirth</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.CountryofBirth</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyProfileEmploymentType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.EmploymentType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyProfileFundSource</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.FundSource</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyProfileGender</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.Gender</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyProfileResidentType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.ResidentType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyProfileReviewDecision</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.ReviewDecision</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyProfileRiskType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.RiskType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyProfileStage</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.Stage</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyScreeningStepType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyScreeningStep.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PartyScreeningSummaryStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyScreeningSummary.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PatientImmunizationStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PatientImmunization.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PaymentMandateAccountType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PaymentMandate.BankAccountType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PaymentMandateMandateFrequency<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PaymentMandate.MandateFrequency<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PaymentMandateMandateType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PaymentMandate.MandateType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PaymentMandateMandateStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PaymentMandate.MandateStatus<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PaymentMandateAuthorizationType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PaymentMandate.AuthorizationType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PEFEFctrDataSourceType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProductEmissionsFactor.EmssnFctrDataSourceType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PFATypeEnum<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyFinancialAsset.Type<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PFAStatusEnum<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyFinancialAsset.Status<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PFAOwnershipTypeEnum<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyFinancialAsset.OwnershipType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PFAVerificationStatusEnum<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyFinancialAsset.VerificationStatus<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PersonEmploymentType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonEmployment.EmploymentType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PersonLanguageLanguage<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonLanguage.Language<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PersonLanguageSpeakingProficiencyLevel<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonLanguage.SpeakingProficiencyLevel<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PersonLanguageWritingProficiencyLevel<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonLanguage.WritingProficiencyLevel<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PersonNameNameUsageType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonName.NameUsageType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PersonVerificationStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PersonEmployment.VerificationStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PHealthReactionSeverity<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PatientHealthReaction.Severity<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PIdentityVerificationResult</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIdentityVerification.Result</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PIdentityVerificationStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIdentityVerification.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PIVerificationStepStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIdentityVerificationStep.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PIVerificationStepType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIdentityVerificationStep.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PIVerificationVerifiedBy</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIdentityVerification.VerifiedBy</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PIVOverriddenResult</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIdentityVerification.OverriddenResult</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PIVResultOverrideReason</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIdentityVerificationResult.OverrideReason</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PIVSVerificationDecision</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyIdentityVerificationStep.VerificationDecision</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PlaceOfService<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.PlaceOfService<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PlanBenefitStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PlanBenefit.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PMDDosageDefinitionType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PatientMedicationDosage.DosageDefinitionType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PMDosageDosageAmountType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PatientMedicationDosage.DosageQuantityType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PMDosageRateType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PatientMedicationDosage.DosageRateType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PMPDetailDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PatientMedicalProcedureDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PMPOutcome<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PatientMedicalProcedure.Outcome<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PMPStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PatientMedicalProcedure.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PPCreditScoreProvider</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.CreditScoreProvider</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PPPrimaryIdentifierType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.PrimaryIdentifierType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PProfileAddressAddressType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfileAddress.AddressType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PProfileCountryOfDomicile</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.CountryOfDomicile</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PProfileEmploymentIndustry</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.EmploymentIndustry</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PProfileNationality</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.Nationality</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PProfileOffBoardingReason</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.OffBoardingReason</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PProfileRiskRiskCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfileRisk.RiskCategory</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PPROverridenRiskCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfileRisk.OverridenRiskCategory</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PPTaxIdentificationType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyProfile.TaxpayerIdentificationType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Problem.Category</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemDefinitionCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProblemDefinition.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemDefinitionPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProblemDefinition.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemDefinitionUsageTypeEnum<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProblemDefinition.UsageType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemImpact</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Problem.Impact</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemPriority</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Problem.Priority</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemRelatedItemImpactLevel</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProblemRelatedItem.ImpactLevel</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemRelatedItemImpactType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProblemRelatedItem.ImpactType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Problem.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemSubCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Problem.SubCategory</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProblemUrgency</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Problem.Urgency</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProcessExceptionCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProcessException.Category</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProcessExceptionPriority</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProcessException.Priority</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProcessExceptionSeverity</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProcessException.Severity</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProcessExceptionStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProcessException.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">Product2Family</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Product2.Family</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProductFeeFrequency<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProductFee.Frequency<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProductFeeType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProductFee.Type<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProdRequestLineItemStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProductRequestLineItem.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProductLineEnum<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EngagementChannelType.UsageType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProductRequestStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ProductRequest.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ProgressionCriteriaMet<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.CriteriaMet<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PRStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PaymentRequest.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PScreeningStepResultCode</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyScreeningStep.ResultCode</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PScreeningStepStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyScreeningStep.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PSSResultOverrideReason</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyScreeningSummary.ResultOverrideReason</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PSStepMatchedFieldList</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyScreeningStep.MatchedFieldList</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PSSummaryScreenedBy</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyScreeningSummaryS.creenedBy</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PSSummaryScreeningDecision</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyScreeningSummary.ScreeningDecision</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PurchaserPlanAffiliation<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PurchaserPlan.Affiliation<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PtyFinclLiabilityType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyFinancialLiability.Type<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PtyFinclLiabilityShareType<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyFinancialLiability.ShareType<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PtyFinclLiabilityStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyFinancialLiability.Status<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PtyFinclLiabilityVerficationStatus<sup class="ph sup">6</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PartyFinancialLiability.VerficationStatus<sup class="ph sup">6</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PurchaserPlanStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PurchaserPlan.PlanStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">PurchaserPlanType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">PurchaserPlan.PlanType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">QuantityUnitOfMeasure</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Product2.QuantityUnitOfMeasure<p class="p">ReturnOrderLineItem.QuantityUnitOfMeasure</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">QuestionOrigin<sup class="ph sup">3</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Question.Origin<sup class="ph sup">3</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">QuickTextCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">QuickText.Category</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">QuickTextChannel</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">QuickText.Channel</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">QuoteStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Quote.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReceivedDocumentDirection<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReceivedDocument.Direction<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReceivedDocumentOcrStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReceivedDocument.OcrStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReceivedDocumentPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReceivedDocument.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReceivedDocumentStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReceivedDocument.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RegAuthCategory<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BusinessLicenseApplication.Category<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RegulatoryBodyType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareProviderAdverseAction.RegulatoryBodyType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReopenReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.ReopenReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RequestedCareCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestItem.CodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RequestedDrugCodeType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequestDrug.CodeType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RequestedLevelOfCare<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.RequestedLevelOfCare<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RequesterType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.RequesterType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RequestingPractitionerLicense<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.RequestingPractitionerLicense<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RequestingPractitionerSpecialty<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.RequestingPractitionerSpecialty<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ResidenceStatusType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">BusinessLicense.ResidenceStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RoleInTerritory2</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">UserTerritory2Association.RoleInTerritory2</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ResourceAbsenceType </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResourceAbsence.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReturnOrderLineItemProcessPlan</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReturnOrderLineItem.ProcessingPlan</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReturnOrderLineItemReasonForRejection</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReturnOrderLineItem.ReasonForRejection</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReturnOrderLineItemReasonForReturn</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReturnOrderLineItem.ReasonForReturn</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReturnOrderLineItemRepaymentMethod</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReturnOrderLineItem.RepaymentMethod</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReturnOrderShipmentType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReturnOrder.ShipmentType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ReturnOrderStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ReturnOrder.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLAAppStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLAAmortType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.AmortizationType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLAAppliedFor</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.MortgageProgramType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLAEstateType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.EstateHoldType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLALoanPurpose</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.LoanPurpose</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLAMortLienType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.MortgageLienType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLANativeTenure</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.NativeLandTenure</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLAProjectType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.ProjectType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLARefinanceType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.RefinanceType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLARefProgType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.RefinanceProgramType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLATitleType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.TitleType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">RLATrustType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ResidentialLoanApplication.TrustTitleType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SalesTeamRole</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">OpportunityTeamMember.TeamMemberRole<p class="p">UserAccountTeamMember.TeamMemberRole</p>
                <p class="p">UserTeamMember.TeamMemberRole</p>
                <p class="p">AccountTeamMember.TeamMemberRole</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">Salutation</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">
                <p class="p">CampaignMember.Salutation</p>

                <p class="p">Contact.Salutation</p>

                <p class="p">Lead.Salutation</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SAppointmentGroupStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ServiceAppointmentGroup.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ScorecardMetricCategory</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ScorecardMetric.Category</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ScienceBasedTargetStatus<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SustainabilityScorecard.ScienceBasedTargetStatus<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SContributionSumCategory<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SocialContributionSum.Category<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">Scope3CrbnFtprntStage<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Scope3CrbnFtprnt.FootprintStage<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ServiceAppointmentStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ServiceAppointment.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ServiceContractApprovalStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ServiceContract.ApprovalStatus</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ServicePlanTemplateStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CarePlanTemplate.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ServicingPractitionerLicense<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.ServicingPractitionerLicense<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ServicingPractitionerSpecialty<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareRequest.ServicingPractitionerSpecialty<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ServTerrMemRoleType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ServiceTerritoryMember.Role</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">ShiftStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Shift.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SocialContributionSumType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SocialContributionSum.Type<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SocialPostClassification</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SocialPost.Classification</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SocialPostEngagementLevel</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SocialPost.EngagementLevel</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SocialPostReviewedStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SocialPost.ReviewedStatus</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SolutionStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Solution.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SourceBusinessRegion<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Scope3EmssnSrc.BusinessRegion<sup class="ph sup">4</sup>
                <p class="p">StnryAssetEnvrSrc.BusinessRegion<sup class="ph sup">4</sup></p>
                <p class="p">VehicleAssetEmssnSrc.BusinessRegion<sup class="ph sup">4</sup></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">StatusReason</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Asset.StatusReason</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">StnryAssetCrbnFtprntStage<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">StnryAssetCrbnFtprnt.FootprintStage<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">StnryAstCrbnFtAllocStatus<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">StnryAssetCrbnFtprnt.AllocationStatus<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">StnryAstCrbnFtDataGapSts<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">StnryAssetCrbnFtprnt.DataGapStatus<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">StnryAstCrbnFtAllocStatus<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">StnryAssetCrbnFtprnt.AllocationStatus<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">StnryAstCrbnFtDataGapSts<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">StnryAssetCrbnFtprnt.DataGapStatus<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">StnryAstEvSrcStnryAstTyp<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">StnryAssetEnvrSrc.StationaryAssetType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">StnryAssetWaterFtprntStage<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">StnryAssetWaterFtprnt.FootprintStage<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SupplierClassification<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SustainabilityScorecard.SupplierClassification<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SupplierEmssnRdctnCmtTypev</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SustainabilityScorecard.SupplierEmssnRdctnCmtType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SupplierReportingScope<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SustainabilityScorecard.SupplierReportingScope<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SupplierTier<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SustainabilityScorecard.SupplierTier<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">SustainabilityScorecardStatus<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">SustainabilityScorecard.Status<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TaskPriority</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Task.Priority</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TaskStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Task.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TaskSubject</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Task.Subject</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TaskType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">Task.Type</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TCDDetailType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">TrackedCommunicationDetail.DetailType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TCPriority<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">TrackedCommunication.Priority<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TCStatus<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">TrackedCommunication.Status<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TCStatusReason<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">TrackedCommunication.StatusReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TopicFailureReasonEnum<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EngagementTopic.ProcessFailureReason<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TopicProcessStatusEnum<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">EngagementTopic.ProcessStatus<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TrackedCommunicationType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">TrackedCommunication.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">TypesOfIntervention<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">CareInterventionType.InterventionType<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">UnitOfMeasure</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ConsumptionSchedule.UnitOfMeasure</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">UnitOfMeasureType<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">UnitOfMeasure.Type<sup class="ph sup">1</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">VehicleAstCrbnFtprntStage<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">VehicleAssetCrbnFtprnt.FootprintStage<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">VehicleType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">VehicleAssetCrbnFtprnt.VehicleType<sup class="ph sup">4</sup>
                <p class="p">VehicleAssetEmssnSrc.VehicleType<sup class="ph sup">4</sup></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WasteFootprintStage<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">WasteFootprint.FootprintStage<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WasteDisposalType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">WstDispoEmssnFctrSetItm.DisposalType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WasteType<sup class="ph sup">4</sup>
              </td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">WstDispoEmssnFctrSetItm.WasteType<sup class="ph sup">4</sup>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WorkOrderLineItemPriority</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">WorkOrderLineItem.Priority</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WorkOrderLineItemStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">WorkOrderLineItem.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WorkOrderPriority</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">WorkOrder.Priority</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WorkOrderStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">WorkOrder.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WorkStepStatus</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">WorkStep.Status</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WorkTypeDefApptType</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">ServiceAppointment.AppointmentType</td>

            </tr>

            <tr>
              <td class="entry" headers="d3677e51" data-title="Standard Value Set Name (API version 38.0 and later)">WorkTypeGroupAddInfo</td>

              <td class="entry" headers="d3677e54" data-title="Field Name (API version 37.0 and earlier)">WorkTypeGroup.AdditionalInformation</td>

            </tr>

          </tbody>

        </table>

1Part of Salesforce Health Cloud.

2You can only update the label in this standard value set or picklist field. You can’t insert or delete picklist values.

3You can’t read or update this standard value set or picklist field.

4Part of Salesforce Net Zero Cloud.

5Part of Public Sector Solutions.

6Part of Digital Lending Solutions.

For values used in Loyalty Management, see [StandardValueSet Names and Standard Picklist Fields for Loyalty Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.loyalty.meta/loyalty/loyalty_standardvalueset_names.htm "HTML (New Window)").

<!-- document id=b666c23a22d70b444a220b9e758e1baeb27cbb6cbb51cab95f0b74a08ba9c95c url=/legacydeveloper/current/en-us/api_meta/meta_standardvaluesettranslation.md -->

# StandardValueSetTranslation

Contains details for a standard picklist translation. It returns a translated standard value set.This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

StandardValueSetTranslation components have the suffix .standardValueSetTranslation and are stored in the standardValueSetTranslations folder.

Translations are stored in a file with a format of ValueSetName-lang.standardValueSetTranslation, where ValueSetName is the global value set’s name, and lang is the translation language.

## Version

StandardValueSetTranslation components are available in API version 38.0 and later.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| valueTranslation | [ValueTranslation\[\]](meta_globalvaluesettranslation.htm#ValueTranslation_section) | A list of values from global value sets to be translated. |

## Declarative Metadata Sample Definition

The following is an example of a StandardValueSetTranslation component. When a value isn’t translated, its translation becomes a comment that’s paired with its label.

<?xml version="1.0" encoding="UTF-8"?>
<StandardValueSetTranslation xmlns="http://soap.sforce.com/2006/04/metadata">
    <valueTranslation\>
        <masterLabel\>Cold</masterLabel\>
        <translation\><!-- Cold --></translation\>
    </valueTranslation\>
    <valueTranslation\>
        <masterLabel\>Hot</masterLabel\>
        <translation\><!-- Hot --></translation\>
    </valueTranslation\>
    <valueTranslation\>
        <masterLabel\>Warm</masterLabel\>
        <translation\><!-- Warm --></translation\>
    </valueTranslation\>
</StandardValueSetTranslation\>

The following is an example package.xml that references the StandardValueSetTranslation definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
        <types\>
        <members\>AccountRating-fr</members\>
        <name\>StandardValueSetTranslation</name\>
    </types\>
    <version\>38.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [Translations](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm "Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.")

<!-- document id=c857416e9bb19042f5830f1f28fa20ed64affa27ea4e28f74fc7a29a5c8eb183 url=/legacydeveloper/current/en-us/api_meta/meta_staticresource.md -->

# StaticResource

Represents a static resource file, often a code library in a ZIP file. Static resources allow you to upload content that you can reference in a Visualforce page, including archives (such as .zip and .jar files), images, style sheets, JavaScript, and other files. Static resources can be used only within your Salesforce org, so you can’t host content here for other apps or websites.

This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

## File Suffix and Directory Location

The file suffix is .resource for the template file. The accompanying metadata file is named resource\-meta.xml.

Static resource components are stored in the staticresources folder in the corresponding package directory.

## Version

Static resources are available in API version 12.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d880092e115">Field Name</th>

              <th class="featureTableHeader  " id="d880092e118">Field Type</th>

              <th class="featureTableHeader  " id="d880092e121">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d880092e115" data-title="Field Name"><span class="keyword parmname">cacheControl</span></td>

              <td class="entry" headers="d880092e118" data-title="Field Type">StaticResourceCacheControl (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d880092e121" data-title="Description">Required. <span class="ph" id="field_cacheControl_desc"><a name="field_cacheControl_desc"><!-- --></a>Indicates whether the
                  static resource is marked with a public caching tag so that a
                  third-party delivery client can cache the content.</span> This
                field is available in API version 14.0. The valid values are:<ul class="ul bulletList">
                  <li class="li">Private</li>

                  <li class="li">Public</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d880092e115" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d880092e118" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d880092e121" data-title="Description">The static resource content. Base 64-encoded binary data. Before
                making an API call, client applications must encode the binary
                attachment data as base64. Upon receiving a response, client
                applications must decode the base64 data to binary. This conversion
                is handled for you by a SOAP client. This field is inherited from
                the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm" title="MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.">MetadataWithContent</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d880092e115" data-title="Field Name"><span class="keyword parmname">contentType</span></td>

              <td class="entry" headers="d880092e118" data-title="Field Type">string</td>

              <td class="entry" headers="d880092e121" data-title="Description">Required. The content type of the file, for example
                text/plain.</td>

            </tr>

            <tr>
              <td class="entry" headers="d880092e115" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d880092e118" data-title="Field Type">string</td>

              <td class="entry" headers="d880092e121" data-title="Description">The description of the static resource.</td>

            </tr>

            <tr>
              <td class="entry" headers="d880092e115" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d880092e118" data-title="Field Type">string</td>

              <td class="entry" headers="d880092e121" data-title="Description">The static resource name. <span class="ph" id="fullName_allowed_chars"><a name="fullName_allowed_chars"><!-- --></a>The
                  name can only contain characters, letters, and the underscore
                  (_) character. The name must start with a letter, and can’t end
                  with an underscore or contain two consecutive underscore
                  characters.</span>
                <p class="p">Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component, this field isn’t defined in the WSDL for this
                  component. It must be specified when creating, updating, or
                  deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see an example of this field
                  specified for a call.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>
<StaticResource xmlns="http://soap.sforce.com/2006/04/metadata">
    <contentType\>text/plain</contentType\>
    <description\>Test Resource</description\>
</StaticResource\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b99adee1d4f11904df99c550b81459cc229ad9a56c1a1ec9772a4e8a115d3ec7 url=/legacydeveloper/current/en-us/api_meta/meta_quickstart_retrieve_add_components.md -->

# Step 1: (Optional) Add Metadata Components to an Org Using the UI

If you’re starting with a new practice org that doesn’t have customizations, you only have standard metadata that can’t be retrieved. To use the Metadata API retrieve call, add a component on the Salesforce UI to your practice org. If you’re working on an existing project, you already have components to retrieve and can skip this step.

1. From the Object Manager tab in Setup, click **Create** | **Custom Object**.
2. Enter an arbitrary name for Label and Plural Label.
3. Save the component.

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_prereqs.htm "Metadata Development Prerequisites")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_build_manifest.htm "Step 2: Build a Package.xml Manifest")

<!-- document id=39cb66b84a83ee48c2bf2ce006933ac16bb604ae629dbf8064f4e91f796e3504 url=/legacydeveloper/current/en-us/api_meta/meta_mcp_cursor_configuration.md -->

# Step 1: Configure an MCP Client

Configure a client to connect to MCP servers hosted in your Salesforce org. In this quick start guide, we provide guidance on how to configure Agentforce Vibes, Cursor, and Claude.

## Configure Agentforce Vibes

The Agentforce Vibes extension is an AI-powered developer tool that's available as an easy-to-install Visual Studio Code extension.

1. Install the [Agentforce Vibes VS Code Extension](https://developer.salesforce.com/docs/platform/einstein-for-devs/guide/einstein-setup.html)
2. Create or open a project. See [Create Project](https://developer.salesforce.com/docs/platform/sfvscode-extensions/guide/create-project.html).
3. Open the Command Palette and run **SFDX: Authorize an Org** and log in with your Salesforce credentials.
4. From the VS Code Activity Bar, click the Agentforce icon (![Graphic of Vibe Codey](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/vibecodey_icon.png)).
5. To open the MCP Servers interface, click the icon (![Graphic of Servers](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/dev_guides/api_meta/images/server.png)) in the Agentforce panel.
6. In VSCode, in the Agentforce panel, click the **Configure** tab and turn on the Salesforce API Context Server.

Agentforce attempts to connect to the server and display the connection status. Verify the connection using the status indicators. For more details, review the Managed Connected Servers, or the Troubleshoot Connection Issues sections in [Connect to Remote MCP Servers](https://developer.salesforce.com/docs/platform/einstein-for-devs/guide/devagent-mcpservers.html) in the Agentforce Vibes Extension Guide.

## Configure Cursor in Developer Mode

Cursor is an AI-driven coding editor that supports MCP.

1. Select **Cursor** | **Settings** | **Cursor Settings** | **MCP**
2. Click **New MCP Server**.
    
    This creates a file called mcp.json.
3. Replace the contents of mcp.json file with this code.
    
          {
        "mcpServers": {
            "salesforce-api-context": {
                "command": "npx",
                "args": \[
                    "-y",
                    "mcp-remote@0.1.18",
                    "https://api.salesforce.com/platform/mcp/v1-beta.2/platform/salesforce-api-context",
                    "8080",
                    "--static-oauth-client-info",
                    "{"client\_id":"YOUR\_CONSUMER\_KEY","client\_secret":""}"
                \]
            }
        }
    }
4. Replace placeholder values in the mcp.json file.
    1. Replace YOUR\_CONSUMER\_KEY with the consumer key that you saved from your external client app setup.
        
        ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
        
        #### Note
        
        The client\_secret is an empty string. Leave this string blank.
    2. If you're connecting to a scratch or sandbox org, change the URL to https://api.salesforce.com/platform/mcp/v1-beta.2/sandbox/platform/salesforce-api-context.

You can now test the client's connection to the MCP server.

1. From Cursor, select **Settings**, and then select **Cursor Settings**.
2. From the Cursor Settings page, select **MCP & Integrations**.
3. In the MCP Tools section, locate salesforce\_api\_context. Confirm that get\_metadata\_api\_context is enabled.

## Configure Claude Desktop in Developer Mode

Claude is an AI assistant that you configure to connect to Salesforce Hosted MCP Servers. Configure Claude using a special Claude Desktop Extensions file.

1. Download salesforce-hosted-mcp-servers.mcpb from this [GitHub repository](https://github.com/forcedotcom/mcp-hosted). This is the extension file for Salesforce Hosted MCP Servers.
2. Double-click the salesforce-hosted-mcp-servers.mcpb file. The Claude desktop client opens and shows the Salesforce extension.
3. Click **Install**.
4. In Server Name, enter platform/salesforce-api-context.
5. In Consumer Key, paste the consumer key that you saved from the external client app, then click **Save**.
    
    A toggle to enable the extension appears.
6. Enable the extension using the toggle.
    
    If you encounter an error, quit and restart Claude.

You can now test the client's connection to the MCP server.

<!-- document id=adba507e1d328ddfaec7e85e68f8e1802a8729e3815356e38f8ec57eaa9e5e8a url=/legacydeveloper/current/en-us/api_meta/meta_quickstart_get_WSDLs.md -->

# Step 1: Generate or Obtain the Web Service WSDLs for Your Organization

To access Metadata API calls, you need a Web Service Description Language (WSDL) file. The WSDL file defines the Web service that is available to you. Your development platform uses this WSDL to generate stub code to access the Web service it defines. You can obtain the WSDL file from your organization’s Salesforce administrator, or if you have access to the WSDL download page in the Salesforce user interface, you can generate it yourself. For more information about WSDL, see [http://www.w3.org/TR/wsdl](http://www.w3.org/TR/wsdl).

Before you can access Metadata API calls, you must authenticate to use the Web service using the login() call, which is defined in the enterprise WSDL and the partner WSDL. Therefore, you must also obtain one of these WSDLs.

Any user with the Modify Metadata Through Metadata API Functions or Modify All Data permission can download the WSDL file to integrate and extend the Salesforce platform.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

The sample code in [Step 3: Walk Through the Java Sample Code](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_java_sample.htm) uses the enterprise WSDL, though the partner WSDL works equally well.

To generate the metadata and enterprise WSDL files for your organization:

1. Log in to your Salesforce account. You must log in as an administrator or as a user who has the “Modify All Data” permission.
2. From Setup, enter API in the Quick Find box, then select **API**.
3. Click **Generate Metadata WSDL**, and save the XML WSDL file to your file system.
4. Click **Generate Enterprise WSDL**, and save the XML WSDL file to your file system.

<!-- document id=772e977dc855eb166868ef2ccdd783ded20bc359e5248f301cb763e0ab44e0d0 url=/legacydeveloper/current/en-us/api_meta/meta_quickstart_retrieve_build_manifest.md -->

# Step 2: Build a Package.xml Manifest

The package.xml manifest file lists the components to retrieve from your org.

## Package.xml Manifest Structure

The package.xml manifest uses Extensible Markup Language (XML) to identify and migrate metadata components. The basic framework of the package.xml manifest is built with <types> elements. A <types> element specifies which metadata type you want to work with. You can add multiple <types> to a package.xml file.

Inside the <types> element is the <name> element and the <members> element. The <members> element selects for individual components of a specific type, and the <name> element selects for metadata component types. To work with a specific component, input the fullName of the component in the <members> element.

For example, to retrieve Account components, add Account in the <members> element and CustomObject in the <name> element in your package.xml. When you issue a retrieve call, you retrieve only the Account component from your org.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Account</members\>
        <name\>CustomObject</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

## Retrieve Custom Objects

To retrieve all components of a metadata type, you don’t specify the fullName of a component. Instead, use the wildcard character \* (asterisk) in the <members> tag. Some components, such as standard objects, don’t support \* (asterisk) as a specifier.

To retrieve all custom objects from your org:

1. (Optional) If you do not have a project folder, use Salesforce CLI to create a new directory that organizes your project. Run this command with your specified project name:
    
    sf project generate --name YourProjectName
2. Create a file called package.xml in your project.
3. In your text editor, open the file and paste in this script:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>CustomObject</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

Now you have a package.xml file that we can use to retrieve all custom objects. When you develop more on your own, you can retrieve more components from your org with multiple <types> elements.

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_add_components.htm "Step 1: (Optional) Add Metadata Components to an Org Using the UI")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_use_retrieve.htm "Step 3: Retrieve Components with Metadata API")

#### See Also

- [Sample package.xml Manifest Files](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/manifest_samples.htm "This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if you want to work with all the metadata in one batch.")
- [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.")

<!-- document id=4cec50fb111fbf94687c2132ef7ab399fc8890ff787a88fb5cbbc6c44246a8e8 url=/legacydeveloper/current/en-us/api_meta/meta_quickstart_import_WSDLs.md -->

# Step 2: Import the WSDL Files Into Your Development Platform

Once you have the WSDL files, import them into your development platform so that your development environment can generate the necessary objects for use in building client Web service applications. This section provides sample instructions for WSC. For instructions about other development platforms, see your platform’s product documentation.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The process for importing WSDL files is identical for the metadata and enterprise WSDL files.

## Instructions for Java Environments (WSC)

Java environments access the API through Java objects that serve as proxies for their server-side counterparts. Before using the API, you must first generate these objects from your organization's WSDL file.

Each SOAP client has its own tool for this process. For WSC, use the wsdlc utility.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Before you run wsdlc, you must have the WSC JAR file installed on your system and referenced in your classpath. You can download the latest force-wsc JAR file and its dependencies (dependencies are listed on the page when you select a version) from [mvnrepository.com/artifact/com.force.api/force-wsc/](http://mvnrepository.com/artifact/com.force.api/force-wsc/ "HTML (New Window)").

The basic syntax for wsdlc is:

java -classpath _pathToWsc;pathToWscDependencies_ com.sforce.ws.tools.wsdlc _pathToWsdl/WsdlFilename_ _pathToOutputJar/OutputJarFilename_

For example, on Windows:

java –classpath force-wsc-30.0.0.jar;ST4-4.0.7.jar;antlr-runtime-3.5.jar com.sforce.ws.tools.wsdlc metadata.wsdl metadata.jar

On Mac OS X and Unix, use a colon instead of a semicolon in between items in the classpath:

java –classpath force-wsc-30.0.0.jar:ST4-4.0.7.jar:antlr-runtime-3.5.jar com.sforce.ws.tools.wsdlc metadata.wsdl metadata.jar

wsdlc generates a JAR file and Java source code and bytecode files for use in creating client applications. Repeat this process for the enterprise WSDL to create an enterprise.JAR file.

<!-- document id=0d58e1f3d93834bf9f60d60e703b35fd1838c530a9ae1da9a3cf401c69c52b8f url=/legacydeveloper/current/en-us/api_meta/meta_mcp_prompt_examples.md -->

# Step 2: Test Your Connection to the MCP Server

Use simple prompts to test your client’s connection to the Salesforce API Context MCP server you configured.

## Example 1

In your client's chat field, enter the prompt "Query the Salesforce API Context MCP tools to get the metadata context for the CustomTab Metadata Type".

The MCP client should respond with information about the CustomTab Metadata Type.

## Example 2

In your client's chat field, enter the prompt "Can you create a new custom object to track Projects with the following fields: Start Date (date), End Date (date), and Budget (number). Use the Salesforce API Context MCP tools as context when creating each metadata type."

The MCP client should respond with information about the CustomObject and CustomField Metadata Types. The MCP client uses this context to generate the proper metadata XML files.

<!-- document id=fa36fac976967ad1aba4bd5d10034967a37886c3f51f4de20acd8b37b01dd4e4 url=/legacydeveloper/current/en-us/api_meta/meta_mcp_configure_rule.md -->

# Step 3 (Optional): Configure a Rule

​​To help the MCP server function optimally, you can create a rule that guides your AI assistant, such as Agentforce Vibes or Cursor Agent, to call the Metadata API Context MCP tools. An AI rule is a plain-text file like markdown that provides specific instructions, context, or constraints to your AI assistant.

Use this example rule to make sure that the Metadata API Context MCP tools are called to provide AI with additional context when generating metadata XML files. This helps ensure the structural integrity of the metadata XML files generated, and minimize errors during deployment.

\# Rule: Salesforce Metadata Generation

##Description: To guarantee the creation of accurate and deployable Salesforce metadata files, you must use these tools from the \`salesforce-api-context\` MCP server:
    - \`get\_metadata\_type\_sections\`
    - \`get\_metadata\_type\_context\`
    - \`get\_metadata\_type\_fields\`
    - \`get\_metadata\_type\_fields\_properties\`
    - \`search\_metadata\_types\`

These tools provide comprehensive contextual information—including complete field definitions, valid values, and constraints—that's essential for correctly determining the required entity shape and creating a valid Salesforce metadata file structure.

## Constraints
1. \*\*One metadata type at a time\*\* - finish one metadata type before starting the next one
3. \*\*One metadata type per tool call\*\* - don't batch metadata types when calling the MCP tools
4. \*\*Child metadata types need their own context\*\* - if adding any child metadata inside a parent metadata's file, treat the child metadata seperately; don't rely on the parent's schema for creating child metadata

## Workflow
### Step 1: Metadata loop - Execute for each metadata type
For each metadata type, use these tools from \`salesforce-api-context\` MCP server to get metadata type context:
- \`get\_metadata\_type\_sections\`
- \`get\_metadata\_type\_context\`
- \`get\_metadata\_type\_fields\`
- \`get\_metadata\_type\_fields\_properties\`
- \`search\_metadata\_types\`

### Step 2. Verify deployment
\`\`\`bash
sf project deploy start --dry-run -d "force-app/main/default" --target-org <alias> --test-level NoTestRun --wait 10 --json
\`\`\`
On failure: attempt to fix the errors and re-run, retrying up to a maximum of 3 times until it succeeds.

## Anti-patterns
| Don't | Why | Do |
|-------|-----|-----|
| Batch types in calls to MCP tools | Violates constraint | One type per call |

For more details about configuring AI rules, see:

- Agentforce Vibes Extension: [Agentforce Rules](https://developer.salesforce.com/docs/platform/einstein-for-devs/guide/devagent-rules.html)
- Cursor Docs: [Rules](https://cursor.com/docs/context/rules)

<!-- document id=52f2947e906a031f91d95c3e1bd65ce2b7daabac519694df66bc65aed4e7e57f url=/legacydeveloper/current/en-us/api_meta/meta_quickstart_retrieve_use_retrieve.md -->

# Step 3: Retrieve Components with Metadata API

With Salesforce CLI, retrieve a file representation of the specified components in your package.xml manifest.

You can use one of two commands to retrieve metadata components.

## Option 1: Source Format Retrieval with Source Tracking (Developer-Focused)

To retrieve the components specified in your package.xml manifest, issue a retrieve call using a Salesforce CLI command. On the command line, run this call with the appropriate file path:

sf project retrieve start --manifest path/to/package.xml

Metadata retrieve() is an asynchronous, file-based command. You can issue multiple retrieve or deploy requests that run on their own when resources are available.

With this command, you send a request to retrieve all custom objects as specified in your package.xml manifest. Your requests are queued until our systems are ready to process your retrieve call. After your request is dequeued, your retrieve call is run. The client checks the status of the retrieve and notifies you when the call is complete. The call returns a file representation of the chosen components. When you use Salesforce CLI to issue a retrieve call, all these processes are automated.

The project retrieve start command allows for source tracking. Source tracking includes information about which revision you’re working on and when the last changes were made, which makes source commands more developer-friendly. To use source tracking, ensure that it’s enabled in your org.

## Option 2: MDAPI Format Retrieval without Source Tracking (Admin-Focused)

Alternatively, run this command in your terminal:

sf project retrieve start --manifest path/to/package.xml --target-metadata-dir path/to/retrieve/dir

This command retrieves components in mdapi format rather than source format, and doesn’t allow for source tracking. In practice, admins use mdapi commands more often because the commands don’t include source tracking.

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickstart_retrieve_build_manifest.htm "Step 2: Build a Package.xml Manifest")

#### See Also

- [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.")
- [source Commands](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source)
- [Source Tracking](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_source_tracking.htm)
- [mdapi Commands](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_mdapi.htm#cli_reference_force_mdapi)

<!-- document id=63276c7c7eb22d63eea29defa011f079f9bd3d0c77e4ead6657fe9e72603e3e3 url=/legacydeveloper/current/en-us/api_meta/meta_quickstart_java_sample.md -->

# Step 3: Walk Through the Java Sample Code

When you have imported the WSDL files, you can build client applications that use Metadata API. The sample is a good starting point for writing your own code.

Before you run the sample, modify your project and the code to:

1. Include the WSC JAR, its dependencies, and the JAR files you generated from the WSDLs.
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)
    
    #### Note
    
    Although WSC has other dependencies, the following sample only requires Rhino (js-1.7R2.jar), which you can download from [mvnrepository.com/artifact/rhino/js](http://mvnrepository.com/artifact/rhino/js "HTML (New Window)").
2. Update USERNAME and PASSWORD variables in the MetadataLoginUtil.login() method with your user name and password. If your current IP address isn’t in your organization's trusted IP range, you'll need to append a security token to the password.
3. If you are using a sandbox, be sure to change the login URL.

## Login Utility

Java users can use ConnectorConfig to connect to Enterprise, Partner, and Metadata SOAP API. MetadataLoginUtil creates a ConnectorConfig object and logs in using the Enterprise WSDL login method. Then it retrieves sessionId and metadataServerUrl to create a ConnectorConfig and connects to Metadata API endpoint. ConnectorConfig is defined in WSC.

The MetadataLoginUtil class abstracts the login code from the other parts of the sample, allowing portions of this code to be reused without change across different Salesforce APIs.

import com.sforce.soap.enterprise.EnterpriseConnection;
import com.sforce.soap.enterprise.LoginResult;
import com.sforce.soap.metadata.MetadataConnection;
import com.sforce.ws.ConnectionException;
import com.sforce.ws.ConnectorConfig;

/\*\*
 \* Login utility.
 \*/
public class MetadataLoginUtil {

    public static MetadataConnection login() throws ConnectionException {
        final String USERNAME = "user@company.com";
        // This is only a sample. Hard coding passwords in source files is a bad practice.
        final String PASSWORD = "password"; 
        final String URL = "https://login.salesforce.com/services/Soap/c/68.0";
        final LoginResult loginResult = loginToSalesforce(USERNAME, PASSWORD, URL);
        return createMetadataConnection(loginResult);
    }

    private static MetadataConnection createMetadataConnection(
            final LoginResult loginResult) throws ConnectionException {
        final ConnectorConfig config = new ConnectorConfig();
        config.setServiceEndpoint(loginResult.getMetadataServerUrl());
        config.setSessionId(loginResult.getSessionId());
        return new MetadataConnection(config);
    }

    private static LoginResult loginToSalesforce(
            final String username,
            final String password,
            final String loginUrl) throws ConnectionException {
        final ConnectorConfig config = new ConnectorConfig();
        config.setAuthEndpoint(loginUrl);
        config.setServiceEndpoint(loginUrl);
        config.setManualLogin(true);
        return (new EnterpriseConnection(config)).login(username, password);
    }
}

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This example uses user and password authentication to obtain a session ID, which is then used for making calls to Metadata API. Alternatively, you can use OAuth authentication. After you athenticate with OAuth to Salesforce, pass the returned access token instead of the session ID. For example, pass the access token to the setSessionId() call on ConnectorConfig. To learn how to use OAuth authentication in Salesforce, see [Authenticating Apps with OAuth](https://help.salesforce.com/apex/HTViewHelpDoc?id=remoteaccess_authenticate.htm&language=en_US "HTML (New Window)") in the Salesforce Help.

## Java Sample Code for File-Based Development

The sample code logs in using the login utility. Then it displays a menu with retrieve, deploy, and exit.

The retrieve() and deploy() calls both operate on a .zip file named components.zip. The retrieve() call retrieves components from your organization into components.zip, and the deploy() call deploys the components in components.zip to your organization. If you save the sample to your computer and execute it, run the retrieve option first so that you have a components.zip file that you can subsequently deploy. After a retrieve call, the sample calls checkRetrieveStatus() in a loop until the operation is completed. Similarly, after a deploy call, the sample checks checkDeployStatus() in a loop until the operation is completed.

The retrieve() call uses a manifest file to determine the components to retrieve from your organization. A sample package.xml manifest file follows. For more details on the manifest file structure, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders."). For this sample, the manifest file retrieves all custom objects, custom tabs, and page layouts.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>CustomObject</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>CustomTab</name\>
    </types\>
    <types\>
        <members\>\*</members\>
        <name\>Layout</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

Note the error handling code that follows each API call.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This sample requires API version 34.0 or later.

import java.io.\*;
import java.nio.channels.Channels;
import java.nio.channels.FileChannel;
import java.nio.channels.ReadableByteChannel;
import java.rmi.RemoteException;
import java.util.\*;

import javax.xml.parsers.\*;

import org.w3c.dom.\*;
import org.xml.sax.SAXException;

import com.sforce.soap.metadata.\*;

/\*\*
 \* Sample that logs in and shows a menu of retrieve and deploy metadata options.
 \*/
public class FileBasedDeployAndRetrieve {

    private MetadataConnection metadataConnection;

    private static final String ZIP\_FILE = "components.zip";

    // manifest file that controls which components get retrieved
    private static final String MANIFEST\_FILE = "package.xml";

    private static final double API\_VERSION = 29.0;

    // one second in milliseconds
    private static final long ONE\_SECOND = 1000;

    // maximum number of attempts to deploy the zip file
    private static final int MAX\_NUM\_POLL\_REQUESTS = 50;

    private BufferedReader reader = new BufferedReader(new InputStreamReader(System.in));

    public static void main(String\[\] args) throws Exception {
        FileBasedDeployAndRetrieve sample = new FileBasedDeployAndRetrieve();
        sample.run();
    }

    public FileBasedDeployAndRetrieve() {
    }

    private void run() throws Exception {
        this.metadataConnection = MetadataLoginUtil.login();

        // Show the options to retrieve or deploy until user exits
        String choice = getUsersChoice();
        while (choice != null && !choice.equals("99")) {
            if (choice.equals("1")) {
                retrieveZip();
            } else if (choice.equals("2")) {
                deployZip();
            } else {
                break;
            }
            // show the options again
            choice = getUsersChoice();
        }
    }

    /\*
     \* Utility method to present options to retrieve or deploy.
     \*/
    private String getUsersChoice() throws IOException {
        System.out.println(" 1: Retrieve");
        System.out.println(" 2: Deploy");
        System.out.println("99: Exit");
        System.out.println();
        System.out.print("Enter 1 to retrieve, 2 to deploy, or 99 to exit: ");
        // wait for the user input.
        String choice = reader.readLine();
        return choice != null ? choice.trim() : "";
    }

    private void deployZip() throws Exception {
        byte zipBytes\[\] = readZipFile();
        DeployOptions deployOptions = new DeployOptions();
        deployOptions.setPerformRetrieve(false);
        deployOptions.setRollbackOnError(true);
        AsyncResult asyncResult = metadataConnection.deploy(zipBytes, deployOptions);
        DeployResult result = waitForDeployCompletion(asyncResult.getId());
        if (!result.isSuccess()) {
            printErrors(result, "Final list of failures:\\n");
            throw new Exception("The files were not successfully deployed");
        }
        System.out.println("The file " + ZIP\_FILE + " was successfully deployed\\n");
    }

    /\*
    \* Read the zip file contents into a byte array.
    \*/
    private byte\[\] readZipFile() throws Exception {
        byte\[\] result = null;
        // We assume here that you have a deploy.zip file.
        // See the retrieve sample for how to retrieve a zip file.
        File zipFile = new File(ZIP\_FILE);
        if (!zipFile.exists() || !zipFile.isFile()) {
            throw new Exception("Cannot find the zip file for deploy() on path:"
                + zipFile.getAbsolutePath());
        }

        FileInputStream fileInputStream = new FileInputStream(zipFile);
        try {
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            byte\[\] buffer = new byte\[4096\];
            int bytesRead = 0;
            while (-1 != (bytesRead = fileInputStream.read(buffer))) {
                bos.write(buffer, 0, bytesRead);
            }

            result = bos.toByteArray();
        } finally {
            fileInputStream.close();
        }
        return result;
    }

    /\*
    \* Print out any errors, if any, related to the deploy.
    \* @param result - DeployResult
    \*/
    private void printErrors(DeployResult result, String messageHeader) {
        DeployDetails details = result.getDetails();
        StringBuilder stringBuilder = new StringBuilder();
        if (details != null) {
            DeployMessage\[\] componentFailures = details.getComponentFailures();
            for (DeployMessage failure : componentFailures) {
                String loc = "(" + failure.getLineNumber() + ", " + failure.getColumnNumber();
                if (loc.length() == 0 && !failure.getFileName().equals(failure.getFullName()))
                {
                    loc = "(" + failure.getFullName() + ")";
                }
                stringBuilder.append(failure.getFileName() + loc + ":" 
                    + failure.getProblem()).append('\\n');
            }
            RunTestsResult rtr = details.getRunTestResult();
            if (rtr.getFailures() != null) {
                for (RunTestFailure failure : rtr.getFailures()) {
                    String n = (failure.getNamespace() == null ? "" :
                        (failure.getNamespace() + ".")) + failure.getName();
                    stringBuilder.append("Test failure, method: " + n + "." +
                            failure.getMethodName() + " -- " + failure.getMessage() + 
                            " stack " + failure.getStackTrace() + "\\n\\n");
                }
            }
            if (rtr.getCodeCoverageWarnings() != null) {
                for (CodeCoverageWarning ccw : rtr.getCodeCoverageWarnings()) {
                    stringBuilder.append("Code coverage issue");
                    if (ccw.getName() != null) {
                        String n = (ccw.getNamespace() == null ? "" :
                        (ccw.getNamespace() + ".")) + ccw.getName();
                        stringBuilder.append(", class: " + n);
                    }
                    stringBuilder.append(" -- " + ccw.getMessage() + "\\n");
                }
            }
        }
        if (stringBuilder.length() > 0) {
            stringBuilder.insert(0, messageHeader);
            System.out.println(stringBuilder.toString());
        }
    }
    

    private void retrieveZip() throws Exception {
        RetrieveRequest retrieveRequest = new RetrieveRequest();
        // The version in package.xml overrides the version in RetrieveRequest
        retrieveRequest.setApiVersion(API\_VERSION);
        setUnpackaged(retrieveRequest);

        AsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);
        RetrieveResult result = waitForRetrieveCompletion(asyncResult);

        if (result.getStatus() == RetrieveStatus.Failed) {
            throw new Exception(result.getErrorStatusCode() + " msg: " +
                    result.getErrorMessage());
        } else if (result.getStatus() == RetrieveStatus.Succeeded) {  
	        // Print out any warning messages
	        StringBuilder stringBuilder = new StringBuilder();
	        if (result.getMessages() != null) {
	            for (RetrieveMessage rm : result.getMessages()) {
	                stringBuilder.append(rm.getFileName() + " - " + rm.getProblem() + "\\n");
	            }
	        }
	        if (stringBuilder.length() > 0) {
	            System.out.println("Retrieve warnings:\\n" + stringBuilder);
	        }
	
	        System.out.println("Writing results to zip file");
	        File resultsFile = new File(ZIP\_FILE);
	        FileOutputStream os = new FileOutputStream(resultsFile);
	
	        try {
	            os.write(result.getZipFile());
	        } finally {
	            os.close();
	        }
        }
    }

    private DeployResult waitForDeployCompletion(String asyncResultId) throws Exception {
        int poll = 0;
        long waitTimeMilliSecs = ONE\_SECOND;
        DeployResult deployResult;
        boolean fetchDetails;
        do {
            Thread.sleep(waitTimeMilliSecs);
            // double the wait time for the next iteration

            waitTimeMilliSecs \*= 2;
            if (poll++ > MAX\_NUM\_POLL\_REQUESTS) {
                throw new Exception(
                    "Request timed out. If this is a large set of metadata components, " +
                    "ensure that MAX\_NUM\_POLL\_REQUESTS is sufficient.");
            }
            // Fetch in-progress details once for every 3 polls
            fetchDetails = (poll % 3 == 0);

            deployResult = metadataConnection.checkDeployStatus(asyncResultId, fetchDetails);
            System.out.println("Status is: " + deployResult.getStatus());
            if (!deployResult.isDone() && fetchDetails) {
                printErrors(deployResult, "Failures for deployment in progress:\\n");
            }
        }
        while (!deployResult.isDone());

        if (!deployResult.isSuccess() && deployResult.getErrorStatusCode() != null) {
            throw new Exception(deployResult.getErrorStatusCode() + " msg: " +
                    deployResult.getErrorMessage());
        }
        
        if (!fetchDetails) {
            // Get the final result with details if we didn't do it in the last attempt.
            deployResult = metadataConnection.checkDeployStatus(asyncResultId, true);
        }
        
        return deployResult;
    }

    private RetrieveResult waitForRetrieveCompletion(AsyncResult asyncResult) throws Exception {
    	// Wait for the retrieve to complete
        int poll = 0;
        long waitTimeMilliSecs = ONE\_SECOND;
        String asyncResultId = asyncResult.getId();
        RetrieveResult result = null;
        do {
            Thread.sleep(waitTimeMilliSecs);
            // Double the wait time for the next iteration
            waitTimeMilliSecs \*= 2;
            if (poll++ > MAX\_NUM\_POLL\_REQUESTS) {
                throw new Exception("Request timed out.  If this is a large set " +
                "of metadata components, check that the time allowed " +
                "by MAX\_NUM\_POLL\_REQUESTS is sufficient.");
            }
            result = metadataConnection.checkRetrieveStatus(
                    asyncResultId, true);
            System.out.println("Retrieve Status: " + result.getStatus());
        } while (!result.isDone());         

        return result;
    }

    private void setUnpackaged(RetrieveRequest request) throws Exception {
        // Edit the path, if necessary, if your package.xml file is located elsewhere
        File unpackedManifest = new File(MANIFEST\_FILE);
        System.out.println("Manifest file: " + unpackedManifest.getAbsolutePath());

        if (!unpackedManifest.exists() || !unpackedManifest.isFile()) {
            throw new Exception("Should provide a valid retrieve manifest " +
                "for unpackaged content. Looking for " +
                unpackedManifest.getAbsolutePath());
        }

        // Note that we use the fully quualified class name because
        // of a collision with the java.lang.Package class
        com.sforce.soap.metadata.Package p = parsePackageManifest(unpackedManifest);
        request.setUnpackaged(p);
    }

    private com.sforce.soap.metadata.Package parsePackageManifest(File file)
            throws ParserConfigurationException, IOException, SAXException {
        com.sforce.soap.metadata.Package packageManifest = null;
        List<PackageTypeMembers> listPackageTypes = new ArrayList<PackageTypeMembers>();
        DocumentBuilder db =
                DocumentBuilderFactory.newInstance().newDocumentBuilder();
        InputStream inputStream = new FileInputStream(file);
        Element d = db.parse(inputStream).getDocumentElement();
        for (Node c = d.getFirstChild(); c != null; c = c.getNextSibling()) {
            if (c instanceof Element) {
                Element ce = (Element) c;
                NodeList nodeList = ce.getElementsByTagName("name");
                if (nodeList.getLength() == 0) {
                    continue;
                }
                String name = nodeList.item(0).getTextContent();
                NodeList m = ce.getElementsByTagName("members");
                List<String\> members = new ArrayList<String\>();
                for (int i = 0; i < m.getLength(); i++) {
                    Node mm = m.item(i);
                    members.add(mm.getTextContent());
                }
                PackageTypeMembers packageTypes = new PackageTypeMembers();
                packageTypes.setName(name);
                packageTypes.setMembers(members.toArray(new String\[members.size()\]));
                listPackageTypes.add(packageTypes);
            }
        }
        packageManifest = new com.sforce.soap.metadata.Package();
        PackageTypeMembers\[\] packageTypesArray =
                new PackageTypeMembers\[listPackageTypes.size()\];
        packageManifest.setTypes(listPackageTypes.toArray(packageTypesArray));
        packageManifest.setVersion(API\_VERSION + "");
        return packageManifest;
    }
}

<!-- document id=d87ecec56cadbc4ef1753a56cfab11b0747f53403062be8b2dbdb8960275da86 url=/legacydeveloper/current/en-us/api_meta/meta_streamingappdataconnector.md -->

# StreamingAppDataConnector

Represents the connection information specific to Web and Mobile Connectors.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

StreamingAppDataConnector components have the suffix .streamingAppDataConnector and are stored in the streamingAppDataConnectors folder.

## Version

StreamingAppDataConnector components are available in API version 55.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| appIdentifier | 
Field Type

string

Description

Required.

The unique app identifier (UUID).



 |
| dataConnectorType | 

Field Type

DataConnectorType (enumeration of type string)

Description

Required.

The value of the field is restricted to SteamingApp.

Possible values are:

- DataCloud
- StreamingApp





 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type.



 |
| masterLabel | 

Field Type

string

Description

Required.

The display name of the connector.



 |
| streamingAppDataConnectorType | 

Field Type

StreamingAppDataConnectorType (enumeration of type string)

Description

Required.

The type of connector.

Possible values are:

- MobileApp
- WebApp





 |

## Declarative Metadata Sample Definition

The following is an example of a StreamingAppDataConnector component.

<?xml version="1.0" encoding="UTF-8"?>
<StreamingAppDataConnector xmlns="http://soap.sforce.com/2006/04/metadata">
    <appIdentifier\>61826b62-6b90-49ff-8259</appIdentifier\>
    <dataConnectorType\>StreamingApp</dataConnectorType\>
    <masterLabel\>My Web Application</masterLabel\>
    <streamingAppDataConnectorType\>WebApp</streamingAppDataConnectorType\>
</StreamingAppDataConnector\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>MyPackage</fullName\>
    <namespacePrefix\>ns1</namespacePrefix\>
    <types\>
        <members\>My\_Web\_Application\_Behavioral\_Events\_F4DA8759</members\>
        <name\>DataStreamDefinition</name\>
    </types\>
    <types\>
        <members\>My\_Web\_Application\_61826b62\_6b90\_49ff\_8259</members\>
        <name\>ExternalDataConnector</name\>
    </types\>
    <types\>
        <members\>My\_Web\_Application\_61826b62\_6b90\_49ff\_8259</members\>
        <name\>StreamingAppDataConnector</name\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=a203aa9b29df86c51920a227e31cab13b53f14052d0b60334954722502bd471d url=/legacydeveloper/current/en-us/api_meta/meta_subscriptionmanagementsettings.md -->

# SubscriptionManagementSettings

Represents the settings used to manage recurring subscriptions.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

SubscriptionManagementSettings values are stored in the subscriptionmanagement.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

## Version

SubscriptionManagementSettings components are available in API version 55.0 and later.

## Special Access Rules

This metadata type is available with Subscription Management.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableBillingDocGen | boolean | Indicates whether document generation is enabled in the org (true) or not (false). The default value is false. |
| enableConvert​NegativeInvoiceLines​ToCreditMemo​AndApply | boolean | Indicates whether to convert negative invoice lines into a credit note (true) or not (false). This credit note holds a positive balance that you can later use to apply against future invoices. The default value is false. |
| enableInvHeaderLvlSettlement | boolean | Indicates whether payments can be applied on the whole invoice (true) or only on invoice lines (false). The default value is false. |
| enablePaymentScheduleAutomation | boolean | Indicates whether the payment schedule and payment schedule item are created automatically (true) or not (false). The default value is false. |
| enableRefundAutomation | boolean | Indicates whether refunds are processed automatically (true) or not (false). The default value is false. |
| enableRevSubMgmtBlngOptOut | boolean | Indicates whether the billing schedules in Subscription Management are disabled (true) or not (false). The default value is false. |
| enableSubscriptionManagement | boolean | Indicates whether Subscription Management is enabled (true) or not (false). The default value is false. |

## Declarative Metadata Sample Definition

This example shows a sample SubscriptionManagementSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<SubscriptionManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableSubscriptionManagement\>true</enableSubscriptionManagement\>
</SubscriptionManagementSettings\>

This example shows a sample package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>SubscriptionManagementSettings</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=9a884bbfb1d973fe120185c34f1c465e3ec2b9feb91d707d8b2ce247c801445b url=/legacydeveloper/current/en-us/api_meta/meta_editions.md -->

# Supported Salesforce Editions

To use Metadata API, your organization must use **Enterprise Edition**, **Unlimited Edition**, **Performance Edition**, or **Developer Edition**. If you’re an existing Salesforce customer and want to upgrade to Enterprise, Unlimited, or Performance Edition, contact your account representative.

We strongly recommend that you use a sandbox, which is an exact replica of your production organization. Enterprise, Unlimited, and Performance Editions come with free developer sandboxes. For more information, see [http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jsp](http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jsp).

Alternatively, you can use a Developer Edition (DE) org. A DE org provides access to all features that are available with Enterprise Edition, but is limited by the number of users and the amount of storage space. A DE org isn’t a copy of your production org/ It provides an environment where you can build and test your solutions without affecting your organization’s data. Developer Edition accounts are available for free at [https://developer.salesforce.com/signup](https://developer.salesforce.com/signup).

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

A metadata component must be visible in the org for Metadata API to act on it. Also, a user must have the API Enabled permission to have access to metadata components.

**Metadata API Access for Professional Edition**

ISV partners can request Metadata API access to Professional Edition orgs for apps that have passed AppExchange Security Review. Access is granted through an API token (client ID). This special key enables the app to make Metadata API calls to customers’ Professional Edition orgs.

As an ISV partner, you can request Metadata API access by following these steps.

1. Submit your app for security review. See [Steps in the Security Review](https://developer.salesforce.com/docs/atlas.en-us.264.0.packagingGuide.meta/packagingGuide/security_review.htm "HTML (New Window)") in the [ISVForce Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.packagingGuide.meta/packagingGuide/ "HTML (New Window)").
2. After your app is approved, log a case in the [Partner Community](https://partners.salesforce.com/ "HTML (New Window)") in **AppExchange and Feature Requests** | **API Token Request**, and specify SOAP for the type of token.

To make calls to the Metadata API, append the API token to the [CallOptions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_calloptions.htm "Specifies the API client identifier.") SOAP header in your calls.

<!-- document id=8783005a97598f8fe7cdb2c28f05fe01f9d0bdae20a34dc769de3c2713f2cc3f url=/legacydeveloper/current/en-us/api_meta/meta_surveysettings.md -->

# SurveySettings

Represents an org’s survey settings. Use the SurveySettings component to enable Salesforce Surveys, enable Customer Lifecycle Maps, and choose whether the owner of a survey can manage the responses.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details.

## File Suffix and Directory Location

SurveySettings values are stored in a single file named Survey.settings 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

SurveySettings is available in API version 47.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableGenerativeAISurveys | boolean | Indicates whether AI-Generated Surveys is enabled for your org (true) or not (false). The default value is false. Available in API version 62.0 and later. |
| enableIndustriesCxmEnabled | boolean | Indicates whether Customer Lifecycle Maps is enabled for your org (true) or not (false). The default value is false. |
| enableSurvey | boolean | Indicates whether Surveys is enabled for your org (true) or not (false). The default value is false. |
| enableSurveyOwnerCanManageResponse | boolean | Indicates whether the owner of a survey can manage its responses. The default value is false. |

## Declarative Metadata Sample Definition

This example shows a sample SurveySettings component.

<?xml version="1.0" encoding="UTF-8"?>
<SurveySettingsxmlns="http://soap.sforce.com/2006/04/metadata">
<enableIndustriesCxmEnabled\>false</enableIndustriesCxmEnabled\>
<enableSurvey\>true</enableSurvey\>
<enableSurveyOwnerCanManageResponse\>false</enableSurveyOwnerCanManageResponse\>
<enableGenerativeAISurveys\>false</enableGenerativeAISurveys\>
</SurveySettings\>

This example shows a sample package.xml file that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Survey</members>
        <name>Settings</name>
    </types>
    <version>61.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)"). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=409f2ab801ec3d67c87e804c7294ee274ec321db1216bac174de2336cef03c5b url=/legacydeveloper/current/en-us/api_meta/meta_sustainabilityuom.md -->

# SustainabilityUom

Represents the unit of measure (UOM) values for custom fuel types in an org. Track fuel consumption and emission results with the flexibility to add custom fuel types and UOM values.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

SustainabilityUom components have the suffix .sustainabilityUom and are stored in the sustainabilityUoms folder.

## Version

SustainabilityUom components are available in API version 56.0 and later.

## Special Access Rules

The Net Zero Cloud permission set license is required to access this object along with the user access for carbon accounting and org access for custom fuels and UOMs.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d882754e101">Field Name</th>

              <th class="featureTableHeader  " id="d882754e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The description of the unit of measure.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isProductUom</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Indicates whether the unit of measure is for a
                  product that the company has procured in its supply
                  chain operations (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type.</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isStationaryAssetUom</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Indicates whether the unit of measure is used in the
                  stationary asset calculations (<samp class="codeph nolang">true</samp>) or (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isVehicleAssetUom</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether the unit of measure is used in the vehicle asset calculations
                  (<samp class="codeph nolang">true</samp>) or
                  (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isWasteUom</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether the unit of measure is used in the
                  generated material waste calculations (<samp class="codeph nolang">true</samp>) or (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

                <p class="p">This field is available in API version 65.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The label assigned to this object.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">unitType</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: UnitType
                  (enumeration of type string)</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The type of unit used for conversions or
                  calculations.</p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Energy</samp></li>

                  <li class="li"><samp class="codeph nolang">Other</samp></li>

                  <li class="li"><samp class="codeph nolang">Volume</samp></li>

                  <li class="li"><samp class="codeph nolang">Weight</samp></li>

                </ul>

              </td>


            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SustainabilityUom component.

<?xml version="1.0" encoding="UTF-8"?>
<SustainabilityUom xmlns="http://soap.sforce.com/2006/04/metadata">
   <description\>Weight in Grams</description\>
   <isProductUom\>true</isProductUom\>
   <isProtected\>false</isProtected\>
   <isStationaryAssetUom\>false</isStationaryAssetUom\>
   <isVehicleAssetUom\>false</isVehicleAssetUom\>
   <isWasteUom\>true</isWasteUom\>
   <masterLabel\>Grams</masterLabel\>
   <unitType\>Weight</unitType\>
</SustainabilityUom\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <fullName\>Pkg</fullName\>
   <types\>
    <members\>Grams</members\>
    <name\>SustainabilityUom</name\>
   </types\>
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=c6cca363a697729741e0b03617df1fe1b9eb2f25f69ebd7e656c44cad05f27c2 url=/legacydeveloper/current/en-us/api_meta/meta_sustnuomconversion.md -->

# SustnUomConversion

Represents information about the unit of measure (UOM) conversion for the custom fuel types defined by a customer in an org.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

SustnUomConversion components have the suffix sustnUomConversion and are stored in the sustnUomConversions folder.

## Version

SustnUomConversion components are available in API version 57.0 and later.

## Special Access Rules

The Net Zero Cloud permission set license is required to access this object along with the user access for carbon accounting and org access for custom fuels and UOMs.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d883628e101">Field Name</th>

              <th class="featureTableHeader  " id="d883628e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">

            <tr>
              <td class="entry" headers="d883628e101" data-title="Field Name"><span class="keyword parmname">conversionFactor</span></td>

              <td class="entry" headers="d883628e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: double</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The conversion factor that's used to convert values
                  from one unit of measure to another for the fuel
                  type.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d883628e101" data-title="Field Name"><span class="keyword parmname">fuelType</span></td>

              <td class="entry" headers="d883628e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">The name of the fuel type.</p>

                <div class="p">Possible values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">AutogasLPG</samp></li>

                    <li class="li"><samp class="codeph nolang">Biodiesel</samp></li>

                    <li class="li"><samp class="codeph nolang">Biomass</samp></li>

                    <li class="li"><samp class="codeph nolang">CityGas</samp></li>

                    <li class="li"><samp class="codeph nolang">CompressedNaturalGasCNG</samp></li>

                    <li class="li"><samp class="codeph nolang">Cooling</samp></li>

                    <li class="li"><samp class="codeph nolang">Diesel</samp></li>

                    <li class="li"><samp class="codeph nolang">Electricity</samp></li>

                    <li class="li"><samp class="codeph nolang">Ethanol</samp></li>

                    <li class="li"><samp class="codeph nolang">FuelOil</samp></li>

                    <li class="li"><samp class="codeph nolang">Gasoline</samp></li>

                    <li class="li"><samp class="codeph nolang">Heat</samp></li>

                    <li class="li"><samp class="codeph nolang">HeavyOil</samp></li>

                    <li class="li"><samp class="codeph nolang">ITElectricity</samp></li>

                    <li class="li"><samp class="codeph nolang">JetFuel</samp></li>

                    <li class="li"><samp class="codeph nolang">Kerosene</samp></li>

                    <li class="li"><samp class="codeph nolang">LightOil</samp></li>

                    <li class="li"><samp class="codeph nolang">LiquidNaturalGasLNG</samp></li>

                    <li class="li"><samp class="codeph nolang">MobileDiesel</samp></li>

                    <li class="li"><samp class="codeph nolang">NaturalGas</samp></li>

                    <li class="li"><samp class="codeph nolang">Propane</samp></li>

                    <li class="li"><samp class="codeph nolang">Refrigerant</samp></li>

                    <li class="li"><samp class="codeph nolang">Steam</samp></li>

                  </ul>
                </div>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d883628e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d883628e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type.</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d883628e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d883628e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: A user-friendly name for SustnUomConversion, which is defined when the
                  SustnUomConversion is created.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d883628e101" data-title="Field Name"><span class="keyword parmname">sourceUom</span></td>

              <td class="entry" headers="d883628e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The source unit of measure for the fuel type.</p>

                <div class="p">Possible values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">1000m3</samp></li>

                    <li class="li"><samp class="codeph nolang">GJ</samp></li>

                    <li class="li"><samp class="codeph nolang">GWh</samp></li>

                    <li class="li"><samp class="codeph nolang">Kiloliters</samp></li>

                    <li class="li"><samp class="codeph nolang">Liters</samp></li>

                    <li class="li"><samp class="codeph nolang">MJ</samp></li>

                    <li class="li"><samp class="codeph nolang">MMBtu</samp></li>

                    <li class="li"><samp class="codeph nolang">MWh</samp></li>

                    <li class="li"><samp class="codeph nolang">Therms</samp></li>

                    <li class="li"><samp class="codeph nolang">Tonnes</samp></li>

                    <li class="li"><samp class="codeph nolang">UkGallons</samp></li>

                    <li class="li"><samp class="codeph nolang">UsGallons</samp></li>

                    <li class="li"><samp class="codeph nolang">ccf</samp></li>

                    <li class="li"><samp class="codeph nolang">kG</samp></li>

                    <li class="li"><samp class="codeph nolang">kWh</samp></li>

                    <li class="li"><samp class="codeph nolang">kcal</samp></li>

                    <li class="li"><samp class="codeph nolang">lbs</samp></li>

                    <li class="li"><samp class="codeph nolang">longTons</samp></li>

                    <li class="li"><samp class="codeph nolang">m3</samp></li>

                    <li class="li"><samp class="codeph nolang">shortTons</samp></li>

                  </ul>
                </div>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d883628e101" data-title="Field Name"><span class="keyword parmname">targetUom</span></td>

              <td class="entry" headers="d883628e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The target unit of measure for the fuel type.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d883628e101" data-title="Field Name"><span class="keyword parmname">uomsKey</span></td>

              <td class="entry" headers="d883628e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The key associated with a unit of measure for the fuel type.</p>

              </td>


            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SustnUomConversion component.

<?xml version="1.0" encoding="UTF-8"?>
<SustnUomConversion xmlns="http://soap.sforce.com/2006/04/metadata">
    <conversionFactor\>0.9</conversionFactor\>
    <fuelType\>Diesel</fuelType\>
    <isProtected\>false</isProtected\>
    <masterLabel\>KG\_Liters</masterLabel\>
    <sourceUom\>KG</sourceUom\>
    <targetUom\>Liters</targetUom\>
    <uomsKey\>uomsKey</uomsKey\>
</SustnUomConversion\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>Pkg</fullName\>
    <types\>
        <members\>US\_UK\_Gallons</members\>
        <members\>Therms\_kWh</members\>
        <members\>KG\_Liters</members\>
        <name\>SustnUomConversion</name\>
    </types\>
    <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=ef572d4caeb252b6b808382652083cfb14fee80e97ddee8f69fac190c013e0dc url=/legacydeveloper/current/en-us/api_meta/meta_svccatalogcategory.md -->

# SvcCatalogCategory

Represents the grouping of individual catalog items in Service Catalog.

## File Suffix and Directory Location

SvcCatalogCategory components have the suffix category and are stored in the svcCatalogCategories folder.

## Version

SvcCatalogCategory components are available in API version 53.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| image | 
Field Type

string

Description

The developer name of a content document to be displayed in the Service Catalog for this category.



 |
| isActive | 

Field Type

boolean

Description

Indicates if a catalog category is active.



 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value. This value currently has no impact.



 |
| masterLabel | 

Field Type

string

Description

Required. The primary label for the catalog category record.



 |
| parentCategory | 

Field Type

string

Description

If provided, the name of another SvcCatalogCategory that this category should appear under. The parent category in this field can’t have its own parent category. Categories can’t have more than one level of nesting.



 |
| sortOrder | 

Field Type

int

Description

Displays a set order for catalog category entities.



 |

## Declarative Metadata Sample Definition

The following is an example of a SvcCatalogCategory component.

<?xml version="1.0" encoding="UTF-8"?>
<SvcCatalogCategory xmlns="http://soap.sforce.com/2006/04/metadata">
    <image\>AdobeStock\_287068722</image\>
    <isActive\>true</isActive\>
    <isProtected\>false</isProtected\>
    <masterLabel\>Workplace Services</masterLabel\>
    <sortOrder\>4</sortOrder\>
</SvcCatalogCategory\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=5ce2c761a877e7a5ab852ef70809eb66d997afbf18d0da78c5a3566ac971d876 url=/legacydeveloper/current/en-us/api_meta/meta_svccatalogfulfillmentflow.md -->

# SvcCatalogFulfillmentFlow

Represents the flow associated with a specific catalog item in the Service Catalog.

## File Suffix and Directory Location

SvcCatalogFulfillmentFlow components have the suffix fulfillmentFlow and are stored in the svcCatalogFulfillmentFlows folder.

## Version

SvcCatalogFulfillmentFlows components are available in API version 53.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Required. Free-text description of the fulfillment flow.



 |
| flow | 

Field Type

string

Description

Required. The name of the flow represented by this SvcCatalogFulfillmentFlow.



 |
| icon | 

Field Type

string

Description

Represents the details of an icon.



 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value. This value currently has no impact.



 |
| items | 

Field Type

[SvcCatalogFulfillFlowItem](#subtype_SvcCatalogFulfillFlowItem)\[\]

Description

The list of variables in the flow that can accept a value as input.



 |
| masterLabel | 

Field Type

string

Description

Required. The primary label for the fulfillment flow record.



 |

## SvcCatalogFulfillFlowItem

Represents a variable in a fulfillment flow that can accept input. Describes what type of value it accepts.

| Field Name | Description |
| --- | --- |
| catalogInputVariable | 
Field Type

string

Description

Required.

The FlowVariable the fulfillment flow property represents.





 |
| displayType | 

Field Type

PropertyDisplayType (enumeration of type string)

Description

The display options available.

Values are:

- Checkbox
- Date (available in API version 59.0 and later)
- DateTime (available in API version 59.0 and later)
- Lookup
- Number
- Picklist
- Queue (available in API version 57.0 and later)
- Text





 |
| fieldDefinition | 

Field Type

string

Description

The name of a field in the object provided in objectLookupDomain that specifies the value for this variable. If displayType is Picklist, this value must be the name of a picklist field. If displayType is Lookup and fieldLookupDomain is FieldDefinition, this value must be the name of a relationship field.



 |
| fieldLookupDomain | 

Field Type

string

Description

The name of a standard or custom object that specifies the domain of that lookup or picklist. This value is relevant only if displayType is Lookup or Picklist.



 |
| isAdditionalQuestionsInputVariable | 

Field Type

boolean

Description

Determines if this variable accepts input for all additional questions that were asked to a user. This value can only be true if the displayType for this item is Text. Only one item per SvcCatalogFulfillmentFlow component can set this attribute to true.



 |
| isRequired | 

Field Type

boolean

Description

Determines if the field is required for the related fulfillment flow to be executed.



 |
| lookupDomainFieldType | 

Field Type

string

Description

This value specifies the fields for the object specified by objectLookupDomain that are displayed in the Catalog Builder by type. This value is only relevant if displayType is Lookup and fieldLookupDomain is FieldDefinition.



 |
| masterLabel | 

Field Type

string

Description

Required.

The primary label for the fulfillment flow record.





 |
| objectLookupDomain | 

Field Type

string

Description

The name of a custom or standard object. If displayType is Lookup or Picklist, this value filters the available options to a specific object.



 |

## Declarative Metadata Sample Definition

The following is an example of a SvcCatalogFulfillmentFlow component.

<?xml version="1.0" encoding="UTF-8"?>
<SvcCatalogFulfillmentFlow xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Creates a Case record related to the Contact belonging to the current User. If this will be used by Users without related Contacts, provide an Account Id below. This Account Id will be used instead of a Contact.</description\>
    <flow\>Create\_Case\_by\_Record\_Type</flow\>
    <isProtected\>false</isProtected\>
    <items\>
        <catalogInputVariable\>Input\_RecordTypeApiName</catalogInputVariable\>
        <displayType\>Text</displayType\>
        <isAdditionalQuestionsInputVariable\>false</isAdditionalQuestionsInputVariable\>
        <isRequired\>true</isRequired\>
        <masterLabel\>Record Type Developer Name</masterLabel\>
    </items\>
    <items\>
        <catalogInputVariable\>Input\_AccountId</catalogInputVariable\>
        <displayType\>Lookup</displayType\>
        <fieldDefinition\>AccountId</fieldDefinition\>
        <fieldLookupDomain\>Account</fieldLookupDomain\>
        <isAdditionalQuestionsInputVariable\>false</isAdditionalQuestionsInputVariable\>
        <isRequired\>false</isRequired\>
        <masterLabel\>(Optional) Related Account</masterLabel\>
        <objectLookupDomain\>Contact</objectLookupDomain\>
    </items\>
    <items\>
        <catalogInputVariable\>Input\_Origin</catalogInputVariable\>
        <displayType\>Picklist</displayType\>
        <fieldDefinition\>Origin</fieldDefinition\>
        <isAdditionalQuestionsInputVariable\>false</isAdditionalQuestionsInputVariable\>
        <isRequired\>true</isRequired\>
        <masterLabel\>Case Origin</masterLabel\>
        <objectLookupDomain\>Case</objectLookupDomain\>
    </items\>
    <items\>
        <catalogInputVariable\>Input\_Priority</catalogInputVariable\>
        <displayType\>Picklist</displayType\>
        <fieldDefinition\>Priority</fieldDefinition\>
        <isAdditionalQuestionsInputVariable\>false</isAdditionalQuestionsInputVariable\>
        <isRequired\>false</isRequired\>
        <masterLabel\>Case Priority</masterLabel\>
        <objectLookupDomain\>Case</objectLookupDomain\>
    </items\>
    <items\>
        <catalogInputVariable\>Input\_Status</catalogInputVariable\>
        <displayType\>Picklist</displayType\>
        <fieldDefinition\>Status</fieldDefinition\>
        <isAdditionalQuestionsInputVariable\>false</isAdditionalQuestionsInputVariable\>
        <isRequired\>true</isRequired\>
        <masterLabel\>Case Status</masterLabel\>
        <objectLookupDomain\>Case</objectLookupDomain\>
    </items\>
    <items\>
        <catalogInputVariable\>Input\_Subject</catalogInputVariable\>
        <displayType\>Text</displayType\>
        <isAdditionalQuestionsInputVariable\>false</isAdditionalQuestionsInputVariable\>
        <isRequired\>true</isRequired\>
        <masterLabel\>Case Subject</masterLabel\>
    </items\>
    <items\>
        <catalogInputVariable\>Input\_Description</catalogInputVariable\>
        <displayType\>Text</displayType\>
        <isAdditionalQuestionsInputVariable\>true</isAdditionalQuestionsInputVariable\>
        <isRequired\>false</isRequired\>
        <masterLabel\>Case Description</masterLabel\>
    </items\>
    <masterLabel\>Create Case by Record Type</masterLabel\>
</SvcCatalogFulfillmentFlow\>   
      

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=ee2f28b3c54d2234e81f48dd247af341f70fb27f86364cb5488fb8ec47ed8cef url=/legacydeveloper/current/en-us/api_meta/meta_svccatalogitemdef.md -->

# SvcCatalogItemDef

Represents the entity associated with a specific, individual service available in the Service Catalog.

## File Suffix and Directory Location

SvcCatalogItemDef components have the suffix catalogItem and are stored in the svcCatalogItems folder.

## Version

SvcCatalogItemDef components are available in API version 53.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| apiVersion | 
Field Type

double

Description

The API version in which this catalog item was created. The value for this field updates based on the value of fulfillmentFlow. For catalog items created before version 57.0, the value for this field is null. Available in version 57.0 and later.



 |
| catalogFilterCriteria | 

Field Type

[SvcCatalogItemDefFiltrCrit](#subtype_SvcCatalogCategoryItemDefFilterCrit)\[\]

Description

The eligibility rule associated with a catalog item. Eligibility rules customize access to catalog items for different audiences, based on the User object. Available in API version 59.0 and later.



 |
| categories | 

Field Type

[SvcCatalogCategoryItem](#subtype_SvcCatalogCategoryItem)\[\]

Description

A list of catalog categories that contain this catalog item.



 |
| dataCategories | 

Field Type

[SvcCatalogItemDefDataCategorySelection](#SvcCatalogItemDefDataCategorySelection)\[\]

Description

A list of data categories for this catalog item. Available in API version 59.0 and later.



 |
| description | 

Field Type

string

Description

Description of the catalog item.



 |
| flow | 

Field Type

string

Description

The screen flow associated with the catalog item. Available in API version 53.0 to 58.0.



 |
| fulfillmentFlow | 

Field Type

string

Description

Name of the related [SvcCatalogFulfillmentFlow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_svccatalogfulfillmentflow.htm "Represents the flow associated with a specific catalog item in the Service Catalog."), which represents the flow associated with a specific catalog item in the Service Catalog. Available in API version 56.0 and later.



 |
| image | 

Field Type

string

Description

The developer name of a content document to be displayed in the Service Catalog for this item.



 |
| inputs | 

Field Type

[SvcCatalogItemAttribute](#subtype_SvcCatalogItemAttribute)\[\]

Description

Represents attributes of a catalog item version. Available in API version 57.0 and later.



 |
| internalNotes | 

Field Type

string

Description

Intended to describe what the catalog item does and its implementation. That value is meant for other catalog builders.



 |
| isAvailableToAllCustomers | 

Field Type

boolean

Description

Required. Controls catalog item access for internal users. To share with all internal users, set the value to True. This value corresponds to the **Allow Access for All Users** option for Internal Access in the Catalog Item Builder. Available in API version 61.0 and later.



 |
| isFeatured | 

Field Type

boolean

Description

Determines if the catalog item is part of the featured catalog items.



 |
| isGuestAccessible | 

Field Type

boolean

Description

Required. Controls catalog item access for guest users. To share with guests, set the value to True. This value corresponds to **Guest Visibility** option for External Access in the Catalog Item Builder. Available in API version 61.0 and later.



 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value. This value has no impact.



 |
| masterLabel | 

Field Type

string

Description

Required. The primary label for the catalog item record.



 |
| sharedTo | 

Field Type

[SharedTo](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.")

Description

Describes how the catalog item is shared across multiple catalog categories. SvcCatalogItemDef only supports sharing with groups.



 |
| status | 

Field Type

PublishStatusType (enumeration of type string)

Description

Required. Displays the publishing status of a catalog item.

Values are:

- Deprecated
- Draft
- PendingChanges
- Published





 |

## SvcCatalogItemDefFiltrCrit

Represents the association of an eligibility rule with a catalog item. Eligibility rules customize access to catalog items for different audiences, based on the User object. Available in version 59.0 and later.

| Field Name | Description |
| --- | --- |
| svcCatalogFilterCriteria | 
Field Type

string

Description

The name of the associated catalogFilerCriteria eligibility filter.



 |

## SvcCatalogCategoryItem

Represents the assignment of this service to a category within the Service Catalog.

| Field Name | Description |
| --- | --- |
| isPrimaryCategory | 
Field Type

boolean

Description

Determines if the catalog category (svcCatalogCategory) is the primary category for this catalog item. Exactly one category per SvcCatalogItemDef component must set this attribute to true.



 |
| sortOrder | 

Field Type

int

Description

The position of the catalog item relative to other catalog items in the catalog category.



 |
| svcCatalogCategory | 

Field Type

string

Description

Required. The catalog category the catalog item is assigned to.





 |

## SvcCatalogItemDefDataCategorySelection

Represents a list of data categories for this catalog item. This subtype is available in API version 59.0 and later.

| Field Name | Description |
| --- | --- |
| category | 
Field Type

string

Description

API name of a data category.





 |
| categoryGroup | 

Field Type

string

Description

API Name of a data category group.





 |

## SvcCatalogItemAttribute

Represents an attribute of a catalog item version. It can be a static input filled by the catalog builder user or additional questions that end users answer at runtime. Available in API version 57.0 and later.

| Field Name | Description |
| --- | --- |
| field | 
Field Type

string

Description

Applicable when the display type is Lookup/Reference.





 |
| inputType | 

Field Type

SvcCatalogItemAttrDataType (enumeration of type string)

Description

Required.

Values are:

- Attachment
- Checkbox
- Currency
- Date
- Datetime
- DisplayText
- Email
- IPAddress
- Integer
- ListOfAttachment(available in API version 65.0 and later)
- ListOfBoolean
- ListOfDouble
- ListOfInteger
- ListOfMaps
- ListOfString
- Lookup
- Map
- MultilineText
- MultiSelectPicklist(available in API version 65.0 and later)
- Number
- NumericScale
- Password(available in API version 65.0 and later)
- Percentage
- Picklist
- Queue
- RadioButton(available in API version 65.0 and later)
- SingleCheckbox (available in API version 59.0 and later)
- SinglelineText
- Text
- Toggle (available in API version 59.0 and later)
- Url





 |
| inputVariable | 

Field Type

string

Description

References the input variable to which the attribute value is forwarded.





 |
| isRequired | 

Field Type

boolean

Description

Determines if an answer is required for this question.





 |
| label | 

Field Type

string

Description

A translatable label for rendering the attribute to users.





 |
| maxValue | 

Field Type

double

Description

Applicable when the display type is slider.





 |
| minValue | 

Field Type

double

Description

Applicable when the display type is slider.





 |
| name | 

Field Type

string

Description

Required. Applicable when the display type is Lookup/Reference.





 |
| object | 

Field Type

string

Description

A picklist object’s custom API Name. Applies when inputType is set to Picklist.



 |
| options | 

Field Type

SvcCatalogItemAttrDetail

Description

The values attached to an attribute of an item version.



 |
| type | 

Field Type

SvcCatalogItemAttrType (enumeration of type string)

Description

Required. Type of the attribute; used to determine if it's a pre-filled input or questions to ask users.

Values are:

- FulfillmentInput
- UserQuestion





 |
| value | 

Field Type

string

Description

Attribute value defined by the catalog builder.





 |

## SvcCatalogItemAttrDetail

Represents the details for an attribute of an item version. Used for options displayed in picklist or checkbox groups.

| Field Name | Description |
| --- | --- |
| isDefault | 
Field Type

boolean

Description

Required. Marks the attribute detail as the default. Applicable when the input display type is picklist or checkbox.





 |
| label | 

Field Type

string

Description

Required. Picklist option label when the input type is picklist or checkbox.





 |
| value | 

Field Type

string

Description

Attribute value defined by the catalog builder.





 |

## Declarative Metadata Sample Definition

The following is an example of a SvcCatalogItemDef component.

<SvcCatalogItemDef xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion\>57.0</apiVersion\>
    <categories\>
        <isPrimaryCategory\>true</isPrimaryCategory\>
        <sortOrder\>3</sortOrder\>
        <svcCatalogCategory\>Category1</svcCatalogCategory\>
    </categories\>
    <dataCategories\>
        <category\>France</category\>
        <categoryGroup\>World</categoryGroup\>
    </dataCategories\>
    <masterLabel\>Item Draft Update</masterLabel\>
    <description\>Item with a Draft state</description\>
    <fulfillmentFlow\>TestQuestions</fulfillmentFlow\>
    <isFeatured\>false</isFeatured\>
    <isProtected\>false</isProtected\>
    <status\>Published</status\>
    <inputs\>
        <name\>Input1</name\>
        <type\>FulfillmentInput</type\>
        <inputVariable\>input1</inputVariable\>
        <label\>Input Static</label\>
        <inputType\>Text</inputType\>
        <isRequired\>false</isRequired\>
    </inputs\>
    <inputs\>
        <type\>UserQuestion</type\>
        <inputType\>Picklist</inputType\>
        <isRequired\>false</isRequired\>
        <label\>My First Question</label\>
        <name\>first\_question</name\>
        <options\>
            <label\>Option 1</label\>
            <value\>option\_1</value\>
            <isDefault\>true</isDefault\>
        </options\>
        <options\>
            <label\>Option 2</label\>
            <value\>option\_2</value\>
            <isDefault\>false</isDefault\>
        </options\>
        <options\>
            <label\>Option 3</label\>
            <value\>option\_3</value\>
            <isDefault\>false</isDefault\>
        </options\>
    </inputs\>
</SvcCatalogItemDef\>        

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=4fea5b43f401210aea812cd9f0bf9782c2f04bf9669eed90bfde9ad6c95ae9c8 url=/legacydeveloper/current/en-us/api_meta/meta_synonymdictionary.md -->

# SynonymDictionary

Represents a set of synonym groups, which are groups of words or phrases that are treated as equivalent in users’ searches. You can define synonym groups to optimize search results for acronyms, variations of product names, and other terminology unique to your organization.

Synonyms are available in Service Cloud features such as Salesforce Knowledge. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

SynonymDictionary components have the suffix .synonymDictionary and are stored in the synonymDictionaries folder.

## Version

SynonymDictionary components are available in API version 29.0 and later.

## Special Access Rules

Synonyms must be enabled in your organization. Only users with the “Manage Synonyms” permission can access this object.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| groups | [SynonymGroup](#SubTypeID) | The synonym groups defined in this dictionary. |
| isProtected | boolean | Indicates whether this component is protected (true) or not (false). Protected components cannot be linked to or referenced by components created in the installing organization. |
| label | string | Required. Specifies the display name of the synonym dictionary. |

## SynonymGroup

Represents a group of synonymous words or phrases.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d889990e194">Field Name</th>

              <th class="featureTableHeader  " id="d889990e197">Field Type</th>

              <th class="featureTableHeader  " id="d889990e200">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d889990e194" data-title="Field Name"><span class="keyword parmname">languages</span></td>

              <td class="entry" headers="d889990e197" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_translations.htm#translation_languages">Language</a></td>

              <td class="entry" headers="d889990e200" data-title="Description">Required. Specifies the languages the synonym group applies to.
                If synonyms are specific to a single language, specify only that
                language. If the synonyms apply to multiple languages, specify
                multiple languages for one synonym group.</td>

            </tr>

            <tr>
              <td class="entry" headers="d889990e194" data-title="Field Name"><span class="keyword parmname">terms</span></td>

              <td class="entry" headers="d889990e197" data-title="Field Type">string</td>

              <td class="entry" headers="d889990e200" data-title="Description">Required. A word or phrase synonymous with other terms in the
                group. Maximum of 50 characters. Minimum of two
                <span class="keyword parmname">terms</span> per group.<p class="p">Synonym groups are
                  symmetric, which means that if oranges and apples are defined in
                  a synonym group, a search for <kbd class="ph userinput">oranges</kbd>
                  will return a match for <kbd class="ph userinput">apples</kbd>, and vice
                  versa for a search for
                  <kbd class="ph userinput">apples</kbd>.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SynonymDictionary component:

<?xml version="1.0" encoding="UTF-8"?>
<SynonymDictionary xmlns="http://soap.sforce.com/2006/04/metadata">
    <groups\>
        <languages\>en\_US</languages\>
        <terms\>Salesforce</terms\>
        <terms\>salesforce.com</terms\>
        <terms\>The Customer Company</terms\>
        <terms\>SFDC</terms\>
    </groups\>
    <groups\>
        <languages\>fr</languages\>
        <terms\>renault</terms\>
        <terms\>clio</terms\>
    </groups\>
    <label\>Sample Dictionary</label\>
</SynonymDictionary\>

The following is an example package.xml that references the SynonymDictionary component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Sample Dictionary</members\>
        <name\>SynonymDictionary</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

## Usage

If you have existing synonym groups defined before API version 29.0, your existing groups are associated with a default dictionary called \_Default.

If you have a set of synonyms that require frequent updates, we recommend assigning the synonym group or groups to a dedicated dictionary with a small number of groups. Each time you deploy an existing dictionary, all of its synonym groups are overwritten. We don’t support deploying updates to only a single synonym group within a dictionary.

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=718bb6544925ae37b81db091b2f7892977c007316981a414e8c05435e1ca981c url=/legacydeveloper/current/en-us/api_meta/meta_tag.md -->

# Tag

Represents a named label that can be applied to Salesforce metadata records to categorize, describe, or classify them. Tags are organized within a TagSet, which defines the category they belong to. For example, a TagSet named DataDomain might contain Tags such as Financial, Operational, or Legal. Use Tag to define the individual classification values available in a category.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

Tag components are stored in .tagset files as children of TagSet.

## Version

Tag components are available in API version 67.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | A description of the tag. |
| label | string | Required. Label that identifies the tag in the Salesforce user interface. |
| name | string | Required. The unique name of the tag. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. |
| options | [TagOption](#TagOption)\[\] | A list of options associated with the tag. |
| properties | [TagProperty](#TagProperty)\[\] | A list of properties associated with the tag. |

## TagOption

Represents an option associated with a tag.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. The name of the option. |
| value | boolean | Required. The value of the option. |

## TagProperty

Represents a property associated with a tag.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. The name of the property. |
| value | string | Required. The value of the property. |

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

Use the [listMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listmetadata.htm "This call retrieves property information about metadata components in your organization. Data is returned for the components that match the criteria specified in the queries parameter. The queries array can contain up to three ListMetadataQuery queries for each call. This call supports every metadata type: both top-level, such as CustomObject and ApexClass, and child types, such as CustomField and RecordType.") call to discover custom Tags and TagSets in your org.

<!-- document id=be6a9242c9ab0f4717d85bbde7fc7307df95b5e604b712832a60bdf3c703f831 url=/legacydeveloper/current/en-us/api_meta/meta_tagset.md -->

# TagSet

Represents a category that groups related Tag records. A TagSet defines the classification category, and its associated Tag records represent the individual values within that category. For example, a TagSet named DataDomain might group Tags such as Financial, Operational, or Legal. TagSets can be organized into a hierarchy, where a parent TagSet contains one or more child TagSets. This hierarchy allows you to make progressively granular classifications.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

TagSet components have the suffix .tagSet and are stored in the tagSet folder.

## Version

TagSet components are available in API version 67.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | A description of the tag set. |
| label | string | Required. Label that identifies the tag set in the Salesforce user interface. |
| name | string | Required. The unique name of the tag set. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. |
| options | [TagOption](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_tag.htm#TagOption)\[\] | A list of options associated with the tag set. |
| properties | [TagProperty](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_tag.htm#TagProperty)\[\] | A list of properties associated with the tag set. |
| tags | [Tag](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_tag.htm "Represents a named label that can be applied to Salesforce metadata records to categorize, describe, or classify them. Tags are organized within a TagSet, which defines the category they belong to. For example, a TagSet named DataDomain might contain Tags such as Financial, Operational, or Legal. Use Tag to define the individual classification values available in a category.")\[\] | A list of tags included in this tag set. |

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

Use the [listMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listmetadata.htm "This call retrieves property information about metadata components in your organization. Data is returned for the components that match the criteria specified in the queries parameter. The queries array can contain up to three ListMetadataQuery queries for each call. This call supports every metadata type: both top-level, such as CustomObject and ApexClass, and child types, such as CustomField and RecordType.") call to discover custom Tags and TagSets in your org.

<!-- document id=06c4341d049c0860f23040e61328aa63f8c31e03c2c7d10f107120cb09d8c192 url=/legacydeveloper/current/en-us/api_meta/meta_telephonyprovider.md -->

# TelephonyProvider

Represents a telephony provider configuration that an org uses with Bring Your Own Carrier (BYOC).

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

TelephonyProvider components have the suffix .telephonyProvider and are stored in the telephonyProviders folder.

## Version

TelephonyProvider components are available in API version 68.0 and later.

## Special Access Rules

To access TelephonyProvider, you must have the Agentforce Contact Center Admin (Salesforce Voice) permission set assigned.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d894139e103">Field Name</th>

              <th class="featureTableHeader  " id="d894139e106">Field Type</th>

              <th class="featureTableHeader  " id="d894139e109">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">country</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">ByocCountryCode(
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a>
                of type string)
              </td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. Specifies the country of the telephony provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">externalIdentifier</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Specifies the ID of the telephony provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. The unique name of the TelephonyProvider component.
                Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> metadata type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Specifies the ID of the TelephonyProvider record.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. Specifies the label for the telephony provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">providerName</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. Specifies the name of the telephony provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">trunkType</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">TrunkType(
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a>
                of type string)
              </td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. Specifies the trunk type of the telephony provider. Valid
                values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Trusted</samp></li>

                  <li class="li"><samp class="codeph nolang">Secondary</samp></li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample XML definition of a TelephonyProvider component is shown here.

<telephonyProvider>
    <fullName>MyTelephonyProvider</fullName>
    <country>US</country>
    <externalIdentifier>sampleValue</externalIdentifier>
    <id>sampleValue</id>
    <masterLabel>sampleValue</masterLabel>
    <providerName>sampleValue</providerName>
    <trunkType>Trusted</trunkType>
</telephonyProvider>

The following package.xml manifest retrieves the TelephonyProvider component.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   ~ Copyright 2020 Salesforce, Inc.
   ~ All Rights Reserved
   ~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types>
      <members>\*</members>
      <name>TelephonyProvider</name>
   </types>
   <version>XX.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=5e0eb40bda4fdd3fbc768ff894575789e635c90799d894cf8b64660cd736027a url=/legacydeveloper/current/en-us/api_meta/meta_territory.md -->

# Territory

Represents a territory.

## Declarative Metadata File Suffix and Directory Location

The file suffix for territory components is .territory and components are stored in the territories directory of the corresponding package directory.

## Version

Territory components are available in API version 24.0 and later.

## Fields

This metadata type extends to subtype [RoleOrTerritory](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_roleorterritory.htm#meta_roleorterritory "Represents the common base type and valid values for role or territory.").

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d894876e93">Field Name</th>

              <th class="featureTableHeader  " id="d894876e96">Field Type</th>

              <th class="featureTableHeader  " id="d894876e99">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d894876e93" data-title="Field Name"><span class="keyword parmname">accountAccessLevel</span></td>

              <td class="entry" headers="d894876e96" data-title="Field Type">string</td>

              <td class="entry" headers="d894876e99" data-title="Description">
                <span class="ph" id="accountAccessLevel_desc1"><a name="accountAccessLevel_desc1"><!-- --></a>Specifies whether users in this
                  territory can access accounts that are assigned to this
                  territory and are otherwise inaccessible. Valid values
                  are:</span><a name="accountAccessLevel_desc2"><!-- --></a>
                <ul class="ul bulletList" id="accountAccessLevel_desc2">
                  <li class="li"><samp class="codeph apex_code">Read</samp></li>

                  <li class="li"><samp class="codeph apex_code">Edit</samp></li>

                  <li class="li"><samp class="codeph apex_code">All</samp></li>

                </ul>
                <p class="p" id="accountAccessLevel_desc3"><a name="accountAccessLevel_desc3"><!-- --></a>If your organization’s
                  sharing model for accounts is Public Read/Write, valid values
                  are only <samp class="codeph apex_code">Edit</samp> and
                  <samp class="codeph apex_code">All</samp>.
                </p>
                <p class="p">If no
                  value is set for this field, this field value uses the default
                  access level that is specified in the Manage Territory page in
                  Setup.</p>
                <p class="p">This field is available in API version 31.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d894876e93" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d894876e96" data-title="Field Type">string</td>

              <td class="entry" headers="d894876e99" data-title="Description">The unique identifier for API access. The
                <span class="keyword parmname">fullName</span> can contain only underscores and
                alphanumeric characters. It must be unique, begin with a letter, not
                include spaces, not end with an underscore, and not contain two
                consecutive underscores. This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>
                component. Corresponds to <strong class="ph uicontrol">Territory Name</strong> in
                the user interface.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d894876e93" data-title="Field Name"><span class="keyword parmname">parentTerritory</span></td>

              <td class="entry" headers="d894876e96" data-title="Field Type">string</td>

              <td class="entry" headers="d894876e99" data-title="Description">The territory above this territory in the territory
                hierarchy.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of a territory.

<?xml version="1.0" encoding="UTF-8"?>
<Territory xmlns="http://soap.sforce.com/2006/04/metadata">
    <accountAccessLevel\>Edit</accountAccessLevel\>
    <caseAccessLevel\>Edit</caseAccessLevel\>
    <contactAccessLevel\>Edit</contactAccessLevel\>
    <description\>Sample Territory</description\>
    <mayForecastManagerShare\>false</mayForecastManagerShare\>
    <name\>T22name</name\>
    <opportunityAccessLevel\>Read</opportunityAccessLevel\>
</Territory\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a4d198c26fc7f6cb7244cfe3650b8f70ad49b5951746907f0308a7b5cea6587f url=/legacydeveloper/current/en-us/api_meta/meta_territory2.md -->

# Territory2

Represents the metadata associated with a sales territory. This type extends the Metadata metadata type and inherits its fullName field. Available if Sales Territories has been enabled.

## File Suffix and Directory Location

Territory2 components have the suffix territory2 and are stored in the territories folder under the folder for the corresponding Territory2Model.

## Version

Territory2 components are available in API version 32.0 and later.

## Special Access Rules

The Territory2Model object has a State field in the SOAP API. States include Planning, Active, Archived, and several other states, such as Cloning, that indicate that a process is underway. Users who do not have the Manage Territories permission can access territories that belong to the model in Active state. The Manage Territories permission is required for deploy() calls for all territory management entities. Using retrieve() without the Manage Territories permission returns only entities that belong to a Territory2Model in Active state. We recommend against retrieving without the Manage Territories permission because the call retrieves only partial data.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d895357e123">Field Name</th>

              <th class="featureTableHeader  " id="d895357e126">Field Type</th>

              <th class="featureTableHeader  " id="d895357e129">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">accountAccessLevel</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e129" data-title="Description">Specifies whether users in this territory can access accounts that are assigned
                to this territory and are otherwise inaccessible. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">All</samp></li>

                </ul>
                If your organization’s sharing model for accounts is Public Read/Write, valid
                values are only <samp class="codeph nolang">Edit</samp> and <samp class="codeph nolang">All</samp>. If no value is set for this field, this field
                value uses the default access level that is specified in Territory2Settings as
                permitted by the organization’s sharing settings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">caseAccessLevel</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e129" data-title="Description">Specifies whether users in this territory can access cases that are assigned to
                this territory and are otherwise inaccessible. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
                Specify no value if your organization’s sharing model for cases/opportunities
                is Public Read/Write. If no value is set for this field, this field value uses the
                default access level that is specified in Territory2Settings as permitted by the
                organization’s sharing settings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">contactAccessLevel</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e129" data-title="Description">Specifies whether users in this territory can access contacts that are assigned
                to this territory and are otherwise inaccessible. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
                Specify no value if your organization’s sharing model for contacts is Public
                Read/Write or Controlled By Parent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">customFields</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">FieldValue</td>

              <td class="entry" headers="d895357e129" data-title="Description">Values for custom fields defined on the Territory2 object and used by this
                territory. Their metadata is captured separately in CustomObject. Note the
                following:<a name="t2_t2m_custom_fields_def"><!-- --></a>
                <ul class="ul bulletList" id="t2_t2m_custom_fields_def">
                  <li class="li">Territory2 and Territory2Model objects do not handle values for Text Area
                    (Long), Text Area (Rich), and text-encrypted custom fields.</li>

                  <li class="li">Fields are referenced using their API names. Compound field types like
                    Location appear as their constituent column fields. For example,
                    <span class="keyword parmname">nnn_Latitude__s</span>, <span class="keyword parmname">nnn_Longitude__s</span>
                    where “nnn” is the field name and the suffixes are the geolocation
                    components.
                  </li>

                  <li class="li">Values of required custom fields are enforced during the <samp class="codeph nolang">deploy()</samp> operation.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e129" data-title="Description">A description of the territory.</td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e129" data-title="Description">Required. The user interface label for the territory.</td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">objectAccessLevels</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">Territory2AccessLevel</td>

              <td class="entry" headers="d895357e129" data-title="Description">Represents the user access levels of an object associated to a territory.
                Available in API version 57.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">opportunityAccessLevel</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e129" data-title="Description">Specifies whether users in this territory can access opportunities that are
                assigned to this territory and are otherwise inaccessible. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">None</samp></li>

                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                </ul>
                Specify no value if your organization’s sharing model for cases/opportunities
                is Public Read/Write. If no value is set for this field, this field value uses the
                default access level that is specified in Territory2Settings as permitted by the
                organization’s sharing settings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">parentTerritory</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e129" data-title="Description">The name of the territory’s parent. When you specify the parent territory, use
                the developer name. Do not use the “fully qualified” name. Custom fields with no
                values are retrieved with values of type: <samp class="codeph nolang"> &lt;value
                  xsi:nil="true"/&gt;</samp>. You can also use <samp class="codeph nolang"> &lt;value
                  xsi:nil="true"/&gt;</samp> syntax to remove existing values in custom fields.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">ruleAssociations</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">Territory2RuleAssociation[]</td>

              <td class="entry" headers="d895357e129" data-title="Description">Represents an object assignment rule and its association to a territory. Use
                the developer name of the rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e123" data-title="Field Name"><span class="keyword parmname">territory2Type</span></td>

              <td class="entry" headers="d895357e126" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e129" data-title="Description">Required. The territory type that the territory belongs to.</td>

            </tr>

          </tbody>

        </table>

## FieldValue

Represents the values of custom fields on the Territory2 object. Available in API version 32.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| name | string | Required. The user interface label for the territory. |
| value | any type | The value of the field, which can also be null. The field type is specified in the XML and depends on the field value. |

## Territory2AccessLevel

Represents the association of an object access level to a territory. Available in API version 57.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d895357e468">Field Name</th>

              <th class="featureTableHeader  " id="d895357e471">Field Type</th>

              <th class="featureTableHeader  " id="d895357e474">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d895357e468" data-title="Field Name"><span class="keyword parmname">accessLevel</span></td>

              <td class="entry" headers="d895357e471" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e474" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Read</samp></li>

                  <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  <li class="li"><samp class="codeph nolang">Transfer</samp></li>

                  <li class="li"><samp class="codeph nolang">All</samp></li>

                </ul>
                If your organization’s sharing model for accounts is Public Read/Write, valid
                values are only <samp class="codeph nolang">Edit</samp> and <samp class="codeph nolang">All</samp>. If no value is set for this field, this field
                value uses the default access level that is specified in Territory2Settings as
                permitted by the organization’s sharing settings. </td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e468" data-title="Field Name"><span class="keyword parmname">objectType</span></td>

              <td class="entry" headers="d895357e471" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e474" data-title="Description">Required. The type of object associated to the territory. For example,
                Lead.</td>

            </tr>

          </tbody>

        </table>

## Territory2RuleAssociation

Represents the association of an object assignment rule to a territory. Available in API version 32.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d895357e558">Field Name</th>

              <th class="featureTableHeader  " id="d895357e561">Field Type</th>

              <th class="featureTableHeader  " id="d895357e564">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d895357e558" data-title="Field Name"><span class="keyword parmname">inherited</span></td>

              <td class="entry" headers="d895357e561" data-title="Field Type">boolean</td>

              <td class="entry" headers="d895357e564" data-title="Description">Required. Indicates whether the rule is inherited from a parent territory
                (<samp class="codeph nolang">true</samp>) or local to the current territory
                (<samp class="codeph nolang">false</samp>).<p class="p">Rule inheritance flows from the
                  parent territory where the rule is created to the rule’s descendent territories,
                  if any, in the territory model hierarchy. A local rule is created within a single
                  territory and affects that territory only.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d895357e558" data-title="Field Name"><span class="keyword parmname">ruleName</span></td>

              <td class="entry" headers="d895357e561" data-title="Field Type">string</td>

              <td class="entry" headers="d895357e564" data-title="Description">Required. The name of a rule associated with the territory. It isn’t necessary
                to fully qualify <span class="keyword parmname">ruleName</span> because Metadata API assumes that the
                rule belongs to the same model as the territory.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following example shows the definition of a Territory2 component.

<?xml version="1.0" encoding="UTF-8"?>
<Territory2 xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <name\>USA</name\>
    <description\>United States sales</description\>
    <accountAccessLevel\>Edit</accountAccessLevel\>
    <opportunityAccessLevel\>Read</opportunityAccessLevel\>
    <caseAccessLevel\>Edit</caseAccessLevel\>
    <contactAccessLevel\>Edit</contactAccessLevel\>
    <parentTerritory\>Worldwide\_Sales</parentTerritory\>
    <territory2Type\>Geo</territory2Type\>
    <objectAccessLevels\>
        <accessLevel\>All</accessLevel\>
        <objectType\>Lead</objectType\>
    </objectAccessLevels\>
    <ruleAssociations\>
        <ruleName\>AccRule1</name\>
        <inherited\>True</inherited\>
     </ruleAssociations\>
     <ruleAssociations\>
        <ruleName\>AccRule2</name\>
        <inherited\>False</inherited\>
     </ruleAssociations\>
     <customFields\>
        <name\>Activation\_DateTime\_\_c</name\>
        <value xsi:type="xsd:dateTime">2014-07-16T05:05:00.000Z</value\>
     </customFields\>
     <customFields\>
        <name\>AutoNumber\_\_c</name\>
        <value xsi:type="xsd:string">T# 000001</value\>
     </customFields\>
     <customFields\>
        <name\>DeactivationDate\_\_c</name\>
        <value xsi:type="xsd:date">2016-07-12</value\>
     </customFields\>
     <customFields\>
        <name\>External\_Id\_\_c</name\>
        <value xsi:type="xsd:string">AB2345</value\>
     </customFields\>
     <customFields\>
        <name\>ManagersPhone\_\_c</name\>
        <value xsi:nil="true"/>
     </customFields\>
</Territory2\>

The following is a package.xml sample. FY13 and FY14 represent the names of territory models and demonstrate that rules can have identical developer names within different models. A wildcard character (\*) in place of the model name can be used to retrieve all rules in all models in an organization.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">    
    <types\>
        <members\>FY13</members\>
        <members\>FY14</members\>
        <name\>Territory2Model</name\>
    </types\>    

    <types\>
        <members\>FY13.USA</members\>
        <members\>FY13.Worldwide\_Sales</members\>
        <members\>FY14.APAC</members\>
        <members\>FY14.USA</members\>
        <name\>Territory2</name\>
    </types\>
        
    <version\>68.0</version\>
</Package\>

## Usage

- Triggers defined on Territory2 do _not_ fire during a deploy() operation unless there is a deployment failure. For example, when a child territory references a parent and deploys before the parent territory, the failed components try to deploy again one at a time, allowing triggers to run.
- Sales Territories components don’t support packaging or change sets and aren’t supported in [CRUD calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects.").
- For unlocked packaging, Territory2 requires packages without a namespace.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=961f642188205ec94852cf7f4f40d2c4fecd4f4037785e93d5f811689d161bec url=/legacydeveloper/current/en-us/api_meta/meta_territory2model.md -->

# Territory2Model

Represents the metadata associated with a territory model in Sales Territories. This type extends the Metadata metadata type and inherits its fullName field. Available if Sales Territories has been enabled.

## File Suffix and Directory Location

Territory2Model components have the suffix territory2Model and are stored in the territory2Models folder.

## Version

Territory2Model components are available in API version 32.0 and later.

## Special Access Rules

The Territory2Model object has a State field in the SOAP API. States include Planning, Active, Archived, and several other states, such as Cloning, that indicate that a process is underway. Users who do not have the Manage Territories permission can access models in Active state. The Manage Territories permission is required for deploy() calls for all territory management entities. Using retrieve() without the Manage Territories permission returns only entities that belong to a Territory2Model in Active state. We recommend against retrieving without the Manage Territories permission because the call retrieves only partial data.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d897156e123">Field Name</th>

              <th class="featureTableHeader  " id="d897156e126">Field Type</th>

              <th class="featureTableHeader  " id="d897156e129">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d897156e123" data-title="Field Name"><span class="keyword parmname">customFields</span></td>

              <td class="entry" headers="d897156e126" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_territory2.htm#FieldValue">FieldValue</a></td>

              <td class="entry" headers="d897156e129" data-title="Description">Custom fields defined on the Territory2Model object and used by this model.
                Their metadata is captured separately.<ul class="ul bulletList">
                  <li class="li">Territory2 and Territory2Model objects do not handle values for Text Area
                    (Long), Text Area (Rich), and text-encrypted custom fields.</li>

                  <li class="li">Fields are referenced using their API names. Compound field types like
                    Location appear as their constituent column fields. For example,
                    <span class="keyword parmname">nnn_Latitude__s</span>, <span class="keyword parmname">nnn_Longitude__s</span>
                    where “nnn” is the field name and the suffixes are the geolocation
                    components.
                  </li>

                  <li class="li">Values of required custom fields are enforced during the <samp class="codeph nolang">deploy()</samp> operation.</li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d897156e123" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d897156e126" data-title="Field Type">string</td>

              <td class="entry" headers="d897156e129" data-title="Description">A description for the territory model.</td>

            </tr>

            <tr>
              <td class="entry" headers="d897156e123" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d897156e126" data-title="Field Type">string</td>

              <td class="entry" headers="d897156e129" data-title="Description">Required. The user interface label for the territory model.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following example shows the definition of a Territory2Model component.

<?xml version="1.0" encoding="UTF-8"?>
    <Territory2Model xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <name\>FY13</name\>
    <description\>Geographic allocation</description\>
    <customFields\>
        <name\>Activation\_DateTime\_\_c</name\>
        <value xsi:type="xsd:dateTime">2014-07-16T05:05:00.000Z</value\>
    </customFields\>
    <customFields\>
        <name\>AutoNumber\_\_c</name\>
        <value xsi:type="xsd:string">M# 000001</value\>
    </customFields\>
    <customFields\>
        <name\>DeactivationDate\_\_c</name\>
        <value xsi:type="xsd:date">2016-07-12</value\>
    </customFields\>
    <customFields\>
        <name\>External\_Id\_\_c</name\>
        <value xsi:nil="true"/>
    </customFields\>
</Territory2Model\>

## Usage

- The retrieve() call _does not_ return models in these four states: Cloning, Cloning Failed, Deleting, and Deletion Failed.
- Whenever a model is created, its initial state is Planning. You can only do a deploy() operation for models in Planning or Active state. The same requirement applies to territories and rules associated with those models. For example, sometimes you can have a model in Planning state on a sandbox org, and a model with the same developer name in Archived state on your production org. The deploy() operation on production fails because that model’s state is Archived and that state prevents changes to the model.
- Because of the state restrictions, if you have territory models in different orgs with identical developer names and you attempt a deploy() operation, Metadata API attempts to create new models. However, that operation fails because of the developer name conflict. For example, sometimes you can have a model in Planning state on a sandbox org, and a model with the same developer name in Archived state on your production org. The deploy() operation on production fails because that model’s state is Archived and that state prevents changes to the model.
- If you try to delete a model that has territories, then the delete() call changes the model’s state to Deleting and cascade deletes all territories, rules, and user associations in the model. Deleting can take some time depending on the number of territories in the model.
- Whenever a model is created, its initial state is Planning. If a model with the same developer name already exists, it already has a state, so we do not include the State field in Territory2.
- Sales Territories components don’t support packaging or change sets and aren’t supported in [CRUD calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects.").
- Namespaces aren’t supported for unlocked packages.

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=becd55b457f32e2f3387bb52b691c70e055226909d9ea7829c93eb9434cc7bb0 url=/legacydeveloper/current/en-us/api_meta/meta_territory2rule.md -->

# Territory2Rule

Represents the metadata associated with a territory assignment rule associated with an object, such as Account. Available if Sales Territories has been enabled.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

Territory2Rule components have the suffix territory2Rule and are stored in the rules folder under the folder for the corresponding Territory2Model.

## Version

Territory2Rule components are available in API version 32.0 and later.

## Special Access

The Territory2Model object has a State field in SOAP API. States include Planning, Active, Archived, and several other states, such as Cloning, that indicate that a process is underway. Users who don’t have the Manage Territories permission can access rules that belong to the model in Active state. The Manage Territories permission is required for deploy() calls for all territory management entities, in addition to the permissions required by Metadata API. Using retrieve() without the Manage Territories permission returns only entities that belong to a Territory2Model in Active state. We recommend against retrieving without the Manage Territories permission because the call retrieves only partial data.

The SOAP API and the user interface require that a user attempting to create or edit a rule has field-level security access to the fields referenced in the rule item. This restriction is relaxed for Metadata API deploy() operations, as they require both Manage Territories and either the Modify Metadata Through Metadata API Functions or Modify All Data permissions.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| active | boolean | Required. Indicates whether the rule is active (true) or inactive (false). Via the API, active rules run automatically when object records are created and edited. The exception is when the value of the IsExcludedFromRealign field on an object record is true, which prevents record assignment rules from evaluating that record. |
| booleanFilter | string | An advanced filter condition. For example: (1 AND 2) OR 3. Numbering must start at 1 and must be contiguous. |
| name | string | Required. The user interface label for the rule. |
| objectType | string | Required. The object that the rule is defined for. For API version 32.0, the only available object is Account. |
| ruleItems | [Territory2RuleItem](#Territory2RuleItem) | The items that define a rule’s the selection criteria, such as Billing State equals California. |

## Territory2RuleItem

Represents the association of a rule item to a rule. Available in API version 32.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d897813e265">Field Name</th>

              <th class="featureTableHeader  " id="d897813e268">Field Type</th>

              <th class="featureTableHeader  " id="d897813e271">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d897813e265" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d897813e268" data-title="Field Type">string</td>

              <td class="entry" headers="d897813e271" data-title="Description">The standard or custom object field that the rule item operates on.</td>

            </tr>

            <tr>
              <td class="entry" headers="d897813e265" data-title="Field Name"><span class="keyword parmname">operation</span></td>

              <td class="entry" headers="d897813e268" data-title="Field Type">FilterOperation (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d897813e271" data-title="Description">The criterion to apply for the rule item. For example:
                <kbd class="ph userinput">equals</kbd> or <kbd class="ph userinput">starts with</kbd>. Valid values
                are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph soql">equals</samp></li>

                  <li class="li"><samp class="codeph soql">notEqual</samp></li>

                  <li class="li"><samp class="codeph soql">lessThan</samp></li>

                  <li class="li"><samp class="codeph soql">greaterThan</samp></li>

                  <li class="li"><samp class="codeph soql">lessOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">greaterOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">contains</samp></li>

                  <li class="li"><samp class="codeph soql">notContain</samp></li>

                  <li class="li"><samp class="codeph soql">startsWith</samp></li>

                  <li class="li"><samp class="codeph soql">includes</samp></li>

                  <li class="li"><samp class="codeph soql">excludes</samp></li>

                  <li class="li">
                    <samp class="codeph soql">within</samp> (<samp class="codeph nolang">DISTANCE</samp> criteria only)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d897813e265" data-title="Field Name"><span class="keyword parmname">value</span></td>

              <td class="entry" headers="d897813e268" data-title="Field Type">string</td>

              <td class="entry" headers="d897813e271" data-title="Description">The field value or values to evaluate. For example: if the field is
                <span class="keyword parmname">Billing ZIP/Postal Code</span>, a value could be
                <samp class="ph systemoutput">94105</samp>.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following example shows the definition of a Territory2RuleItem component.

<?xml version="1.0" encoding="UTF-8"?>
<Territory2Rule xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>Northern CA</label\>
    <description\>To capture northern CA based accounts</description\>
    <objectType\>Account</objectType\>
    <active\>True</active\>
    <ruleItems\>
        <field\>BillingZip</field\>
        <operation\>contains</operation\>
        <value\><94105,94404,94536/value>
    </ruleItems\>
    <ruleItems\>
        <field\>Industry</field\>
        <operation\>equals</operation\>
        <value\>IT</value\>
    </ruleItems\>
    <ruleItems\>
        <field\>someCustomField\_\_c</field\>
        <operation\>greater\_than</operation\>
        <value\>50000</value\>
    </ruleItems\>
    <booleanFilter\>(1 OR 2) AND 3</booleanFilter\>
</Territory2Rule\>

The following is a package.xml sample. FY13 and FY14 represent names of territory models and demonstrate that rules can have _identical_ developer names within _different_ models. A wildcard character (\*) in place of the model name can be used to retrieve all rules in all models in an org.

<?xml version="1.0" encoding="UTF-8"?> 
<Package xmlns="http://soap.sforce.com/2006/04/metadata"> 
        <types\> 
            <members\>FY13</members\>
            <members\>FY14</members\> 
            <name\>Territory2Model</name\> 
        </types\>
        
        <types\>
            <members\>FY13.AccRule1</members\>
            <members\>FY14.AccRule1</members\>
            <name\>Territory2Rule</name\>
        </types\>
        
        <version\>68.0</version\>
</Package\>

## Usage

- A territory rule can have up to 10 rule items.
- The sort order of rule items is implicitly derived from the position of the rule items in the XML
- Rules can’t be run via Metadata API.
- Territory Management 2.0 components don’t support packaging or change sets and aren’t supported in [CRUD calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects.").

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=11215a7d7214998658949c865515a0c0df40cefc2ffc099e219239d55286b302 url=/legacydeveloper/current/en-us/api_meta/meta_territory2settings.md -->

# Territory2Settings

Represents an org’s Territory2 settings. Use Territory2 settings to set the access level that Sales Territories users have to records associated with sales territories, and to enable features. The standard record access settings apply to accounts and opportunities. With Private default internal access for contacts or cases, you can also set access for those records.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

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.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d898934e111">Field Name</th>

              <th class="featureTableHeader  " id="d898934e114">Field Type</th>

              <th class="featureTableHeader  " id="d898934e117">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">defaultAccountAccessLevel</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type">string</td>

              <td class="entry" headers="d898934e117" data-title="Description">Sets the default level of access that users have to account records in
                territories: <kbd class="ph userinput">view</kbd> and <kbd class="ph userinput">edit</kbd> accounts
                assigned to territories or <kbd class="ph userinput">view</kbd>, <kbd class="ph userinput">edit</kbd>,
                <kbd class="ph userinput">transfer</kbd>, and <kbd class="ph userinput">delete</kbd> accounts
                assigned to territories.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">defaultCaseAccessLevel</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type">string</td>

              <td class="entry" headers="d898934e117" data-title="Description">Sets the default level of access that users have to case records in
                territories: <kbd class="ph userinput">view</kbd> and <kbd class="ph userinput">edit</kbd> accounts
                assigned to territories or <kbd class="ph userinput">view</kbd>, <kbd class="ph userinput">edit</kbd>,
                <kbd class="ph userinput">transfer</kbd>, and <kbd class="ph userinput">delete</kbd> accounts
                assigned to territories.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">defaultContactAccessLevel</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type">string</td>

              <td class="entry" headers="d898934e117" data-title="Description">Sets the default level of access that users have to contact records in
                territories: <kbd class="ph userinput">view</kbd> and <kbd class="ph userinput">edit</kbd> accounts
                assigned to territories or <kbd class="ph userinput">view</kbd>, <kbd class="ph userinput">edit</kbd>,
                <kbd class="ph userinput">transfer</kbd>, and <kbd class="ph userinput">delete</kbd> accounts
                assigned to territories.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">defaultOpportunityAccessLevel</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type">string</td>

              <td class="entry" headers="d898934e117" data-title="Description">Sets the default level of access that users have to opportunity records in
                territories: <kbd class="ph userinput">view</kbd> and <kbd class="ph userinput">edit</kbd> accounts
                assigned to territories or <kbd class="ph userinput">view</kbd>, <kbd class="ph userinput">edit</kbd>,
                <kbd class="ph userinput">transfer</kbd>, and <kbd class="ph userinput">delete</kbd> accounts
                assigned to territories.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">enableTerritoryManagement2</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d898934e117" data-title="Description">Enables and disables Sales Territories only. If <samp class="codeph nolang">true</samp>, Sales Territories is enabled. If
                <samp class="codeph nolang">false</samp> (default), Enterprise Territory
                Management isn’t enabled. Enabling and disabling Sales Territories is
                exclusive of all other operations, and the field value must be <samp class="codeph nolang">true</samp> before other territory-management operations can
                run. <p class="p">Available in API version 47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">opportunityFilterSettings</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type"><a class="xref" href="#Territory2SettingsOpportunityFilter">Territory2SettingsOpportunityFilter</a></td>

              <td class="entry" headers="d898934e117" data-title="Description">
                <p class="p">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.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">showTM2EnabledBanner</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d898934e117" data-title="Description">If <samp class="codeph nolang">true</samp>, a success banner appears on the
                Territory Settings page in
                Setup.<p class="p">Available
                  in API version 49.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">supportedObjects</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type"><a class="xref" href="#Territory2SupportedObject">Territory2SupportedObject[]</a></td>

              <td class="entry" headers="d898934e117" data-title="Description">
                <p class="p">Sets the user access levels of all objects that support territory assignments in
                  the org. Available in API version 57.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">t2ForecastAccessLevel</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type">string</td>

              <td class="entry" headers="d898934e117" data-title="Description">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.<div class="p">Valid
                  values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">View</samp></li>

                    <li class="li"><samp class="codeph nolang">Edit</samp></li>

                  </ul>
                </div>
                <p class="p">Available in API version 49.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">tm2BypassRealignAccInsert</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d898934e117" data-title="Description">If <samp class="codeph nolang">true</samp>, account assignment rules don’t
                run during account insert jobs.<p class="p">Available in API version 53.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d898934e111" data-title="Field Name"><span class="keyword parmname">tm2EnableUserAssignmentLog</span></td>

              <td class="entry" headers="d898934e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d898934e117" data-title="Description">If <samp class="codeph nolang">true</samp>, when a user is assigned to a
                territory, the assignment action is logged.<p class="p">Available in API version 57.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## 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.

| Field Name | Description |
| --- | --- |
| apexClassName | 
Field Type

string

Description

Represents the Apex class name.





 |
| enableFilter | 

Field Type

boolean

Description

If true, the Apex class is used to assign territories to opportunities.





 |
| runMultiThreaded | 

Field Type

boolean

Description

Required. If true, the Apex class runs by using multithreading, which can improve performance. Set this value to true only if you’re assigning opportunity or opportunity product splits, and your Apex code can run with multithreading. This field has a default value of false.

Available in API version 62.0 and later.





 |
| runOnCreate | 

Field Type

boolean

Description

If true, the Apex class runs automatically every time a user creates an opportunity.





 |

## Territory2SupportedObject

Sets the user access levels of all objects that support territory assignments in the org.

| Field Name | Description |
| --- | --- |
| defaultAccessLevel | 
Field Type

string

Description

Required. The default user access level as permitted by the organization’s sharing settings. Valid values are:

- Read
- Edit
- Transfer
- All





 |
| objectType | 

Field Type

string

Description

Required. The only supported object type is Lead.



 |
| state | 

Field Type

string

Description

Required. Valid values are:

- Disabled
- Enabled







 |

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects.").

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=8b38fba3de4a1f2f5d9d37aa064397bd477eff07a251cfb7db12866d8cc3a608 url=/legacydeveloper/current/en-us/api_meta/meta_territory2type.md -->

# Territory2Type

Represents the metadata for a category of territories in Sales Territories. Every Territory2 must have a Territory2Type. This type extends the Metadata metadata type and inherits its fullName field. Available if Sales Territories has been enabled.

## File Suffix and Directory Location

Territory2Type components have the suffix territory2Type and are stored in the territory2Types folder.

## Version

Territory2Type components are available in API version 32.0 and later.

## Special Access Rules

The Manage Territories permission is required for the deploy() operation, but not retrieve(). The retrieve() operation retrieves all the Territory2Type components in the org.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | A description of the territory type. |
| name | string | Required. The user interface label for the territory type. |
| priority | int | Required. Used for Filter-Based Opportunity Territory Assignment (Pilot in Spring ’15 / Metadata API version 33). Lets you specify a priority for a territory type. For opportunity assignments, the filter examines all territories assigned to the account that the opportunity is assigned to. The account-assigned territory whose territory type priority is highest is then assigned to the opportunity. The priority field value on each territory type must be unique. Further, if there are multiple territories with the same territory type, and therefore the same priority, assigned to the account, no territory is not assigned to the opportunity. |

## Declarative Metadata Sample Definition

The following example shows the definition of a Territory2Type component.

<?xml version="1.0" encoding="UTF-8"?>
<Territory2Type xmlns="http://soap.sforce.com/2006/04/metadata">
    <name\>Geo</name\>
    <description\>Geographic allocation</description\>
</Territory2Type\>

## Usage

Sales Territories components don’t support packaging or change sets and aren’t supported in [CRUD calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_crud_based_calls_intro.htm "Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects.").

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=294a87a9165e5e3e4a138542ce29580aa55c3178dfb8aee1ebdc5277cebb09c4 url=/legacydeveloper/current/en-us/api_meta/meta_timelineobjectdefinition.md -->

# TimelineObjectDefinition

Represents the container that stores the details of a timeline configuration. You can use this resource with Salesforce objects to see their records' related events in a linear time-sorted view.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

TimelineObjectDefinition components have the suffix .timelineObjectDefinition and are stored in the timelineObjectDefinitions folder.

## Version

TimelineObjectDefinition components are available in API version 55.0 and later.

## Special Access Rules

TimelineObjectDefinition is available in any org that has the Timeline org preference enabled.

## Fields

| Field Name | Description |
| --- | --- |
| baseObject | 
Field Type

string

Description

Required.

The object on which a timeline is based. Information displayed in a timeline comes from objects that are related to the base object. The base object can be a Salesforce object or custom object.



 |
| definition | 

Field Type

string

Description

Required.

The timeline definition in JSON format.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the timeline is active (true) or not (false).



 |
| masterLabel | 

Field Type

string

Description

Required.

The user interface label of the timeline object definition record.



 |

## Declarative Metadata Sample Definition

The following is an example of a TimelineObjectDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<TimelineObjectDefinition
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<baseObject\>Account</baseObject\>
	<definition\>{&quot;timeline&quot;:{&quot;anchorObject&quot;:{&quot;object&quot;:{&quot;entity&quot;:&quot;Account&quot;,&quot;label&quot;:&quot;Account&quot;,&quot;source&quot;:&quot;&quot;,&quot;icon&quot;:&quot;&quot;}},&quot;age&quot;:{&quot;field&quot;:&quot;EffectiveDate&quot;,&quot;label&quot;:&quot;Effective Date&quot;,&quot;type&quot;:&quot;DateTime&quot;},&quot;events&quot;:\[{&quot;oneToMany&quot;:{&quot;eventObject&quot;:{&quot;name&quot;:&quot;Case&quot;,&quot;label&quot;:&quot;Case&quot;,&quot;recordTypes&quot;:\[\],&quot;fieldsToDisplay&quot;:\[{&quot;field&quot;:&quot;Description&quot;,&quot;label&quot;:&quot;Description&quot;,&quot;type&quot;:&quot;StringPlusClob&quot;},{&quot;field&quot;:&quot;Priority&quot;,&quot;label&quot;:&quot;Priority&quot;,&quot;type&quot;:&quot;DynamicEnum&quot;},{&quot;field&quot;:&quot;Status&quot;,&quot;label&quot;:&quot;Status&quot;,&quot;type&quot;:&quot;DynamicEnum&quot;},{&quot;field&quot;:&quot;Subject&quot;,&quot;label&quot;:&quot;Subject&quot;,&quot;type&quot;:&quot;Text&quot;}\],&quot;relatedlistsToDisplay&quot;:\[{&quot;entity&quot;:&quot;CaseComments&quot;,&quot;label&quot;:&quot;Case Comments&quot;},{&quot;entity&quot;:&quot;CombinedAttachments&quot;,&quot;label&quot;:&quot;Attachments&quot;},{&quot;entity&quot;:&quot;AttachedContentDocuments&quot;,&quot;label&quot;:&quot;Files&quot;}\],&quot;title&quot;:{&quot;field&quot;:&quot;CaseNumber&quot;,&quot;label&quot;:&quot;Case Number&quot;,&quot;type&quot;:&quot;AutoNumber&quot;},&quot;subTitle&quot;:{&quot;field&quot;:&quot;Comments&quot;,&quot;label&quot;:&quot;Internal Comments&quot;,&quot;type&quot;:&quot;MultiLineText&quot;}},&quot;filters&quot;:\[{&quot;field&quot;:{&quot;field&quot;:&quot;Status&quot;,&quot;label&quot;:&quot;Status&quot;,&quot;type&quot;:&quot;DynamicEnum&quot;},&quot;operator&quot;:&quot;EQ&quot;,&quot;values&quot;:\[&quot;New&quot;\],&quot;order&quot;:1}\],&quot;sort&quot;:{&quot;field&quot;:&quot;CreatedDate&quot;,&quot;label&quot;:&quot;Created Date&quot;,&quot;type&quot;:&quot;DateTime&quot;},&quot;anchorReferenceField&quot;:{&quot;field&quot;:&quot;AccountId&quot;,&quot;label&quot;:&quot;Account ID&quot;,&quot;type&quot;:&quot;EntityId&quot;}}},{&quot;oneToMany&quot;:{&quot;eventObject&quot;:{&quot;name&quot;:&quot;Event&quot;,&quot;label&quot;:&quot;Event&quot;,&quot;recordTypes&quot;:\[\],&quot;fieldsToDisplay&quot;:\[{&quot;field&quot;:&quot;ActivityDate&quot;,&quot;label&quot;:&quot;Due Date Only&quot;,&quot;type&quot;:&quot;DueDate&quot;},{&quot;field&quot;:&quot;Attendees&quot;,&quot;label&quot;:&quot;Attendees&quot;,&quot;type&quot;:&quot;StringPlusClob&quot;}\],&quot;relatedlistsToDisplay&quot;:\[\],&quot;title&quot;:{&quot;field&quot;:&quot;Description&quot;,&quot;label&quot;:&quot;Description&quot;,&quot;type&quot;:&quot;StringPlusClob&quot;},&quot;subTitle&quot;:{&quot;field&quot;:&quot;Location&quot;,&quot;label&quot;:&quot;Location&quot;,&quot;type&quot;:&quot;Text&quot;}},&quot;filters&quot;:\[\],&quot;sort&quot;:{&quot;field&quot;:&quot;ActivityDate&quot;,&quot;label&quot;:&quot;Due Date Only&quot;,&quot;type&quot;:&quot;DueDate&quot;},&quot;anchorReferenceField&quot;:{&quot;field&quot;:&quot;WhatId&quot;,&quot;label&quot;:&quot;Related To ID&quot;,&quot;type&quot;:&quot;EntityId&quot;}}},{&quot;oneToMany&quot;:{&quot;eventObject&quot;:{&quot;name&quot;:&quot;Task&quot;,&quot;label&quot;:&quot;Task&quot;,&quot;recordTypes&quot;:\[\],&quot;fieldsToDisplay&quot;:\[{&quot;field&quot;:&quot;CallDisposition&quot;,&quot;label&quot;:&quot;Call Result&quot;,&quot;type&quot;:&quot;Text&quot;},{&quot;field&quot;:&quot;CallObject&quot;,&quot;label&quot;:&quot;Call Object Identifier&quot;,&quot;type&quot;:&quot;Text&quot;},{&quot;field&quot;:&quot;CallType&quot;,&quot;label&quot;:&quot;Call Type&quot;,&quot;type&quot;:&quot;StaticEnum&quot;}\],&quot;relatedlistsToDisplay&quot;:\[\],&quot;title&quot;:{&quot;field&quot;:&quot;Description&quot;,&quot;label&quot;:&quot;Description&quot;,&quot;type&quot;:&quot;StringPlusClob&quot;},&quot;subTitle&quot;:{&quot;field&quot;:&quot;Priority&quot;,&quot;label&quot;:&quot;Priority&quot;,&quot;type&quot;:&quot;DynamicEnum&quot;}},&quot;filters&quot;:\[\],&quot;sort&quot;:{&quot;field&quot;:&quot;ActivityDate&quot;,&quot;label&quot;:&quot;Due Date Only&quot;,&quot;type&quot;:&quot;DueDate&quot;},&quot;anchorReferenceField&quot;:{&quot;field&quot;:&quot;WhatId&quot;,&quot;label&quot;:&quot;Related To ID&quot;,&quot;type&quot;:&quot;EntityId&quot;}}}\]}}</definition\>
	<isActive\>true</isActive\>
	<masterLabel\>HealthTimeline</masterLabel\>
</TimelineObjectDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>\*</members\>
		<name\>TimelineObjectDefinition</name\>
	</types\>
	<version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=9178d990b4147f9369c7ec43f6b5960357ffef7432c5d58b1fd5b0faff915686 url=/legacydeveloper/current/en-us/api_meta/meta_timesheettemplate.md -->

# TimeSheetTemplate

Represents a template for creating time sheets in Field Service. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

TimeSheetTemplate components have the suffix timeSheetTemplate and are stored in the timeSheetTemplates folder.

## Version

TimeSheetTemplate components are available in API version 46.0 and later.

## Special Access Rules

Field Service must be enabled. Users must have the Customize Application and Time Sheet Template permissions.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d901709e99">Field Name</th>

              <th class="featureTableHeader  " id="d901709e102">Field Type</th>

              <th class="featureTableHeader  " id="d901709e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d901709e99" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d901709e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d901709e105" data-title="Description">Required. Indicates whether the time sheet template is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d901709e99" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d901709e102" data-title="Field Type">string</td>

              <td class="entry" headers="d901709e105" data-title="Description">The time sheet template's description.</td>

            </tr>

            <tr>
              <td class="entry" headers="d901709e99" data-title="Field Name"><span class="keyword parmname">frequency</span></td>

              <td class="entry" headers="d901709e102" data-title="Field Type">TimeSheetFrequency (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d901709e105" data-title="Description">Required. Defines the frequency of the time sheet creation period. One of the
                following values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Daily</samp></li>

                  <li class="li"><samp class="codeph nolang">Weekly</samp></li>

                  <li class="li"><samp class="codeph nolang">EveryTwoWeeks</samp></li>

                  <li class="li"><samp class="codeph nolang">TwiceAMonth</samp></li>

                  <li class="li"><samp class="codeph nolang">Monthly</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d901709e99" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d901709e102" data-title="Field Type">string</td>

              <td class="entry" headers="d901709e105" data-title="Description">Required. The name of the time sheet template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d901709e99" data-title="Field Name"><span class="keyword parmname">startDate</span></td>

              <td class="entry" headers="d901709e102" data-title="Field Type">date</td>

              <td class="entry" headers="d901709e105" data-title="Description">Required. The date when the time sheet takes effect.</td>

            </tr>

            <tr>
              <td class="entry" headers="d901709e99" data-title="Field Name"><span class="keyword parmname">timeSheetTemplateAssignments</span></td>

              <td class="entry" headers="d901709e102" data-title="Field Type">
                <a class="xref" href="#TimeSheetTemplateAssignment">TimeSheetTemplateAssignment</a>
              </td>

              <td class="entry" headers="d901709e105" data-title="Description">A list of profiles that the template is assigned to.</td>

            </tr>

            <tr>
              <td class="entry" headers="d901709e99" data-title="Field Name"><span class="keyword parmname">workWeekEndDay</span></td>

              <td class="entry" headers="d901709e102" data-title="Field Type">DaysOfWeek (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d901709e105" data-title="Description">Required. The end day of the template's work week. One of the following values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph xml">Monday</samp></li>

                  <li class="li"><samp class="codeph xml">Tuesday</samp></li>

                  <li class="li"><samp class="codeph xml">Wednesday</samp></li>

                  <li class="li"><samp class="codeph xml">Thursday</samp></li>

                  <li class="li"><samp class="codeph xml">Friday</samp></li>

                  <li class="li"><samp class="codeph xml">Saturday</samp></li>

                  <li class="li"><samp class="codeph xml">Sunday</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d901709e99" data-title="Field Name"><span class="keyword parmname">workWeekStartDay</span></td>

              <td class="entry" headers="d901709e102" data-title="Field Type">DaysOfWeek (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d901709e105" data-title="Description">Required. The start day of the template's work week. One of the following values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph xml">Monday</samp></li>

                  <li class="li"><samp class="codeph xml">Tuesday</samp></li>

                  <li class="li"><samp class="codeph xml">Wednesday</samp></li>

                  <li class="li"><samp class="codeph xml">Thursday</samp></li>

                  <li class="li"><samp class="codeph xml">Friday</samp></li>

                  <li class="li"><samp class="codeph xml">Saturday</samp></li>

                  <li class="li"><samp class="codeph xml">Sunday</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## TimeSheetTemplateAssignment

Returns a quick action that’s associated with an EmbeddedServiceLiveAgent setup. The quick action includes the pre-chat form fields that the embedded chat window displays and shows the order in which the fields are displayed.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assignedTo | string | The IDs of the user profiles that a time sheet template is assigned to. |

## Declarative Metadata Sample Definition

The following is an example of a TimeSheetTemplate file.

<?xml version=“1.0” encoding=“UTF-8"?>
<TimeSheetTemplate xmlns=“http://soap.sforce.com/2006/04/metadata“>
   <active\>true</active\>
   <description\>Time Sheet Template description</description\>
   <frequency\>Daily</frequency\>
   <masterLabel\>label</masterLabel\>
   <startDate\>2018-10-18</startDate\>
   <timeSheetTemplateAssignments\>
       <assignedTo\>admin</assignedTo\>
   </timeSheetTemplateAssignments\>
   <timeSheetTemplateAssignments\>
       <assignedTo\>standard</assignedTo\>
   </timeSheetTemplateAssignments\>
   <workWeekEndDay\>Tuesday</workWeekEndDay\>
   <workWeekStartDay\>Monday</workWeekStartDay\>
</TimeSheetTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version=“1.0” encoding=“UTF-8"?>
<Package xmlns=“http://soap.sforce.com/2006/04/metadata“>
   <types\>
       <members\>\*</members\>
       <name\>TimeSheetTemplate</name\>
   </types\>
   <version\>46.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a13f2168a1893c3c24ff3845d3ea8296f0a3d615de4577d6ee96104e45266bc4 url=/legacydeveloper/current/en-us/api_meta/meta_topicsforobjects.md -->

# TopicsForObjects

Represents the ability to assign topics to objects or to remove topic assignments.

## File Suffix and Directory Location

TopicsForObjects components have the suffix .topicsForObjects and are stored in the topicsForObjects folder of the corresponding package directory.

## Version

TopicsForObjects components are available in API version 41.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d902821e81">Field Name</th>

              <th class="featureTableHeader  " id="d902821e84">Field Type</th>

              <th class="featureTableHeader  " id="d902821e87">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d902821e81" data-title="Field Name"><span class="keyword parmname">enableTopics</span></td>

              <td class="entry" headers="d902821e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d902821e87" data-title="Description">Required. When true, indicates whether users can assign topics or remove topic
                assignments. When false, users can’t assign or remove topics.<div class="p">Upon org creation,
                  this value is true for the following objects:<ul class="ul bulletList">
                    <li class="li">Account</li>

                    <li class="li">Asset</li>

                    <li class="li">Campaign</li>

                    <li class="li">Case</li>

                    <li class="li">Contact</li>

                    <li class="li">Content Document</li>

                    <li class="li">Contract</li>

                    <li class="li">Event</li>

                    <li class="li">Lead</li>

                    <li class="li">Opportunity</li>

                    <li class="li">Order</li>

                    <li class="li">Solution</li>

                    <li class="li">Task</li>

                  </ul>
                </div>
                <p class="p">For all remaining standard objects and custom objects, the default is
                  false.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d902821e81" data-title="Field Name"><span class="keyword parmname">entityApiName</span></td>

              <td class="entry" headers="d902821e84" data-title="Field Type">string</td>

              <td class="entry" headers="d902821e87" data-title="Description">Required. Indicates the object’s API name for enabling topics.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a TopicsForObjects component.

<?xml version="1.0" encoding="UTF-8"?>
<TopicsForObjects xmlns="http://soap.sforce.com/2006/04/metadata">
       <enableTopics\>false</enableTopics\>
       <entityApiName\>Account</entityApiName\>
</TopicsForObjects\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>\*</members\>
<name\>TopicsForObjects</name\>
</types\>
<version\>41.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=c842c9922fecae8445422ec1c64d281583c50948cb259a7b25f52346f210f4b6 url=/legacydeveloper/current/en-us/api_meta/meta_trailheadsettings.md -->

# TrailheadSettings

Represents an org’s integration with Trailhead for Learning Paths or Enablement programs, including access to enablement sites (formerly myTrailhead).

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

TrailheadSettings values are stored in the Trailhead.settings file in the settings directory. The .settings files are different from other named components because there's only one settings file for each settings component.

## Version

TrailheadSettings components are available in API version 47.0 and later.

## Special Access Rules

To access enablement site (myTrailhead) content, the org must have a Sales Enablement license.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableConfettiEffect | boolean | Indicates whether animated confetti plays on the screen after a user reaches certain milestones, such as completing an Enablement program in the Guidance Center. The default value of this field is false. |
| enableMyTrailheadPref | boolean | Indicates whether the org is connected to an enablement site (myTrailhead). The default value of this field is true. |
| enableTrailheadInLexTerms | boolean | Indicates whether the terms and conditions for showing Trailhead content in Lightning Experience are accepted in your org. The default value of this field is false. |

## Declarative Metadata Sample Definition

The following is an example of a TrailheadSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<TrailheadSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableMyTrailheadPref\>true</enableMyTrailheadPref\>
</TrailheadSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Trailhead</members>
        <name>Settings</name>
    </types>
    <version>47.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=caec5574d36edb7b863d740a4807cf48d755b84d362d54c90796310f95733005 url=/legacydeveloper/current/en-us/api_meta/meta_transactionsecurity.md -->

# TransactionSecurityPolicy

Represents a transaction security policy definition. Transaction security policies give you a way to look through events in your organization and specify actions to take when certain combinations occur.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

TransactionSecurityPolicy components have the suffix .transactionSecurityPolicy and are stored in the transactionSecurityPolicies folder.

## Version

TransactionSecurityPolicy components are available in API version 35.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d903664e104">Field Name</th>

              <th class="featureTableHeader  " id="d903664e107">Field Type</th>

              <th class="featureTableHeader  " id="d903664e110">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type"><a class="xref" href="#TxnSecAction_title">TransactionSecurityAction</a></td>

              <td class="entry" headers="d903664e110" data-title="Description">Required. Describes the action to take when the matching Transaction
                Security policy is triggered.</td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d903664e110" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, the policy is enabled
                and actively monitors its event.</td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">apexClass</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">string</td>

              <td class="entry" headers="d903664e110" data-title="Description">Required for Apex-based policies, and optional for all other policies. The name
                of the class that implements the <samp class="codeph nolang">TxnSecurity.PolicyCondition</samp> or <samp class="codeph nolang">TxnSecurity.EventCondition</samp> interface for this policy. Available in API
                version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">blockMessage</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">string</td>

              <td class="entry" headers="d903664e110" data-title="Description">The custom message sent to a user when a policy blocks their action. Used in
                Real-Time Event Monitoring only. Maximum of 1000 characters. This field is null when
                the default message option is selected in the UI. Available only when
                <span class="keyword parmname">eventName</span> is set to <samp class="codeph nolang">ApiEvent</samp>, <samp class="codeph nolang">ListViewEvent</samp>, <samp class="codeph nolang">BulkApiResultEventStore</samp>, or <samp class="codeph nolang">ReportEvent</samp>. Available in API version 49.0 and later.
                <p class="p">Include org- or policy-specific information in your custom message, such as the
                  name of the responsible administrator or the business unit. Be careful about what
                  you include. Too much information on how the policy was designed. can aid a
                  malicious user. </p>
                <p class="p">Two-factor authentication (2FA) isn’t supported in
                  Lightning Experience, so events like <samp class="codeph nolang">ListView</samp>
                  and <samp class="codeph nolang">ReportEvent</samp> are upgraded to Block in
                  Lightning.</p>
                <p class="p">Custom messages aren’t translatable.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">customEmailContent</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">string</td>

              <td class="entry" headers="d903664e110" data-title="Description">The administrator-created custom email content sent when a policy is triggered.
                Used in Real-Time Event Monitoring only. Maximum of 1333 characters. This field is
                null when the Custom Email Content setting is selected in the UI but no message
                content is entered. Available in API version 54.0 and later.<p class="p">Custom messages
                  aren’t translatable.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="field_description_name"><a name="field_description_name"><!-- --></a>description</span></span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">string</td>

              <td class="entry" headers="d903664e110" data-title="Description"><span class="ph" id="field_description_descr"><a name="field_description_descr"><!-- --></a>A description of the policy.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="field_developerName_name"><a name="field_developerName_name"><!-- --></a>developerName</span></span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">string</td>

              <td class="entry" headers="d903664e110" data-title="Description">
                <span class="ph" id="field_developerName_descr"><a name="field_developerName_descr"><!-- --></a>This unique name prevents conflicts with
                  other policies that have the same <span class="keyword parmname">masterLabel</span>.</span> This name
                can contain only underscores and alphanumeric characters, and must be unique in your
                org. It must begin with a letter, not include spaces, not end with an underscore,
                and not contain two consecutive underscores.
                <p class="p">Only users with View DeveloperName OR View Setup and Configuration permission
                  can view, group, sort, and filter this field.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">eventName</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">TransactionSecurityEventName (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d903664e110" data-title="Description">Used in Real-Time Event Monitoring only. Indicates the name of the event the
                policy monitors. This field is available in API 45.0 and later. Valid values are:<ul class="ul bulletList">

                  <li class="li"><samp class="codeph nolang">AdminSetupEvent</samp></li>


                  <li class="li">
                    <samp class="codeph nolang">ApiAnomalyEventStore</samp>—Tracks
                    anomalies in how users make API calls. ApiAnomalyEventStore is an object that
                    stores the event data of ApiAnomalyEvent. This object is available in API
                    version 50.0 and later.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">ApiEvent</samp>—Tracks these
                    user-initiated read-only API calls: <samp class="codeph nolang">query()</samp>, <samp class="codeph nolang">queryMore()</samp>, and <samp class="codeph nolang">count()</samp>. Captures API requests through SOAP API
                    and Bulk API for the Enterprise and Partner WSDLs. Tooling API calls and API
                    calls originating from a Salesforce mobile app aren’t captured.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">BulkApiResultEventStore</samp>—Tracks
                    when a user downloads the results of a Bulk API request. BulkApiResultEventStore
                    is a big object that stores the event data of BulkApiResultEvent. This object is
                    available in API version 50.0 and later.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">CredentialStuffingEventStore</samp>—Tracks when a user successfully
                    logs into Salesforce during an identified credential stuffing attack. Credential
                    stuffing refers to large-scale automated login requests using stolen user
                    credentials.This value is available in API version 49.0 and later.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">FileEventStore</samp>
                    —Tracks when a user downloads, previews, or uploads a file.
                    FileEventStore is a big object that stores the event data of FileEvent. This
                    object is available in API version 57.0 and later.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">GuestUserAnomalyEventStore</samp>—Tracks data access anomalies
                    that are caused by guest user permission misconfiguration. This object is
                    available in API version 60.0 and later.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">ListViewEvent</samp>—Tracks when users
                    access data with list views using Lightning Experience, Salesforce Classic, or
                    the API. It doesn’t track list views of Setup entities.
                  </li>


                  <li class="li"><samp class="codeph nolang">LoginAnomalyEventStore</samp></li>


                  <li class="li">
                    <samp class="codeph nolang">LoginAsEvent</samp>—Tracks the login
                    activity of admins who log in to Salesforce as other users. This object is
                    available in API version 46.0 and later.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">LoginEvent</samp>—LoginEvent tracks the
                    login activity of users who log in to Salesforce.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">PermissionSetEventStore</samp> —Tracks
                    changes to permission sets and permission set groups.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">ReportAnomalyEventStore</samp>— This
                    value is available in API version 49.0 and later.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">ReportEvent</samp>—Tracks when reports
                    are run in your org.
                  </li>


                  <li class="li">
                    <samp class="codeph nolang">SessionHijackingEventStore</samp>—Tracks
                    when unauthorized users gain ownership of a Salesforce user’s session with a
                    stolen session identifier. To detect such an event, Salesforce evaluates how
                    significantly a user’s current browser fingerprint diverges from the previously
                    known fingerprint using a probabilistically inferred significance of change.
                    Available in API version 49.0 and later.
                  </li>


                  <li class="li"><samp class="codeph nolang">UniversalAnomalyEventStore</samp></li>


                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">eventType</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">MonitoredEvents (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d903664e110" data-title="Description">Used in Legacy Transaction Security only. Required for Apex-based policies, and
                optional for all other policies. Indicates which type of event is being monitored.
                Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AccessResource</samp>—Notifies you when
                    the selected resource has been accessed.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AuditTrail</samp>—Reserved for future
                    use.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DataExport</samp>—Notifies you when the
                    selected object type has been exported using the Data Loader API client.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Entity</samp>—Notifies you on use of an
                    object type such as an authentication provider or Chatter comment.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Login</samp>—Notifies you when a user
                    logs in.
                  </li>

                </ul>

                <p class="p">As of Summer '20, Legacy Transaction Security is a retired feature in all
                  Salesforce orgs.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">executionUser</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">string</td>

              <td class="entry" headers="d903664e110" data-title="Description">Used in Legacy Transaction Security only. The name or ID of an active user who
                is assigned the Modify All Data and View Setup user permissions.
                <p class="p">As of Summer '20, Legacy Transaction Security is a retired feature in all Salesforce
                  orgs.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">flow</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">string</td>

              <td class="entry" headers="d903664e110" data-title="Description">Required only for policies of type <samp class="codeph nolang">CustomConditionBuilderPolicy</samp>. The ID of the Flow object that contains
                the logic the Condition Builder transaction security policy. Available in API
                version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="field_masterLabel_name"><a name="field_masterLabel_name"><!-- --></a>masterLabel</span></span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">string</td>

              <td class="entry" headers="d903664e110" data-title="Description">
                <span class="ph" id="field_masterLabel_descr"><a name="field_masterLabel_descr"><!-- --></a>The label for this object. This display value
                  is the internal label that is’t translated.</span>
                <p class="p">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.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">resourceName</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">string</td>

              <td class="entry" headers="d903664e110" data-title="Description">Used in Legacy Transaction Security only. Required for Apex-based policies, and
                optional for all other policies. A resource used to narrow down the conditions under
                which the policy triggers. For example, with a <samp class="codeph nolang">DataExport</samp> event, you can select a resource Lead to specifically monitor
                export activity occurring on your Lead entities. The resources available depend on
                the <span class="keyword parmname"><a class="xref" href="#txnsec_eventtype">Event Type</a></span> field. The following valid
                resources are grouped by event type. <ul class="ul bulletList">
                  <li class="li">AccessResource—ConnectedApplication, Reports</li>

                  <li class="li">DataExport—Account, Case, Contact, Lead, Opportunity</li>

                  <li class="li">Entity—AuthProvider, ChatterMessage, FeedComment, FeedItem, Idea,
                    Question</li>

                  <li class="li">Login—LoginHistory</li>

                </ul>

                <p class="p">As of Summer '20, Legacy Transaction Security is a retired feature in all
                  Salesforce orgs.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e104" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d903664e107" data-title="Field Type">TxnSecurityPolicyType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d903664e110" data-title="Description">The type of validation that the policy uses. The valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">CustomApexPolicy</samp>— Created with
                    Apex editor.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomConditionBuilderPolicy</samp>—
                    Created with Condition Builder.
                  </li>

                </ul>
                The default value is <samp class="codeph nolang">CustomApexPolicy</samp>.</td>

            </tr>

          </tbody>

        </table>

## TransactionSecurityAction

Describes the action to take when the matching Transaction Security policy is triggered.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d903664e569">Field Name</th>

              <th class="featureTableHeader  " id="d903664e572">Field Type</th>

              <th class="featureTableHeader  " id="d903664e575">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d903664e569" data-title="Field Name"><span class="keyword parmname">block</span></td>

              <td class="entry" headers="d903664e572" data-title="Field Type">boolean</td>

              <td class="entry" headers="d903664e575" data-title="Description">If <samp class="codeph nolang">true</samp>, the requested operation is
                blocked. This action only applies to Login and AccessResource events.</td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e569" data-title="Field Name"><span class="keyword parmname">endSession</span></td>

              <td class="entry" headers="d903664e572" data-title="Field Type">boolean</td>

              <td class="entry" headers="d903664e575" data-title="Description">Used in Legacy Transaction Security only. If <samp class="codeph nolang">true</samp>, a current session must be closed before a new session can be
                started. This action only applies to Login events.
                <p class="p">As of Summer '20, Legacy Transaction Security is a retired feature in all
                  Salesforce orgs.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e569" data-title="Field Name"><span class="keyword parmname">freezeUser</span></td>

              <td class="entry" headers="d903664e572" data-title="Field Type">boolean</td>

              <td class="entry" headers="d903664e575" data-title="Description">Used in Legacy Transaction Security only. If <samp class="codeph nolang">true</samp>, the user that triggered the policy is frozen. This action only
                applies to Chatter resources for Entity events.
                <p class="p">As of Summer '20, Legacy Transaction Security is a retired feature in all
                  Salesforce orgs.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e569" data-title="Field Name"><span class="keyword parmname">notifications</span></td>

              <td class="entry" headers="d903664e572" data-title="Field Type">
                <a class="xref" href="#TxnSecNotification_title">TransactionSecurityNotification</a>[]
              </td>

              <td class="entry" headers="d903664e575" data-title="Description">Specifies how to notify the Salesforce administrator when the action is
                triggered. There can be none, one, or multiple notifications.</td>

            </tr>

            <tr>
              <td class="entry" headers="d903664e569" data-title="Field Name"><span class="keyword parmname">twoFactorAuthentication</span></td>

              <td class="entry" headers="d903664e572" data-title="Field Type">boolean</td>

              <td class="entry" headers="d903664e575" data-title="Description">If <samp class="codeph nolang">true</samp>, multi-factor authentication (MFA)
                is required for a higher level of access before the requested operation can
                continue. This action only applies to Login and AccessResource
                events.
                <p class="p">Multi-factor authentication was formerly called two-factor
                  authentication.</p>
              </td>

            </tr>

          </tbody>

        </table>

## TransactionSecurityNotification

Describes who to notify and how to notify them when the matching Transaction Security policy is triggered.

| Field Name | Field Type | Description |
| --- | --- | --- |
| inApp | boolean | True if an in-app notification is selected. |
| sendEmail | boolean | True if an email notification is selected. |
| user | string | The user to receive the notification. |

## Declarative Metadata Sample Definition

The following is an example of a Real-Time Event Monitoring TransactionSecurityPolicy component.

<?xml version="1.0" encoding="UTF-8"?>
<TransactionSecurityPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
    <action\>
        <block\>true</block\>
        <notifications\>
            <inApp\>true</inApp\>
            <sendEmail\>true</sendEmail\>
            <user\>user@your.org</user\>
        </notifications\>
        <twoFactorAuthentication\>false</twoFactorAuthentication\>
    </action\>
    <active\>true</active\>
    <apexClass\>TxnSecMDApiPolicyEventCondition</apexClass\>
    <blockMessage\>You cannot view this report.</blockMessage\>
    <developerName\>TxnSecPolicyMDApi</developerName\>
    <eventName\>ReportEvent</eventName\>
    <masterLabel\>Txn Sec MD Api Policy</masterLabel\>
    <type\>CustomApexPolicy</type\>
</TransactionSecurityPolicy\>

The following is an example package manifest used to deploy or retrieve the transaction security metadata for an organization.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MySecurityPolicy</members\>
        <name\>TransactionSecurityPolicy</name\>
    </types\>
    <version\>35.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=3505016b70c389428c5daa732f452285455f5df1b65b713aea51aada04d47070 url=/legacydeveloper/current/en-us/api_meta/meta_translations.md -->

# Translations

Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Language

A two-character language code identifies each language. For example, en. A five-character code is used for languages that differ depending on location. For example, en\_AU.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Setting a default language is different from setting a default locale. For more information, see Select Your Language, Locale, and Currency in Salesforce Help.

Salesforce offers full support for these languages.

- Chinese (Simplified): zh\_CN
- Chinese (Traditional): zh\_TW
- Danish: da
- Dutch: nl\_NL
- English: en\_US
- Finnish: fi
- French: fr
- German: de
- Italian: it
- Japanese: ja
- Korean: ko
- Norwegian: no
- Portuguese (Brazil): pt\_BR
- Russian: ru
- Spanish: es
- Spanish (Mexico): es\_MX Defaults to Spanish for customer-defined translations.
- Swedish: sv
- Thai: th The Salesforce user interface is fully translated to Thai, but Salesforce Help is in English.

End-user languages are useful if you have a multilingual organization or partners who speak languages other than your company’s default language. For end-user languages, Salesforce provides translated labels for standard objects and pages, except admin pages, Setup, and Help. Some clouds and features support a subset of these languages in the UI. For details, see User Interface Language Support in Salesforce Help. When you select an end-user language, labels that aren’t translated and Salesforce Help are in English. End-user languages are intended only for personal use by end users. Don’t use end-user languages as corporate languages. Salesforce doesn’t provide customer support in end-user languages.

End-user languages include:

- Arabic: ar
- Bulgarian: bg
- Croatian: hr
- Czech: cs
- English (UK): en\_GB
- Greek: el
- Hebrew: iw
- Hungarian: hu
- Indonesian: in
- Polish: pl
- Portuguese (European): pt\_PT
- Romanian: ro
- Slovak: sk
- Slovenian: sl
- Turkish: tr
- Ukrainian: uk
- Vietnamese: vi

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Before enabling end-user languages Arabic and Hebrew, review the right-to-left language support limitations.

In situations where Salesforce doesn’t provide default translations, use platform-only languages to localize apps and custom functionality that you build on the Salesforce Platform. You can translate items such as custom labels, custom objects, and field names. You can also rename most standard objects, labels, and fields. Informational text and non-field label text aren’t translatable.

Platform-only languages are available in all places where you can select a language in the application. However, when you select a platform-only language, all standard Salesforce labels default to English or, in select cases, to an end-user or fully supported language.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Language support is closely tied to the API version. For example, we introduced support for Belgian Dutch (nl\_BE) in API version 40.0. To take advantage of this language, you must use API version 40.0 or later. In general, we recommend the most recent version of the API to make the most of our language features.

Platform-only languages include:

- Albanian: sq
- Afrikaans: af
- Amharic: am
- Arabic (Algeria): ar\_DZ
- Arabic (Bahrain): ar\_BH
- Arabic (Egypt): ar\_EG
- Arabic (Iraq): ar\_IQ
- Arabic (Jordan): ar\_JO
- Arabic (Kuwait): ar\_KW
- Arabic (Lebanon): ar\_LB
- Arabic (Libya): ar\_LY
- Arabic (Morocco): ar\_MA
- Arabic (Oman): ar\_OM
- Arabic (Qatar): ar\_QA
- Arabic (Saudi Arabia): ar\_SA
- Arabic (Sudan): ar\_SD
- Arabic (Syria): ar\_SY
- Arabic (Tunisia): ar\_TN
- Arabic (United Arab Emirates): ar\_AE
- Arabic (Yemen): ar\_YE
- Armenian: hy
- Basque: eu
- Bosnian: bs
- Bengali: bn
- Burmese: my
- Catalan: ca
- Chinese (Hong Kong): zh\_HK
- Chinese (Singapore): zh\_SG
- Chinese (Malaysia): zh\_MY
- Dutch (Belgium): nl\_BE
- English (Australia): en\_AU
- English (Belgium): en\_BE
- English (Canada): en\_CA
- English (Cyprus): en\_CY
- English (Germany): en\_DE
- English (Hong Kong): en\_HK
- English (India): en\_IN
- English (Ireland): en\_IE
- English (Israel): en\_IL
- English (Malaysia): en\_MY
- English (Malta): en\_MT
- English (Netherlands): en\_NL
- English (New Zealand): en\_NZ
- English (Philippines): en\_PH
- English (Singapore): en\_SG
- English (South Africa): en\_ZA
- English (United Arab Emirates): en\_AE
- Estonian: et
- Farsi: fa
- French (Belgium): fr\_BE
- French (Canada): fr\_CA
- French (Luxembourg): fr\_LU
- French (Morocco): fr\_MA
- French (Switzerland): fr\_CH
- Georgian: ka
- German (Austria): de\_AT
- German (Belgium): de\_BE
- German (Luxembourg): de\_LU
- German (Switzerland): de\_CH
- Greek (Cyprus): el\_CY
- Greenlandic: kl
- Gujarati: gu
- Hawaiian: haw
- Haitian Creole: ht
- Hindi: hi
- Hmong: hmn
- Icelandic: is
- Irish: ga
- Italian (Switzerland): it\_CH
- Kannada: kn
- Kazakh: kk
- Khmer: km
- Latvian: lv
- Lithuanian: lt
- Luxembourgish: lb
- Macedonian: mk
- Malay: ms
- Malayalam: ml
- Maltese: mt
- Marathi: mr
- Montenegrin: sh\_ME
- Punjabi: pa
- Romanian (Moldova): ro\_MD
- Romansh: rm
- Russian (Armenia): ru\_AM
- Russian (Belarus): ru\_BY
- Russian (Kazakhstan): ru\_KZ
- Russian (Kyrgyzstan): ru\_KG
- Russian (Lithuania): ru\_LT
- Russian (Moldova): ru\_MD
- Russian (Poland): ru\_PL
- Russian (Ukraine): ru\_UA
- Samoan: sm
- Serbian (Cyrillic): sr
- Serbian (Latin): sh
- Spanish (Argentina): es\_AR
- Spanish (Bolivia): es\_BO
- Spanish (Chile): es\_CL
- Spanish (Colombia): es\_CO
- Spanish (Costa Rica): es\_CR
- Spanish (Dominican Republic): es\_DO
- Spanish (Ecuador): es\_EC
- Spanish (El Salvador): es\_SV
- Spanish (Guatemala): es\_GT
- Spanish (Honduras): es\_HN
- Spanish (Nicaragua): es\_NI
- Spanish (Panama): es\_PA
- Spanish (Paraguay): es\_PY
- Spanish (Peru): es\_PE
- Spanish (Puerto Rico): es\_PR
- Spanish (United States): es\_US
- Spanish (Uruguay): es\_UY
- Spanish (Venezuela): es\_VE
- Swahili: sw
- Tagalog: tl
- Tamil: ta
- Te reo: mi
- Telugu: te
- Urdu: ur
- Welsh: cy
- Xhosa: xh
- Yiddish: ji
- Zulu: zu

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Before enabling Urdu as a platform-only language, review the right-to-left language support limitations.

## Declarative Metadata File Suffix and Directory Location

Local translations are stored in a file with a format of localeCode.translation, where localeCode is the locale code of the translation language. For example, the file name for German translations is de.translation. Packaged translations are stored in a file with a format of pkgNamespace\_ \_localeCode.translation. For example, if the package namespace is Acme, the file name for German translations installed by the package is Acme\_ \_de.translation. The supported locale codes are listed in [Language](#translation_languages).

Custom object translations are stored in the objectTranslations folder in the corresponding package directory.

## Version

Translations components are available in API version 14.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e1004">Field</th>

              <th class="featureTableHeader  " id="d905869e1007">Field Type</th>

              <th class="featureTableHeader  " id="d905869e1010">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">aiCoachAgentScnrDefs</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#AiCoachAgentScnrDefTranslation">AiCoachAgentScnrDefTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of AI Coach agent scenario definition translations.
                Available in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">botBlocks</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#BotBlockTranslation">BotBlockTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of bot block translations. Available in API version 59.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">botTemplates</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#BotTemplateTranslation">BotTemplateTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of bot template translations. Available in API version
                59.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">bots</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#BotTranslation">BotTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of bot translations. Available in API version 53.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">conversationMessageDefinitions</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#ConversationMessageDefinitionTranslation">ConversationMessageDefinitionTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of conversation message definition translations. Available
                in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">contextDefinitions</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#ContextDefinitionTranslation">ContextDefinitionTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of Context Service context definition translations.
                Available in API version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">customApplications</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#customApplicationTranslation">CustomApplicationTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of custom application translations</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">customLabels</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#customLabelTranslation">CustomLabelTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of custom label translations</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">customPageWebLinks</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#customPageWebLinkTranslation">CustomPageWebLinkTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of translations for web links defined in a home page
                component</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">customTabs</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#customTabTranslation">CustomTabTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of custom tab translations</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">dataConnectors</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#DataConnectorTranslation">DataConnectorTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of data connector translations. Available in API version
                64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">dashboardComponents</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type"><a class="xref" href="#DashboardComponentTranslation">DashboardComponentTranslation[]</a></td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of dashboard component translations. Available in API
                version 67.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">dashboards</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#DashboardTranslation">DashboardTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of dashboard title and description translations. Dashboard
                translations are automatically discoverable by the Translation
                Workbench when enabled. Available in API version 67.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">desFieldTemplateMessages</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type"><a class="xref" href="#ExplainabilityMsgTemplateFieldTranslation">ExplainabilityMsgTemplateFieldTranslation[]</a></td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of admin-configured explainability message
                templates</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">flowDefinitions</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#FlowDefinitionTranslation">FlowDefinitionTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of flow translations.<p class="p"><span class="ph" id="flowDefinitions_supported"><a name="flowDefinitions_supported"><!-- --></a>Only Flow and AutolaunchedFlow types are supported for
                    translation.</span> Available in API version 41.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">identityVerificationCustomFieldLabels</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type"><a class="xref" href="#IdentityVerificationFieldTranslation">IdentityVerificationFieldTranslation</a></td>

              <td class="entry" headers="d905869e1010" data-title="Description">
                <p class="p">A list of identity verification translation fields. Available in
                  API version 54.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e1010" data-title="Description">Required. The language code. For example, <samp class="codeph nolang">de</samp> for German.<p class="p">Inherited from
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for
                  this metadata type. It must be specified when creating,
                  updating, or deleting. For an example of this field
                  specified for a call, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname" id="globalPicklists_name"><a name="globalPicklists_name"><!-- --></a>globalPicklists</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#globalPicklistTranslation">GlobalPicklistTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">
                <span class="ph" id="globalPicklists_def"><a name="globalPicklists_def"><!-- --></a>A list of global picklist
                  translations. A global picklist’s value set is inherited by all
                  the custom picklist fields that are based on it.</span> Available
                in API version 37.0 only and is removed from later versions.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">pipelineInspMetricConfigs</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type"><a class="xref" href="#PipelineInspMetricConfigTranslation">PipelineInspMetricConfigTranslation</a></td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of translations of Pipeline Inspection forecast category
                metric settings. Available in API version 57.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">productSpecificationTypes</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type"><a class="xref" href="#ProductSpecificationTypeTranslation">ProductSpecificationTypeTranslation</a></td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of product specification type translations. Available in
                API version 66.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">prompts</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type"><a class="xref" href="#PromptTranslation">PromptTranslation</a></td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of In-App Guidance prompt translations. Available in API
                version 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname" id="quickActions"><a name="quickActions"><!-- --></a>quickActions</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#globalQuickActionTranslation">GlobalQuickActionTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description"><span class="ph" id="quickAction_desc"><a name="quickAction_desc"><!-- --></a>A list of global rather than
                  object-specific quick actions.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">recordAlertCategories</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#RecordAlertCategoryTranslation">RecordAlertCategoryTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of record alert category translations. Available in API
                version 66.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">recordAlertTemplates</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#RecordAlertTemplateTranslation">RecordAlertTemplateTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of record alert template translations. Available in API
                version 66.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">reportAggregates</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#ReportAggregateTranslation">ReportAggregateTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of Lightning Experience report aggregate translations.
                Available in API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">reportBucketFields</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#ReportBucketFieldTranslation">ReportBucketFieldTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of Lightning Experience report bucket field translations.
                Available in API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">reportCharts</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#ReportChartTranslation">ReportChartTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of Lightning Experience report chart translations.
                Available in API version 68.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">reports</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#ReportTranslation">ReportTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of Lightning Experience report name translations. Report translations are
                automatically discoverable by the Translation Workbench when enabled.
                Available in API version 67.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">reportTypes</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#reportTypeTranslation">ReportTypeTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of Lightning Experience report type translations</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">scontrols</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#scontrolTranslation">ScontrolTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of s-control translations</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">svcCatalogItemAttributes</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#ServiceProcessAttributeTranslation">ServiceProcessAttributeTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of service catalog item attribute translations. Available
                in API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">svcCatalogItemGroups</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#ServiceProcessItemGroupTranslation">ServiceProcessItemGroupTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of service catalog item group translations. Available in
                API version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1004" data-title="Field"><span class="keyword parmname">timelineObjectDefinitions</span></td>

              <td class="entry" headers="d905869e1007" data-title="Field Type">
                <a class="xref" href="#TimelineObjectDefinitionTranslation">TimelineObjectDefinitionTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1010" data-title="Description">A list of timeline object definition translations. Available in
                API version 66.0 and later.</td>

            </tr>

          </tbody>

        </table>

## ContextDefinitionTranslation

ContextDefinitionTranslation contains details for a translation of a Context Service context definition. Available in API version 62.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The translated description of the context definition. |
| label | string | Required. The translated label of the context definition. |
| name | string | Required. The name of the context definition. |

## AiCoachAgentScnrDefTranslation

AiCoachAgentScnrDefTranslation contains details for the translation of Agentforce Sales Coach scenarios. Available in API version 64.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The description of the coaching scenario |
| label | string | The title of the coaching scenario |
| name | string | Required. Name of the coaching scenario. |
| userGuidance | string | The instructions that the rep must follow before starting the coaching session |

## BotBlockTranslation

BotBlockTranslation contains details for a translation of a bot block. Available in API version 59.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| botBlockVersions | [BotBlockVersionTranslation](#BotBlockVersionTranslation)\[\] | A list of bot block version translations |
| fullName | string | Required. The name of the bot block. |

## BotBlockVersionTranslation

BotBlockVersionTranslation contains details for a translation of a bot block version. Available in API version 59.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| botDialogs | [BotDialogTranslation](#BotDialogTranslation)\[\] | A list of bot dialog translations for the bot block version |
| fullName | string | Required. The name of the bot block version. |

## BotTemplateTranslation

BotTemplateTranslation contains details for a translation of a bot template. Available in API version 59.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| botDialogs | [BotDialogTranslation](#BotDialogTranslation)\[\] | A list of bot dialog translations for the bot template |
| fullName | string | Required. The name of the bot template. |

## BotTranslation

BotTranslation contains details for a translation of a bot. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e1974">Field</th>

              <th class="featureTableHeader  " id="d905869e1977">Field Type</th>

              <th class="featureTableHeader  " id="d905869e1980">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e1974" data-title="Field"><span class="keyword parmname">botVersions</span></td>

              <td class="entry" headers="d905869e1977" data-title="Field Type">
                <a class="xref" href="#BotVersionTranslation">BotVersionTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e1980" data-title="Description">A list of bot version translations</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e1974" data-title="Field"><span class="keyword parmname">fullName </span></td>

              <td class="entry" headers="d905869e1977" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e1980" data-title="Description">Required. Name of the bot.<p class="p">The <span class="keyword parmname">fullName</span>
                  for the translation must match the <span class="keyword parmname">fullName</span>
                  inherited by the original Bot type.</p>
              </td>

            </tr>

          </tbody>

        </table>

## BotVersionTranslation

BotVersionTranslation contains details for a translation of a bot version. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e2050">Field</th>

              <th class="featureTableHeader  " id="d905869e2053">Field Type</th>

              <th class="featureTableHeader  " id="d905869e2056">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e2050" data-title="Field"><span class="keyword parmname">botDialogs</span></td>

              <td class="entry" headers="d905869e2053" data-title="Field Type">
                <a class="xref" href="#BotDialogTranslation">BotDialogTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e2056" data-title="Description">A translated list of dialogs in this bot version</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2050" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d905869e2053" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2056" data-title="Description">Required. Name of a bot version.<p class="p">The
                  <span class="keyword parmname">fullName</span> for the translation must match
                  the <span class="keyword parmname">fullName</span> inherited by the original
                  BotVersion type.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## BotDialogTranslation

BotDialogTranslation contains details for a translation of a bot dialog. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e2126">Field</th>

              <th class="featureTableHeader  " id="d905869e2129">Field Type</th>

              <th class="featureTableHeader  " id="d905869e2132">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e2126" data-title="Field"><span class="keyword parmname">botSteps</span></td>

              <td class="entry" headers="d905869e2129" data-title="Field Type">
                <a class="xref" href="#BotStepTranslation">BotStepTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e2132" data-title="Description">A translated list of steps that are executed as part of the
                dialog</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2126" data-title="Field"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d905869e2129" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2132" data-title="Description">Required. This unique name prevents conflicts with other dialogs
                associated with the same bot version.<p class="p">The
                  <span class="keyword parmname">developerName</span> for the translation must
                  match the <span class="keyword parmname">developerName</span> on the original
                  BotDialog subtype of BotVersion.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2126" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d905869e2129" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2132" data-title="Description">A translated label that identifies the dialog throughout the
                Salesforce user interface</td>

            </tr>

          </tbody>

        </table>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

In Metadata Deployment of Translations, it's expected that blank values cannot be used to delete existing translations. If a translation label is left blank, it's skipped during deployment, and no error is shown.

## BotStepTranslation

BotStepTranslation contains details for a translation of a bot step. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e2218">Field</th>

              <th class="featureTableHeader  " id="d905869e2221">Field Type</th>

              <th class="featureTableHeader  " id="d905869e2224">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e2218" data-title="Field"><span class="keyword parmname">botMessages</span></td>

              <td class="entry" headers="d905869e2221" data-title="Field Type">
                <a class="xref" href="#BotMessageTranslation">BotMessageTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e2224" data-title="Description">A translated list of bot messages used by a BotStep of type
                <samp class="codeph nolang">Message</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2218" data-title="Field"><span class="keyword parmname">botSteps</span></td>

              <td class="entry" headers="d905869e2221" data-title="Field Type">BotStepTranslation[]</td>

              <td class="entry" headers="d905869e2224" data-title="Description">A translated list of bot steps associated with a BotStep of type
                <samp class="codeph nolang">Group</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2218" data-title="Field"><span class="keyword parmname">botVariableOperation</span></td>

              <td class="entry" headers="d905869e2221" data-title="Field Type"><a class="xref" href="#BotVariableOperationTranslation">BotVariableOperationTranslation</a></td>

              <td class="entry" headers="d905869e2224" data-title="Description">A translated bot variable operation used by a BotStep of type
                <samp class="codeph nolang">VariableOperation</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2218" data-title="Field"><span class="keyword parmname">stepIdentifier</span></td>

              <td class="entry" headers="d905869e2221" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2224" data-title="Description">Required. A unique key that identifies a step within a dialog.
                This key is used to link translated labels to labels within the
                step. This field is recommended for all step records and is required
                for translated step labels.<p class="p">The
                  <span class="keyword parmname">stepIdentifier</span> for the translation must
                  match the <span class="keyword parmname">stepIdentifier</span> on the original
                  BotStep subtype of BotVersion.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2218" data-title="Field"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d905869e2221" data-title="Field Type">BotStepType (enumeration of type string)</td>

              <td class="entry" headers="d905869e2224" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Navigation</samp></li>

                  <li class="li"><samp class="codeph nolang">Invocation</samp></li>

                  <li class="li"><samp class="codeph nolang">VariableOperation</samp></li>

                  <li class="li"><samp class="codeph nolang">Message</samp></li>

                  <li class="li"><samp class="codeph nolang">Wait</samp></li>

                  <li class="li"><samp class="codeph nolang">Group</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">RecordLookup</samp> (Available
                    in API version 48.0 and later.)
                  </li>

                </ul>
                <p class="p">The <span class="keyword parmname">type</span> for the translation must match
                  the <span class="keyword parmname">type</span> on the original BotStep subtype of
                  BotVersion.</p>
              </td>

            </tr>

          </tbody>

        </table>

## BotMessageTranslation

BotMessageTranslation contains details for a translation of a bot message step. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e2381">Field</th>

              <th class="featureTableHeader  " id="d905869e2384">Field Type</th>

              <th class="featureTableHeader  " id="d905869e2387">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e2381" data-title="Field"><span class="keyword parmname">message</span></td>

              <td class="entry" headers="d905869e2384" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2387" data-title="Description">A translated message to show as part of an outgoing message from
                the bot to the customer</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2381" data-title="Field"><span class="keyword parmname">messageIdentifier</span></td>

              <td class="entry" headers="d905869e2384" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2387" data-title="Description">Required. A unique key that identifies a message within a dialog.
                This key is used to link translated labels to labels within the
                message. This field is recommended for all message records and is
                required for translated message labels.<p class="p">The
                  <span class="keyword parmname">messageIdentifier</span> for the translation
                  must match the <span class="keyword parmname">messageIdentifier</span> on the
                  original BotMessage subtype of BotVersion.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## BotVariableOperationTranslation

BotVariableOperationTranslation contains details for a translation of a bot variable operation (question) step. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e2454">Field</th>

              <th class="featureTableHeader  " id="d905869e2457">Field Type</th>

              <th class="featureTableHeader  " id="d905869e2460">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e2454" data-title="Field"><span class="keyword parmname">botMessages</span></td>

              <td class="entry" headers="d905869e2457" data-title="Field Type">
                <a class="xref" href="#BotMessageTranslation">BotMessageTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e2460" data-title="Description">A translated list of bot messages used as prompt messages by a
                BotVariableOperation of type <samp class="codeph nolang">Collect</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2454" data-title="Field"><span class="keyword parmname">botQuickReplyOptions</span></td>

              <td class="entry" headers="d905869e2457" data-title="Field Type">
                <a class="xref" href="#BotQuickReplyOptionTranslation">BotQuickReplyOptionTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e2460" data-title="Description">A translated list of static choice options used by a
                BotVariableOperation of type <samp class="codeph nolang">Collect</samp> and <span class="keyword parmname">quickReplyType</span> of
                <samp class="codeph nolang">Static</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2454" data-title="Field"><span class="keyword parmname">quickReplyOptionTemplate</span></td>

              <td class="entry" headers="d905869e2457" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2460" data-title="Description">A translated formula template used to resolve a label for Dynamic
                choice options of type <samp class="codeph nolang">Object</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2454" data-title="Field"><span class="keyword parmname">retryMessages</span></td>

              <td class="entry" headers="d905869e2457" data-title="Field Type">
                <a class="xref" href="#BotMessageTranslation">BotMessageTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e2460" data-title="Description">In <a class="xref" href="https://help.salesforce.com/s/articleView?id=service.bots_service_setup_dialog_question_text.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Conversation Repair</a>, the translated messages assigned to
                repair attempts</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2454" data-title="Field"><span class="keyword parmname">successMessages</span></td>

              <td class="entry" headers="d905869e2457" data-title="Field Type">
                <a class="xref" href="#BotMessageTranslation">BotMessageTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e2460" data-title="Description">In a File dialog step, the translated message shown to the
                customer as part of type CollectAttachment to confirm a successful
                file upload. Available in API version 57.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2454" data-title="Field"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d905869e2457" data-title="Field Type">BotVariableOperationType (enumeration of type string)</td>

              <td class="entry" headers="d905869e2460" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Set</samp></li>

                  <li class="li"><samp class="codeph nolang">Unset</samp></li>

                  <li class="li"><samp class="codeph nolang">Collect</samp></li>

                  <li class="li"><samp class="codeph nolang">SetConversationLanguage</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2454" data-title="Field"><span class="keyword parmname">variableOperationIdentifier</span></td>

              <td class="entry" headers="d905869e2457" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2460" data-title="Description">Required. A unique key that identifies a variable operation
                within a dialog. This key is used to link translated labels to
                labels within the variable operation. This field is recommended for
                all variable operation records and is required for translated
                variable operation labels.<p class="p">The
                  <span class="keyword parmname">variableOperationIdentifier</span> for the
                  translation must match the
                  <span class="keyword parmname">variableOperationIdentifier</span> on the
                  original BotVariableOperation subtype of BotVersion.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## BotQuickReplyOptionTranslation

BotQuickReplyOptionTranslation contains details for a translation of a bot quick reply option within a bot variable operation (question) step. Available in API version 53.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e2640">Field</th>

              <th class="featureTableHeader  " id="d905869e2643">Field Type</th>

              <th class="featureTableHeader  " id="d905869e2646">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e2640" data-title="Field"><span class="keyword parmname">literalValue</span></td>

              <td class="entry" headers="d905869e2643" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2646" data-title="Description">A translated value to be shown as a menu or button choice to your
                customer.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e2640" data-title="Field"><span class="keyword parmname">quickReplyOptionIdentifier</span></td>

              <td class="entry" headers="d905869e2643" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e2646" data-title="Description">Required. A unique key that identifies a quick reply option
                within a dialog. This key is used to link translated labels to
                labels within the quick reply option. This field is recommended for
                all quick reply option records and is required for translated quick
                reply option labels.<p class="p">The
                  <span class="keyword parmname">quickReplyOptionIdentifier</span> for the
                  translation must match the
                  <span class="keyword parmname">quickReplyOptionIdentifier</span> on the
                  original BotQuickReplyOption subtype of BotVersion.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## CustomApplicationTranslation

CustomApplicationTranslation contains details for a custom application translation. For more details, see [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customapplication.htm "CustomApplication represents a custom or standard application. In API version 29.0 and earlier, CustomApplication represents only a custom application. An application is a list of tab references, with a description and a logo. This type extends the Metadata metadata type and inherits its fullName field.").

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | Description text for the application translation. |
| label | string | The translated custom application name. Maximum of 765 characters. |
| name | string | Required. The name of the custom application. |

## CustomLabelTranslation

CustomLabelTranslation contains details for a custom label translation. For more details, see [CustomLabels](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customlabels.htm "The CustomLabels metadata type allows you to create custom labels that can be localized for use in different languages, countries, and currencies.").

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The translated custom label name. Maximum of 765 characters. |
| name | string | Required. The custom label name. |

## CustomPageWebLinkTranslation

CustomPageWebLinkTranslation contains details for a translation of a web link defined in a home page component. For more details, see [CustomPageWebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/custompageweblink.htm "Represents a custom link defined in a home page component.").

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The translated web link. |
| name | string | Required. The name of the web link. |

## CustomTabTranslation

CustomTabTranslation contains details for a translation of a custom tab. For more details, see [CustomTab](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_tab.htm "Represents a custom tab. Custom tabs let you display custom object data or other web content in Salesforce. When you add a custom tab to an app in Salesforce Classic, it appears as a tab. When you add a custom tab to an app in Lightning Experience, it appears as an item in the app’s navigation bar and in the App Launcher. When a tab displays a custom object, the tab name is the same as the custom object name. For page, s-control, or URL tabs, the name is arbitrary.").

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The translated custom tab name. |
| name | string | Required. The custom tab name. |

## DashboardComponentTranslation

DashboardComponentTranslation contains details for a translation of a Lightning Experience dashboard components. For more details, see [DashboardComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dashboard.htm#DashboardComponent).

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The dashboard component description. |
| footer | string | The dashboard component footer. |
| label | string | The dashboard component label. |
| name | string | Required. The dashboard component name. |

## DashboardTranslation

DashboardTranslation contains details for a translation of a Lightning Experience dashboard. For more details, see [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dashboard.htm "Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.").

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The dashboard description. |
| label | string | The dashboard label. |
| name | string | Required. The dashboard name. |

## ExplainabilityMsgTemplateFieldTranslation

ExplainabilityMsgTemplateFieldTranslation represents the template that contains the decision explanation message for a specified step element type.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e3204">Field Name</th>

              <th class="featureTableHeader  " id="d905869e3207">Field Type</th>

              <th class="featureTableHeader  " id="d905869e3210">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e3204" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d905869e3207" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e3210" data-title="Description">The explainability message field description</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3204" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d905869e3207" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e3210" data-title="Description">A user-friendly name for
                ExplainabilityMsgTemplateFieldTranslation</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3204" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d905869e3207" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e3210" data-title="Description">
                <p class="p">Required. The name of the decision explanation message for a
                  specified step element type.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3204" data-title="Field Name"><span class="keyword parmname">templateMessage</span></td>

              <td class="entry" headers="d905869e3207" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e3210" data-title="Description">The message associated with the template for a specific
                expression set step type</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This is an example of an ExplainabilityMsgTemplateFieldTranslation component.

<?xml version="1.0" encoding="UTF-8"?>
<Translations xmlns="http://soap.sforce.com/2006/04/metadata">
    <desFieldTemplateMessages\>
        <description\>Calc Blitz Message</description\>
        <label\>CALBLITZ</label\>
        <name\>CALBLITZ</name\>
        <templateMessage\>CALBLITZ</templateMessage\>
    </desFieldTemplateMessages\>
</Translations\>

## FlowDefinitionTranslation

FlowDefinitionTranslation contains details for a translation of a flow definition. For more details, see [FlowDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_flowdefinition.htm "Represents the flow definition’s description and active flow version number.").

Available in API version 41.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e3322">Field</th>

              <th class="featureTableHeader  " id="d905869e3325">Field Type</th>

              <th class="featureTableHeader  " id="d905869e3328">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e3322" data-title="Field"><span class="keyword parmname">flows</span></td>

              <td class="entry" headers="d905869e3325" data-title="Field Type">
                <a class="xref" href="#FlowTranslation">FlowTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e3328" data-title="Description">A list of flow version translations for the flow
                definition</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3322" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d905869e3325" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e3328" data-title="Description">Required. The API name for the flow definition.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3322" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d905869e3325" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e3328" data-title="Description">A translated label for the flow definition. <p class="p">By default, flow
                  definitions inherit the label of the active flow version. If you
                  provide a label here, the definition label no longer inherits
                  changes to the active version label.</p>
              </td>

            </tr>

          </tbody>

        </table>

## FlowTranslation

FlowTranslation contains details for a translation of a flow version. For more details, see [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm "Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.").

Available in API version 41.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d905869e3415">Field</th>

              <th class="featureTableHeader  " id="d905869e3418">Field Type</th>

              <th class="featureTableHeader  " id="d905869e3421">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d905869e3415" data-title="Field"><span class="keyword parmname">choices</span></td>

              <td class="entry" headers="d905869e3418" data-title="Field Type">
                <a class="xref" href="#FlowChoiceTranslation">FlowChoiceTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e3421" data-title="Description">A list of choice translations for the flow version</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3415" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d905869e3418" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e3421" data-title="Description">The API name for the flow version.<p class="p">A unique name for the flow
                  that contains only underscores and alphanumeric characters. The
                  name must be unique across the org, begin with a letter, not
                  include spaces, not end with an underscore, and not contain two
                  consecutive underscores.</p>
                <p class="p">To deploy or retrieve a version,
                  you can specify the version number. For example, <samp class="codeph nolang">sampleFlow-3</samp> specifies version
                  3 of the flow whose unique name is sampleFlow. If you don't
                  specify a version number, the flow is the latest
                  version.</p>
                <p class="p">In API version 43.0 and earlier, this field
                  included the version number. In API version 44 and later, this
                  field no longer includes the version number.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3415" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d905869e3418" data-title="Field Type">string</td>

              <td class="entry" headers="d905869e3421" data-title="Description">A translated label for the flow version</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3415" data-title="Field"><span class="keyword parmname">orchestrationStages</span></td>

              <td class="entry" headers="d905869e3418" data-title="Field Type"><a class="xref" href="#FlowOrchestrationStageTranslation">FlowOrchestrationStageTranslation</a></td>

              <td class="entry" headers="d905869e3421" data-title="Description">A list of orchestration stage translations for the flow version.
                Available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3415" data-title="Field"><span class="keyword parmname">orchestrationSteps</span></td>

              <td class="entry" headers="d905869e3418" data-title="Field Type"><a class="xref" href="#FlowOrchestrationStepTranslation">FlowOrchestrationStepTranslation</a></td>

              <td class="entry" headers="d905869e3421" data-title="Description">A list of orchestration step translations for the flow version.
                Available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3415" data-title="Field"><span class="keyword parmname">screens</span></td>

              <td class="entry" headers="d905869e3418" data-title="Field Type">
                <a class="xref" href="#FlowScreenTranslation">FlowScreenTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e3421" data-title="Description">A list of screen translations for the flow version</td>

            </tr>

            <tr>
              <td class="entry" headers="d905869e3415" data-title="Field"><span class="keyword parmname">stages</span></td>

              <td class="entry" headers="d905869e3418" data-title="Field Type">
                <a class="xref" href="#FlowStageTranslation">FlowStageTranslation</a>[]
              </td>

              <td class="entry" headers="d905869e3421" data-title="Description">A list of stage translations for the flow version. Available in
                API version 43.0 and later.</td>

            </tr>

          </tbody>

        </table>

## FlowChoiceTranslation

FlowChoiceTranslation contains details for a translation of a choice in a flow version. For more details, see FlowChoice in [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm "Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.").

Available in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| choiceText | string | A translated label for the choice |
| name | string | Required. A unique name for the choice. |
| userInput | [FlowChoiceUserInputTranslation](#FlowChoiceUserInputTranslation) | A translated choice input for the choice |

## FlowChoiceUserInputTranslation

FlowChoiceUserInputTranslation contains details for a translation of a choice input. For more details, see FlowChoiceUserInput in [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm "Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.").

Available in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| promptText | string | A translated label for the choice input |
| validationRule | [FlowInputValidationRuleTranslation](#FlowInputValidationRuleTranslation) | A translated validation rule for the choice input |

## FlowInputValidationRuleTranslation

FlowInputValidationRuleTranslation contains details for a translation of a validation rule. For more details, see FlowInputValidationRule in [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm "Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.").

Available in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| errorMessage | string | A translated error message for the validation rule |

## FlowOrchestrationStageTranslation

FlowOrchestrationStageTranslation contains details for a translation of an orchestration stage in an orchestration version. For more details, see FlowOrchestratedStage in [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm "Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.").

Available in API version 64.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| name | string | Required. The unique name of the orchestration stage translation. |
| stageLabel | string | A translated label for the orchestration stage |

## FlowOrchestrationStepTranslation

FlowOrchestrationStepTranslation contains details for a translation of an orchestration step in an orchestration version. For more details, see FlowStageStep in [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm "Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.").

Available in API version 63.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| name | string | Required. The unique name of the orchestration step translation. |
| stepLabel | string | A translated label for the orchestration step |

## FlowScreenTranslation

FlowScreenTranslation contains details for a translation of a screen. For more details, see FlowScreen in [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm "Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.").

Available in API version 41.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| backButtonLabel | string | A translated label for the Back button. Available in API version 54.0 and later. |
| fields | [FlowScreenFieldTranslation](#FlowScreenFieldTranslation)\[\] | A list of screen component translations for the screen |
| helpText | string | Translated help text for the screen |
| name | string | Required. An API name for the screen. |
| nextOrFinishButtonLabel | string | A translated label for the Next or Finish button. Available in API version 54.0 and later. |
| pauseButtonLabel | string | A translated label for the Pause button. Available in API version 54.0 and later. |
| pausedText | string | A translated pause confirmation message for the screen |

## FlowScreenFieldTranslation

FlowScreenFieldTranslation contains details for a translation of a screen component. For more details, see FlowScreenField in [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm "Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.").

Available in API version 41.0 and later.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Translation isn’t supported for screen components that require Lightning runtime.

| Field | Field Type | Description |
| --- | --- | --- |
| fieldText | string | A translated label for the screen component |
| helpText | string | Translated help text for the screen component |
| inputParameters | [FlowInputParameterTranslation](#FlowInputParameterTranslation) | Reserved for internal use. |
| name | string | Required. An API name for the screen component. |
| validationRule | [FlowInputValidationRuleTranslation](#FlowInputValidationRuleTranslation) | Translated validation rule for the screen component |

## FlowInputParameterTranslation

FlowInputParameterTranslation is reserved for internal use.

| Field | Field Type | Description |
| --- | --- | --- |
| name | string | Reserved for internal use |
| value | [FlowFerovTranslation](#FlowFerovTranslation) | Reserved for internal use |

## FlowFerovTranslation

FlowFerovTranslation is reserved for internal use.

| Field | Field Type | Description |
| --- | --- | --- |
| complexValues | [FlowComplexLiteralTranslation](#FlowComplexLiteralTranslation) | Reserved for internal use |
| stringValue | string | Reserved for internal use |

## FlowComplexLiteralTranslation

FlowComplexLiteralTranslation is reserved for internal use.

| Field | Field Type | Description |
| --- | --- | --- |
| customAspectKey | string | Reserved for internal use |
| value | string | Reserved for internal use |

## FlowStageTranslation

FlowStageTranslation contains details for a translation of a stage in a flow version. For more details, see FlowStage in [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_visual_workflow.htm "Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.").

Available in API version 43.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | A translated label for the stage |
| name | string | Required. An API name for the stage. |

## FlowTextTemplateTranslation

FlowTextTemplateTranslation is available only in flows created via Salesforce Surveys and represents the translation details for the text on all the pages of a survey.

Available in API version 45.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Unique name for the text template. |
| text | string | Translated text for the text template |

## IdentityVerificationFieldTranslation

Translates the UI components associated with identity verification fields.

Available in API version 54.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| customFieldLabel | string | The custom label for the field that contains the verification data |
| description | string | The identity verification field description |
| label | string | A user-friendly name for IdentityVerificationFieldTranslation |
| name | string | Required. The name of the identity verification field. |

## TimelineObjectDefinitionTranslation

Contains details for a translation of a timeline object definition. Available in API version 66.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Translated label for the timeline object definition |
| name | string | Required. Name of the timeline object definition |

## Declarative Metadata Sample Definition

This is an example of an IdentityVerificationFieldTranslation component.

<?xml version="1.0" encoding="UTF-8"?>
<Translations
    xmlns="http://soap.sforce.com/2006/04/metadata">
    <identityVerificationCustomFieldLabels\>
        <description\>Telefono Numero</description\>
        <label\>Telefono Numero</label\>
        <name\>Sample93Phone</name\>
    </identityVerificationCustomFieldLabels\>
    <identityVerificationCustomFieldLabels\>
        <description\>Nombre de la Cuenta</description\>
        <label\>Nombre de la Cuenta</label\>
        <name\>Sample93Account</name\>
    </identityVerificationCustomFieldLabels\>
    <identityVerificationCustomFieldLabels\>
        <name\>Sample93PostalCode</name\>
    </identityVerificationCustomFieldLabels\>
    <identityVerificationCustomFieldLabels\>
        <name\>Sample93AccountName</name\>
        <description\>Nombre</description\>
        <label\>Nombre</label\>
    </identityVerificationCustomFieldLabels\>
</Translations\>

## GlobalPicklistTranslation

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

GlobalPicklistTranslation is available in API version 37.0 only and is removed from later versions.

GlobalPicklistTranslation contains details for a global picklist translation.

Translations are stored in a file with a format of globalPicklistName\_\_e\-lang.objectTranslation, where globalPicklistName\_\_e is the global picklist name and lang is the translation language. To reference a global picklist translation value, use globalPicklistName\_\_e.value1, where value1 is the translated value for the user interface.

Here’s what translations look like for a global picklist.

<?xml version="1.0" encoding="UTF-8"?>
<Translations xmlns="http://soap.sforce.com/2006/04/metadata">
<globalPicklists\>
    <name\>transpicklist</name\>
    <picklistValues\>
        <masterLabel\>Three</masterLabel\>
        <translation\>Trois</translation\>
    </picklistValues\>
    <picklistValues\>
        <masterLabel\>Four</masterLabel\>
        <translation\>Quatre</translation\>
    </picklistValues\>
</globalPicklists\>
</Translations\>

| Field | Field Type | Description |
| --- | --- | --- |
| name | string | Required. Represents the name of a global picklist to be translated. |
| picklistValues | [PicklistValueTranslation](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customobjecttranslation.htm#pickListValueTranslation)\[\] | A list of picklist values from global picklists to be translated |

## GlobalQuickActionTranslation

GlobalQuickActionTranslation contains details for the global translation of a quick action. For more information, see [QuickAction](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickaction.htm "Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields.").

| Field | Field Type | Description |
| --- | --- | --- |
| aspect | string | Identifies which quick action label the translated text belongs to. Use this field only when you want to use different strings for the quick action’s field label and informational message. Valid values are Master and InfoMessage. Available in API version 53.0 and later. |
| label | string | Required. The translated quick action name, globally. |
| name | string | Required. The quick action name. |

## PipelineInspMetricConfigTranslation

PipelineInspMetricConfigTranslation contains details for the translation of Pipeline Inspection forecast category metric settings. Available in API version 57.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The translated Pipeline Inspection metric configuration name. |
| name | string | Required. The name of the Pipeline Inspection metric configuration. |

## ProductSpecificationTypeTranslation

ProductSpecificationTypeTranslation contains details for a translation of a product specification type. For more details, see [ProductSpecificationType](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/meta_productspecificationtype.htm "HTML (New Window)"). Available in API version 66.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The translated product specification type description. |
| label | string | The translated product specification type name. |
| name | string | Required. The name of the product specification type. |

## PromptTranslation

PromptTranslation contains metadata for the translation of a prompt, which is part of In-App Guidance. Available in API Version 48.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The prompt description |
| label | string | The translated prompt name |
| name | string | Required. The name of the prompt. |
| promptVersions | PromptVersionTranslation | A list of the prompt version translations |

## PromptVersionTranslation

PromptVersionTranslation contains details for translation of a prompt, which is part of In-App Guidance. Available in API Version 48.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| actionButtonLabel | string | The label for the prompt’s action button |
| actionButtonLink | string | The URL for the prompt’s action button |
| body | string | The body text of the prompt |
| description | string | The prompt description |
| dismissButtonLabel | string | The label for the floating prompt’s dismiss button |
| header | string | The header for the docked prompt |
| imageAltText | string | The alt text for a prompt’s image. Available in API version 53.0 and later. |
| imageLink | string | The URL for a prompt’s image. Available in API version 53.0 and later. |
| label | string | The translated prompt name |
| name | string | Required. The name of the prompt. |
| title | string | The title of the prompt |
| videoLink | string | The URL for the docked prompt’s video |

## ReportAggregateTranslation

ReportAggregateTranslation contains details for a translation of a Lightning Experience report aggregate. For more details, see [ReportAggregate](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm#ReportAggregate).

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | The aggregate label. |
| name | string | Required. The aggregate name. |
| reportName | string | Required. The report name for the aggregate. |

## ReportBucketFieldTranslation

ReportBucketFieldTranslation contains details for a translation of a Lightning Experience report bucket field. For more details, see [ReportBucketField](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm#ReportBucketField).

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | The bucket field label. |
| name | string | Required. The bucket field name. |
| reportName | string | Required. The report name for the bucket field. |

## ReportChartTranslation

ReportChartTranslation contains details for a translation of a Lightning Experience report chart. For more details, see [ReportChart](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm#ReportChart).

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | The chart label. |
| name | string | Required. The chart name. |
| reportName | string | Required. The report name for the chart. |

## ReportTranslation

ReportTranslation contains details for a translation of a Lightning Experience report. For more details, see [Report](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm "Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.").

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The report description. |
| label | string | The report label. |
| name | string | Required. The report name. |

## ReportTypeTranslation

ReportTypeTranslation contains details for a translation of a custom Lightning Experience report type. For more details, see [ReportType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_reporttype.htm "Represents the metadata associated with a custom report type. Custom report types allow you to build a framework from which users can create and customize reports.").

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The translated report type description |
| label | string | The translated report type name |
| name | string | Required. The name of the report type. |
| sections | [ReportTypeSectionTranslation](#reportTypeSectionTranslation)\[\] | A list of report type section translations |

## ReportTypeSectionTranslation

ReportTypeSectionTranslation contains details for a Lightning Experience report type section translation.

| Field | Field Type | Description |
| --- | --- | --- |
| columns | [ReportTypeColumnTranslation](#reportTypeColumnTranslation)\[\] | A list of report type column translations |
| label | string | The translated report type section name |
| name | string | Required. The name of the report type section. |

## ReportTypeColumnTranslation

ReportTypeColumnTranslation contains details for a Lightning Experience report type column translation.

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The translated report type column name. |
| name | string | Required. The report type column name. |

## ScontrolTranslation

ScontrolTranslation contains details for a translation of an s-control. For more information, see “About S-Controls” in Salesforce Help.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Visualforce pages supersede s-controls. Organizations that haven't previously used s-controls can’t create them. Existing s-controls are unaffected and can still be edited.

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The translated s-control name. |
| name | string | Required. The name of the s-control. |

## ConversationMessageDefinitionTranslation

ConversationMessageDefinitionTranslation contains details for a translation of a conversation message definition. Available in API version 61.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| constantValueTranslations | [ConversationMessageConstantValueTranslation](#ConversationMessageConstantValueTranslation)\[\] | A list of conversation message constant value translations |
| label | string | Required. The translated label for the conversation message definition. |
| name | string | Required. The name of the conversation message definition. |

## ConversationMessageConstantValueTranslation

ConversationMessageConstantValueTranslation contains details for a translation of a conversation message constant value. Available in API version 61.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| name | string | Required. The name of the conversation message constant value. |
| value | string | Required. The translated constant value. |

## DataConnectorTranslation

DataConnectorTranslation contains details for a translation of a data connector. Available in API version 64.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| attributes | [DataConnectorAttributeTranslation](#DataConnectorAttributeTranslation)\[\] | A list of data connector attribute translations |
| description | string | The translated description for the data connector |
| errors | [DataConnectorErrorTranslation](#DataConnectorErrorTranslation)\[\] | A list of data connector error translations |
| help | string | The translated help text for the data connector |
| label | string | The translated label for the data connector |
| language | string | The language for the data connector translation |
| name | string | The name of the data connector |

## DataConnectorAttributeTranslation

DataConnectorAttributeTranslation contains details for a translation of a data connector attribute. Available in API version 64.0 and later. For more information, see [Data Cloud Connector Framework](https://help.salesforce.com/s/articleView?id=data.c360_a_data_cloud_connector_framework.htm&type=5&language=en_US).

| Field | Field Type | Description |
| --- | --- | --- |
| errorMessage | string | The translated error message for the attribute |
| infoMessage | string | The translated info message for the attribute |
| inputLabel | string | The translated input label for the attribute |
| label | string | Required. The translated label for the attribute. |
| name | string | Required. The name of the attribute. |
| options | [DataConnectorAttributeOptTranslation](#DataConnectorAttributeOptTranslation)\[\] | A list of data connector attribute option translations |

## DataConnectorAttributeOptTranslation

DataConnectorAttributeOptTranslation contains details for a translation of a data connector attribute option. Available in API version 64.0 and later. For more information, see [Data Cloud Connector Framework](https://help.salesforce.com/s/articleView?id=data.c360_a_data_cloud_connector_framework.htm&type=5&language=en_US).

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The translated label for the attribute option. |
| name | string | Required. The name of the attribute option. |

## DataConnectorErrorTranslation

DataConnectorErrorTranslation contains details for a translation of a data connector error. Available in API version 64.0 and later. For more information, see [Data Cloud Connector Framework](https://help.salesforce.com/s/articleView?id=data.c360_a_data_cloud_connector_framework.htm&type=5&language=en_US).

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The translated label for the error. |
| name | string | Required. The name of the error. |

## RecordAlertCategoryTranslation

RecordAlertCategoryTranslation contains details for a translation of a record alert category. Available in API version 66.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The translated description for the record alert category |
| label | string | Required. The translated label for the record alert category. |
| name | string | Required. The name of the record alert category. |

## RecordAlertTemplateTranslation

RecordAlertTemplateTranslation contains details for a translation of a record alert template. Available in API version 66.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| description | string | The translated description for the record alert template |
| label | string | The translated label for the record alert template |
| name | string | Required. The name of the record alert template. |
| subject | string | The translated subject for the record alert template |

## ServiceProcessAttributeTranslation

ServiceProcessAttributeTranslation contains details for a translation of a service process attribute. Available in API version 64.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| label | string | Required. The translated label for the service process attribute. |
| name | string | Required. The name of the service process attribute. |
| serviceProcessName | string | Required. The name of the service process. |

## ServiceProcessItemGroupTranslation

ServiceProcessItemGroupTranslation contains details for a translation of a service process item group. Available in API version 64.0 and later.

| Field | Field Type | Description |
| --- | --- | --- |
| groupName | string | Required. The name of the service process item group. |
| name | string | Required. The name of the service process item group translation. |
| serviceProcessName | string | Required. The name of the service process. |

## Declarative Metadata Sample Definition

This sample XML definition shows a translations component.

<?xml version="1.0" encoding="UTF-8"?>
<Translations xmlns="http://soap.sforce.com/2006/04/metadata">
    <customApplications\>
    <label\>Angebot-Manager</label\>
        <name\>Quote Manager</name\>
    </customApplications\>
    <customLabels\>
    <label\>Dieses ist ein manuelles Angebot</label\>
        <name\>quoteManual</name\>
    </customLabels\>
</Translations\>

## Usage

When you use the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") call to get translations, the files returned in the .translations folder only include translations for the other metadata types referenced in package.xml. For example, this package.xml file contains types elements that match all custom applications, custom labels, web links defined in home page components, custom tabs, report types, and s-controls. Translations for all these metadata types are returned because each metadata type is explicitly listed in package.xml.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
       <members\>\*</members\>
       <name\>CustomApplication</name\>
    </types\>
    <types\>
       <members\>\*</members\>
       <name\>CustomLabels</name\>
    </types\>
    <types\>
       <members\>\*</members\>
       <name\>CustomPageWebLink</name\>
    </types\>
    <types\>
       <members\>\*</members\>
       <name\>CustomTab</name\>
    </types\>
    <types\>
       <members\>\*</members\>
       <name\>ReportType</name\>
    </types\>
    <types\>
       <members\>\*</members\>
       <name\>Scontrol</name\>
    </types\>
    <types\>
       <members\>\*</members\>
        <name\>Translations</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [CustomLabels](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customlabels.htm "The CustomLabels metadata type allows you to create custom labels that can be localized for use in different languages, countries, and currencies.")

<!-- document id=cd9d44e49e8c186a4928fbd8027e7c2a4a424bff4c6acd4100dfe965296ba02d url=/legacydeveloper/current/en-us/api_meta/meta_trialorgsettings.md -->

# TrialOrgSettings

Represents the settings in a trial user’s org. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

TrialOrgSettings values are stored in the TrialOrg.settings file in the settings directory.The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

TrialOrgsettings is available in API version 48.0 and later.

## Special Access Rules

Access to TrialOrgSettings requires users to complete the checkout flow in Enterprise, Professional, or Essentials editions. For Essentials, you can also access TrialOrgSettings by completing step 7 of the Setup Assistant.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableSampleDataDeleted | boolean | Indicates whether sample data may be deleted on trial orgs (true) or not (false). The default value is false. |

## Declarative Metadata Sample Definition

The following is an example of a TrialOrgSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<TrialOrgSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableSampleDataDeleted\>false</enableSampleDataDeleted\>
</TrialOrgSettings\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=15c9ce3e82b494a3c890270c675b8a15bfb4e7a0ee11ca6b5987557b8e968b78 url=/legacydeveloper/current/en-us/api_meta/meta_trustedtelephonyprovider.md -->

# TrustedTelephonyProvider

Represents the trusted telephony carrier configuration for Agentforce Contact Center BYOC.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

TrustedTelephonyProvider components have the suffix .trustedTelephonyProvider and are stored in the trustedTelephonyProviders folder.

## Version

TrustedTelephonyProvider components are available in API version 68.0 and later.

## Special Access Rules

To access TrustedTelephonyProvider, you must have the Agentforce Contact Center Admin (Salesforce Voice) permission set assigned.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d926790e105">Field Name</th>

              <th class="featureTableHeader  " id="d926790e108">Field Type</th>

              <th class="featureTableHeader  " id="d926790e111">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d926790e105" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d926790e108" data-title="Field Type">string</td>

              <td class="entry" headers="d926790e111" data-title="Description">Required. The unique name of the TrustedTelephonyProvider component.
                Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> metadata type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d926790e105" data-title="Field Name"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d926790e108" data-title="Field Type">string</td>

              <td class="entry" headers="d926790e111" data-title="Description">Specifies the ID of the trusted telephony provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d926790e105" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d926790e108" data-title="Field Type">string</td>

              <td class="entry" headers="d926790e111" data-title="Description">Required. Specifies the master label of the trusted telephony
                provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d926790e105" data-title="Field Name"><span class="keyword parmname">providerCarrier</span></td>

              <td class="entry" headers="d926790e108" data-title="Field Type">ByocTrustedAggregator(
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a>
                of type string)
              </td>

              <td class="entry" headers="d926790e111" data-title="Description">Required. Specifies the aggregator type associated with trusted telephony
                provider. Valid value: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Bandwidth</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d926790e105" data-title="Field Name"><span class="keyword parmname">telephonyProvider</span></td>

              <td class="entry" headers="d926790e108" data-title="Field Type">string</td>

              <td class="entry" headers="d926790e111" data-title="Description">Specifies the associated telephony provider for the trusted telephony
                provider.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample XML definition of a TrustedTelephonyProvider component is shown here.

<trustedTelephonyProvider>
    <fullName>MyTrustedTelephonyProvider</fullName>
    <id>sampleValue</id>
    <masterLabel>sampleValue</masterLabel>
    <providerCarrier>Bandwidth</providerCarrier>
    <telephonyProvider>sampleValue</telephonyProvider>
</trustedTelephonyProvider>

The following package.xml manifest retrieves the TrustedTelephonyProvider component.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   ~ Copyright 2020 Salesforce, Inc.
   ~ All Rights Reserved
   ~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types>
      <members>\*</members>
      <name>TrustedTelephonyProvider</name>
   </types>
   <version>XX.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=23037e152968698893827180dbddaaf9b31e1d0e351c9f764776bcf20fcbdd96 url=/legacydeveloper/current/en-us/api_meta/meta_uibundle.md -->

# UIBundle

Represents the UI of a Salesforce Multi-Framework app, such as a React app.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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.

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

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>UIBundle</name\>
    </types\>
    <version\>66.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [_Agentforce Vibes Developer Guide_: Build a React App with Salesforce Multi-Framework (Beta)](https://developer.salesforce.com/docs/platform/einstein-for-devs/guide/reactdev-overview.html "Agentforce Vibes Developer
    Guide: Build a React App with Salesforce Multi-Framework (Beta) - html (New Window)")

<!-- document id=8b428d764574d6f0267e633f466082f156801f7b3c77e7947024fa187a7f3cec url=/legacydeveloper/current/en-us/api_meta/meta_uiformatspecificationset.md -->

# UiFormatSpecificationSet

Represents a set of rules that define the style and visibility of conditional field formatting on Dynamic Forms-enabled Lightning page field instances.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

A UiFormatSpecificationSet is referred to as a conditional formatting ruleset in the rest of the Salesforce documentation and UI.

## File Suffix and Directory Location

UiFormatSpecificationSet components have the suffix .uiFormatSpecificationSet and are stored in the uiFormatSpecificationSets folder.

## Version

UiFormatSpecificationSet components are available in API version 62.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| field | 
Field Type

string

Description

Required. The object field that the conditional formatting is associated with.





 |
| formatType | 

Field Type

FormatType (enumeration of type string)

Description

Required. The type of conditional formatting associated with the field.

Values are:

- ICON





 |
| masterLabel | 

Field Type

string

Description

Required. The label for the conditional formatting ruleset, which displays in Setup.





 |
| sobjectType | 

Field Type

string

Description

Required. The object the ruleset is associated with.





 |
| uiFormatSpecifications | 

Field Type

[UiFormatSpecification\[\]](#UiFormatSpecification)

Description

The list of rules contained in the ruleset.



 |

## UiFormatSpecification

A single rule in the ruleset.

| Field Name | Description |
| --- | --- |
| formatProperties | 
Field Type

string

Description

Required. The properties for a given formatType in JSON format.





 |
| formatType | 

Field Type

FormatType (enumeration of type string)

Description

Required. The type of conditional formatting associated with the field when the rule evaluates to true.

Values are:

- ICON





 |
| order | 

Field Type

int

Description

Required. A numerical value representing the conditional formatting rule’s position in the evaluation order.





 |
| visibilityRule | 

Field Type

[UiFormulaRule](#UiFormulaRule)

Description

A set of one or more filters that define the conditions under which the conditional formatting appears on the field.

If the visibility rule evaluates to true, the formatting displays on the field. If false, it doesn’t display. If this field is null, the formatting displays by default.





 |

## UiFormulaRule

A set of one or more filters that define the conditions under which conditional field formatting displays on a Dynamic Forms-enabled Lightning page field instance. For example, you could construct a filter that causes conditional formatting to display only when the Amount field is greater than $1,000,000.

| Field Name | Description |
| --- | --- |
| booleanFilter | 
Field Type

string

Description

Specifies advanced filter conditions such as 1 AND 2.



 |
| criteria | 

Field Type

[UiFormulaCriterion\[\]](#UiFormulaCriterion)

Description

List of one or more filters that, when evaluated, determine conditional field formatting visibility.



 |

## UiFormulaCriterion

A single filter that when evaluated, helps define conditional formatting visibility on a Dynamic Forms-enabled Lightning page field instance.

| Field Name | Description |
| --- | --- |
| leftValue | 
Field Type

string

Description

Required. The field upon which the filter is based. For example, AMOUNT.



 |
| operator | 

Field Type

string

Description

Required. Defines the operator used to filter the data. Valid values are:

- CONTAINS
- EQUAL
- NE—not equal
- GT—greater than
- GE—greater than or equal
- LE—less than or equal
- LT—less than





 |
| rightValue | 

Field Type

string

Description

The value by which you want to evaluate the formatting visibility. For example, 1000000.



 |

## Declarative Metadata Sample Definition

The following is an example of an UiFormatSpecificationSet component.

<?xml version="1.0" encoding="UTF-8"?>
<UiFormatSpecificationSet xmlns="http://soap.sforce.com/2006/04/metadata">
    <field\>Contact.Customer\_Sentiment\_\_c</field\>
    <formatType\>ICON</formatType\>
    <masterLabel\>Sentiment Score</masterLabel\>
    <sobjectType\>Contact</sobjectType\>
    <uiFormatSpecifications\>
        <formatProperties\>{&quot;icon&quot;:&quot;happy\_face&quot;,
&quot;iconColor&quot;:&quot;green&quot;}</formatProperties\>
        <formatType\>ICON</formatType\>
        <order\>1</order\>
        <visibilityRule\>
            <criteria\>
                <leftValue\>{!Record.Customer\_Sentiment\_\_c}</leftValue\>
                <operator\>EQUAL</operator\>
                <rightValue\>Happy</rightValue\>
            </criteria\>
        </visibilityRule\>
    </uiFormatSpecifications\>
    <uiFormatSpecifications\>
        <formatProperties\>{&quot;icon&quot;:&quot;neutral\_face&quot;,
&quot;iconColor&quot;:&quot;gray&quot;}</formatProperties\>
        <formatType\>ICON</formatType\>
        <order\>2</order\>
        <visibilityRule\>
            <criteria\>
                <leftValue\>{!Record.Customer\_Sentiment\_\_c}</leftValue\>
                <operator\>EQUAL</operator\>
                <rightValue\>Neutral</rightValue\>
            </criteria\>
        </visibilityRule\>
    </uiFormatSpecifications\>
    <uiFormatSpecifications\>
        <formatProperties\>{&quot;icon&quot;:&quot;sad\_face&quot;,
&quot;iconColor&quot;:&quot;red&quot;}</formatProperties\>
        <formatType\>ICON</formatType\>
        <order\>3</order\>
        <visibilityRule\>
            <criteria\>
                <leftValue\>{!Record.Customer\_Sentiment\_\_c}</leftValue\>
                <operator\>EQUAL</operator\>
                <rightValue\>Unhappy</rightValue\>
            </criteria\>
        </visibilityRule\>
    </uiFormatSpecifications\>
</UiFormatSpecificationSet\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Sentiment\_Score</members\>
        <name\>UiFormatSpecificationSet</name\>
    </types\>
    <version\>62.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=61b2c285e6bc760afe85dfa6fcd3cc46f7692b6e890fe9fea2379ca6319c3e12 url=/legacydeveloper/current/en-us/api_meta/meta_uiobjectrelationconfig.md -->

# UIObjectRelationConfig

Represents the admin-created configuration of the object relation UI component.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

UIObjectRelationConfig components have the suffix .uiObjectRelationConfig and are stored in the uiObjectRelationConfigs folder.

## Version

UIObjectRelationConfig components are available in API version 54.0 and later.

## Special Access Rules

You must be a Health Cloud or Life Sciences Cloud customer to use this metadata type

## Fields

| Field Name | Description |
| --- | --- |
| contextObject | 
Field Type

string

Description

Required.

The object that provides the context for this object relation configuration.



 |
| contextObjectRecordType | 

Field Type

string

Description

The record type of the context object for this configuration, if applicable.



 |
| directRelationshipField | 

Field Type

string

Description

For direct relationships, the child relationship field on the related object that matches the context object.



 |
| indirectObjectContextField | 

Field Type

string

Description

For indirect relationships, the field on the junction object that matches the context object.



 |
| indirectObjectRelatedField | 

Field Type

string

Description

For indirect relationships, the field on the junction object that matches the related object.



 |
| indirectRelationshipObject | 

Field Type

string

Description

For indirect relationships, the junction object representing the relationship between the related object and its context object.



 |
| isActive | 

Field Type

boolean

Description

Indicates whether the configuration is active (true) or not (false).



 |
| masterLabel | 

Field Type

string

Description

Required.

Label for the UIObjectRelationConfig. In the UI, this field is UI Object Relation Config.



 |
| relatedObject | 

Field Type

string

Description

Required.

The object containing the data that this object relation configuration displays.



 |
| relatedObjectRecordType | 

Field Type

string

Description

The record type of the related object for this configuration.



 |
| relationshipType | 

Field Type

ObjectRelationshipType (enumeration of type string)

Description

Required.

A string indicating the type of relationship between the related object and context object.

Valid values are:

- Direct
- Indirect
- InverseDirect
- Self





 |
| UIObjectRelationFieldConfigs | 

Field Type

[UIObjectRelationFieldConfig\[\]](#UIObjectRelationFieldConfig)

Description

Provides a configuration for an object relation field on a specific row of content.



 |

## UIObjectRelationFieldConfig

Represents a configuration for a single row of content on a specific object relation configuration.

| Field Name | Description |
| --- | --- |
| displayLabel | 
Field Type

string

Description

Required.

A string containing the user-defined label for this field, to be displayed on each object relation of this type.





 |
| queryText | 

Field Type

string

Description

Required.

A case-insensitive template query for generating the content in this field.



 |
| rowOrder | 

Field Type

int

Description

Required.

Determines the top-to-bottom display order of this field on the object relation UI.



 |

## Declarative Metadata Sample Definition

This is an example of a UIObjectRelationConfig component.

 <?xml version="1.0" encoding="UTF-8"?>
 <UIObjectRelationConfig xmlns="http://soap.sforce.com/2006/04/metadata">
     <UIObjectRelationFieldConfigs\>
         <displayLabel\>Address:</displayLabel\>
         <queryText\>{
     "startNode": {
         "initialObject": "RelatedObject"
     },
     "traversalNodes": \[\],
     "fieldNode": {
         "fieldEnumOrId": "ShippingAddress"
     }
 }</queryText\>
         <rowOrder\>1</rowOrder\>
     </UIObjectRelationFieldConfigs\>
     <UIObjectRelationFieldConfigs\>
         <displayLabel\>Phone:</displayLabel\>
         <queryText\>{
     "startNode": {
         "initialObject": "RelatedObject"
     },
     "traversalNodes": \[\],
     "fieldNode": {
         "fieldEnumOrId": "Phone"
     }
 }</queryText\>
         <rowOrder\>2</rowOrder\>
     </UIObjectRelationFieldConfigs\>
     <UIObjectRelationFieldConfigs\>
         <displayLabel\>Fax:</displayLabel\>
         <queryText\>{
     "startNode": {
         "initialObject": "RelatedObject"
     },
     "traversalNodes": \[\],
     "fieldNode": {
         "fieldEnumOrId": "Fax"
     }
 }</queryText\>
         <rowOrder\>3</rowOrder\>
     </UIObjectRelationFieldConfigs\>
     <UIObjectRelationFieldConfigs\>
         <displayLabel\>Parent Organization:</displayLabel\>
         <queryText\>{
     "startNode": {
         "initialObject": "RelatedObject"
     },
     "traversalNodes": \[
         {
             "destinationObjectEnumOrId": "Account",
             "fieldEnumOrId": "ParentId",
             "traversalDirection": "parent"
         }
     \],
     "fieldNode": {
         "fieldEnumOrId": "Name"
     }
 }</queryText\>
         <rowOrder\>4</rowOrder\>
     </UIObjectRelationFieldConfigs\>
     <contextObject\>Contact</contextObject\>
     <directRelationshipField\>AccountId</directRelationshipField\>
     <isActive\>true</isActive\>
     <masterLabel\>Sample Primary Account Configuration</masterLabel\>
     <relatedObject\>Account</relatedObject\>
     <relationshipType\>Direct</relationshipType\>
     <indirectObjectRelatedField\></indirectObjectRelatedField\>
     <indirectObjectContextField\></indirectObjectContextField\>
     <contextObjectRecordType\></contextObjectRecordType\>
     <indirectRelationshipObject\></indirectRelationshipObject\>
     <relatedObjectRecordType\></relatedObjectRecordType\>
 </UIObjectRelationConfig\>

This is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types\>
      <members\>\*</members\>
      <name\>UIObjectRelationConfig</name\>
  </types\>
    <version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").

<!-- document id=a783c4ef39d7217e0666024543cb4512a3bd21510a18f42c66c49d5ae27a4370 url=/legacydeveloper/current/en-us/api_meta/meta_uipreviewmessagetabdef.md -->

# UiPreviewMessageTabDef

Represents the registration of a custom Marketing Cloud Preview and Test modal tab, created using custom Lightning web components. You can register and show multiple tabs in the Preview and Test experience.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

UiPreviewMessageTabDef components have the suffix .uiPreviewMessageTabDef and are stored in the uiPreviewMessageTabDef folder.

## Version

UiPreviewMessageTabDef components are available in API version 63.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| isActive | 
Field Type

boolean

Description

Required.

Indicates whether the tab is enabled and is customer controlled (true) or not (false).



 |
| isProtected | 

Field Type

boolean

Description

Indicates whether the configuration is protected (true) or not (false).



 |
| label | 

Field Type

string

Description

Required.

Label for the tab.



 |
| lightningComponentDef | 

Field Type

string

Description

Required.

The customer-created Lightning web component that displays in the Preview and Test tabs.



 |
| supportedChannel | 

Field Type

SupportedChannel (enumeration of type string)

Description

Required.

A string indicating the type of channel.

Values are:

- Email
- Sms
- WhatsApp





 |
| tabName | 

Field Type

string

Description

Required.

The case-sensitive, user-defined label displayed as the name of the tab. Maximum length is 255 characters.





 |

## Declarative Metadata Sample Definition

This example is a custom Lightning web component’s HTML file.

<template\>
    <div\>A custom tab</div\>
    <div\>Preview data</div\>
    <div\>{previewData}</div\>
</template\>

Here’s the component’s JavaScript file.

import { LightningElement, api } from "lwc";

export default class CustomTab extends LightningElement {
    @api previewData;
}

Here’s the component’s configuration file.

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion\>63.0</apiVersion\>
    <isExposed\>true</isExposed\>
    <capabilities\>
        <capability\>lightning\_\_dynamicComponent</capability\>
    </capabilities\>
</LightningComponentBundle\>

This example package.xml references the component’s definition.

<?xml version="1.0" encoding="UTF-8"?>

<UiPreviewMessageTabDef xmlns="http://soap.sforce.com/2006/04/metadata">
    <isActive\>true</isActive\>
    <label\>TestUiPreviewMessageTab</label\>
    <lightningComponentDef\>customTab</lightningComponentDef\>
    <supportedChannel\>Email</supportedChannel\>
    <tabName\>My Tab</tabName\>
    <isProtected\>false</isProtected\>
</UiPreviewMessageTabDef\>

<!-- document id=4a102aec1901155ccdbad808378caa16f1a51a50c5d4b2146904cc8031bf676e url=/legacydeveloper/current/en-us/api_meta/meta_uiwidgetbundle.md -->

# UiWidgetBundle (Beta)

Represents a widget. Use widgets to define reusable UI compositions once and deploy them across supported Salesforce applications and third-party platforms. Deploy this bundle to your Salesforce org to make the widget available.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

This feature is a beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/ "HTML (New Window)") or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/ "HTML (New Window)"). Use of this pilot or beta service is at the Customer's sole discretion.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Structure and Directory Location

UiWidgetBundle components are stored in the uiWidgets folder.

Here’s an example of the UiWidgetBundle structure.

+--myMetadataPackage
    +--uiWidgets (1)
        +--WIDGET\_NAME (2)
		+--WIDGET\_NAME.json (3)
		+--WIDGET\_NAME.uiwidget-meta.xml(4)
		+--schema.json (5)

The bundle includes these resources.

- The uiWidgets folder (1) contains a folder for each created widget in the format {widgetName} (2).
- Each widget folder contains a {widgetName}.json file (3) that defines the JSON UI composition structure for the widget, specifying the component layout, nesting, and data bindings.
- Each widget folder also contains a  {widgetName}.uiwidget-meta.xml file (4) that defines the widget type.
- Finally, an optional schema.json file (5) defines the attribute contract—the attributes and their associated Lightning types the widget accepts.

## Version

UiWidgetBundle components are available in API version 67.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

Required. Describes the widget.





 |
| masterLabel | 

Field Type

string

Description

Required. Represents the name of a widget bundle which is defined when the UiWidgetBundle is created.





 |
| widgetType | 

Field Type

string

Description

Required. Represents the widget type. The only allowed value is JSON.





 |

## Declarative Metadata Sample Definition

This package.xml file retrieves all the UiWidgetBundle components in an org.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>UiWidgetBundle</name\>
    </types\>
    <version\>67.0</version\>
</Package\>

In the retrieved .zip file, each widget is nested under a uiWidgets folder.

This example shows the directory structure in the .zip file of a widget named hotelCard:

+--uiWidgets
        +--hotelCard
            +--schema.json
            +--hotelCard.json
            +--hotelCard.uiwidget-meta.xml 

Here are the contents of the files in the hotelCard directory. This sample code shows the contents of the schema.json file.

{
  "title": "Hotel Card Widget",
  "description": "Displays hotel information as a visual card",
  "type": "object",
  "properties": {
    "attributes": {
      "lightning:type": "lightning\_\_objectType",
      "properties": {
        "title": {
          "title": "Hotel Name",
          "description": "Primary heading displayed at the top",
          "lightning:type": "lightning\_\_textType"
        },
        "imageUrl": {
          "title": "Image URL",
          "description": "URL of the hotel image",
          "lightning:type": "lightning\_\_urlType"
        },
        "price": {
          "title": "Price Per Night",
          "description": "Nightly rate displayed as currency",
          "lightning:type": "lightning\_\_numberType"
        },
        "description": {
          "title": "Description",
          "description": "Short description of the hotel",
          "lightning:type": "lightning\_\_textType"
        }
      }
    }
  }
}

Contents of the hotelCard.json file.

{
  "type": "lightning\_\_agentforceWidget",
  "contentBody": {
    "widgetBody": {
      "definition": "tile/widget",
      "children": \[
        {
          "definition": "tile/card",
          "attributes": {
            "padding": "lg",
            "variant": "default",
            "maxWidth": "full"
          },
          "children": \[
            {
              "definition": "tile/image",
              "attributes": {
                "src": "{!$attrs.imageUrl}",
                "alt": "{!$attrs.title}"
              }
            },
            {
              "definition": "tile/text",
              "attributes": {
                "text": "{!$attrs.title}",
                "variant": "h3",
                "weight": "semibold"
              }
            },
            {
              "definition": "tile/text",
              "attributes": {
                "text": "{!$attrs.price}",
                "variant": "body",
                "weight": "medium"
              }
            },
            {
              "definition": "tile/text",
              "attributes": {
                "text": "{!$attrs.description}",
                "variant": "body"
              }
            }
          \]
        }
      \]
    }
  }
}

Contents of the hotelCard.uiwidget-meta.xml file.

<?xml version="1.0" encoding="UTF-8"?>
<UiWidgetBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel>Hotel Card</masterLabel>
    <description>Displays hotel information as a visual card.</description>
    <widgetType>JSON</widgetType>
</UiWidgetBundle>

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

#### See Also

- [Headless Experience Layer Developer Guide (Beta)](https://developer.salesforce.com/docs/platform/hxl/guide/get-started.html "Headless Experience Layer Developer Guide (Beta) - html (New Window)")

<!-- document id=66268cdb0a22a508f0308cadc7b0260622d036a481f692010af35bdac8520dfc url=/legacydeveloper/current/en-us/api_meta/meta_intro.md -->

# Understanding Metadata API

Learn how the Salesforce Metadata API manages org configurations. Easily deploy, retrieve, and move customizations across orgs.

## Salesforce Metadata

Metadata is data that describes other data. To understand how Salesforce defines metadata, contrast business data with Salesforce metadata. Business data includes the records that directly correspond to your company’s business such as an address, account, or product. Salesforce metadata describes the schema, process, presentation, authorization, and general configuration of your Salesforce org.

To contrast Salesforce metadata with business data, first examine how schema metadata describes the properties of business data. For example, the Salesforce standard object [Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_address.htm) has schema metadata and business data. Address fields such as Address Type, City, and Postal Code, are all schema metadata. The corresponding values in each field, such as Mailing address, Chicago, IL, and 60106, are all data. While personally identifiable information (PII) is usually found in business data, metadata can also include PII, such as custom object names, report names, etc.

Metadata in Salesforce also defines how your org functions. For example, process metadata describes what happens when a user presses the Save button. Presentation metadata concerns the layout of your org, and authorization metadata determines user access. Salesforce metadata also describes your org’s general configuration. For example, you can configure Chatter to block emoticons in posts.

Metadata API works with metadata types and components. A metadata type defines the structure of application metadata. A metadata component is an instance of a metadata type. The fields and values of a metadata type are all metadata. For example, the metadata type [CustomTab](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_tab.htm) represents a custom tab that displays content. The CustomTab field hasSidebar indicates if the tab is on the sidebar panel, which is an example of metadata determining presentation. Metadata types like CustomTab build the metadata model that describe how your org is structured, displayed, or functions. Use Metadata API to develop customizations and build tools that manage the metadata model, not the data itself.

## Metadata API Functionality

The main purpose of Metadata API is to move metadata between Salesforce orgs during the development process. Use Metadata API to deploy, retrieve, create, update, or delete customization information, such as custom object definitions and page layouts. Metadata API doesn’t work directly with business data. To create, retrieve, update, or delete records such as accounts or leads, use [SOAP API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/ "HTML (New Window)") or [REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/ "HTML (New Window)").

You can move metadata with one of two ways. The first method is with Metadata API deploy() and retrieve() calls. Admins often use the deploy() and retrieve() calls to move the full metadata model. These calls are best fit for the final stages of development, such as deploying tested customizations to the production org.

The second method is source push and pull commands that move only changes in metadata. These commands use source tracking, which makes them friendlier for developers and better for intermediary stages of development.

#### See Also

- [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.")
- [Declarative (File-Based) Metadata API Calls](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based.htm)
- [source Commands](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source)

<!-- document id=4b1da5b056695055828bd876dee630f8674accf14955e92c9cee2072eeea0137 url=/legacydeveloper/current/en-us/api_meta/meta_unsupported_types.md -->

# Unsupported Metadata Types

Some Salesforce features have metadata types that aren’t available in Metadata API. These metadata types can’t be retrieved or deployed with Metadata API. To make changes to these types, you must do it manually in each of your organizations.

Some metadata types may also be unsupported in source tracking, packaging, and change sets.

For a complete list of metadata types and where they’re supported, see [Metadata Coverage](https://developer.salesforce.com/docs/metadata-coverage).

#### See Also

- [_Salesforce Developers_: Metadata Coverage](https://developer.salesforce.com/docs/metadata-coverage "Salesforce Developers: Metadata Coverage - HTML (New Window)")
- [_Salesforce DX Developer Guide_: Track Changes Between Your Project and Org](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_source_tracking.htm "Salesforce DX Developer Guide: Track Changes
    Between Your Project and Org - HTML (New Window)")
- [_Second-Generation Managed Packaging Developer Guide_: Second-Generation Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev_dev2gp.htm "Second-Generation Managed Packaging Developer
    Guide: Second-Generation Managed Packages - HTML (New Window)")
- [_Sandboxes: Staging Environments for Customizing and Testing_: Change Sets](https://help.salesforce.com/s/articleView?id=platform.changesets.htm&type=5&language=en_US "Sandboxes: Staging Environments for Customizing and
    Testing: Change Sets - HTML (New Window)")

<!-- document id=789b81a03da49aa01b7ce83e5684339e37925935decee018b60d430a85a40e1b url=/legacydeveloper/current/en-us/api_meta/meta_update.md -->

# update()

Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead.

This call can be used to update any of the objects that extend [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm). For more details, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

## Syntax

 [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")\[\] = metadataConnection.update([UpdateMetadata](#meta_update_updatemetadata)\[\] metadata);

## Usage

Use this call to update one or more components. This call is analogous to the ALTER TABLE statement in SQL.

## Version

This call is available in API version 30.0 and earlier only. This call isn’t available in API version 31.0 and later. Use [updateMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_updateMetadata.htm "Updates one or more metadata components in your organization synchronously.") instead to update metadata components or [renameMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_renameMetadata.htm "Renames a metadata component in your organization synchronously.") to rename a metadata component.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Required Fields

You must supply values for all the required fields in the component.

## Valid Field Values

You must supply values that are valid for the field’s data type, such as integers for integer fields (not alphabetic characters). In your client application, follow the data formatting rules specified for your programming language and development tool. (Your development tool handles the appropriate mapping of data types in SOAP messages).

## String Values

When storing values in string fields, the API trims any leading and trailing white space. For example, if the value of a label field is entered as "MyObject ", the value is stored in the database as "MyObject".

## Basic Steps for Updating Metadata Components

Use this process to update metadata components:

1. Create an array of UpdateMetadata components, and populate it with the components you want to update. All components must be of the same type.
2. Invoke the update() call, passing in the array of metadata components to update.
3. An [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") object is returned for each component you try to update, and is updated with status information as the operation moves from a queue to completed or error state. In a loop, call [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") until the status values in [AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.") indicate that all the update operations are completed. Start with a wait time of 1 second between iterations of [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.") calls, and double the wait time each time you make a subsequent call.

## Sample Code—Java

public void updateCustomObject() {
  try {
    CustomObject co = new CustomObject();
    String name = "MyCustomObject";
    co.setFullName(name + "\_\_c");
    co.setDeploymentStatus(DeploymentStatus.Deployed);
    co.setDescription("Created by the Metadata API");
    co.setEnableActivities(true);
    co.setLabel(name + " Object");
    co.setPluralLabel(co.getLabel() + "s");
    co.setSharingModel(SharingModel.ReadWrite);
    
    CustomField nf = new CustomField();
    nf.setType(FieldType.Text);
    nf.setLabel(co.getFullName() + " Name");
    
    co.setNameField(nf);
    
    UpdateMetadata updateMetadata = new UpdateMetadata();
    updateMetadata.setMetadata(co);
    updateMetadata.setCurrentName("TheCurrentName");
    
    AsyncResult\[\] ars = metadataConnection.update(new UpdateMetadata\[\] 
        { updateMetadata });
    AsyncResult asyncResult = ars\[0\];
    // set initial wait time to one second in milliseconds
    long waitTimeMilliSecs = 1000;
    while (!asyncResult.isDone()) {
      Thread.sleep(waitTimeMilliSecs);
      // double the wait time for the next iteration
      waitTimeMilliSecs \*= 2;
      asyncResult = metadataConnection.checkStatus(
        new String\[\] {asyncResult.getId()})\[0\];
      System.out.println("Status is: " + asyncResult.getState());
    }
    
    if (asyncResult.getState() != AsyncRequestState.Completed) {
      System.out.println(asyncResult.getStatusCode() + " msg: " +
          asyncResult.getMessage());
    }
  } catch (InterruptedException ie) {
    ie.printStackTrace();
  } catch (ConnectionException ce) {
    ce.printStackTrace();
  }
}

#### See Also

- [updateMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_updateMetadata.htm "Updates one or more metadata components in your organization synchronously.")
- [create()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm "Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.")
- [delete()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_delete.htm "Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead.")
- [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.")

## Arguments

### metadata

- **Type**: [UpdateMetadata](#meta_update_updatemetadata)\[\]
- **Description**: Array of one or more [UpdateMetadata](#meta_update_updatemetadata) data structures that represent the components you wish to update. Limit: 10.
    
    You must submit arrays of only one type of component. For example, you could submit an array of 10 custom objects or 10 profiles, but not a mix of both types.

## UpdateMetadata

One or more UpdateMetadata objects are defined in the metadata [argument. This object can be used to update any of the objects that extend](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) . For more details, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type."). Each UpdateMetadata object has the following fields:

### currentName

- **Field Type**: string
- **Description**: The API name of the component or field before the update. For example, if you wanted to update a [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.") named Foo, the value of this field would be Foo\_\_c. This value is supplied because this call can change the name, and the value here provides mapping.

### metadata

- **Field Type**: [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)
- **Description**: Full specification of the component or field you want to update.

## Response

[AsyncResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_asyncresult.htm "Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.")\[\]

<!-- document id=54470ef45178a8332f9755b214954f76890882ae46d488d4b60831b02ad903ee url=/legacydeveloper/current/en-us/api_meta/meta_updateMetadata.md -->

# updateMetadata()

Updates one or more metadata components in your organization synchronously.

## Syntax

[SaveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_saveResult.htm#meta_saveResult "Contains result information for the createMetadata, updateMetadata, or renameMetadata call.")\[\] = metadataConnection.updateMetadata([Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\] metadata);

## Usage

Use the updateMetadata() call to update any component that extends [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm). All components must be of the same type in the same call. For more details, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

This call executes synchronously, which means that the call returns only when the operation completes.

Starting in API version 34.0, this call supports the [AllOrNoneHeader](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_allornoneheader.htm "Indicates whether to roll back all metadata changes when some of the records in a call result in failures.") header. By default, if AllOrNoneHeader isn’t used in API version 34.0 and later, this call can save a partial set of records for records with no errors (equivalent to AllOrNoneHeader=false). In API version 33.0 and earlier, the default behavior is to only save all records when there are no failures in any record in the call (equivalent to AllOrNoneHeader=true).

## Version

Available in API version 30.0 and later.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Required Fields

You must supply values for all the required fields in the component.

## Valid Field Values

You must supply values that are valid for the field’s data type, such as integers for integer fields (not alphabetic characters). In your client application, follow the data formatting rules specified for your programming language and development tool. (Your development tool handles the appropriate mapping of data types in SOAP messages.)

## String Values

When storing values in string fields, the API trims any leading and trailing white space. For example, if the value of a label field is entered as "MyObject ", the value is stored in the database as "MyObject".

## Basic Steps for Updating Metadata Components

Use this process to update metadata components.

1. Create an array of the components you want to update. All components must be of the same type.
2. Invoke the updateMetadata() call, passing in the array of metadata components to update.
    
    A SaveResult object is returned for each component you try to update. It contains information about whether the operation was successful, the name of the component updated, and any errors returned if the operation wasn’t successful.

## Sample Code—Java

public void updateCustomObjectSync() {
    try {
        CustomObject co = new CustomObject();
        String name = "MyCustomObject1";
        co.setFullName(name + "\_\_c");
        co.setDeploymentStatus(DeploymentStatus.Deployed);
        co.setDescription("Updated description");
        co.setLabel(name + " Object Update");
        co.setPluralLabel(co.getLabel() + "s");
        co.setSharingModel(SharingModel.ReadWrite);

        // Name field with a type and label is required
        CustomField cf = new CustomField();
        cf.setType(FieldType.Text);
        cf.setLabel(co.getFullName() + " Name");
        co.setNameField(cf);

        SaveResult\[\] results = metadataConnection
                .updateMetadata(new Metadata\[\] { co });

        for (SaveResult r : results) {
            if (r.isSuccess()) {
                System.out.println("Updated component: " + r.getFullName());
            } else {
                System.out
                        .println("Errors were encountered while updating "
                                + r.getFullName());
                for (Error e : r.getErrors()) {
                    System.out.println("Error message: " + e.getMessage());
                    System.out.println("Status code: " + e.getStatusCode());
                }
            }
        }
    } catch (ConnectionException ce) {
        ce.printStackTrace();
    }
}

## Arguments

### metadata

- **Type**: [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\]
- **Description**: Array of one or more metadata components you wish to update.
    
    Limit: 10. (For [CustomMetadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_custommetadata.htm) and [CustomApplication](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_customapplication.htm) only, the limit is 200.)
    
    You must submit arrays of only one type of component. For example, you can submit an array of 10 custom objects or 10 profiles, but not a mix of both types.

## Response

[SaveResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_saveResult.htm#meta_saveResult "Contains result information for the createMetadata, updateMetadata, or renameMetadata call.")\[\]

<!-- document id=8bd3b64e751125f542f4493fe67338deeff93d7a42b9e3e8bb2459e2520067de url=/legacydeveloper/current/en-us/api_meta/meta_upsertMetadata.md -->

# upsertMetadata()

Creates or updates one or more metadata components in your organization synchronously.

## Syntax

[UpsertResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_upsertResult.htm#meta_upsertResult "Contains information about the result of the associated upsertMetadata() call.")\[\] = metadataConnection.upsertMetadata([Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\] metadata);

## Usage

Use the upsertMetadata() call to create or update any component that extends [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm). All components must be of the same type in the same call. For more details, see [Metadata Components and Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm "Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.").

If the specified components currently exist in your organization, the upsertMetadata() call updates them. Otherwise, upsertMetadata() creates these components. The fullname field matches the components. This call executes synchronously, which means that the call returns only after the operation is completed.

Starting in API version 34.0, this call supports the [AllOrNoneHeader](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_allornoneheader.htm "Indicates whether to roll back all metadata changes when some of the records in a call result in failures.") header. By default, if AllOrNoneHeader isn’t used in API version 34.0 and later, this call can save a partial set of records for records with no errors (equivalent to AllOrNoneHeader=false). In API version 33.0 and earlier, the default behavior is to only save all records when there are no failures in any record in the call (equivalent to AllOrNoneHeader=true).

## Version

Available in API version 31.0 and later.

## Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If a user requires access to metadata but not to data, enable the [Modify Metadata Through Metadata API Functions](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadata_perm.htm "To use Metadata API, a user must have these things.") permission. Otherwise, enable the Modify All Data permission.

## Required Fields

You must supply values for all the required fields in the component.

## Valid Field Values

You must supply values that are valid for the field’s data type, such as integers (not alphabetic characters) for integer fields. In your client application, follow the data formatting rules that are specified for your programming language and development tool. (Your development tool handles the appropriate mapping of data types in SOAP messages.)

## String Values

The API trims any leading and trailing white space when storing values in string fields. For example, if the value of a label field is entered as " MyObject ", the value is stored in the database as "MyObject".

## Basic Steps for Upserting Metadata Components

Use this process to upsert metadata components.

1. Create an array of [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) objects that correspond to the components that you want to create or update. All components must be of the same type.
2. Invoke upsertMetadata(), passing in the array of metadata components that you created in the previous step.
    
    The upsertMetadata() call returns an array of UpsertResult objects. Each returned UpsertResult corresponds to a component that you upserted and contains information about the upsert operation—whether the operation was successful, the name of the component that was upserted, a flag indicating whether the component was created, and any errors that were returned if the operation wasn’t successful.

## Sample Code—Java

public void upsertMetadataSample() {
    try {
        // Create custom object to upsert
        CustomObject co = new CustomObject();
        String name = "MyCustomObject";
        co.setFullName(name + "\_\_c");
        co.setDeploymentStatus(DeploymentStatus.Deployed);
        co.setDescription("Upserted by the Metadata API");
        co.setEnableActivities(true);
        co.setLabel(name + " Object");
        co.setPluralLabel(co.getLabel() + "s");
        co.setSharingModel(SharingModel.ReadWrite);

        CustomField nf = new CustomField();
        nf.setType(FieldType.Text);
        nf.setLabel("CustomField1");
        co.setNameField(nf);
        
        // Upsert the custom object
        UpsertResult\[\] results = metadataConnection
                .upsertMetadata(new Metadata\[\] { co });

        for (UpsertResult r : results) {
            if (r.isSuccess()) {
                System.out.println("Success!");
                if (r.isCreated()) {
                    System.out.println("Created component: "
                            + r.getFullName());
                } else {
                    System.out.println("Updated component: "
                            + r.getFullName());
                }
            } else {
                System.out
                .println("Errors were encountered while upserting "
                        + r.getFullName());
                for (Error e : r.getErrors()) {
                    System.out.println("Error message: " + e.getMessage());
                    System.out.println("Status code: " + e.getStatusCode());
                }
            }
        }
    } catch (ConnectionException ce) {
        ce.printStackTrace();
    }
}

## Arguments

### metadata

- **Type**: [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm)\[\]
- **Description**: An array of one or more metadata components that you want to create or update.
    
    Limit: 10.
    
    You must submit arrays of only one type of component. For example, you can submit an array of 10 custom objects or 10 profiles, but not a mix of both types.

## Response

[UpsertResult](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_upsertResult.htm#meta_upsertResult "Contains information about the result of the associated upsertMetadata() call.")\[\]

<!-- document id=cee9ff5fcf63d941f3b8cb4004ae36b199a956a54ba47fdd99d47e0da5225c07 url=/legacydeveloper/current/en-us/api_meta/meta_upsertResult.md -->

# UpsertResult

Contains information about the result of the associated upsertMetadata() call.

## Version

Available in API version 31.0 and later.

## created

- **Type**: boolean
- **Description**: Indicates whether the upsert operation resulted in the creation of the component (true) or not (false). If false and the upsert operation was successful, the component was updated.

## errors

- **Type**: [Error](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_error.htm "Represents an error that occurred during a synchronous CRUD (createMetadata(), updateMetadata(), or deleteMetadata()) operation.")\[\]
- **Description**: An array of errors that were returned if the operation wasn't successful.

## fullName

- **Type**: string
- **Description**: The full name of the component that was created or updated if the operation was successful.

## success

- **Type**: boolean
- **Description**: Indicates whether the operation was successful (true) or not (false).

<!-- document id=96ef771b72b244c5eae0446d04780ec726040bfa06a46422c6c0acd28b1d98d0 url=/legacydeveloper/current/en-us/api_meta/meta_use_cases.md -->

# Use Cases for Metadata API

Use Metadata API to move metadata between orgs during the development cycle. Metadata API is also used for deploying large metadata configuration changes from development.

To understand how to use Metadata API, let’s imagine you’re a Salesforce developer at Zephyrus Relocation Services. Zephyrus is a talent-mobility firm that helps companies develop processes for domestic and international employee relocation. Zephyrus is expanding into Asia and South America and wants to add orientation services for both regions. Orientation services include in-country assistance in housing and school searches, area tours, and transportation information.

Your development team must add these new orientation services to their existing org. Products such as in-country orientations are objects that can be customized in Salesforce. When you add objects and customize your org, you change its metadata. The development process of creating a custom product is where Metadata API can help.

## Use Metadata API in the Development Process

Currently, Zephyrus has production metadata and orientation services tailored to other countries. To begin building the new product customizations, you need the existing configurations from Zephyrus’ production Salesforce org in a separate repository. The configuration of the production org is all metadata. To save production metadata in a repository, move the metadata from the Zephyrus production org to your local file system.

[Move Metadata from Production to Your Local File System](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_use_cases_prod_to_local.htm "To make development changes without affecting your existing configurations, use Metadata API to move metadata to your local file system. Next, push metadata from your local file system to a shareable repository for development.")

To make development changes without affecting your existing configurations, use Metadata API to move metadata to your local file system. Next, push metadata from your local file system to a shareable repository for development.

With all the Zephyrus metadata retrieved, you can develop locally or in a scratch org. Scratch orgs are disposable Salesforce environments with no data. Many developers use both tools together. Loading files and making changes are much faster locally than doing so in a scratch org. Developers often build customizations on their local file system and run tests in a scratch org. Move changes between your local file system and scratch org as you test and develop.

[Move Metadata Changes to and from a Scratch Org](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_use_cases_to_from_scratch_org.htm "Use a scratch org to develop and test changes to metadata. You can perform your development within or outside the scratch org using Salesforce CLI or Salesforce Extensions for VS Code, which leverage the power of Metadata API.")

You can use a scratch org along with your local file system to develop and test changes to metadata. To move the changes you make locally to and from the scratch org, use Metadata API.

The rest of the Zephyrus development team has their own customizations. After developing and testing on your own, it’s time for the team to integrate changes and run tests in sandboxes. Sandboxes are development environments used for developing and testing integrations.

[Move Metadata to a Sandbox at Integration Points](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_use_cases_move_to_sandbox.htm "During development, use Metadata API to move metadata to sandboxes for integrating changes, testing, and collaborating with your team.")

During development, use Metadata API to move metadata to sandboxes for integrating changes, testing, and collaborating with your team.

After your team builds the orientation service customization and completes testing, deploy these components to production with Metadata API.

[Deploy Metadata to Production](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_use_cases_deploy_prod.htm "In the final step of the development cycle, move customizations from a source control system such as Git into production with Metadata API.")

In the final step of the development cycle, move customizations from a source control system such as Git into production with Metadata API.

## Other Use Cases

You can use Metadata API for larger changes in Salesforce, such as splitting and merging production orgs.

For example, Zephyrus wants to split the company into two divisions, one that specializes in domestic relocation and another for international relocation. In this case, you split Zephyrus’ Salesforce org and decide which metadata belongs in which org. Metadata API can move metadata to the new org.

Then, let’s say Zephyrus acquires Apollo Global Relocation and both companies use Salesforce. To consolidate information, you use Metadata API to merge the Apollo org into the Zephyrus org.

[Move Metadata for Production-Level Changes](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_use_cases_prod_level_changes.htm "Use Metadata API to move metadata during large changes, such as merging or splitting Salesforce orgs.")

Use Metadata API to move metadata during large changes, such as merging or splitting Salesforce orgs.

You can use Metadata API to make configuration changes during the development process that are too large for alternative API calls. For example, Zephyrus supports many languages for their global clients. To translate different languages for your objects, you include an object translation file for each language.

[Make Large Metadata Configuration Changes](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_use_cases_large_config_changes.htm "Metadata API is better suited than other APIs for deploying large changes to your Salesforce org.")

Metadata is better suited than other APIs for deploying large changes to your org.

<!-- document id=1bbbe929f8554b37d3f94d1841d7c4cfc0da9942a54a8806496f4a3ef04a9eef url=/legacydeveloper/current/en-us/api_meta/meta_useraccesspolicy.md -->

# UserAccessPolicy

Represents a user access policy.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

UserAccessPolicy components have the suffix .useraccesspolicy and are stored in the useraccesspolicies folder.

## Version

UserAccessPolicy components are available in API version 57.0 and later.

## Special Access Rules

To create or modify user access policies, users must have the Manage User Access Policies permission.

## Fields

| Field Name | Description |
| --- | --- |
| booleanFilter | 
Field Type

string

Description

Required. The logic that determines how your user criteria filters are applied in the user access policy. For example, if you have two user access policy filters with the sortOrder equal to 1 and 2, respectively, the booleanFilter can be 1 AND 2 or 1 OR 2.



 |
| description | 

Field Type

string

Description

Description of the user access policy.



 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is false.



 |
| masterLabel | 

Field Type

string

Description

Required. A user-friendly name for the user access policy, which is defined when the user access policy is created.





 |
| order | 

Field Type

int

Description

Indicates the order for which active policy is applied when a user meets the criteria for multiple policies. Must be an integer from 0 to 10,000. Only the active policy with the lowest order value is applied. This field is required only if the status field is set to Active.

Available in API version 61.0 and later.



 |
| status | 

Field Type

UserAccessPolicyStatus (enumeration of type string)

Description

Required. The status of the user access policy.

Values are:

- Active
- Completed
- Design
- Failed
- Migrate
- Testing
- Updating

If you deploy a policy with a status of Active, the status is changed to Design. A Salesforce admin can then set the status to Active by automating the policy in Setup.





 |
| triggerType | 

Field Type

UserAccessPolicyTriggerType (enumeration of type string)

Description

The type of user record trigger for which this user access policy runs.

Values are:

- Create—The user access policy runs when a user who matches the policy criteria is created.
- CreateAndUpdate—The user access policy runs when a user who matches the policy criteria is either created or updated.
- Update—The user access policy runs when a user who matches the policy criteria is updated.





 |
| userAccessPolicyActions | 

Field Type

[UserAccessPolicyAction\[\]](#UserAccessPolicyAction)

Description

The actions applied by the user access policy to grant access to or revoke access from an access mechanism.



 |
| userAccessPolicyFilters | 

Field Type

[UserAccessPolicyFilter\[\]](#UserAccessPolicyFilter)

Description

The filters used to define the users that the user access policy is applied to.



 |

## UserAccessPolicyAction

Represents an action applied by a user access policy.

| Field Name | Description |
| --- | --- |
| action | 
Field Type

UserAccessPolicyActionType (enumeration of type string)

Description

Required. Indicates whether the user access policy grants or revokes the target access mechanism.

Values are:

- Grant
- Revoke





 |
| target | 

Field Type

string

Description

Required. Developer name of the access mechanism that the user access policy applies.





 |
| type | 

Field Type

UserAccessPolicyActionTargetType (enumeration of type string)

Description

Required. The type of access mechanism that the user access policy applies.

Values are:

- Group
- PackageLicense
- PermissionSet
- PermissionSetGroup
- PermissionSetLicense
- Queue





 |

## UserAccessPolicyFilter

Represents a user criteria filter for a user access policy.

| Field Name | Description |
| --- | --- |
| columnName | 
Field Type

string

Description

If type is set to User, this is the user field that your user criteria filter is based on. If you set type to any value other than User, then this field isn’t used.



 |
| operation | 

Field Type

UserAccessPolicyFilterOperation (enumeration of type string)

Description

Required. The operator of the user criteria filter.

Values are:

- equals
- equalsIgnoreCase—Available in API version 59.0 and later.
- in— Available in API version 58.0 and later.
- includes—Available in API version 59.0 and later.
- notEquals

Select in if you want to reference multiple profiles or roles in the same user criteria filter via the target field.



 |
| sortOrder | 

Field Type

int

Description

Required. The numeric reference used to identify the specific user criteria filter.





 |
| target | 

Field Type

string

Description

Required. If type is set to User, then set this field to User as well. If type is set to any other value, then set this field to the developer name of the specific resource used in the user criteria filter.





 |
| type | 

Field Type

UserAccessPolicyFilterTargetType (enumeration of type string)

Description

Required. The type of resource that the user criteria filter is based on.

Values are:

- Group
- PackageLicense
- PermissionSet
- PermissionSetGroup
- PermissionSetLicense
- Profile
- Queue
- User
- UserRole





 |
| value | 

Field Type

string

Description

If type is set to User, this field is the value of the user field specified in columnName that your user filter is operating on. If you set type to any value other than User, then this field isn’t used.



 |

## Declarative Metadata Sample Definition

The following is an example of a UserAccessPolicy component.

<?xml version="1.0" encoding="UTF-8"?>
<UserAccessPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
    <booleanFilter\>1 AND 2</booleanFilter\>
    <description\>Policy to assign Sales Rep PSG to active Sales Reps.</description\>
    <masterLabel\>Sales Rep Migration</masterLabel\>
    <order\>3</order\>
    <status\>Design</status\>
    <triggerType\>CreateAndUpdate</triggerType\>
    <userAccessPolicyActions\>
        <action\>Grant</action\>
        <target\>SalesRepPSG</target\>
        <type\>PermissionSetGroup</type\>
    </userAccessPolicyActions\>
    <userAccessPolicyFilters\>
        <operation\>equals</operation\>
        <sortOrder\>1</sortOrder\>
        <target\>SalesRepCustomProfile</target\>
        <type\>Profile</type\>
    </userAccessPolicyFilters\>
    <userAccessPolicyFilters\>
        <columnName\>IsActive</columnName\>
        <operation\>equals</operation\>
        <sortOrder\>2</sortOrder\>
        <target\>User</target\>
        <type\>User</type\>
        <value\>true</value\>
    </userAccessPolicyFilters\>
</UserAccessPolicy\>

To reference multiple profiles or roles, in UserAccessPolicyFilter, set the operator field to in. Then, reference the resources’ developer names in the target field, separated by commas.

<?xml version="1.0" encoding="UTF-8"?>
<UserAccessPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
    <booleanFilter\>1</booleanFilter\>
    <description\>Policy to remove AMER Sales group from employees with one of two roles</description\>
    <masterLabel\>Remove AMER Sales Group</masterLabel\>
    <status\>Design</status\>
    <userAccessPolicyActions\>
        <action\>Revoke</action\>
        <target\>AMERSalesPublicGroup</target\>
        <type\>Group</type\>
    </userAccessPolicyActions\>
    <userAccessPolicyFilters\>
        <operation\>in</operation\>
        <sortOrder\>1</sortOrder\>
        <target\>SalesOps,InsideSalesRep</target\>
        <type\>UserRole</type\>
    </userAccessPolicyFilters\>
</UserAccessPolicy\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>UserAccessPolicy</name\>
    </types\>
    <version\>61.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=8683e32b1a12bee33fe565664e58662c857672604d0e064979b5b0c4fa33f216 url=/legacydeveloper/current/en-us/api_meta/meta_userauthcertificate.md -->

# UserAuthCertificate

Represents a PEM-encoded user certificate. These certificates are associated with a user, and externally uploaded. The uploaded certificate is used to authenticate the user.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

UserAuthCertificate components have the suffix .userAuthCertificate and are stored in the userAuthCertificates folder.

## Version

UserAuthCertificate components are available in API version 50.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d939947e101">Field Name</th>

              <th class="featureTableHeader  " id="d939947e104">Field Type</th>

              <th class="featureTableHeader  " id="d939947e107">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d939947e101" data-title="Field Name"><span class="keyword parmname">developerName</span></td>

              <td class="entry" headers="d939947e104" data-title="Field Type">string</td>

              <td class="entry" headers="d939947e107" data-title="Description">Required: The name of the certificate with an underscore between
                words.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Only
                            users with View DeveloperName OR View Setup and Configuration permission can view,
                            group, sort, and filter this field.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d939947e101" data-title="Field Name"><span class="keyword parmname">expirationDate</span></td>

              <td class="entry" headers="d939947e104" data-title="Field Type">dateTime</td>

              <td class="entry" headers="d939947e107" data-title="Description">Required. The date on which the certificate expires.</td>

            </tr>

            <tr>
              <td class="entry" headers="d939947e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d939947e104" data-title="Field Type">string</td>

              <td class="entry" headers="d939947e107" data-title="Description">Required. A user-friendly name that you create for the certificate. Limited to
                64 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d939947e101" data-title="Field Name"><span class="keyword parmname">serialNumber</span></td>

              <td class="entry" headers="d939947e104" data-title="Field Type">string</td>

              <td class="entry" headers="d939947e107" data-title="Description">Required. The serial number for the certificate.</td>

            </tr>

            <tr>
              <td class="entry" headers="d939947e101" data-title="Field Name"><span class="keyword parmname">user</span></td>

              <td class="entry" headers="d939947e104" data-title="Field Type">string</td>

              <td class="entry" headers="d939947e107" data-title="Description">Required: The user’s name.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a UserAuthCertificate component.

<UserAuthCertificate xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <content xsi:nil="true"/>
    <developerName\>ND\_user\_cert</developerName\>
    <expirationDate\>2030-10-01T08:30:00.000Z</expirationDate\>
    <masterLabel\>ND user cert</masterLabel\>
    <serialNumber\>1401</serialNumber\>
    <user\>005RM000001Zn1E</user\>
</UserAuthCertificate\>

The following is an example package.xml that references the previous definition.

Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>UserAuthCertificate</name\>
    </types\>
    <version\>50.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=017f252890e8462650ed1ba26597de0a24153337f5db0fe0823913fde5974c6c url=/legacydeveloper/current/en-us/api_meta/meta_usercriteria.md -->

# UserCriteria

Represents the member criteria to use in Experience Cloud site moderation rules. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field..

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

UserCriteria components have the suffix site\_name.user\_criteria\_developer\_name.userCriteria and are stored in the UserCriteria folder.

## Version

UserCriteria components are available in API version 39.0 and later.

## Special Access Rules

To view, create, edit, and delete moderation rules, you need the Manage Experiences or Create and Set Up Experiences permission. As of Spring ’20 and later, only users with permission to edit moderation rules can access this object.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d940496e110">Field Name</th>

              <th class="featureTableHeader  " id="d940496e113">Field Type</th>

              <th class="featureTableHeader  " id="d940496e116">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d940496e110" data-title="Field Name"><span class="keyword parmname">creationAgeInSeconds</span></td>

              <td class="entry" headers="d940496e113" data-title="Field Type">int</td>

              <td class="entry" headers="d940496e116" data-title="Description">
                <span class="ph" id="creationageinseconds_desc"><a name="creationageinseconds_desc"><!-- --></a> If specified, includes only users that were
                  created within a specific time frame.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d940496e110" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d940496e113" data-title="Field Type">string</td>

              <td class="entry" headers="d940496e116" data-title="Description"><span class="ph" id="description_desc"><a name="description_desc"><!-- --></a>The description of the user criteria.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d940496e110" data-title="Field Name"><span class="keyword parmname">lastChatterActivityAgeInSeconds</span></td>

              <td class="entry" headers="d940496e113" data-title="Field Type">int</td>

              <td class="entry" headers="d940496e116" data-title="Description"><span class="ph" id="lastchatteractivityageinseconds_desc"><a name="lastchatteractivityageinseconds_desc"><!-- --></a>If specified, includes only
                  members that have posted or commented in the Experience Cloud site within a
                  specific time frame.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d940496e110" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d940496e113" data-title="Field Type">string</td>

              <td class="entry" headers="d940496e116" data-title="Description"><span class="ph" id="masterlabel_desc"><a name="masterlabel_desc"><!-- --></a>Name of the user criteria.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d940496e110" data-title="Field Name"><span class="keyword parmname">userTypes</span></td>

              <td class="entry" headers="d940496e113" data-title="Field Type">NetworkUserType enumeration ( of type string)</td>

              <td class="entry" headers="d940496e116" data-title="Description">
                <span class="ph" id="userTypes_desc"><a name="userTypes_desc"><!-- --></a>The member type to use in moderation rules. </span> Valid
                values are:<ul class="ul bulletList">
                  <li class="li">Internal</li>

                  <li class="li">Customer</li>

                  <li class="li">Partner</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a UserCriteria component.

<?xml version="1.0" encoding="UTF-8"?>
<UserCriteria xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel\>Customer and Partner Members</masterLabel\>
    <description\>Member criteria matches customer and partner member</description\>
    <userTypes\>Partner</userTypes\>
    <userTypes\>Customer</userTypes\>
</UserCriteria\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=ff58a00c98a3a5829e3ce3b18bc7395ce0f692bf94912da2dfbb69a0fc83efca url=/legacydeveloper/current/en-us/api_meta/meta_userengagementsettings.md -->

# UserEngagementSettings

Represents the metadata associated with various feature settings around Lightning Experience transition and adoption, user engagement and adoption assistance, and adoption apps.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

UserEngagementSettings components have the suffix .settings and are stored in the settings folder.

## Version

Prompt components are available in API version 47.0 and later.

## Special Access Rules

See related Salesforce Help for each feature for permission and edition requirements.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d941066e117">Field Name</th>

              <th class="featureTableHeader  " id="d941066e120">Field Type</th>

              <th class="featureTableHeader  " id="d941066e123">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">canUseAdoptionApps</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether an org can access Lightning Experience transition tools
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Examples of these tools are Salesforce Optimizer, Lightning
                Experience Transition Assistant, and the Lightning Experience Readiness Report. The
                default is <samp class="codeph nolang">false</samp>. This field applies only to
                orgs with the External Application Settings page in Setup. Otherwise, this field has
                no effect. Available in API version 62.0 and later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">doesScheduledSwitcherRunDaily</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates where users are automatically switched from Salesforce Classic to
                Lightning Experience every day (<samp class="codeph nolang">true</samp>) or weekly
                (<samp class="codeph nolang">false</samp>). If <samp class="codeph nolang">false</samp>, then users are switched weekly. The default is <samp class="codeph nolang">false</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=lex_enable_users_autoswitch.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Encourage Users to Stay in
                  Lightning Experience</a> in Salesforce Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableCustomHelpGlobalSection</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether a custom section has been added to the Lightning Experience
                Help Menu (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lexhelpmenu.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Custom Help for the
                  Lightning Experience Help Menu</a> in Salesforce Help for more
                information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableHelpMenuShowFeedback</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the Give Feedback to Salesforce link in the Lightning
                Experience Help Menu is visible to users (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Even if <samp class="codeph nolang">false</samp>, admins always see all links in the Help Menu. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lexhelpmenu.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Custom Help for the
                  Lightning Experience Help Menu</a> in Salesforce Help for more
                information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableHelpMenuShowHelp</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the Help For This Page section in the Lightning Experience
                Help Menu is visible to users (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Even if <samp class="codeph nolang">false</samp>, admins always see all links in the Help Menu. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lexhelpmenu.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Custom Help for the
                  Lightning Experience Help Menu</a> in Salesforce Help for more information.
                <p class="p">Available in API version 64.0 and earlier.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableHelpMenuShowNewUser</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the Getting Started section in the Lightning Experience Help
                Menu is visible to users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Even if <samp class="codeph nolang">false</samp>, admins always
                see all links in the Help Menu. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lexhelpmenu.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Custom Help for the
                  Lightning Experience Help Menu</a> in Salesforce Help for more
                information.<p class="p">Available in API version 64.0 and earlier.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableHelpMenuShowSearch</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the Search Documentation link in the Lightning Experience
                Help Menu is visible to users (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Even if <samp class="codeph nolang">false</samp>, admins always see all links in the Help Menu. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lexhelpmenu.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Custom Help for the
                  Lightning Experience Help Menu</a> in Salesforce Help for more
                information.<p class="p">Available in API version 64.0 and earlier.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableHelpMenuShowSfdcContent</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether any Salesforce-created help resources in Lightning Experience
                Help Menu are visible to users (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Even if <samp class="codeph nolang">false</samp>, admins always see all links in the Help Menu. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lexhelpmenu.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Custom Help for the
                  Lightning Experience Help Menu</a> in Salesforce Help for more
                information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableHelpMenuShowShortcut</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the View Keyboard Shortcuts link in the Lightning Experience
                Help Menu is visible to users (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Even if <samp class="codeph nolang">false</samp>, admins always see all links in the Help Menu. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lexhelpmenu.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Custom Help for the
                  Lightning Experience Help Menu</a> in Salesforce Help for more
                information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableHelpMenuShowSupport</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the Go to Salesforce Help link in the Lightning Experience
                Help Menu is visible to users (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Even if <samp class="codeph nolang">false</samp>, admins always see all links in the Help Menu. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lexhelpmenu.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Custom Help for the
                  Lightning Experience Help Menu</a> in Salesforce Help for more
                information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableHelpMenuShowTrailhead</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the Go to Trailhead link in the Lightning Experience Help
                Menu is visible to users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Even if <samp class="codeph nolang">false</samp>, admins always
                see all links in the Help Menu. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lexhelpmenu.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Custom Help for the
                  Lightning Experience Help Menu</a> in Salesforce Help for more
                information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableIBILOptOutDashboards</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the It’s Better in Lightning prompt about Dashboards is
                hidden from users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Deprecated in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableIBILOptOutEvents</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the It’s Better in Lightning prompt about Events/Calendar is
                hidden from users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Deprecated in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableIBILOptOutReports</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the It’s Better in Lightning prompt about Reports is hidden
                from users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Deprecated in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableIBILOptOutTasks</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the It’s Better in Lightning prompt about Tasks is hidden
                from users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Deprecated in API version 51.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableLexToClassicFeedbackEnable</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the Switch to Salesforce Classic Feedback Form is shown to
                users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=lex_encourage_work_feedback.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Switch to Salesforce Classic
                  Feedback Form</a> in Salesforce Help for more information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableOrchestrationInSandbox</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether adoption assistance and other in-app guidance is shown to
                users in sandbox orgs (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lex_prompt_add.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Prompts in Lightning
                  Experience in Salesforce Help</a> for more information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableOrgUserAssistEnabled</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether all custom in-app guidance created by an org is shown to
                users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Doesn’t affect active status. The default is
                <samp class="codeph nolang">true</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lex_prompt_add.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Prompts in Lightning
                  Experience in Salesforce Help</a> for more information.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableScheduledSwitcher</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether users are automatically switched from Salesforce Classic to
                Lightning Experience (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=lex_enable_users_autoswitch.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Encourage Users to Stay in
                  Lightning Experience</a> in Salesforce Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableSfdcProductFeedbackSurvey</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the Salesforce Product Feedback Form is shown to users
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. See
                <a class="xref" href="https://help.salesforce.com/articleView?id=lex_encourage_work_sfdc_feedback.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Salesforce Product Feedback
                  Form</a> in Salesforce Help for more information.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">enableShowSalesforceUserAssist</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether all standard in-app guidance created by Salesforce is shown
                to users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Doesn’t affect active status. The default is
                <samp class="codeph nolang">true</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=customhelp_lex_prompt_add.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Define Prompts in Lightning
                  Experience in Salesforce Help</a> for more information.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">isCrucNotificationDisabled</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether all notifications about the Winter ’20 Turn on Lightning
                Experience critical update are hidden from admins (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">isLEXWelcomeMatDisabled</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether the Lightning Experience welcome mat is hidden from users the
                first time they log into the user interface (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                is <samp class="codeph nolang">false</samp>. See <a class="xref" href="https://help.salesforce.com/articleView?id=lex_encourage_work_welcome_mat.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Lightning Experience Welcome
                  Mat</a> in Salesforce Help for more information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">isMeetTheAssistantDisabledInClassic</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether all notifications about the Lightning Experience Transition
                Assistant are hidden from admins in Salesforce Classic (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">isMeetTheAssistantDisabledInLightning</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether all notifications about the Lightning Experience Transition
                Assistant are hidden from admins in Lightning Experience (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">optimizerAppEnabled</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether Salesforce Optimizer is turned on in the org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. See
                <a class="xref" href="https://help.salesforce.com/articleView?id=optimizer_introduction.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Improve Your Implementation
                  with Salesforce Optimizer</a> in Salesforce Help.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d941066e117" data-title="Field Name"><span class="keyword parmname">suggestedForYou</span></td>

              <td class="entry" headers="d941066e120" data-title="Field Type">boolean</td>

              <td class="entry" headers="d941066e123" data-title="Description">Indicates whether Suggested For You is turned on in the org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. See
                <a class="xref" href="https://help.salesforce.com/s/articleView?id=sf.suggested_for_you.htm&amp;language=en_US" target="_blank" title="HTML (New Window)">Suggested For You</a> in
                Salesforce Help.
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a UserEngagementSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<UserEngagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
   <canUseAdoptionApps\>false</canUseAdoptionApps\>
   <doesScheduledSwitcherRunDaily\>true</doesScheduledSwitcherRunDaily\>
   <enableCustomHelpGlobalSection\>true</enableCustomHelpGlobalSection\>
   <enableHelpMenuShowSfdcContent\>true</enableHelpMenuShowSfdcContent\>
   <enableHelpMenuShowShortcut\>true</enableHelpMenuShowShortcut\>
   <enableHelpMenuShowSupport\>true</enableHelpMenuShowSupport\>
   <enableHelpMenuShowTrailhead\>true</enableHelpMenuShowTrailhead\>
   <enableIBILOptOutDashboards\>true</enableIBILOptOutDashboards\>
   <enableIBILOptOutEvents\>true</enableIBILOptOutEvents\>
   <enableIBILOptOutReports\>true</enableIBILOptOutReports\>
   <enableIBILOptOutTasks\>true</enableIBILOptOutTasks\>
   <enableLexToClassicFeedbackEnable\>true</enableLexToClassicFeedbackEnable\>
   <enableOrgUserAssistEnabled\>true</enableOrgUserAssistEnabled\>
   <enableScheduledSwitcher\>true</enableScheduledSwitcher\>
   <enableSfdcProductFeedbackSurvey\>true</enableSfdcProductFeedbackSurvey\>
   <enableOrchestrationInSandbox\>true</enableOrchestrationInSandbox\>
   <enableShowSalesforceUserAssist\>true</enableShowSalesforceUserAssist\>
   <isCrucNotificationDisabled\>false</isCrucNotificationDisabled\>
   <isLEXWelcomeMatDisabled\>false</isLEXWelcomeMatDisabled\>
   <isMeetTheAssistantDisabledInClassic\>false</isMeetTheAssistantDisabledInClassic\>
   <isMeetTheAssistantDisabledInLightning\>false</isMeetTheAssistantDisabledInLightning\>
   <optimizerAppEnabled\>true</optimizerAppEnabled\>
</UserEngagementSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>UserEngagement</members\>
      <name\>Settings</name\>
   </types\>
   <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b7acfcd7adc89f046e20f33da3839b47aa5c471d06bb5ca8f8c6e17227cb33af url=/legacydeveloper/current/en-us/api_meta/meta_userinterfacesettings.md -->

# UserInterfaceSettings

Represents the settings that modify the behavior of the org’s user interface.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

A UserInterfaceSettings component file has the suffix .settings and is stored in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

UserInterfaceSettings components are available in API version 46.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d943687e115">Field Name</th>

              <th class="featureTableHeader  " id="d943687e118">Field Type</th>

              <th class="featureTableHeader  " id="d943687e121">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">dynamicMruActionsOff</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users can create custom actions for their Recently Viewed
                lists (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. Available in API version 52.0 and later. Applies to Lightning
                Experience only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableAsyncRelatedLists</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether related lists are loaded asynchronously (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>.
                Available in API version 47.0 and later. Salesforce Classic only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableClickjackUserPageHeaderless</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether a Visualforce page that hides the standard header has
                clickjack protections (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>. This setting applies to all of your Visualforce pages.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableCollapsibleSections</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users are allowed to collapse or expand sections in record
                details by using the arrow icon next to the section heading. The default is <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableCollapsibleSidebar</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users are allowed to show or hide the sidebar on every page
                that normally includes it (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. Applies to Salesforce Classic only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableCustomObjectTruncate</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users with Customize Application permission can truncate
                custom objects (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When you truncate an object, you delete the
                object’s associated records permanently, while preserving the empty object and its
                metadata. The default is <samp class="codeph nolang">false</samp>. Available in
                API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableCustomeSideBarOnAllPages</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether custom sidebar components are available on all pages for all
                org users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. Applies to Salesforce Classic only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableDeleteFieldHistory</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users can delete field history and field history archive
                records (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. Available in API version 47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableExternalObjectAsyncRelatedLists</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether related lists of external objects are loaded asynchronously (
                <samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>.
                Available in API version 48.0 and later. Salesforce Classic only.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableHoverDetails</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether an interactive overlay containing record details is displayed
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>.<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>To view hover details for a record, users need the
                            appropriate sharing access and field-level security access for the fields in the
                            mini page layout.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableInlineEdit</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users are allowed to edit field values on a record’s detail
                page (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enablePersonalCanvas</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users can install and use personal canvas apps <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. The default is <samp class="codeph nolang">true</samp>. This
                setting applies to all of your Visualforce pages.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableRelatedListHovers</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether related list hover links display at the top of record detail
                pages and custom object detail pages in Setup (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Users can
                hover over a related list link to display the list and its number of records in an
                interactive overlay. Users quickly view and manage the related list items from the
                overlay. Users can also click a related list hover link to jump to the related list
                without having to scroll down the page. The default is <samp class="codeph nolang">true</samp>. Available in API version 50.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableSldsV2DarkModeInCosmos</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether individual users can enable dark mode (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) for the Salesforce Cosmos theme. The default value is <samp class="codeph nolang">false</samp>. Available for SLDS 2 themes in select
                editions. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=xcloud.customize_ui_enhancedlex.htm&amp;type=5&amp;language=en_US" target="_blank">Salesforce Cosmos Theme and SLDS 2
                  Availability</a>. Available in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">enableQuickCreate</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether an area displays on a tab home page (corresponds to the
                <strong class="ph uicontrol">Show Quick Create</strong> setting), allowing users to create a
                record quickly with minimal information (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). The Quick Create area displays
                by default on the tab home pages for leads, accounts, contacts, and opportunities.
                You can control whether the Quick Create area is displayed on all relevant tab home
                pages.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">listViewIleBypassLayout</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users can inline edit any field they have edit access to in
                list views, regardless of page layout restrictions (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default
                is <samp class="codeph nolang">false</samp>. Available in API version 68.0 and
                later. Applies to Lightning Experience only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">listViewIleMultiRecordType</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users can inline edit fields in list views that contain
                records of more than one record type (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">false</samp>. Available in API version 68.0 and later.
                Applies to Lightning Experience only. Inline editing with multiple record types
                applies to list views rendered with Lightning Web Components (LWC).</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">multiColumnSortLv</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users can sort list views by multiple columns (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>.
                Available in API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d943687e115" data-title="Field Name"><span class="keyword parmname">multiColumnSortRL</span></td>

              <td class="entry" headers="d943687e118" data-title="Field Type">boolean</td>

              <td class="entry" headers="d943687e121" data-title="Description">Indicates whether users can sort related lists by multiple columns (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default is <samp class="codeph nolang">true</samp>.
                Available in API version 63.0 and later.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a UserInterfaceSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<UserInterfaceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <enableDeleteFieldHistory\>false</enableDeleteFieldHistory\>
  <enableInlineEdit\>true</enableInlineEdit\>
  <enableHoverDetails\>false</enableHoverDetails\>
  <enableQuickCreate\>true</enableQuickCreate\>
  <enablePersonalCanvas\>false</enablePersonalCanvas\>
  <enableClickjackUserPageHeaderless\>true</enableClickjackUserPageHeaderless\>
</UserInterfaceSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the user interface settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>UserInterface</members\>
		<name\>Settings</name\>
	</types\>
	<version\>46.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=14d594f17e5cb44f8305b39a349c9a07432e4468b36125538f37db383a889355 url=/legacydeveloper/current/en-us/api_meta/meta_usermanagementsettings.md -->

# UserManagementSettings

Represents a selection of user management options that appear on the User Management Settings Setup page. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

UserMangementSettings are stored in the UserManagement.settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

Manage org-wide settings for certain options. User Management Settings are available in API version 46.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d945452e99">Field</th>

              <th class="featureTableHeader  " id="d945452e102">Field Type</th>

              <th class="featureTableHeader  " id="d945452e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableConcealPersonalInfo</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates if personal information fields in user records are
                hidden from external users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When this field is set to <samp class="codeph nolang">true</samp>, 10 personal information
                fields are hidden. The default value is <samp class="codeph nolang">false</samp>. This field is unavailable for orgs created in
                Winter ’22 or later.<p class="p">Salesforce recommends that you use the
                  <span class="keyword parmname">enableEnhancedConcealPersonalInfo</span> field
                  instead of <span class="keyword parmname">enableConcealPersonalInfo</span>.
                  Before you set the
                  <span class="keyword parmname">enableEnhancedConcealPersonalInfo</span> field
                  to <samp class="codeph nolang">true</samp>, make sure that
                  <span class="keyword parmname">enableConcealPersonalInfo</span> is set to
                  <samp class="codeph nolang">false</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableContactlessExternalIdentityUsers</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">If <samp class="codeph nolang">true</samp> and your org has the
                External Identity license, you can create contactless users. Having
                users without contact information reduces the overhead of managing
                customers. Purchase the External Identity license to access the
                Customer 360 Identity product.<p class="p">The default is <samp class="codeph nolang">false</samp>. Available in API version
                  47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableEnhancedConcealPersonalInfo</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates if personal information fields in user records are
                hidden from external users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When this field is set to <samp class="codeph nolang">true</samp>, you can choose which fields
                are classified as personal information and hidden on the User
                Management Settings Setup page. The default value is <samp class="codeph nolang">false</samp>. This field is available in
                API version 53.0 and later.<p class="p">Before you set the
                  <span class="keyword parmname">enableEnhancedConcealPersonalInfo</span> field
                  to <samp class="codeph nolang">true</samp>, make sure that
                  <span class="keyword parmname">enableConcealPersonalInfo</span> is set to
                  <samp class="codeph nolang">false</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableEnhancedPermsetMgmt</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">If you enable <strong class="ph uicontrol">Enhanced Permission Set Component
                  Views</strong> (<samp class="codeph nolang">true</samp>),
                you can work with permission sets more easily. For example, when you
                have large numbers of Apex class assignments for permission sets,
                you can enable a paginated result set, standard filtering, and
                sorting.</td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableEnhancedProfileMgmt</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">If you enable <strong class="ph uicontrol">Enhanced Profile Lists Views</strong>
                (<samp class="codeph nolang">true</samp>), you can quickly
                view, customize, and edit list data.</td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableEnhcUiUserAccessPolicies</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates whether you create and manage user access policies
                through an improved user interface (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. If user access policies
                aren’t enabled, this field has no effect. If user access policies
                are enabled, this field is automatically set to <samp class="codeph nolang">true</samp>, but you can change it to
                <samp class="codeph nolang">false</samp>. Available in API
                version 60.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableNewProfileUI</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">If you enable <strong class="ph uicontrol">Enhanced Profile User
                  Interface</strong> (<samp class="codeph nolang">true</samp>), you can use the streamlined, enhanced profile user
                interface to browse, search, and modify settings. You can use only
                one user interface at a time.</td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableProfileFiltering</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">With profile filtering enabled (<samp class="codeph nolang">true</samp>), you can restrict who sees profile names to the
                users who require the access for their job roles. If profile
                filtering is disabled (<samp class="codeph nolang">false</samp>),
                users can see all profiles in a Salesforce org, regardless of which
                permissions they have. <p class="p">Profile names are also exposed when users
                  with permissions to perform the following tasks take these
                  actions:</p>
                <ul class="ul bulletList">
                  <li class="li">Create a tab or record type with a wizard step that includes
                    the assignment of tabs and record types to profiles.</li>

                  <li class="li">Configure a login flow where viewing profile lists is
                    required to make flow associations.</li>

                  <li class="li">Set up delegated admins where looking up profiles is needed
                    to identify assignable profiles.</li>

                  <li class="li">Administer an org as a delegated customer admin.</li>

                  <li class="li">Administer an org as a delegated admin to view and assign
                    profiles of the delegated group.</li>

                </ul>
                <p class="p">This field is available in API version 50.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableRestrictEmailDomains</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates whether the Email Domain Allowlist is visible (<samp class="codeph nolang">true</samp>) or hidden (<samp class="codeph nolang">false</samp>) in Setup. The default value
                is <samp class="codeph nolang">false</samp>.<p class="p">This field is
                  available in API version 53.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableScrambleUserData</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">If you enable <strong class="ph uicontrol">Let Users Scramble Their User
                  Data</strong> (<samp class="codeph nolang">true</samp>),
                users can request that Salesforce remove all their personal data.
                Because Salesforce can’t delete information, it scrambles their
                data. Scrambling a user’s data is unrecoverable. So this org-wide
                setting serves as an extra precaution. If a user requests it, you
                scramble the data programmatically with the <samp class="codeph nolang">obfuscateUser</samp> Apex method. You can
                use the method, for example, in a custom Apex trigger, workflow, or
                the Developer Console.<p class="p">This field is available in API version 47.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enableUserSelfDeactivate</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">If you enable <strong class="ph uicontrol">User Self Deactivate</strong>
                (<samp class="codeph nolang">true</samp>), users can
                deactivate their Experience Cloud site or Chatter accounts.</td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enhancedPermSetList</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates whether you manage permission sets with an updated user
                interface on the Permissions Setup page (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">false</samp>. Available in API version
                63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enhancedUserListView</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates whether you manage users with an updated user interface
                on the Users Setup page (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). The default
                value is <samp class="codeph nolang">false</samp>. Available in
                API version 62.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">enhancedUserRoleListView</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates whether you manage roles with an updated user interface
                on the Roles Setup page (<samp class="codeph nolang">true</samp>)
                or not (<samp class="codeph nolang">false</samp>). The default
                value is <samp class="codeph nolang">false</samp>. Available in
                API version 63.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">groupSummaryUIEnhancement</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates whether you use an improved user interface to add or
                remove public group members through the group’s summary page <samp class="codeph nolang">true</samp> or not (<samp class="codeph nolang">false</samp>). If this field is set to
                <samp class="codeph nolang">true</samp>, you can still manage
                public group membership through the group’s detail page. The default
                value is <samp class="codeph nolang">true</samp>. Available in API
                version 62.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">permsetsInFieldCreation</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">If <samp class="codeph nolang">true</samp>, users can assign
                field-level security to permission sets instead of to profiles when
                creating a field on an object, setting field-level security on a
                field, or changing a field type on a field. The default is <samp class="codeph nolang">false</samp>. <p class="p">Available in API version
                  56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">psaExpirationUIEnabled</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates if admins can use an updated user interface that
                includes an assignment expiration for permission sets and permission
                set groups (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value
                is <samp class="codeph nolang">false</samp>. This field is
                available in API version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">restrictedProfileCloning</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">When enabled (<samp class="codeph nolang">true</samp>), only
                permissions accessible to your org are enabled when you clone
                profiles. When disabled (<samp class="codeph nolang">false</samp>), all permissions currently enabled in the source
                profile are also enabled for the cloned profile, even if your org
                can't currently access them.<p class="p">This field is available in API
                  version 50.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">userAccessPoliciesEnabled</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates if user access policies are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). With user access policies,
                you can automate and migrate your users’ assignments to managed
                package licenses, permission sets, and other access mechanisms based
                on criteria that you set. The default value is <samp class="codeph nolang">false</samp>. This field is available in
                API version 58.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d945452e99" data-title="Field"><span class="keyword parmname">userFieldHistoryTracking</span></td>

              <td class="entry" headers="d945452e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d945452e105" data-title="Description">Indicates if user field history tracking is enabled (true) or not
                (false). With user field history tracking, you can keep track of
                changes in user fields. The default value is <samp class="codeph nolang">false</samp>. This field is available in
                API version 64.0 and later.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a UserManagementSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<UserManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <enableConcealPersonalInfo\>false</enableConcealPersonalInfo\>
    <enableContactlessExternalIdentityUsers\>false</enableContactlessExternalIdentityUsers\>
    <enableEnhancedConcealPersonalInfo\>true</enableEnhancedConcealPersonalInfo\>
    <enableEnhancedPermsetMgmt\>false</enableEnhancedPermsetMgmt\>
    <enableEnhancedProfileMgmt\>true</enableEnhancedProfileMgmt\>
    <enableNewProfileUI\>false</enableNewProfileUI\>
    <enableProfileFiltering\>false</enableProfileFiltering\>
    <enableRestrictEmailDomains\>true</enableRestrictEmailDomains\>
    <enableScrambleUserData\>false</enableScrambleUserData\>
    <enableUserSelfDeactivate\>false</enableUserSelfDeactivate\>
    <enhancedPermSetList\>true</enhancedPermSetList\>
    <enhancedUserListView\>true</enhancedUserListView\>
    <enhancedUserRoleListView\>true</enhancedUserRoleListView\>
    <groupSummaryUIEnhancement\>true</groupSummaryUIEnhancement\>
    <restrictedProfileCloning\>true</restrictedProfileCloning\>
    <userAccessPoliciesEnabled\>true</userAccessPoliciesEnabled\>
</UserManagementSettings\>

The following is an example package.xml manifest that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>UserManagement</members\>
        <name\>Settings</name\>
    </types\>
    <version\>53.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=a1091895646e8a15e5c650724437a8918a9244f0abd1d5e97a68e75eb39e700e url=/legacydeveloper/current/en-us/api_meta/meta_userprofilesearchscope.md -->

# UserProfileSearchScope

Reserved for internal use.

<!-- document id=58928c438acb3d4575acd08502b8f76cae0d81e6307556008f942e04524c563a url=/legacydeveloper/current/en-us/api_meta/meta_userprovisioningconfig.md -->

# UserProvisioningConfig

Represents information to use during a user provisioning request flow, such as the attributes for an update. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

UserProvisioningConfig components have the suffix .userProvisioningConfig and are stored in the UserProvisioningConfigs directory.

## Version

UserProvisioningConfig components are available in API version 49.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d947373e92">Field Name</th>

              <th class="featureTableHeader  " id="d947373e95">Field Type</th>

              <th class="featureTableHeader  " id="d947373e98">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">approvalRequired</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">Indicates whether approvals are required for provisioning users for the
                associated connected app. If the value is null, no approval is required.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">connectedApp</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">The ID of the connected app for which users are being provisioned.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">enabled</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">boolean</td>

              <td class="entry" headers="d947373e98" data-title="Description">Indicates whether user provisioning is enabled for the associated connected app
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Default setting is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">enabledOperations</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">Lists the operations, as comma-separated values, that create a user
                provisioning request for the associated connected app. Allowed values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Create</samp>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Update</samp>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EnableAndDisable</samp> (activation and
                    deactivation)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SuspendAndRestore</samp> (freeze and
                    unfreeze)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">flow</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">User Provisioning flow type which includes a reference to the Apex
                <span class="keyword parmname">UserProvisioningPlugin</span> class. The flow calls the third-party
                service’s API to manage user account provisioning on that system.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">The primary label for this object. This value is the internal label that
                doesn’t get translated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">namedCredential</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">The Salesforce ID of the named credential that’s used for a request. The named
                credential identifies the third-party system and the third-party authentication
                settings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">notes</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">Serves as a place for admins to add any additional information about the
                configuration. This field is for internal reference only, and is not used by any
                process.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">onUpdateAttributes</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">Lists the user attributes, as comma-separated values, that generate a user
                provisioning request during an update.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">reconFilter</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">When collecting and analyzing users on a third-party system, the plug-in uses
                this filter to limit the scope of the collection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">userAccountMapping</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">Stores the attributes used to link the Salesforce user to the account on the
                third-party system, in JSON format. For example:
                <div class="codeSection nolang">
                  <pre class="codeblock nolang">{"linkingSalesforceUserAttribute":"Username", 
"linkingTargetUserAttribute":"Email"}</pre>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a UserProvisioningConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<UserProvisioningConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <approvalRequired\>True</approvalRequired\>
    <enabled\>true</enabled\>
    <enabledOperations\>NA</enabledOperations\>
    <connectedApp\>ExampleApp</connectedApp\>
    <masterLabel\>label</masterLabel\>
    <notes\>note</notes\>
    <onUpdateAttributes\>attri</onUpdateAttributes\>
    <reconFilter\>filter</reconFilter\>
    <userAccountMapping\>mapping</userAccountMapping\>
</UserProvisioningConfig\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>UPC</members\>
        <name\>UserProvisioningConfig</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=49e6d2e94c474095b03d234d5e024589820d71706cf774a1d05cb12d32be8c6d url=/legacydeveloper/current/en-us/api_meta/meta_utility_calls_intro.md -->

# Utility Calls

Use utility calls to gather information that is useful for working with the file-based or CRUD-based calls.

- (Deprecated) [checkStatus()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkstatus.htm "Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.")
- [describeMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describe.htm "This call retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types.")
- [describeValueType()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describeValueType.htm "Retrieves the metadata describing a given metadata type (value type).")
- [listMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_listmetadata.htm "This call retrieves property information about metadata components in your organization. Data is returned for the components that match the criteria specified in the queries parameter. The queries array can contain up to three ListMetadataQuery queries for each call. This call supports every metadata type: both top-level, such as CustomObject and ApexClass, and child types, such as CustomField and RecordType.")

<!-- document id=58bb8fc8b4e0677decec5909ae47bf8bed7e7f007932e8d293bf6760ba910f68 url=/legacydeveloper/current/en-us/api_meta/meta_validationformulas.md -->

# ValidationRule

Represents a validation rule, which is used to verify that the data a user enters in a record is valid and can be saved. A validation rule contains a formula or expression that evaluates the data in one or more fields and returns a value of true or false. Validation rules also include an error message that your client application can display to the user when the rule returns a value of true due to invalid data.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

As of API version 20.0, validation rules can't have compound fields. Examples of compound fields include addresses, first and last names, dependent picklists, and dependent lookups.

As of API version 40.0, you can use validation rules with custom metadata types.

## Version

Validation rules are available in API version 12.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d948333e98">Field Name</th>

              <th class="featureTableHeader  " id="d948333e101">Field Type</th>

              <th class="featureTableHeader  " id="d948333e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d948333e98" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d948333e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d948333e104" data-title="Description">Required. Indicates whether this validation rule is active,
                (<samp class="codeph nolang">true</samp>), or not active
                (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d948333e98" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d948333e101" data-title="Field Type">string</td>

              <td class="entry" headers="d948333e104" data-title="Description">A description of the validation rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d948333e98" data-title="Field Name"><span class="keyword parmname">errorConditionFormula</span></td>

              <td class="entry" headers="d948333e101" data-title="Field Type">string</td>

              <td class="entry" headers="d948333e104" data-title="Description">Required. The formula defined in the validation rule. If the
                formula returns a value of <samp class="codeph nolang">true</samp>, an error message is displayed. </td>

            </tr>

            <tr>
              <td class="entry" headers="d948333e98" data-title="Field Name"><span class="keyword parmname">errorDisplayField</span></td>

              <td class="entry" headers="d948333e101" data-title="Field Type">string</td>

              <td class="entry" headers="d948333e104" data-title="Description">The fully specified name of a field in the application. If a
                value is supplied, the error message appears next to the specified
                field. If you do not specify a value or the field isn’t visible on
                the page layout, the value changes automatically to <samp class="codeph nolang">Top of Page</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d948333e98" data-title="Field Name"><span class="keyword parmname">errorMessage</span></td>

              <td class="entry" headers="d948333e101" data-title="Field Type">string</td>

              <td class="entry" headers="d948333e104" data-title="Description">Required. The message that appears if the validation rule fails.
                The message must be 255 characters or less.</td>

            </tr>

            <tr>
              <td class="entry" headers="d948333e98" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d948333e101" data-title="Field Type">string</td>

              <td class="entry" headers="d948333e104" data-title="Description"> The internal name of the object. White spaces and special
                characters are escaped for validity. The name must:<ul class="ul bulletList">
                  <li class="li">Contain characters, letters, or the underscore (_)
                    character</li>

                  <li class="li">Must start with a letter</li>

                  <li class="li">Can’t end with an underscore</li>

                  <li class="li">Can't contain two consecutive underscore characters.</li>

                </ul>
                <p class="p">Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component, this field isn’t defined in
                  the WSDL for this component. It must be specified when creating,
                  updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see an example of this field
                  specified for a call.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample XML definition of a validation rule in a custom object is shown in this code block.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <deploymentStatus\>Deployed</deploymentStatus\>
    <fields\>
        <fullName\>Mommy\_Cat\_\_c</fullName\>
        <label\>Mommy Cat</label\>
        <referenceTo\>Cat\_\_c</referenceTo\>
        <relationshipName\>Cats</relationshipName\>
        <type\>Lookup</type\>
    </fields\>
    <label\>Cat</label\>
    <nameField\>
        <label\>Cat Name</label\>
        <type\>Text</type\>
    </nameField\>
    <pluralLabel\>Cats</pluralLabel\>
    <sharingModel\>ReadWrite</sharingModel\>
    <validationRules\>
        <fullName\>CatsRule</fullName\>
        <active\>true</active\>
        <errorConditionFormula\>OR(Name = &apos;Milo&apos;,Name = &apos;Moop&apos;)</errorConditionFormula\>
        <validationMessage\>Name must be that of one of my cats</validationMessage\>
    </validationRules\>
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsharingrecalculation.htm "SharingRecalculation")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm "WebLink")

<!-- document id=d6ba434a14279ef64fcdb5f70f486d10d32f3ca31dd8e5ac8f707fe5198ae04e url=/legacydeveloper/current/en-us/api_meta/meta_virtualvisitconfig.md -->

# VirtualVisitConfig

Represents an external video provider configuration, which relays events from Salesforce to the provider.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

VirtualVisitConfig components have the suffix .virtualVisitConfig and are stored in the VirtualVisitConfigs folder.

## Version

VirtualVisitConfig components are available in API version 54.0 and later.

## Special Access Rules

Access to this metadata type requires at least one of these preferences:

- Video Calls: Org Pref (VideoVisits) Org preference
- Industries Einstein: Intelligent Form Reader (EinsteinDocReader)
- Industries Einstein: Sentiment Insights Account (IESentimentAnalysis)
- Natural Language Processing: Key phrase extraction and entity detection (NLPServiceEnabled) Org Preference and the NLP: Key phrase extraction (KeyPhrasePrefEnabled) Org Preference
- Natural Language Processing (NLPServicePrefEnabled) Org Preference

## Fields

| Field Name | Description |
| --- | --- |
| comprehendServiceType | 
Field Type

VirtualVisitComprehendServiceType (enumeration of type string)

Description

Specifies the type of service used to convert speech into text or to analyze the converted speech text.

Valid values are:

- ComprehendMedicalService
- ComprehendService





 |
| developerName | 

Type

string

Properties

Filter, Group, Sort

Description

The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.



 |
| experienceCloudSiteUrl | 

Field Type

string

Description

The URL of the Digital Experience site where the Video Call component is available to portal or guest users.



 |
| externalMsgServiceIdentifier | 

Field Type

string

Description

For internal use only.



 |
| externalRoleIdentifier | 

Field Type

string

Description

The ID of the role that's used to allow users to join a video call and to grant them temporary access to certain functions needed to participate in the call.



 |
| externalUserIdentifier | 

Field Type

string

Description

For internal use only.



 |
| fullName | 

Type

string

Properties

Create, Group, Nillable

Description

The full name of the VirtualVisitConfig type in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.



 |
| isProtected | 

Field Type

boolean

Description

An auto-generated value that doesn’t currently impact the behavior of the metadata type.



 |
| masterLabel | 

Field Type

string

Description

Required.

A user-friendly name for VirtualVisitConfig, which is defined when the VirtualVisitConfig is created.





 |
| messagingRegion | 

Field Type

string

Description

The region where the waiting room and messaging channel data is processed and stored. Available in API version 57.0 and later.



 |
| namedCredential | 

Field Type

string

Description

The named credential record used to authenticate and authorize a video call vendor’s account.



 |
| storageBucketName | 

Field Type

string

Description

The name of the storage bucket that stores the meeting transcript.



 |
| usageType | 

Field Type

VirtualVisitUsageType (enumeration of type string)

Description

The name of the Salesforce feature for which the video call configuration record is created.

Valid values are:

- CHIME
- ENTITY\_DETECTION
- INTELLIGENT\_FORM\_READER
- KEY\_PHRASE\_EXTRACTION
- SENTIMENT\_ANALYSIS





 |
| videoCallApptTypeValue | 

Field Type

string

Description

The default Appointment Type picklist values from the Service Appointment object that represent a video appointment type. Use semicolons to separate multiple values.



 |
| videoControlRegion | 

Field Type

string

Description

The region where API calls related to Video Calls are made. Available in API version 57.0 and later.



 |
| visitRegion | 

Field Type

VirtualVisitVisitRegion (enumeration of type string)

Description

The region where the Video Call audio and video data is processed.

Valid values are:

- af-south-1
- ap-east-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-south-1
- ap-southeast-1
- ap-southeast-2
- ca-central-1
- eu-central-1
- eu-north-1
- eu-south-1
- eu-west-1
- eu-west-2
- eu-west-3
- me-south-1
- sa-east-1
- us-east-1
- us-east-2
- us-west-1
- us-west-2





 |

## Declarative Metadata Sample Definition

This is an example of a VirtualVisitConfig component.

<?xml version="1.0" encoding="UTF-8"?>
 <VirtualVisitConfig xmlns="http://soap.sforce.com/2006/04/metadata">
     <usageType\>CHIME</usageType\>
     <visitRegion\>us-east-1</visitRegion\>
     <masterLabel\>vvconfig1</masterLabel\>
     <experienceCloudSiteUrl\>videocall\_c@testcloudurl.com</experienceCloudSiteUrl\>
     <namedCredential\>SampleNamedCredential</namedCredential\>
     <comprehendServiceType\>ComprehendService</comprehendServiceType\>
     <storageBucketName\>comprehendbucket</storageBucketName\>
     <isProtected\>false</isProtected\>
 </VirtualVisitConfig\>

This is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
     <namespacePrefix\>\[namespacePrefix\]</namespacePrefix\>
     <fullName\>deployPackage</fullName\>
     <types\>
         <members\>\*</members\>
         <name\>VirtualVisitConfig</name\>
     </types\>
     <types\>
         <members\>\*</members\>
         <name\>NamedCredential</name\>
     </types\>
     <version\>55.0</version\>
 </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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=547b515d4ce518bd4a9d10c83ae2b23478f84aab19bd1bbc2459cde02291061e url=/legacydeveloper/current/en-us/api_meta/meta_voicesettings.md -->

# VoiceSettings

Represents an org’s Sales Dialer settings, such as call recording, conferencing, and voicemail.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

VoiceSettings values are stored in the Voice.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

VoiceSettings is available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1012003e113">Field Name</th>

              <th class="featureTableHeader  " id="d1012003e116">Field Type</th>

              <th class="featureTableHeader  " id="d1012003e119">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name"><span class="keyword parmname">enableCallDisposition</span></td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Indicates whether call disposition is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). With call disposition, also
                called Call Result, sales reps can track whether a call was
                connected and how it went.<p class="p">Default value is <samp class="codeph nolang">false</samp>. To use this feature,
                  enable Dialer in Lightning Experience. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name"><span class="keyword parmname">enableConsentReminder</span></td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Indicates whether the consent reminder is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). With the consent reminder,
                prior to recording a call, users see a prompt reminding them not to
                record phone calls without consent.<p class="p">Default value is <samp class="codeph nolang">false</samp>. To use this feature,
                  enable Dialer in Lightning Experience. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name">enableDefaultRecording</td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Indicates whether the default recording is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). With default recording,
                sales reps can record calls automatically in the Sales
                Dialer.<p class="p">Default value is <samp class="codeph nolang">false</samp>. This field is available in API version 54.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name"><span class="keyword parmname">enableVoiceCallList</span></td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Indicates whether Call List is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Sales reps can use call
                list to keep a running list of the calls they want to make.
                <p class="p">Default value is <samp class="codeph nolang">false</samp>.
                  To use this feature, enable Dialer in Lightning Experience.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name"><span class="keyword parmname">enableVoiceCallRecording</span></td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Indicates whether Call Recording is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Sales reps can record
                important calls directly from the call panel in Sales Dialer.
                <p class="p">Default value is <samp class="codeph nolang">false</samp>.
                  To use this feature, enable Dialer in Lightning Experience.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name"><span class="keyword parmname">enableVoiceCoaching</span></td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Indicates whether Call Monitoring is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Using the Monitor tab in
                the call panel, managers can listen to the calls of their sales reps
                for personalized coaching.<p class="p">Default value is <samp class="codeph nolang">false</samp>. To use this feature,
                  enable Dialer in Lightning Experience. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name"><span class="keyword parmname">enableVoiceConferencing</span></td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Reserved for future use. </td>

            </tr>

            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name"><span class="keyword parmname">enableVoiceLocalPresence</span></td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Indicates whether Local Presence is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Local Presence displays
                phone numbers with the same area code as the prospects your reps are
                calling, so more calls are answered.<p class="p">Default value is <samp class="codeph nolang">false</samp>. To use this feature,
                  enable Dialer in Lightning Experience. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name"><span class="keyword parmname">enableVoiceMail</span></td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Indicates whether voicemail is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Sales reps can receive and
                store up to 20 personal voicemail messages in Salesforce. <p class="p">Default
                  value is <samp class="codeph nolang">false</samp>. To use this
                  feature, enable Dialer in Lightning Experience. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1012003e113" data-title="Field Name"><span class="keyword parmname">enableVoiceMailDrop</span></td>

              <td class="entry" headers="d1012003e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1012003e119" data-title="Description">Indicates whether Voicemail Drop is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Sales reps can “drop” (or
                send) prerecorded messages to recipients’ voicemail boxes.
                <p class="p">Default value is <samp class="codeph nolang">false</samp>.
                  To use this feature, enable Dialer in Lightning Experience.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of the package file.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
    </types\>
    <version\>28.0</version\>
</Package\>

The package file references the following Voice.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<VoiceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCallDisposition\>true</enableCallDisposition\>
    <enableVoiceCallList\>true</enableVoiceCallList\>
    <enableVoiceCallRecording\>true</enableVoiceCallRecording\>
    <enableVoiceCoaching\>true</enableVoiceCoaching\>
    <enableVoiceConferencing\>true</enableVoiceConferencing\>
    <enableVoiceLocalPresence\>true</enableVoiceLocalPresence\>
    <enableVoiceMail\>true</enableVoiceMail\>
    <enableVoiceMailDrop\>true</enableVoiceMailDrop\>
</VoiceSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b0d605a543da9e4b3b4e25991e74d4226551a78e8146bff40dadf6f5a62ac1c6 url=/legacydeveloper/current/en-us/api_meta/meta_mfg_warrantylifecyclemgmtsettings.md -->

# WarrantyLifeCycleMgmtSettings

Represents settings that control the Warranty Administration for your org.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details.

## File Suffix and Directory Location

WarrantyLifeCycleMgmtSettings values are stored in the WarrantyLifecycleMgmt.settings file in the settings directory.

## Version

WarrantyLifeCycleMgmtSettings components are available in API version 54.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableWarrantyLCMgmt | boolean | Indicates whether warranty life-cycle management is enabled in your org (true) or not false). |

## Declarative Metadata Sample Definition

The following is an example of WarrantyLifeCycleMgmtSettings component.

<!--
   ~ Copyright 2022 salesforce.com, inc.
   ~ All Rights Reserved
   ~ Company Confidential
   -->
<WarrantyLifecycleMgmtSettings
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<enableWarrantyLCMgmt\>true</enableWarrantyLCMgmt\>
</WarrantyLifecycleMgmtSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   ~ Copyright 2022 salesforce.com, inc.
   ~ All Rights Reserved
   ~ Company Confidential
   -->
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>WarrantyLifecycleMgmt</members\>
		<name\>Settings</name\>
	</types\>
	<version\>54.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=46e751340d68a62bda3a99bef6c22be72b8553de90364507ab70041740aea252 url=/legacydeveloper/current/en-us/api_meta/meta_waveanalyticassetcollection.md -->

# WaveAnalyticAssetCollection

Represents a collection of Analytics assets. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

WaveAnalyticsAssetCollection components have the suffix .collection and are stored in the wave folder.

## Version

WaveAnalyticsAssetCollection components are available in API version 58.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| collectionType | string | The collection type. |
| color | string | The display color for the collection. |
| description | string | The description that appears in the user interface. |
| folder | string | The internal API name of the folder or application. |
| items | [WaveAnalayticAssestCollectionItem](#waveanalyticassetcollectionitem) | A list of Analytics asset items. |
| label | string | The label for the collection. |
| shares | [FolderShare](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_foldershare.htm#meta_foldershare "Represents the settings for enhanced analytics folder sharing. Users can control access to reports or dashboards by giving others Viewer, Editor, or Manager access to the folder that contains the report or dashboard.") | The folder sharing rules. |

## Declarative Metadata Sample Definition

The following is an example of a WaveAnalyticsAssetCollection component.

<?xml version="1.0" encoding="UTF-8"?>  
<WaveAnalyticsAssetCollection xmlns="http://soap.sforce.com/2006/04/metadata">
  <collectionType\>static</collectionType\>
  <color\>#1b96ff</color\>
  <description\>A collection of my Dashboards</description\>
  <folder\>Shared</folder\>
  <label\>My Dashboard Collection</label\>
  <items\>
     <item\>
        <asset\>Dashboard One</asset\>
        <assetType\>dashboard</assetType\>
        <sortOrder\>1</sortOrder\>
     </item\>
     <item\>
        <asset\>Dashboard Two</asset\>
        <assetType\>dashboard</assetType\>
        <sortOrder\>2</sortOrder\>
     </item\>
  </items\>
  <shares\>
    <accessLevel\>EditAllContents</accessLevel\>
    <sharedTo\>shareswith@org.ee</sharedTo\>
    <sharedToType\>User</sharedToType\>
  </shares\>
</WaveAnalyticsAssetCollection\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

## WaveAnalyticAssestCollectionItem

WaveAnalyticAssestCollectionItem represents an Analytics asset item.

| Field | Field Type | Description |
| --- | --- | --- |
| asset | string | The asset name. |
| assetType | string | The asset type. |
| sortOrder | int | The sort order for the asset. |

<!-- document id=76f9fafb1de180bdeb398c4961303d3436ab40ad32f1f226157daa91c322bf5f url=/legacydeveloper/current/en-us/api_meta/meta_waveapplication.md -->

# WaveApplication

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

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

WaveApplication components have the suffix .wapp and are stored in the wave folder.

## Version

WaveApplication components are available in API version 37.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| assetIcon | string | The icon that represents the Analytics application. |
| description | string | The description that appears in the user interface. |
| folder | string | The internal api name of the folder or application. |
| masterLabel | string | The user interface label name of the folder or application. |
| shares | [FolderShare](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_foldershare.htm#meta_foldershare "Represents the settings for enhanced analytics folder sharing. Users can control access to reports or dashboards by giving others Viewer, Editor, or Manager access to the folder that contains the report or dashboard.") | The folder sharing rules. |
| templateOrigin | string | The internal (unique) name of the template used to create the application. This field is blank if the application wasn’t created from a template. |
| templateVersion | string | The version assigned to the application template by the template's creator. This field is blank if the application wasn’t created from a template. |

## Declarative Metadata Sample Definition

The following is an example of a WaveApplication component.

<?xml version="1.0" encoding="UTF-8"?>  
<WaveApplication xmlns="http://soap.sforce.com/2006/04/metadata">
  <assetIcon\>/analytics/wave/web/proto/images/app/icons/11.png</assetIcon\>
  <description\>Application that shows my sales</description\>
  <folder\>edit</folder\>
  <masterLabel\>Sales Application</masterLabel\>
  <shares\>
   <accessLevel\>EditAllContents</accessLevel\>
   <sharedTo\>shareswith@org.ee</sharedTo\>
   <sharedToType\>User</sharedToType\>
  </shares\>
</WaveApplication\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=c8a53fc6f6a9ab832c0c466ef3c9ca7814bdc9a8c97604d4bb42933aac588e20 url=/legacydeveloper/current/en-us/api_meta/meta_wavecomponent.md -->

# WaveComponent

Represents the WaveComponent object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

When using Metadata API to work with Analytics components, consider that:

- Modifications to the .wcomp component are unsupported.

## File Suffix and Directory Location

WaveComponent components have the suffix .wcomp and are stored in the wave folder.

## Version

WaveComponent components are available in API version 51.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| application | string | Required. The internal name of the application. |
| description | string | The component description that appears in the user interface. |
| masterLabel | string | Required. The component name that appears in the user interface. |
| templateAssetSourceName | string | Links the component to the template used to create it. Null for assets not created from a template. |

## Declarative Metadata Sample Definition

The following is an example of a WaveComponent component.

<?xml version="1.0" encoding="UTF-8"?>
<WaveComponent xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <content xsi:nil="true"/>
    <application\>dev\_\_app</application\>
    <masterLabel\>Component1</masterLabel\>
    <description\>Component description</description\>
</WaveComponent\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=94b769bfca90514e595b82706a19dc329ea9551af9a4d8a57e6d134383c57e67 url=/legacydeveloper/current/en-us/api_meta/meta_wavedashboard.md -->

# WaveDashboard

Represents the WaveDashboard object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

When using Metadata API to work with Analytics dashboards, consider that:

- Modifications to the .wdash component are unsupported.
- Modifying or removing conditional formatting from the source org or .wdash component doesn’t cause issues while deploying.
- Removing steps from the .wdash component causes deployment to the destination org to fail because the source dashboard fails validation.
- If a dashboard is archived (moved to the Recycle Bin), retrieving it doesn't return its metadata. Deploying changes to an archived dashboard fails with an error stating that the dashboard is in the Recycle Bin.

## File Suffix and Directory Location

WaveDashboard components have the suffix .wdash and are stored in the wave folder.

## Version

WaveDashboard components are available in API version 37.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| application | string | Required. The internal name of the application. |
| dateVersion | integer | The date version for the dashboard. Only available in v55.0 and above. |
| description | string | The dashboard description that appears in the user interface. |
| masterLabel | string | Required. The dashboard name that appears in the user interface. |
| templateAssetSourceName | string | Links the dashboard to the template used to create it. Null for assets not created from a template. |

## Declarative Metadata Sample Definition

The following is an example of a WaveDashboard component.

<?xml version="1.0" encoding="UTF-8"?>
<WaveDashboard xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <content xsi:nil="true"/>
  <application\>dev\_\_app</application\>
  <masterLabel\>Dashboard1</masterLabel\>
  <description\>somedesc</description\>
</WaveDashboard\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=3260cf2c412f730f1e2972d0cf62b080081799123553043d636da4c65ec7f8e3 url=/legacydeveloper/current/en-us/api_meta/meta_wavedataflow.md -->

# WaveDataflow

Represents the WaveDataflow object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

WaveDataflow components have the suffix .wdf and are stored in the wave folder.

## Version

WaveDataflow components are available in API version 37.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| application | string | The name of the Analytics application the dataflow is connected to. This field is available in API version 48.0 and later. |
| dataflowType | string | The type of the dataflow. Supported types are User and Prepared. The default value is User This field is available in API version 41.0 and later. |
| description | string | The dataflow description that appears in the user interface. |
| masterLabel | string | Required. The dataflow name that appears in the user interface. |

## Declarative Metadata Sample Definition

The following is an example of a WaveDataflow component.

<?xml version="1.0" encoding="UTF-8"?>
<WaveDataflow xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">    <content xsi:nil="true"/>
    <description\>flow1</description\>
    <masterLabel\>flow1</masterLabel\>
</WaveDataflow\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=42b35c34680f24dc095f1bb8b72680539747b22afd1cf8b79ec7f097f91a5b86 url=/legacydeveloper/current/en-us/api_meta/meta_wavedataset.md -->

# WaveDataset

Represents the WaveDataset object in the Analytics application. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

WaveDataset components have the suffix .wds and are stored in the wave folder.

## Version

WaveDataset components are available in API version 37.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| application | string | Required. The internal name of the application. |
| description | string | The dataset description that appears in the user interface. |
| masterLabel | string | Required. The user interface label name of the dataset. |
| templateAssetSourceName | string | Links the dataset to the template used to create it. Null for assets not created from a template. |
| type | string | The type of the dataset. Dataset types include Default, Live,StagedData, and Trended. |

## Declarative Metadata Sample Definition

The following is an example of a WaveDataset component.

<WaveDataset\>
    <application\>SharedApp</application\>
    <description\>description</description\>
    <masterLabel\>datasetLabel</masterLabel\>
    <type\>Default</type\>
</WaveDataset\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=4843ac4576340302557b5090919c0c07aee8c14da0971ddecdb5f2993835dfdf url=/legacydeveloper/current/en-us/api_meta/meta_wavelens.md -->

# WaveLens

Represents the WaveLens object in the Analytics application.

This type extends to [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

When using Metadata API to work with Analytics lenses, consider that:

- If a lens is archived (moved to the Recycle Bin), retrieving it doesn't return its metadata. Deploying changes to an archived lens fails with an error stating that the lens is in the Recycle Bin.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

WaveLens components have the suffix .wlens and are stored in the wave folder.

## Version

WaveLens components are available in API version 37.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1016571e118">Field Name</th>

              <th class="featureTableHeader  " id="d1016571e121">Field Type</th>

              <th class="featureTableHeader  " id="d1016571e124">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">application</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">Required. The internal name of the application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">datasets</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">A reference to the dataset used to create this lens.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">dateVersion</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">int</td>

              <td class="entry" headers="d1016571e124" data-title="Description">The date version used for this lens.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">The dashboard description that appears in the user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">Required. The user interface label name of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">templateAssetSourceName</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">Links the lens to the template used to create it. Null for assets not created
                from a template. </td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">visualizationType</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">Required. The visualization type to be used for this lens. Valid values are:
                <a name="ac_viz_type_list"><!-- --></a>
                <ul class="ul bulletList" id="ac_viz_type_list">
                  <li class="li">
                    <samp class="codeph nolang">calheatmap</samp>—Calendar heat map
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">comparisontable</samp>—Comparison
                    table
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">heatmap</samp>—Heat map
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">hbar</samp>—Horizontal bar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">hbarhdot</samp>—Horizontal dot plot
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">matrix</samp>—Matrix
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">parallelcoords</samp>—Parallel
                    coordinates
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">pie</samp>—Donut
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">pivottable</samp>—Pivot table
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">scatter</samp>—Scatter plot
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">stackhbar</samp>—Stacked horizontal
                    bar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">stackvbar</samp>—Stacked vertical
                    bar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">time</samp>—Time line
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">valuestable</samp>—Values table
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">vbar</samp>—Vertical bar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">vdot</samp>—Vertical dot plot
                  </li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a WaveLens component.

<?xml version="1.0" encoding="UTF-8"?>
<WaveLens xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <content xsi:nil="true"/>
  <application\>dev\_\_app</application\>
  <datasets\>dev\_\_abc</datasets\>
  <masterLabel\>lens1</masterLabel\>
  <description\>lens in shared app</description\>
  <visualizationType\>hbar</visualizationType\>
</WaveLens\>  

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=86fea1b208a4e015b87364edab5c62b3ede19fd014946a1d899fb45e12a2d3b7 url=/legacydeveloper/current/en-us/api_meta/meta_waverecipe.md -->

# WaveRecipe

Represents the WaveRecipe type in an Analytics application. A recipe is a saved set of steps to perform on a specific source dataset or connected data. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

WaveRecipe components have the suffix .wdpr and are stored in the wave folder.

## Version

WaveRecipe components are available in API version 41.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1017398e93">Field Name</th>

              <th class="featureTableHeader  " id="d1017398e96">Field Type</th>

              <th class="featureTableHeader  " id="d1017398e99">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1017398e93" data-title="Field Name"><span class="keyword parmname">application</span></td>

              <td class="entry" headers="d1017398e96" data-title="Field Type">string</td>

              <td class="entry" headers="d1017398e99" data-title="Description">The internal name of the application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1017398e93" data-title="Field Name"><span class="keyword parmname">dataflow</span></td>

              <td class="entry" headers="d1017398e96" data-title="Field Type">string</td>

              <td class="entry" headers="d1017398e99" data-title="Description">Required. The dataflow ID for the Analytics recipe.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1017398e93" data-title="Field Name"><span class="keyword parmname">format</span></td>

              <td class="entry" headers="d1017398e96" data-title="Field Type">string</td>

              <td class="entry" headers="d1017398e99" data-title="Description">The format of the current recipe definition. Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">R2</samp> - recipes created with Data Prep
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">R3</samp> - recipes created with Data Prep (API
                    version 49.0)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1017398e93" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1017398e96" data-title="Field Type">string</td>

              <td class="entry" headers="d1017398e99" data-title="Description">Required. The recipe name that appears in the user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1017398e93" data-title="Field Name"><span class="keyword parmname">securityPredicate</span></td>

              <td class="entry" headers="d1017398e96" data-title="Field Type">string</td>

              <td class="entry" headers="d1017398e99" data-title="Description">A filter condition that defines row-level access to records in a
                recipe.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1017398e93" data-title="Field Name"><span class="keyword parmname">targetDatasetAlias</span></td>

              <td class="entry" headers="d1017398e96" data-title="Field Type">string</td>

              <td class="entry" headers="d1017398e99" data-title="Description">The name of the dataset the recipe saves data results into.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1017398e93" data-title="Field Name"><span class="keyword parmname">templateAssetSourceName</span></td>

              <td class="entry" headers="d1017398e96" data-title="Field Type">string</td>

              <td class="entry" headers="d1017398e99" data-title="Description">Links the recipe to the template used to create it. Null for assets not created
                from a template.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a WaveRecipe component.

<?xml version="1.0" encoding="UTF-8"?>
<WaveRecipe xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">    <content xsi:nil="true"/>
    <dataflow\>02KB0000000b5c7MAA</dataflow\>
    <format\>R3</format\>
    <masterLabel\>recipe1</masterLabel\>
    <securityPredicate\>'UserId' == "$User.Id"</securityPredicate\>
    <targetDatasetAlias\>Dataset One</targetDatasetAlias\>
</WaveRecipe\>

## Deleting a WaveRecipe Component

Use a simple destructiveChanges.xml file with only the WaveRecipe component declared. This deletes the WaveRecipe and any related WaveDataflow components. For more information, see [Delete Components from an Organization.](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm "To delete components, perform a deployment with the deploy() call by using a destructive changes manifest file that lists the components to remove from your organization. You can perform a deployment that only deletes components, or a deployment that deletes and adds components. In API version 33.0 and later, you can specify components to delete before and after other components are added or updated. In earlier API versions, if deletions and additions are specified for the same deployment, the deploy() call performs the deletions first.")

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

Use of the wildcard character doesn’t return the recipe’s associated dataflows.

<!-- document id=038c57d0983744b3cb075214aae28fb13e03d998f1dacced5b673e7d1e3a82de url=/legacydeveloper/current/en-us/api_meta/meta_wavetemplatebundle.md -->

# WaveTemplateBundle

Represents an Analytics template bundle, which can be used to create Analytics apps. A bundle contains an Analytics template definition and all its related resources.This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

An Analytics template bundle is a folder that contains definition files for a template. Unlike other metadata components, a WaveTemplateBundle component isn’t represented by a single component file, but instead by a collection of JSON and CSV definition files. Each definition file represents a resource in a template, such as lenses, dashboards, dataflows, and comma-separated values. For example, this directory structure shows the hierarchy of the folders and files for one Analytics Template definition, template1.

waveTemplates
    template1
        template-info.json 
        variables.json 
        ui.json 
        extFiles
            PostalCodes.csv

Analytics template bundles must be under a top-level folder that’s named waveTemplates. Each bundle must have its own subfolder under the waveTemplates folder and be named with the template's fully qualified API name. The bundle folder must contain a template-info.json file to specify the metadata about the template and the references to other definition files. An entire bundle doesn’t have a suffix and definition files can have one of the following suffixes.

| Suffix | Component Type |
| --- | --- |
| .json | JavaScript Object Notation |
| .csv | Comma-Separated Values |

## Version

WaveTemplateBundle components are available in API version 35.0 and later.

## Special Access Rules

Definitions can be created in both managed and unmanaged packages.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1018088e143">Field Name</th>

              <th class="featureTableHeader  " id="d1018088e146">Field Type</th>

              <th class="featureTableHeader  " id="d1018088e149">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1018088e143" data-title="Field Name"><span class="keyword parmname">assetIcon</span></td>

              <td class="entry" headers="d1018088e146" data-title="Field Type">string</td>

              <td class="entry" headers="d1018088e149" data-title="Description">The icon to use by default for new Analytics apps based on this template. Valid
                values are <samp class="codeph nolang">1.png</samp> through <samp class="codeph nolang">20.png</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018088e143" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1018088e146" data-title="Field Type">string</td>

              <td class="entry" headers="d1018088e149" data-title="Description">The specification of the template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018088e143" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d1018088e146" data-title="Field Type">string</td>

              <td class="entry" headers="d1018088e149" data-title="Description">Required. The label of the template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018088e143" data-title="Field Name"><span class="keyword parmname">templateType</span></td>

              <td class="entry" headers="d1018088e146" data-title="Field Type">string</td>

              <td class="entry" headers="d1018088e149" data-title="Description">Required. The type of the template. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">App</samp></li>

                  <li class="li"><samp class="codeph nolang">Dashboard</samp></li>

                  <li class="li"><samp class="codeph nolang">Lens</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=294d20b18b2247ced433c0a15ef01c27086cec0aea033afbf5cd64f849980858 url=/legacydeveloper/current/en-us/api_meta/meta_wavexmd.md -->

# WaveXmd

Represents the WaveXmd object in the Analytics application. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

WaveXmd components have the suffix .xmd and are stored in the wave folder.

## Version

WaveXmd components are available in API version 39.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1018664e85">Field Name</th>

              <th class="featureTableHeader  " id="d1018664e88">Field Type</th>

              <th class="featureTableHeader  " id="d1018664e91">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">application</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e91" data-title="Description">The name of the Analytics application the XMD is associated with.
                Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">dataset</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e91" data-title="Description">Required. Specifies the dataset associated with this XMD.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">datasetConnector</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e91" data-title="Description">The name of the connector source for the dataset.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">datasetFullyQualifiedName</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e91" data-title="Description">Specifies the fully qualified name of the dataset version
                associated with this XMD.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">dates</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type"><a class="xref" href="#WaveXmdDate">WaveXmdDate</a></td>

              <td class="entry" headers="d1018664e91" data-title="Description">List of dates, with formatting information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">dimensions</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type"><a class="xref" href="#WaveXmdDimension">WaveXmdDimension</a></td>

              <td class="entry" headers="d1018664e91" data-title="Description">List of dimensions, with formatting information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">measures</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type"><a class="xref" href="#WaveXmdMeasure">WaveXmdMeasure</a></td>

              <td class="entry" headers="d1018664e91" data-title="Description">List of measures, with formatting information.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">organizations</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type"><a class="xref" href="#WaveXmdOrganization">WaveXmdOrganization</a></td>

              <td class="entry" headers="d1018664e91" data-title="Description">List of organizations, for multi-organization support.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">origin</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e91" data-title="Description">The origin of the dataset version.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e91" data-title="Description">The XMD type. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">System</samp></li>

                  <li class="li"><samp class="codeph nolang">User</samp></li>

                  <li class="li"><samp class="codeph nolang">Main</samp></li>

                  <li class="li"><samp class="codeph nolang">Asset</samp></li>

                </ul>
                Available in API version 43.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e85" data-title="Field Name"><span class="keyword parmname">waveVisualization</span></td>

              <td class="entry" headers="d1018664e88" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e91" data-title="Description">The visualization behavior for Analytics assets. Valid values
                are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">dashboard</samp></li>

                  <li class="li"><samp class="codeph nolang">lens</samp></li>

                </ul>
                Available in API version 43.0 and later.</td>

            </tr>

          </tbody>

        </table>

## WaveXmdDate

WaveXmdDate represents a date.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1018664e307">Field</th>

              <th class="featureTableHeader  " id="d1018664e310">Field Type</th>

              <th class="featureTableHeader  " id="d1018664e313">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">alias</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">Required. Alias of the Date column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">compact</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1018664e313" data-title="Description">Indicates whether the date is displayed in compact form (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldDay</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The day field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldEpochDay</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The epoch day field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldEpochSecond</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The epoch second field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldFiscalMonth</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The fiscal month field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldFiscalQuarter</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The fiscal quarter field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldFiscalWeek</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The fiscal week field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldFiscalYear</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The fiscal year field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldFullYear</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The full year field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldHour</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The hour field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldMinute</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The minute field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldMonth</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The month field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldQuarter</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The quarter field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldSecond</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The second field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldWeek</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The week field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">dateFieldYear</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The year field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The description of the date column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">firstDayOfWeek</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">int</td>

              <td class="entry" headers="d1018664e313" data-title="Description">Required. Represents the first day of the week.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">fiscalMonthOffset</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">int</td>

              <td class="entry" headers="d1018664e313" data-title="Description">Required. Offset number of months for the fiscal year in relation
                to the calendar year.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">isYearEndFiscalYear</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1018664e313" data-title="Description">Indicates whether the year end is the fiscal year (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">The label of the date column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">showInExplorer</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1018664e313" data-title="Description">Indicates whether the date is displayed in the explorer (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">sortIndex</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">int</td>

              <td class="entry" headers="d1018664e313" data-title="Description">Required. The index value the system assigns to indicate where
                the item appears in a list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e307" data-title="Field"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d1018664e310" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e313" data-title="Description">Required. The type of date. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Date</samp>—A legacy date
                    type. Available when the time zone isn’t enabled.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DateOnly</samp>—A date type
                    without an associated time. Available when the time zone is
                    enabled.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DateTime</samp>—A date type
                    that contains both date and time parts. Available when the
                    time zone is enabled.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## WaveXmdDimension

WaveXmdDimension represents a dimension.

| Field | Field Type | Description |
| --- | --- | --- |
| conditionalFormatting | [WaveXmdFormattingProperty](#WaveXmdFormattingProperty) | The conditional formatting property for the dimension. Available in API version 43.0 and later. |
| customActions | [WaveXmdDimensionCustomAction](#WaveXmdDimensionCustomAction) | Custom actions linked to this dimension. |
| customActionsEnabled | boolean | Indicates whether the dimension has custom actions enabled (true) or not (false). |
| dateFormat | string | The format used for a date that is a dimension. |
| defaultAction | string | The default action assigned to a dimension. An action for a dimension can be openSfdcRecord, openActionsMenu, none, or a valid API name with dot notation like Global.LogACall or FeedItem.Post. |
| description | string | The description of the dimension. |
| field | string | Required. The field name of the dimension (used in queries). |
| fullyQualifiedName | string | The fully qualified name of the dimension. |
| imageTemplate | string | The image template. |
| isDerived | boolean | Required. Indicates whether the dimension is derived (true) or not (false). |
| isMultiValue | boolean | Indicates whether the dimension is multi-value (true) or not (false). |
| label | string | The label for the dimension. |
| linkTemplate | string | The template for formatting a link. |
| linkTemplateEnabled | boolean | Indicates whether the dimension has link templates enabled (true) or not (false). |
| linkTooltip | string | The tooltip to be displayed for links. |
| members | [WaveXmdDimensionMember](#WaveXmdDimensionMember) | The member overrides for a dimension. |
| origin | string | The origin of this dimension. |
| recordDisplayFields | [WaveXmdRecordDisplayLookup](#WaveXmdRecordDisplayLookup) | Ordered list of dimensions. The list defines the default order in which to display the dimensions in the user interface. |
| recordIdField | string | The record ID for this dimension. |
| recordOrganizationIdField | string | The record organization ID for this dimension. |
| salesforceActions | [WaveXmdDimensionSalesforceAction](#WaveXmdDimensionSalesforceAction) | Salesforce actions linked to this dimension. |
| salesforceActionsEnabled | boolean | Indicates whether the dimension has Salesforce actions enabled (true) or not (false). |
| showDetailsDefaultFieldIndex | int | Default order in which to show the dimensions in the user interface. |
| showInExplorer | boolean | Indicates whether the dimension is displayed in the explorer (true) or not (false). |
| sortIndex | int | Required. The index value the system assigns to indicate where the item appears in a list. |

## WaveXmdFormattingProperty

WaveXmdFormattingProperty represents an XMD formatting property for conditional formatting.

| Field | Field Type | Description |
| --- | --- | --- |
| formattingBins | [WaveXmdFormattingBin](#WaveXmdFormattingBin) | The formatting bins for this property. |
| formattingPredicates | [WaveXmdFormattingPredicate](#WaveXmdFormattingPredicate) | The formatting predicates for this property. |
| property | string | Required. The property name. |
| referenceField | string | Required. The reference field for this property. |
| sortIndex | int | Required. The index value the system assigns to indicate where the item appears in a list. |
| type | string | Required. The property type. |

## WaveXmdFormattingBin

WaveXmdFormatttingBin represents an XMD formatting bin for conditional formatting.

| Field | Field Type | Description |
| --- | --- | --- |
| bin | string | Required. The formatting bin. |
| formatValue | string | Required. The format value for the bin. |
| label | string | Required. The label for the bin. |
| sortIndex | int | Required. The index value the system assigns to indicate where the item appears in a list. |

## WaveXmdFormattingPredicate

WaveXmdFormattingPredicate represents an XMD formatting predicate for conditional formatting.

| Field | Field Type | Description |
| --- | --- | --- |
| formatValue | string | Required. The format value for the predicate. |
| operator | string | Required. The operator for the predicate. |
| sortIndex | int | Required. The index value the system assigns to indicate where the item appears in a list. |
| value | string | Required. The value for the predicate. |

## WaveXmdDimensionCustomAction

WaveXmdDimensionCustomAction represents a custom action in a dimension.

| Field | Field Type | Description |
| --- | --- | --- |
| customActionName | string | Required. The name of this custom action. |
| enabled | boolean | Required. Indicates whether the action is enabled for a specific dimension (true) or not (false). |
| icon | string | The icon for the action. |
| method | string | The method for the action. |
| sortIndex | int | Required. The index value the system assigns to indicate where the item appears in a list. |
| target | string | The target for the action. |
| tooltip | string | The tooltip for the action. |
| url | string | The URL for the action. |

## WaveXmdDimensionMember

WaveXmdDimensionMember represents a dimension.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1018664e1600">Field</th>

              <th class="featureTableHeader  " id="d1018664e1603">Field Type</th>

              <th class="featureTableHeader  " id="d1018664e1606">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1018664e1600" data-title="Field"><span class="keyword parmname">color</span></td>

              <td class="entry" headers="d1018664e1603" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e1606" data-title="Description">The color for the member.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e1600" data-title="Field"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d1018664e1603" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e1606" data-title="Description">The label for the member. <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Multi-line text isn't supported</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e1600" data-title="Field"><span class="keyword parmname">member</span></td>

              <td class="entry" headers="d1018664e1603" data-title="Field Type">string</td>

              <td class="entry" headers="d1018664e1606" data-title="Description">Required. The member value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1018664e1600" data-title="Field"><span class="keyword parmname">sortIndex</span></td>

              <td class="entry" headers="d1018664e1603" data-title="Field Type">int</td>

              <td class="entry" headers="d1018664e1606" data-title="Description">Required. The index value the system assigns to indicate where
                the item appears in a list.</td>

            </tr>

          </tbody>

        </table>

## WaveXmdRecordDisplayLookup

WaveXmdDimensionRecordDisplayLookup represents a record display field.

| Field | Field Type | Description |
| --- | --- | --- |
| recordDisplayField | string | Required. The field to display. |
| sortIndex | int | Required. The index value the system assigns to indicate where the item appears in a list. |

## WaveXmdDimensionSalesforceAction

WaveXmdDimensionSalesforceAction represents an action in a dimension.

| Field | Field Type | Description |
| --- | --- | --- |
| enabled | boolean | Required. Indicates whether the action is enabled for a specific dimension (true) or not (false). |
| salesforceActionName | string | Required. The name of the action. |
| sortIndex | int | Required. The index value the system assigns to indicate where the item appears in a list. |

## WaveXmdMeasure

WaveXmdMeasure represents a measure.

| Field | Field Type | Description |
| --- | --- | --- |
| conditionalFormatting | [WaveXmdFormattingProperty](#WaveXmdFormattingProperty) | The conditional formatting for the measure. Available in API version 43.0 and later. |
| currencies | WaveXmdMeasure\[\] | The list of currency formats for multiple currencies. Use this field to set the format for each currency used in the dataset. |
| currencyCode | String | The default currency code for the dataset. |
| dateFormat | string | The format used for a date that is a measure. |
| description | string | The description of the measure. |
| field | string | Required. The field name of the measure (used in queries). |
| formatCustomFormat | string | The original (XMD 1.1) format array as a single string. |
| formatDecimalDigits | int | The number of digits displayed after the decimal place. |
| formatDecimalSeparator | string | The custom separator for the decimal place. Available in API version 48.0 and later. |
| formatIsNegativeParens | boolean | Indicates whether to display negative numbers with parentheses, rather than a minus sign (true) or not (false). |
| formatPrefix | string | The prefix placed before the field value. |
| formatSuffix | string | The suffix placed after the field value. |
| formatThousandsSeparator | string | The custom separator for the thousands place. Available in API version 48.0 and later. |
| formatUnit | string | The unit string for the measure. For example, 'cm'. |
| formatUnitMultiplier | double | The multiplier for the unit. |
| fullyQualifiedName | string | The fully qualified name of the measure. |
| isDerived | boolean | Required. Indicates whether the measure is derived (true) or not (false). |
| isMultiCurrency | boolean | Indicates whether multiple currencies are available for this dataset (true) or not (false). |
| label | string | The label for the measure. |
| origin | string | The origin of the measure. |
| showDetailsDefaultFieldIndex | int | Default order in which to show the measures in the user interface. |
| showInExplorer | boolean | Indicates whether the measure is displayed in the explorer (true) or not (false). |
| sortIndex | int | Required. The index value the system assigns to indicate where the item appears in a list. |

## WaveXmdOrganization

WaveXmdOrganization represents a Salesforce organization.

| Field | Field Type | Description |
| --- | --- | --- |
| instanceUrl | string | Required. The instance URL for the organization. |
| label | string | Required. The label for the organization. |
| organizationIdentifier | string | Required. The ID of the organization. |
| sortIndex | int | Required. The index value the system assigns to indicate where the item appears in a list. |

## Declarative Metadata Sample Definition

The following is an example of a WaveXmd component for an Asset XMD belonging to a dashboard.

<WaveXmd\>
    <dataset xsi:nil="true"/>
    <dimesions\>
        <conditionalFormatting\>
            <formattingBins\>
                <bin\>\*</bin\>
                <formatValue\>#FFFFFF</formatValue\>
                <label xsi:nil="true"/>
                <sortIndex\>0</sortIndex\>
            </formattingBins\>
            <formattingBins\>
                <bin\>0</bin\>
                <formatValue\>#000000</formatValue\>
                <label xsi:nil="true"/>
                <sortIndex\>1</sortIndex\>
            </formattingBins\>
            <property\>chartColor</property\>
            <referenceField\>count</referenceField\>
            <sortIndex xsi:nil="true"/>
            <type\>multiple</type\>
        </conditionalFormatting\>
        <field\>all\_1.ALL</field\>
        <isDerived\>false</isDerived\>
        <sortIndex\>0</sortIndex\>
    </dimensions\>
    <measures\>
        <conditionalFormatting\>
            <formattingBins\>
                <bin\>\*</bin\>
                <formatValue\>#FFFFFF</formatValue\>
                <label xsi:nil="true"/>
                <sortIndex\>0</sortIndex\>
            </formattingBins\>
            <formattingBins\>
                <bin\>0</bin\>
                <formatValue\>#000000</formatValue\>
                <label xsi:nil="true"/>
                <sortIndex\>1</sortIndex\>
            </formattingBins\>
            <property\>chartColor</property\>
            <referenceField\>count</referenceField\>
            <sortIndex xsi:nil="true"/>
            <type\>multiple</type\>
        </conditionalFormatting\>
        <field\>all\_1.count</field\>
        <formatCustomFormat\>\[&quot;#,###.##%&quot;,1\]</formatCustomFormat\>
        <isDerived\>false</isDerived\>
        <sortIndex\>0</sortIndex\>
    </measures\>
    <type\>Asset</type\>
    <waveVisualization\>dashboard</waveVisualization\>
</WaveXmd\>

<!-- document id=ed71ca30056b5dd80a6667821f008828e3f69fa1c6bf5d1f289819b4619c90d1 url=/legacydeveloper/current/en-us/api_meta/meta_weblink.md -->

# WebLink

Represents a custom button or link defined in a custom object.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Version

WebLinks are available in API version 12.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1026983e89">Field Name</th>

              <th class="featureTableHeader  " id="d1026983e92">Field Type </th>

              <th class="featureTableHeader  " id="d1026983e95">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">availability</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">WebLinkAvailability (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d1026983e95" data-title="Description">Required. Indicates whether the button or link is only available
                online (<samp class="codeph nolang">online</samp>, or if it is
                also available offline (<samp class="codeph nolang">offline</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">string</td>

              <td class="entry" headers="d1026983e95" data-title="Description">A description of the button or link.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname" id="displaytype"><a name="displaytype"><!-- --></a>displayType</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">WebLinkDisplayType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d1026983e95" data-title="Description"> Represents how the button or link is rendered. Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">link</samp> for a
                    hyperlink
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">button</samp> for a
                    button
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">massActionButton</samp> for a
                    button attached to a related list
                  </li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">encodingKey</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">Encoding</td>

              <td class="entry" headers="d1026983e95" data-title="Description"> Required. The default encoding setting is Unicode: <samp class="codeph xml">UTF-8</samp>. Change it if your template
                requires data in a different format. This is available if your
                content source is URL. <p class="p">Valid values include:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">UTF-8</samp>—Unicode (UTF-8)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ISO-8859-1</samp>—General US &amp; Western Europe
                    (ISO-8859–1, ISO-LATIN-1)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Shift_JIS</samp>—Japanese (Shift-JIS)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ISO-2022-JP</samp>—Japanese (JIS)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EUC-JP</samp>—Japanese (EUC-JP)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">x-SJIS_0213</samp>—Japanese (Shift-JIS_2004)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ks_c_5601-1987</samp>—Korean (ks_c_5601-1987)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Big5</samp>—Traditional Chinese (Big5)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">GB2312</samp>—Simplified Chinese (GB2312)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Big5-HKSCS</samp>—Traditional Chinese Hong Kong
                    (Big5–HKSCS)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">string</td>

              <td class="entry" headers="d1026983e95" data-title="Description">The name of the custom button or link with white spaces and
                special characters escaped for validity. The name can only contain
                characters, letters, and the underscore (_) character. The name must
                start with a letter, and can’t end with an underscore or contain two
                consecutive underscore characters.<p class="p">Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component, this
                  field isn’t defined in the WSDL for this component. It must be
                  specified when creating, updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see
                  an example of this field specified for a call.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">hasMenubar</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the <a class="xref" href="#opentype"><span class="keyword parmname">openType</span></a> is
                <samp class="codeph nolang">newWindow</samp>, this field
                indicates whether to show the browser menu bar for the window
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Otherwise, leave this field
                empty.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">hasScrollbars</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the <a class="xref" href="#opentype"><span class="keyword parmname">openType</span></a> is
                <samp class="codeph nolang">newWindow</samp>, this field
                indicates whether to show the scroll bars for the window (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Otherwise, leave this field
                empty.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">hasToolbar</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the <a class="xref" href="#opentype"><span class="keyword parmname">openType</span></a> is
                <samp class="codeph nolang">newWindow</samp>, this field
                indicates whether to show the browser toolbar for the window
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Otherwise, leave this field
                empty.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">int</td>

              <td class="entry" headers="d1026983e95" data-title="Description">Height in pixels of the window opened by the custom button or
                link. Required if the <a class="xref" href="#opentype"><span class="keyword parmname">openType</span></a> is
                <samp class="codeph nolang">newWindow</samp>. Otherwise, leave
                this field empty.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">isResizable</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the <a class="xref" href="#opentype"><span class="keyword parmname">openType</span></a> is
                <samp class="codeph nolang">newWindow</samp>, this field
                indicates whether to allow resizing of the window (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Otherwise, leave this field
                empty.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname" id="linktype"><a name="linktype"><!-- --></a>linkType</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">WebLinkType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d1026983e95" data-title="Description"> Required. Represents whether the content of the button or link
                is specified by a URL, an sControl, a JavaScript code block, or a
                Visualforce page.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">url</samp></li>

                  <li class="li"><samp class="codeph nolang">sControl</samp></li>

                  <li class="li"><samp class="codeph nolang">javascript</samp></li>

                  <li class="li"><samp class="codeph nolang">page</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">flow</samp>—Reserved for
                    future use.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">string</td>

              <td class="entry" headers="d1026983e95" data-title="Description">Master label for this object. This display value is the internal
                label that is not translated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname" id="opentype"><a name="opentype"><!-- --></a>openType</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">WebLinkWindowType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d1026983e95" data-title="Description">Required. When the button or link is clicked, specifies the
                window style that will be used to display the content. Valid values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">newWindow</samp></li>

                  <li class="li"><samp class="codeph nolang">sidebar</samp></li>

                  <li class="li"><samp class="codeph nolang">noSidebar</samp></li>

                  <li class="li"><samp class="codeph nolang">replace</samp></li>

                  <li class="li"><samp class="codeph nolang">onClickJavaScript</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">string</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the value of <a class="xref" href="#linktype"><span class="keyword parmname">linkType</span></a> is
                <samp class="codeph nolang">page</samp>, this field represents
                the Visualforce page. Otherwise, leave this field empty.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">position</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">WebLinkPosition (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the value of <span class="keyword parmname">OpenType</span> is <samp class="codeph nolang">newWindow</samp>, this field indicates how
                the new window should be displayed. Otherwise, don’t specify a
                value. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">fullScreen</samp></li>

                  <li class="li"><samp class="codeph nolang">none</samp></li>

                  <li class="li"><samp class="codeph nolang">topLeft</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">protected</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1026983e95" data-title="Description">Required. <span class="ph" id="field_protected_desc"><a name="field_protected_desc"><!-- --></a>Indicates whether this
                  subcomponent is protected (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Protected subcomponents can’t be linked to
                  or referenced by components or subcomponents created in the
                  installing organization.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">requireRowSelection</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the <span class="keyword parmname">displayType</span> is <samp class="codeph nolang">massActionButton</samp>, this field
                indicates whether to require individual row selection to execute the
                action for this button (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>). Otherwise, leave
                this field empty.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">scontrol</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">string</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the value of <a class="xref" href="#linktype"><span class="keyword parmname">linkType</span></a> is
                <samp class="codeph nolang">sControl</samp>, this field
                represents the name of the sControl. Otherwise, leave this field
                empty.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">showsLocation</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the <a class="xref" href="#opentype"><span class="keyword parmname">openType</span></a> is
                <samp class="codeph nolang">newWindow</samp>, this field
                indicates whether to show the browser location bar for the window
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Otherwise, leave this field
                empty.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">showsStatus</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1026983e95" data-title="Description">If the <a class="xref" href="#opentype"><span class="keyword parmname">openType</span></a> is
                <samp class="codeph nolang">newWindow</samp>, this field
                indicates whether to show the browser status bar for the window.
                Otherwise, leave this field empty.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">url</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">string</td>

              <td class="entry" headers="d1026983e95" data-title="Description">
                <p class="p">If the value of <a class="xref" href="#linktype"><span class="keyword parmname">linkType</span></a> is
                  <samp class="codeph nolang">url</samp>, this is the URL
                  value. If the value of <a class="xref" href="#linktype"><span class="keyword parmname">linkType</span></a> is
                  <samp class="codeph nolang">javascript</samp>, this is the
                  JavaScript content. If the value is neither of these options,
                  leave this field empty.
                </p>

                <p class="p">Content must be escaped in a manner consistent with XML parsing
                  rules.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1026983e89" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d1026983e92" data-title="Field Type">int</td>

              <td class="entry" headers="d1026983e95" data-title="Description">Width in pixels of the window opened by the button or
                link.<p class="p">Required if the <a class="xref" href="#opentype"><span class="keyword parmname">openType</span></a> is
                  <samp class="codeph nolang">newWindow</samp>. Otherwise,
                  leave this field empty.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## Java Sample

The following Java sample shows sample values for WebLink fields:

public void WebLinkSample(String name) throws Exception {
    WebLink WebLink = new WebLink();
    // name variable represents the full name of the object 
    // on which to create the WebLink, for example, customObject\_\_c
    WebLink.setFullName(name + ".googleButton");
    WebLink.setUrl("http://www.google.com");
    WebLink.setAvailability(WebLinkAvailability.online);
    WebLink.setLinkType(WebLinkType.url);
    WebLink.setEncodingKey(Encoding.fromString("UTF-8"));
    WebLink.setOpenType(WebLinkWindowType.newWindow);
    WebLink.setHeight(600);
    WebLink.setWidth(600);
    WebLink.setShowsLocation(false);
    WebLink.setHasScrollbars(true);
    WebLink.setHasToolbar(false);
    WebLink.setHasMenubar(false);
    WebLink.setShowsStatus(false);
    WebLink.setIsResizable(true);
    WebLink.setPosition(WebLinkPosition.none);
    WebLink.setMasterLabel("google");
    WebLink.setDisplayType(WebLinkDisplayType.link);

    AsyncResult\[\] asyncResults = metadataConnection.create(new WebLink\[\]{WebLink});
    // After the create() call completes, we must poll the results of checkStatus() 
    // 

}

## Declarative Metadata Sample Definition

The following is the definition of a WebLink in a custom object. For related samples, see [Declarative Metadata Sample Definition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm#HomePageCompenent_example) and [Declarative Metadata Sample Definition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm#HomePageLayout_meta_example).

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
....
    <WebLinks\>
        <fullName\>googleButton</fullName\>
        <availability\>online</availability\>
        <displayType\>link</displayType\>
        <encodingKey\>UTF-8</encodingKey\>
        <hasMenubar\>false</hasMenubar\>
        <hasScrollbars\>true</hasScrollbars\>
        <hasToolbar\>false</hasToolbar\>
        <height\>600</height\>
        <isResizable\>true</isResizable\>
        <linkType\>url</linkType\>
        <masterLabel\>google</masterLabel\>
        <openType\>newWindow</openType\>
        <position\>none</position\>
        <protected\>false</protected\>
        <showsLocation\>false</showsLocation\>
        <showsStatus\>false</showsStatus\>
        <url\>http://www.google.com</url\>
        <width\>600</width\>
    </WebLinks\>
....
</CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_validationformulas.htm "ValidationRule")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm "Metadata Field Types")

#### See Also

- [HomePageComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm "Represents the metadata associated with a home page component. You can customize the Home tab in Salesforce Classic to include components such as sidebar links, a company logo, a dashboard snapshot, or custom components that you create. Use to create, update, or delete home page component definitions.")
- [HomePageLayout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm "Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile.")
- [CustomPageWebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/custompageweblink.htm "Represents a custom link defined in a home page component.")

<!-- document id=90d9e99e8f1cf426ecfaecf3ef15461cee905895e8061db7420a056c7734e3a9 url=/legacydeveloper/current/en-us/api_meta/meta_webstorebundle.md -->

# WebStoreBundle

For internal use only.

<!-- document id=e67312503885260188b05b52ef82edb3f31ccd0d2c7b3b60aac3f9272587a648 url=/legacydeveloper/current/en-us/api_meta/meta_webstoretemplate.md -->

# WebStoreTemplate

Represents a configuration for creating commerce stores.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

WebStoreTemplate components have the suffix .webstoretemplate and are stored in the webstoretemplate folder.

## Version

WebStoreTemplate components are available in API version 49.0 and later.

## Special Access Rules

A B2B Commerce or D2C Commerce license and access to Commerce objects is required.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1029544e113">Field Name</th>

              <th class="featureTableHeader  " id="d1029544e116">Field Type</th>

              <th class="featureTableHeader  " id="d1029544e119">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">autoFacetingEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Indicates whether auto faceting is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If enabled
                (True), the most relevant search facets are automatically returned, in addition to
                the configured search facets, in the product search results. If disabled (False),
                only the configured search facets are returned. The default is <samp class="codeph nolang">False</samp>. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=commerce.comm_search_add_filters.htm&amp;type=5&amp;language=en_US" target="_blank">Add Product Search Filters
                  (Facets)</a> for more information. This field is available in API version 50.0
                or later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">cartAsyncProcessingEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Indicates whether add-to-cart requests are processed asynchronously (<samp class="codeph nolang">True</samp>) or not (<samp class="codeph nolang">False</samp>). The default value is <samp class="codeph nolang">True</samp>.
                This field is available in API version 59.0 or later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">cartCalculateEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description"> Indicates whether the cart calculate extension is enabled (<samp class="codeph nolang">True</samp>) or not (<samp class="codeph nolang">False</samp>). The default value is <samp class="codeph nolang">False</samp>.
                This field is available in API version 59.0 or later. </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">cartToOrderAutoCustomFieldMapping</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Indicates whether custom field mapping for cart and order objects is enabled
                (<samp class="codeph nolang">True</samp>) or not (<samp class="codeph nolang">False</samp>). The default value is <samp class="codeph nolang">True</samp>.
                This field is available in API version 57.0 or later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">checkoutTimeToLive</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">int</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Amount of time in minutes that a checkout stays active and doesn’t expire. This
                field is available in API version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">checkoutValidAfterDate</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">dateTime</td>

              <td class="entry" headers="d1029544e119" data-title="Description">A timestamp in the default server timezone (GMT). All checkouts that start
                before this date are considered expired. This field is available in API version 52.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">commerceEinsteinActivitiesTracked</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Indicates whether Commerce Einstein activities tracking is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">commerceEinsteinDeployed</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Indicates whether Commerce Einstein is deployed (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">country</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">string</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Two-digit ISO code of the store's country. Purchases can be shipped only to the
                country assigned to the store. Valid for only D2C stores. This field is available in
                API version 56.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">defaultCurrency</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">string</td>

              <td class="entry" headers="d1029544e119" data-title="Description">The template’s default currency setting for new records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">defaultLanguage</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">string</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. The template’s default language setting for new records.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">defaultTaxLocaleType</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">TaxLocaleType​ (enumeration of type string)</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. The template’s default tax type for your webstore. Possible values include:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Automatic</samp></li>

                  <li class="li"><samp class="codeph nolang">Gross</samp></li>

                  <li class="li"><samp class="codeph nolang">Net</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">string</td>

              <td class="entry" headers="d1029544e119" data-title="Description">The description of the template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">duplicateCartItemsEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Indicates whether a cart can include multiple items with the same product ID
                (<samp class="codeph nolang">True</samp>) or not (<samp class="codeph nolang">False</samp>). The default value is <samp class="codeph nolang">False</samp>.
                This field is available in API version 59.0 or later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">guestBrowsingEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Indicates whether guest browsing is enabled for this store. Set the option to
                <samp class="codeph nolang">True</samp> to allow guest buyers access to products
                in the store.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">guestCartEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. Indicates whether guest cart access is enabled for a store created
                with an LWR template. Set the option to <samp class="codeph nolang">True</samp> to
                allow guest buyers access to products in the store.<p class="p">This field is available in API
                  version 58.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">guestCheckoutEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. Indicates whether guest checkout access is enabled for a store
                created with an LWR template. Set the option to <samp class="codeph nolang">True</samp> to allow guest buyers access to products in the store.<p class="p">This field
                  is available in API version 58.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">string</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. The original (untranslated) name of a label. Each translated label is
                paired with its original untranslated version.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">maxValuesPerFacet</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">int</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Maximum number of values that can be added to a facet.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">orderActivationStatus</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">string</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Status of the order. Possible values include: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Activated</samp></li>

                  <li class="li"><samp class="codeph nolang">Draft</samp></li>

                </ul>
                This field is available in API version 55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">orderLifeCycleType</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">OrderLifeCycleType​ (enumeration of type string)</td>

              <td class="entry" headers="d1029544e119" data-title="Description">The order life cycle type. Possible values include:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">MANAGED</samp></li>

                  <li class="li"><samp class="codeph nolang">UNMANAGED</samp></li>

                </ul>
                This field is available in API version 55.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">paginationSize</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">int</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Number of results displayed per search results page. </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">preserveGuestCartEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. Indicates whether cart contents are preserved when a guest logs in to
                the store. Set the option to <samp class="codeph nolang">True</samp> to preserve
                guest carts.<p class="p">This field is available in API version 60.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">pricingStrategy</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">PricingStrategy​ (enumeration of type string)</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. The price selected to display to buyers. Possible values include:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">LowestPrice</samp></li>

                  <li class="li"><samp class="codeph nolang">Priority</samp></li>

                </ul>
                The default value is <samp class="codeph nolang">LowestPrice</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">productGrouping</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">ProductGrouping ​ (enumeration of type string)</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Determines whether product variations are listed individually in search results
                or are represented by the parent product, which links to its children. Possible
                values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">NoGrouping</samp>—Variations are listed
                    individually in search results.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">VariationParent</samp>—The parent product
                    is returned in search results with a link to its children.
                  </li>

                </ul>
                The default value is <samp class="codeph nolang">VariationParent</samp>. This
                field is available in API version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">skipAdditionalEntitlementCheckForSearch</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">By default, user entitlement checks are run as part of a search index rebuild
                and again when product search results are returned. Skips the second check to
                promote faster search performance. Set the option to <samp class="codeph nolang">True</samp> to skip additional entitlement checks on a search. This field is
                available in API version 52.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">skuDetectionEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Indicates whether SKU detection is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">splitShipmentEnabled</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. Indicates whether split shipments are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). </td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">supportedCurrencies</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">string</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Currencies supported for store template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">supportedLanguages</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">string</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. Languages supported for store template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">supportedShipToCountries</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">string</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Countries that a store created from the template can ship to.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1029544e113" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d1029544e116" data-title="Field Type">WebStoreType​ (enumeration of type string)</td>

              <td class="entry" headers="d1029544e119" data-title="Description">Required. The type of store configuration, <samp class="codeph nolang">B2C</samp>, <samp class="codeph nolang">B2B</samp>, <samp class="codeph nolang">or B2CE</samp>. Default is B2B.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a web store template component.

<?xml version="1.0" encoding="UTF-8"?>
<WebStoreTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <autoFacetingEnabled\>true</autoFacetingEnabled\>
    <cartAsyncProcessingEnabled\>true</cartAsyncProcessingEnabled\>
    <cartCalculateEnabled\>false</cartCalculateEnabled\>
    <cartToOrderAutoCustomFieldMapping\>true</cartToOrderAutoCustomFieldMapping\>
    <checkoutTimeToLive\>10</checkoutTimeToLive\>
    <checkoutValidAfterDate\>2020-08-10T09:26:50</checkoutValidAfterDate\>
    <commerceEinsteinActivitiesTracked\>false</commerceEinsteinActivitiesTracked\>
    <commerceEinsteinDeployed\>false</commerceEinsteinDeployed\>
    <country\>US</country\>
    <defaultCurrency\>USD</defaultCurrency\>
    <defaultLanguage\>ENGLISH</defaultLanguage\>
    <defaultTaxLocaleType\>Net</defaultTaxLocaleType\>
    <description\>WebStore description</description\>
    <duplicateCartItemsEnabled\>false</duplicateCartItemsEnabled\>
    <guestBrowsingEnabled\>true</guestBrowsingEnabled\>
    <guestCartEnabled\>false</guestCartEnabled\>
    <guestCartTimeToLive\>10</guestCartTimeToLive\>
    <guestCheckoutEnabled\>false</guestCheckoutEnabled\>
    <masterLabel\>WebStore</masterLabel\>
    <maxValuesPerFacet\>99</maxValuesPerFacet\>
    <orderActivationStatus\>Activated</orderActivationStatus\>
    <orderLifeCycleType\>MANAGED</orderLifeCycleType\>
    <paginationSize\>9</paginationSize\>
    <preserveGuestCartEnabled\>false</preserveGuestCartEnabled\>
    <pricingStrategy\>Priority</pricingStrategy\>
    <productGrouping\>VariationParent</productGrouping\>
    <skipAdditionalEntitlementCheckForSearch\>true</skipAdditionalEntitlementCheckForSearch\>
    <skuDetectionEnabled\>false</skuDetectionEnabled\>
    <supportedCurrencies\>USD</supportedCurrencies\>
    <supportedLanguages\>en\_us</supportedLanguages\>
    <supportedShipToCountries\>CA;US</supportedShipToCountries\>
    <splitShipmentEnabled\>false</splitShipmentEnabled\>
    <type\>B2B</type\>
</WebStoreTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>WebStoreTemplate</name>
    </types>
    <version>60.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

<!-- document id=b34deeeb0b4f659e1333936dcb3402696625c3d9dfd1a94ce14e49bccb8a05a2 url=/legacydeveloper/current/en-us/api_meta/meta_WorkDotComSettings.md -->

# WorkDotComSettings

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

## Version

WorkDotComSettings components are available in API version 31.0 and later.

## Fields

<table class="featureTable sort_table" summary="">

          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d66159e63">Field Name</th>

              <th class="featureTableHeader  " id="d66159e66">Field Type</th>

              <th class="featureTableHeader  " id="d66159e69">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableCoachingManagerGroupAccess</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Coaching Manager Group Access is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>.
                <p class="p">Deprecated.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableGoalManagerGroupAccess</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Goal Manager Group Access is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>.<p class="p">Deprecated.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableProfileSkills</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Profile Skills is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableProfileSkillsAddFeedPost</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Add Skills as Feed Posts is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>. </td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableProfileSkillsAutoSuggest</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Profile Skills Auto Suggest is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableProfileSkillsUsePlatform</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Profile Skills Use Platform is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableWorkBadgeDefRestrictPref</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Badge Definition Restriction is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>.
                <p class="p">Deprecated.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableWorkCalibration</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Calibration is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value
                is <samp class="codeph nolang">false</samp>. <p class="p">Deprecated.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableWorkCanvasPref</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Canvas is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value
                is <samp class="codeph nolang">true</samp>. <p class="p">Deprecated.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableWorkCertification</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Certification is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">true</samp>.
                <p class="p">Deprecated.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableWorkCertificationNotification</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Certification Notification is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value is <samp class="codeph nolang">false</samp>.
                <p class="p">Deprecated.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableWorkRewardsPref</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Rewards is available to users <samp class="codeph nolang">(true)</samp>or not <samp class="codeph nolang">(false)</samp>. Default value
                is <samp class="codeph nolang">true</samp>. <p class="p">Deprecated.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d66159e63" data-title="Field Name"><span class="keyword parmname">enableWorkThanksPref</span></td>

              <td class="entry" headers="d66159e66" data-title="Field Type">boolean</td>

              <td class="entry" headers="d66159e69" data-title="Description">Indicates whether Thanks is available to users <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Default
                value is <samp class="codeph nolang">true</samp>. </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a WorkDotComSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<WorkDotComSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCoachingManagerGroupAccess\>true</enableCoachingManagerGroupAccess\>
    <enableGoalManagerGroupAccess\>true</enableGoalManagerGroupAccess\>
    <enableProfileSkills\>true</enableProfileSkills\>
    <enableProfileSkillsAddFeedPost\>true</enableProfileSkillsAddFeedPost\>
    <enableProfileSkillsAutoSuggest\>true</enableProfileSkillsAutoSuggest\>
    <enableProfileSkillsUsePlatform\>true</enableProfileSkillsUsePlatform\>
    <enableWorkBadgeDefRestrictPref\>true</enableWorkBadgeDefRestrictPref\>
    <enableWorkCalibration\>true</enableWorkCalibration\>
    <enableWorkCanvasPref\>true</enableWorkCanvasPref\>
    <enableWorkCertification\>true</enableWorkCertification\>
    <enableWorkCertificationNotification\>true</enableWorkCertificationNotification\>
    <enableWorkRewardsPref\>true</enableWorkRewardsPref\>
    <enableWorkThanksPref\>true</enableWorkThanksPref\>
    </WorkDotComSettings\>

<!-- document id=03f139f24c72cefd29f77f814a9ca0ac8983049225df0c83b93ec4c31740d267 url=/legacydeveloper/current/en-us/api_meta/meta_workflow.md -->

# Workflow

Represents the metadata associated with a workflow rule. A workflow rule sets workflow actions into motion when its designated conditions are met. You can configure workflow actions to execute immediately when a record meets the conditions in your workflow rule, or set time triggers that execute the workflow actions on a specific day. Use this metadata type to create, update, or delete workflow rule definitions.

For more information, see Workflow in Salesforce Help. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

When using a manifest file, retrieve all workflow components using this code.

<types\>
    <members\>\*</members\>
    <name\>Workflow</name\>
</types\>

## Declarative Metadata File Suffix and Directory Location

Workflow files have the suffix .workflow. There’s one file per standard or custom object that has workflow. These files are stored in the workflows directory of the corresponding package.

## Version

Workflow rules are available in API version 13.0 and later.

## Workflow

This metadata type represents the valid types of workflow rules and actions associated with a standard or custom object.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e107">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e110">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e107" data-title="Field Name"><span class="keyword parmname">alerts</span></td>

              <td class="entry" headers="d1032074e110" data-title="Field Type">
                <a class="xref" href="#WorkflowAlert">WorkflowAlert</a>[]
              </td>

              <td class="entry" headers="d1032074e113" data-title="Description">An array of all alerts for the object associated with the
                workflow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e107" data-title="Field Name"><span class="keyword parmname">fieldUpdates</span></td>

              <td class="entry" headers="d1032074e110" data-title="Field Type">
                <a class="xref" href="#WorkflowFieldUpdate">WorkflowFieldUpdate</a>[]
              </td>

              <td class="entry" headers="d1032074e113" data-title="Description">An array of all field updates for the object associated with the
                workflow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e107" data-title="Field Name"><span class="keyword parmname" id="field_flowActions"><a name="field_flowActions"><!-- --></a>flowActions</span></td>

              <td class="entry" headers="d1032074e110" data-title="Field Type">
                <a class="xref" href="#WorkflowFlowAction">WorkflowFlowAction</a>[]
              </td>

              <td class="entry" headers="d1032074e113" data-title="Description">
                <span class="ph" id="field_flowActions_desc"><a name="field_flowActions_desc"><!-- --></a>An array of flow triggers for the
                  object associated with the workflow.</span> Available in API
                version 30.0 and later.<p class="p">The pilot program for flow trigger
                  workflow actions is closed. If you already enabled the pilot in
                  your org, you can continue to create and edit flow trigger
                  workflow actions. If you didn’t enable the pilot, use Flow
                  Builder to create a record-triggered flow, or use Process
                  Builder to launch a flow from a process.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e107" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d1032074e110" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e113" data-title="Description">The developer name used as a unique identifier for API access.
                The <span class="keyword parmname">fullName</span> can contain only underscores and
                alphanumeric characters. It must be unique, begin with a letter, not
                include spaces, not end with an underscore, and not contain two
                consecutive underscores. This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e107" data-title="Field Name"><span class="keyword parmname">knowledgePublishes</span></td>

              <td class="entry" headers="d1032074e110" data-title="Field Type">
                <a class="xref" href="#WorkflowKnowledgePublish-89EB4B2A">WorkflowKnowledgePublish</a>[]
              </td>

              <td class="entry" headers="d1032074e113" data-title="Description">An array of Salesforce Knowledge Workflow Publishes associated
                with the workflow. Available in API version 27.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e107" data-title="Field Name"><span class="keyword parmname">outboundMessages</span></td>

              <td class="entry" headers="d1032074e110" data-title="Field Type">
                <a class="xref" href="#WorkflowOutboundMessage">WorkflowOutboundMessage</a>[]
              </td>

              <td class="entry" headers="d1032074e113" data-title="Description">An array of all the outbound messages for the object associated
                with the workflow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e107" data-title="Field Name"><span class="keyword parmname">rules</span></td>

              <td class="entry" headers="d1032074e110" data-title="Field Type">
                <a class="xref" href="#WorkflowRule">WorkflowRule</a>[]
              </td>

              <td class="entry" headers="d1032074e113" data-title="Description">An array of all the objects associated with the workflow.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e107" data-title="Field Name"><span class="keyword parmname">tasks</span></td>

              <td class="entry" headers="d1032074e110" data-title="Field Type">
                <a class="xref" href="#WorkflowTask">WorkflowTask</a>[]
              </td>

              <td class="entry" headers="d1032074e113" data-title="Description">An array of all the tasks for the object associated with the
                workflow.</td>

            </tr>

          </tbody>

        </table>

## WorkflowActionReference

WorkflowActionReference represents one of the workflow actions.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e287">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e290">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e293">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e287" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d1032074e290" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e293" data-title="Description">Required. The name of the workflow action.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e287" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d1032074e290" data-title="Field Type">WorkflowActionType (enumeration of type string)</td>

              <td class="entry" headers="d1032074e293" data-title="Description">Required. Available types of workflow actions:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Alert</samp></li>

                  <li class="li"><samp class="codeph nolang">FieldUpdate</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">FlowAction</samp>—Available in API version
                    30.0 and later
                  </li>

                  <li class="li"><samp class="codeph nolang">OutboundMessage</samp></li>

                  <li class="li"><samp class="codeph nolang">Task</samp></li>

                </ul>
                <p class="p">The pilot program for flow trigger
                  workflow actions is closed. If you already enabled the pilot in
                  your org, you can continue to create and edit flow trigger
                  workflow actions. If you didn't enable the pilot, use Flow
                  Builder to create a record-triggered flow, or use Process
                  Builder to launch a flow from a process.</p>
              </td>

            </tr>

          </tbody>

        </table>

## WorkflowAlert

WorkflowAlert represents an email alert associated with a workflow rule.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e378">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e381">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e384">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e378" data-title="Field Name"><span class="keyword parmname">ccEmails</span></td>

              <td class="entry" headers="d1032074e381" data-title="Field Type">string[]</td>

              <td class="entry" headers="d1032074e384" data-title="Description">Additional email addresses. This field is similar to the CC field
                in email clients.<p class="p">For the email to be sent successfully, set a
                  value for <span class="keyword parmname">ccEmails</span> or
                  <span class="keyword parmname">recipients</span>. You can set values for both
                  fields. The value of <span class="keyword parmname">ccEmails</span> can include
                  up to 5 different email addresses.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e378" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="descriptionWorkflowAlert"><a name="descriptionWorkflowAlert"><!-- --></a>description</span></span></td>

              <td class="entry" headers="d1032074e381" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e384" data-title="Description"><span class="ph" id="descriptionWorkflowAlertDescription"><a name="descriptionWorkflowAlertDescription"><!-- --></a>Required. A
                  description of the email alert. Available in API version 16.0
                  and later.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e378" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d1032074e381" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e384" data-title="Description">Required. The developer name used as a unique identifier for API
                access. The <span class="keyword parmname">fullName</span> can contain only
                underscores and alphanumeric characters. It must be unique, begin
                with a letter, not include spaces, not end with an underscore, and
                not contain two consecutive underscores. This field is inherited
                from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e378" data-title="Field Name"><span class="keyword parmname">protected</span></td>

              <td class="entry" headers="d1032074e381" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e384" data-title="Description">Required. Indicates whether this component is protected (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Protected components can’t
                be linked to or referenced by components created in the installing
                organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e378" data-title="Field Name"><span class="keyword parmname">recipients</span></td>

              <td class="entry" headers="d1032074e381" data-title="Field Type">
                <a class="xref" href="#WorkflowEmailRecipient">WorkflowEmailRecipient</a>[]
              </td>

              <td class="entry" headers="d1032074e384" data-title="Description">The recipients for the email.<p class="p">For the email to be sent
                  successfully, set a value for <span class="keyword parmname">ccEmails</span> or
                  <span class="keyword parmname">recipients</span>. You can set values for both
                  fields.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e378" data-title="Field Name"><span class="keyword parmname" id="field_senderAddress"><a name="field_senderAddress"><!-- --></a>senderAddress</span></td>

              <td class="entry" headers="d1032074e381" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e384" data-title="Description">The address in the From field
                for the email alert. <span class="ph" id="field_senderAddress_action"><a name="field_senderAddress_action"><!-- --></a>With
                  this address, you can use a standard global email address
                  for your organization, such as <samp class="codeph nolang">support@company.com</samp>, instead of the default
                  From field, which is the email address of the person who
                  updates the record.</span> You can only specify a value in
                this field if the <span class="keyword parmname">senderType</span> is set to
                <samp class="codeph nolang">OrgWideEmailAddress</samp>.
                <span class="ph" id="see_orgwide_email"><a name="see_orgwide_email"><!-- --></a>See Organization-Wide Email Addresses in
                  Salesforce Help.</span>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e378" data-title="Field Name"><span class="keyword parmname" id="field_senderType"><a name="field_senderType"><!-- --></a>senderType</span></td>

              <td class="entry" headers="d1032074e381" data-title="Field Type">ActionEmailSenderType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d1032074e384" data-title="Description">
                <span class="ph" id="field_senderType_desc"><a name="field_senderType_desc"><!-- --></a>The email used as the sender’s
                  From and Reply-To addresses.</span> These values are valid.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">CurrentUser</samp>—The
                    email address of the person updating the record. This value
                    is the default setting.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="option_DefaultWorkflowUser"><a name="option_DefaultWorkflowUser"><!-- --></a>DefaultWorkflowUser</samp>—The email address
                    of the default workflow user. If the email alert is
                    installed from a package, this field value is changed to
                    <samp class="codeph nolang">CurrentUser</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="option_OrgWideEmailAddress"><a name="option_OrgWideEmailAddress"><!-- --></a>OrgWideEmailAddress</samp>—A verified global
                    email address for your organization, such as <samp class="codeph nolang">support@company.com</samp>.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e378" data-title="Field Name"><span class="keyword parmname">template</span></td>

              <td class="entry" headers="d1032074e381" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e384" data-title="Description">Required. Named reference to an EmailTemplate. This email
                template isn’t required to exist in the zip file, but it must exist
                in Metadata API.<p class="p">Lightning email templates aren’t packageable. We
                  recommend using a Classic email template.</p>
              </td>

            </tr>

          </tbody>

        </table>

## WorkflowEmailRecipient

WorkflowEmailRecipient represents a recipient for an email alert associated with a workflow rule.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e608">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e611">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e614">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e608" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d1032074e611" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e614" data-title="Description">Name of the field referenced in <span class="keyword parmname">type</span>. The
                field named is of the type specified in
                <span class="keyword parmname">type</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e608" data-title="Field Name"><span class="keyword parmname">recipient</span></td>

              <td class="entry" headers="d1032074e611" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e614" data-title="Description">The recipients for the email. Depending on the type selected,
                this field is required.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e608" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d1032074e611" data-title="Field Type">ActionEmailRecipientTypes (enumeration of type string)</td>

              <td class="entry" headers="d1032074e614" data-title="Description">Named reference to an EmailTemplate component. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">accountOwner</samp>—The email
                    is sent to the record’s account owner. For example, the
                    Account owner for an Opportunity.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">accountTeam</samp>—Only
                    applicable on the Account object. The email is sent to
                    everyone on that Account’s account team.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">campaignMemberDerivedOwner</samp>—Emails are sent to
                    lead and contact owners when contacts are added to a
                    campaign or in response to a campaign.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">contactLookup</samp>—The email
                    is sent to a contact whose value is looked up from a field
                    on the record. For this value, the <samp class="codeph nolang">field</samp> field must reference
                    a Contact.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">creator</samp>—The email is
                    sent to the record’s creator.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">customerPortalOwner</samp>—The
                    email is sent to a specific self-service portal user. For
                    this value, the recipient field must reference a
                    self-service portal user by their username.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">email</samp>—The email is sent
                    to an email address whose value is looked up from a field on
                    the record. For this value, the <samp class="codeph nolang">field</samp> field must reference an email
                    field.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">group</samp>—The email is sent
                    to all users in a group. For this value, the recipient field
                    must reference a group by group name.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">opportunityTeam</samp>—Only
                    applicable on the Opportunity object. The email is sent to
                    everyone on that Opportunity’s opportunity team.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">owner</samp>—The email is sent
                    to the record’s owner.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">partnerUser</samp>—The email
                    is sent to a specific partner user. For this value, the
                    recipient field must reference a partner user by
                    username.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">portalRole</samp> - Like
                    <samp class="codeph nolang">role</samp>, but for
                    portal roles only.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">portalRoleSubordinates</samp>
                    -
                    Like
                    <samp class="codeph nolang">roleSubordinates</samp>,
                    but for portal roles only.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">role</samp>—The email is sent
                    to all users in a role. For this value, the recipient field
                    must reference a role name in the role hierarchy.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">roleSubordinates</samp>—The
                    email is sent to all users in a role subordinate. For this
                    value, the recipient field must reference a role.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">roleSubordinatesInternal</samp>—Like <samp class="codeph nolang">roleSubordinates</samp>, but for
                    internal portal roles only.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">user</samp>—The email is sent
                    to a specific user. For this value, the recipient field must
                    reference a user by username.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">userLookup</samp>—The email is
                    sent to a user whose value is looked up from a field on the
                    record. For this value, the <samp class="codeph nolang">field</samp> field must reference a user foreign key
                    field.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## WorkflowFieldUpdate

WorkflowFieldUpdate represents a workflow field update. With field updates, you can automatically update a field value to one that you specify when a workflow rule is triggered.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e807">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e810">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e813">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e813" data-title="Description">The description of the field update. This information is useful
                to track the reasoning for initially configuring the field
                update.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e813" data-title="Description">Required. The field on the object for the workflow to be
                updated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname">formula</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e813" data-title="Description">If the <span class="keyword parmname">operation</span> field value is <samp class="codeph nolang">Formula</samp>, the formula used to
                compute the new field value.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e813" data-title="Description">Required. The developer name used as a unique identifier for API
                access. The <span class="keyword parmname">fullName</span> can contain only
                underscores and alphanumeric characters. It must be unique, begin
                with a letter, not include spaces, not end with an underscore, and
                not contain two consecutive underscores. This field is inherited
                from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname">literalValue</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e813" data-title="Description">If the <span class="keyword parmname">operation</span> field value is <samp class="codeph nolang">Literal</samp>, the literal value for the
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname" id="WorkFlowFieldUpdate_lookupValue"><a name="WorkFlowFieldUpdate_lookupValue"><!-- --></a>lookupValue</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e813" data-title="Description">If the <span class="keyword parmname">operation</span> field value is
                <span class="keyword parmname">lookupValue</span>, the lookup value that is
                referenced.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname">lookupValueType</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">LookupValueType (enumeration of type string)</td>

              <td class="entry" headers="d1032074e813" data-title="Description">The type of object that the <span class="keyword parmname">lookupValue</span>
                field value is referencing. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Queue</samp></li>

                  <li class="li"><samp class="codeph nolang">RecordType</samp></li>

                  <li class="li"><samp class="codeph nolang">User</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="nameFieldUpdate"><a name="nameFieldUpdate"><!-- --></a>name</span></span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e813" data-title="Description"><span class="ph" id="name_added_160"><a name="name_added_160"><!-- --></a>Required. A name for the component. Available in version
                  API 16.0 and later.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname">notifyAssignee</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e813" data-title="Description">Required. Notify the assignee when the field is updated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname" id="WorkflowFieldUpdate_operation"><a name="WorkflowFieldUpdate_operation"><!-- --></a>operation</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">FieldUpdateOperation (enumeration of type string)</td>

              <td class="entry" headers="d1032074e813" data-title="Description">Required. The operation that computes the value with which to
                update the field. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Formula</samp>—Indicates the
                    field is set to a formula. If set, the formula must be a
                    valid formula.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Literal</samp>—Indicates the
                    field is set to a literal value. If set, the literalValue
                    must be a valid literal value for this field.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LookupValue</samp>—Similar to
                    Literal, but for an object reference, such as a contact,
                    user, or account. If set, the <samp class="codeph nolang">lookupValue</samp> element must be set. Only User is
                    supported in the current API.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NextValue</samp>—Indicates
                    that the field will be set to its next value. Only allowed
                    when the field update references a picklist.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Null</samp>—Indicates that the
                    field is set to null.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PreviousValue</samp>—Indicates
                    that the field is set to its previous value. Only allowed
                    when the field update references a picklist.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname">protected</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e813" data-title="Description">Required. Indicates whether this component is protected (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Protected components can’t be
                linked to or referenced by components created in the installing
                organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname" id="WorkflowFieldUpdate_reevaluateOnChange"><a name="WorkflowFieldUpdate_reevaluateOnChange"><!-- --></a>reevaluateOnChange</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e813" data-title="Description">When set to <samp class="codeph nolang">true</samp>,
                if the field update changes the field’s value,
                all workflow rules on the associated object are reevaluated. Any
                workflow rules whose criteria are met as a result of the field value
                change are triggered.<p class="p">If any of the triggered workflow rules
                  result in another field update that’s also enabled for workflow
                  rule reevaluation, a domino effect occurs, and more workflow
                  rules can be reevaluated as a result of the newly triggered
                  field update. This cascade of workflow rule reevaluation and
                  triggering can happen up to 5 times after the initial field
                  update that started it.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e807" data-title="Field Name"><span class="keyword parmname">targetObject</span></td>

              <td class="entry" headers="d1032074e810" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e813" data-title="Description">Object set if the change is detected on a child record.
                If set, the object points to the foreign key reference on the
                child object that points to the parent. For example, if
                <samp class="codeph nolang">EmailMessage</samp> child
                record is changed, <samp class="codeph nolang">EmailMessage.ParentId</samp> points to the <samp class="codeph nolang">Case</samp> parent.
                <span class="ph" id="field_targetObject_old_name"><a name="field_targetObject_old_name"><!-- --></a>This field is named
                  <span class="keyword parmname">sourceField</span> before version 14.0. The
                  field name change is automatically handled between versions and
                  doesn’t require any manual editing of existing XML component
                  files.</span>
              </td>

            </tr>

          </tbody>

        </table>

## WorkflowFlowAction

Represents a flow trigger, which is a workflow action that launches a flow. Available in API version 30.0 and later. For more information, see these topics in Salesforce Help.

- Define a Flow Trigger for Workflow (Pilot)
- Flow Trigger Considerations (Pilot)

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

- The pilot program for flow trigger workflow actions is closed. If you already enabled the pilot in your org, you can continue to create and edit flow trigger workflow actions. If you didn’t enable the pilot, use Flow Builder to create a record-triggered flow, or use Process Builder to launch a flow from a process.
- Test mode for flow triggers isn’t supported in the Metadata API. If you want a flow trigger to run the latest flow version when an administrator causes the workflow rule to fire, enable test mode via the user interface after deployment.

| Field Name | Field Type | Description |
| --- | --- | --- |
| description | string | Describes the flow trigger. |
| flow | string | Required. API name of the flow that this workflow action launches. |
| flowInputs | [WorkflowFlowActionParameter](#WorkflowFlowActionParameter)\[\] | An array of values to pass into flow variables when launching the flow. |
| label | string | Required. Name of the flow trigger. |
| language | string | Reserved for future use. |
| protected | boolean | Reserved for future use. |

## WorkflowFlowActionParameter

Represents a value specified in the flow trigger that is passed into a variable when launching the flow.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

The pilot program for flow trigger workflow actions is closed. If you already enabled the pilot in your org, you can continue to create and edit flow trigger workflow actions. If you didn’t enable the pilot, use Flow Builder to create a record-triggered flow, or use Process Builder to launch a flow from a process.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e1276">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e1279">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e1282">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e1276" data-title="Field Name"><span class="keyword parmname" id="field_name"><a name="field_name"><!-- --></a>name</span></td>

              <td class="entry" headers="d1032074e1279" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1282" data-title="Description">Required. API name of the flow variable.<p class="p">The flow variable must
                  have <span class="keyword parmname">isInput</span> set to <samp class="codeph nolang">True</samp>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1276" data-title="Field Name"><span class="keyword parmname" id="field_value"><a name="field_value"><!-- --></a>value</span></td>

              <td class="entry" headers="d1032074e1279" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1282" data-title="Description">Required. Value to assign to the flow variable when launching the
                flow. <p class="p">If the variable's data type is sObject,
                  <span class="keyword parmname">value</span> must be a merge field that
                  identifies a record—or a lookup relationship field that
                  references a record—of the same object type as the variable. For
                  example:
                </p>
                <ul class="ul bulletList">
                  <li class="li">
                    <kbd class="ph userinput">{!this}</kbd>—Identifies the record that
                    fired the workflow rule.
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">{!Contact}</kbd>—Identifies the contact
                    associated with the record that fired the workflow
                    rule.
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">{!Asset.Account}</kbd>—Identifies the
                    account associated with the asset that is associated with
                    the record that fired the workflow rule.
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">{!SomeObject__r}</kbd>—Uses a lookup
                    relationship field to identify a custom object record
                    associated with the record that fired the workflow
                    rule.
                  </li>

                </ul>
                <p class="p">For variables of other data types, you can enter a merge
                  field or a literal value. Manually enter a literal value when
                  the variable requires the same value every time the flow is
                  launched, regardless of which record fired the workflow rule.
                  For example, you can enter <kbd class="ph userinput">true</kbd> or
                  <kbd class="ph userinput">false</kbd> for a variable of type
                  Boolean.
                </p>
                <p class="p">Supported merge fields identify a global variable
                  or a field of the same data type as the flow variable. For
                  example:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <kbd class="ph userinput">{!Id}</kbd>—ID of the record that fired the
                    workflow rule.
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">{!Account.Owner.Email}</kbd>—Email address
                    of the account owner for the account associated with the
                    record that fired the workflow rule.
                  </li>

                  <li class="li">
                    <kbd class="ph userinput">{!$Organization.Country}</kbd>—Country of
                    the organization.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## WorkflowKnowledgePublish

WorkflowKnowledgePublish represents Salesforce Knowledge article publishing actions and information. Available in API version 27.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e1403">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e1406">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e1409">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e1403" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d1032074e1406" data-title="Field Type">KnowledgeWorkflowAction (enumeration of type string)</td>

              <td class="entry" headers="d1032074e1409" data-title="Description">Required. The article publishing actions available when this rule
                fires. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">PublishAsNew</samp>—Publishes
                    the article as a new article.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Publish</samp>—Publishes the
                    article as a version of a previously published article.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1403" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1032074e1406" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1409" data-title="Description">A brief article description.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1403" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d1032074e1406" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1409" data-title="Description">
                <p class="p">Required. Label that represents the article throughout the
                  Salesforce user interface.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1403" data-title="Field Name"><span class="keyword parmname">language</span></td>

              <td class="entry" headers="d1032074e1406" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1409" data-title="Description">The language of the article.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1403" data-title="Field Name"><span class="keyword parmname">protected</span></td>

              <td class="entry" headers="d1032074e1406" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e1409" data-title="Description">Required. Indicates whether this component is protected (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Protected components can’t
                be linked to or referenced by components created in the installing
                organization.</td>

            </tr>

          </tbody>

        </table>

## WorkflowOutboundMessage

WorkflowOutboundMessage represents an outbound message associated with a workflow rule. Outbound messages are workflow and approval actions that send the information you specify to an endpoint you designate, such as an external service. An outbound message sends the data in the specified fields in the form of a SOAP message to the endpoint. For more information, see Outbound Message Actions in Salesforce Help.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e1529">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e1532">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e1535">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname" id="field_apiVersion"><a name="field_apiVersion"><!-- --></a>apiVersion</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">double</td>

              <td class="entry" headers="d1032074e1535" data-title="Description">Required. <span class="ph" id="field_apiVersion_desc"><a name="field_apiVersion_desc"><!-- --></a>The API version of the
                  outbound message. Automatically set to the current API version
                  when the outbound message is created. Valid API versions for
                  outbound messages are 8.0 and 18.0 or later.</span>
                <p class="p">This API
                  version is used in API calls back to Salesforce using the
                  enterprise or partner WSDLs. The <span class="keyword parmname">API
                    Version</span> can only be modified by using Metadata
                  API. It can’t be modified using the Salesforce user interface.
                  This field is available in API version 18.0 and later.</p>
                <p class="p">If
                  you change the <span class="keyword parmname">apiVersion</span> to a version that
                  doesn’t support one of the <span class="keyword parmname">fields</span>
                  configured for the outbound message, the messages fail until you
                  update your outbound message listener to consume the updated
                  WSDL.</p>
                <p class="p">To monitor the status of outbound messages, from
                  Setup, in the Quick Find box, enter <kbd class="ph userinput">Outbound
                    Messages</kbd>, and then select <strong class="ph uicontrol">Outbound
                    Messages</strong> inSalesforce.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1535" data-title="Description">Describes the outbound message.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname">endpointUrl</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1535" data-title="Description">Required. The endpoint URL to which the outbound message is
                sent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname" id="field_fields"><a name="field_fields"><!-- --></a>fields</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">string[]</td>

              <td class="entry" headers="d1032074e1535" data-title="Description">The named references to the fields to be sent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1535" data-title="Description">Required. The developer name used as a unique identifier for API
                access. The <span class="keyword parmname">fullName</span> can contain only
                underscores and alphanumeric characters. It must be unique, begin
                with a letter, not include spaces, not end with an underscore, and
                not contain two consecutive underscores. This field is inherited
                from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname">includeSessionId</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e1535" data-title="Description">Required. Set if you want the Salesforce <dfn class="term">session ID</dfn>
                included in the outbound message. Useful if you intend to make API
                calls and you don’t want to include a username and password.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname">integrationUser</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1535" data-title="Description">Required. The named reference to the user under which this
                message is sent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1535" data-title="Description"><span class="ph" id="nameOutboundMessageDescription"><a name="nameOutboundMessageDescription"><!-- --></a>Required. A name for the
                  component. Available in version API 16.0 and later.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname">protected</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e1535" data-title="Description">Required. Indicates whether this component is protected (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Protected components can’t
                be linked to or referenced by components created in the installing
                organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1529" data-title="Field Name"><span class="keyword parmname">useDeadLetterQueue</span></td>

              <td class="entry" headers="d1032074e1532" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e1535" data-title="Description">This field is only available for organizations with dead letter
                queue permissions turned on. If set, this outbound message uses
                the dead letter queue if normal delivery fails.</td>

            </tr>

          </tbody>

        </table>

## WorkflowRule

This metadata type represents a workflow rule. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e1759">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e1762">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e1765">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname">actions</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type">
                <a class="xref" href="#WorkflowActionReference">WorkflowActionReference</a>[]
              </td>

              <td class="entry" headers="d1032074e1765" data-title="Description">An array of references for the actions that happen when
                this rule fires.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname">active</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e1765" data-title="Description">Required. Determines if this rule is active.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname">booleanFilter</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1765" data-title="Description">For advanced criteria filter, the boolean formula. For example,
                <samp class="codeph nolang">(1 AND 2) OR 3</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname">criteriaItems</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem">FilterItem</a>[]
              </td>

              <td class="entry" headers="d1032074e1765" data-title="Description">An array of the boolean criteria (conditions) under which this
                rule fires. Either <span class="keyword parmname">criteriaItems</span> or
                <span class="keyword parmname">formula</span> must be set.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1765" data-title="Description">The description of the workflow rule.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname">failedMigrationToolVersion</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1765" data-title="Description">The API version in which a migration fails. Used as a reference to
                admins to retry the migration when the next version is released.
                <p class="p">Available in API version 54.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname">formula</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1765" data-title="Description">The formula condition under which this rule first must be set,
                either <span class="keyword parmname">formula</span> or
                <span class="keyword parmname">criteriaItems</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1765" data-title="Description">The developer name used as a unique identifier for API access.
                The <span class="keyword parmname">fullName</span> can contain only underscores and
                alphanumeric characters. It must be unique, begin with a letter, not
                include spaces, not end with an underscore, and not contain two
                consecutive underscores. This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname">triggerType</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type">WorkflowTriggerTypes (enumeration of type string)</td>

              <td class="entry" headers="d1032074e1765" data-title="Description">Under what conditions the trigger fires. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <span class="ph" id="onAllChanges"><a name="onAllChanges"><!-- --></a><samp class="codeph nolang">onAllChanges</samp></span>—The workflow rule is
                    considered on all changes.
                  </li>

                  <li class="li">
                    <span class="ph" id="onCreateOnly"><a name="onCreateOnly"><!-- --></a><samp class="codeph nolang">onCreateOnly</samp></span>—The workflow rule is
                    considered only on create.
                  </li>

                  <li class="li">
                    <span class="ph" id="onCreateOrTriggeringUpdate"><a name="onCreateOrTriggeringUpdate"><!-- --></a><samp class="codeph nolang">onCreateOrTriggeringUpdate</samp></span>—The
                    workflow rule is considered on create and triggering
                    updates.
                  </li>
                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1759" data-title="Field Name"><span class="keyword parmname" id="workflowTimeTriggers"><a name="workflowTimeTriggers"><!-- --></a>workflowTimeTriggers</span></td>

              <td class="entry" headers="d1032074e1762" data-title="Field Type"><a class="xref" href="#WorkflowTimeTrigger">WorkflowTimeTrigger</a></td>

              <td class="entry" headers="d1032074e1765" data-title="Description">Represents a set of Workflow actions, including Field Updates,
                Email Alerts, Outbound Messages, and Tasks, that executes before or
                after a specified interval of time.</td>

            </tr>

          </tbody>

        </table>

## WorkflowTask

This metadata type references an assigned workflow task.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e1985">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e1988">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e1991">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">assignedTo</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">Specifies the user, role, or team to which the workflow rule or
                action is assigned. The field corresponding to the value specified
                here must be the same as the specified
                <span class="keyword parmname">assignedToType</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">assignedToType</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">ActionTaskAssignedToTypes (enumeration of type string)</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">Valid string values for this type are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">accountCreator</samp>—When
                    set, the task is assigned to the record’s account's
                    creator.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">accountOwner</samp>—When set,
                    the task is assigned to the record’s account owner
                    (Opportunity).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">accountTeam</samp>—Same as
                    WorkflowAlert type
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">creator</samp>—When set, the
                    task is assigned to the record’s creator.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">opportunityTeam</samp>—Same as
                    WorkflowAlert type
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">owner</samp>—When set, the
                    task is assigned to the record’s owner.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">partnerUser</samp>—When set,
                    the <span class="keyword parmname">assignedTo</span> field references a
                    partner user by username.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">portalRole</samp>—When set,
                    the <span class="keyword parmname">assignedTo</span> field references a Role
                    by role name, a portal role.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">role</samp>—When set, the
                    <span class="keyword parmname">assignedTo</span> field references a Role
                    by role name.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">user</samp>—When set, the
                    <span class="keyword parmname">assignedTo</span> field references a User
                    by username.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">The description of this workflow task.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">dueDateOffset</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">int</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">Required. The offset, in days, from either the trigger date, or
                the date specified in the (optional)
                <span class="keyword parmname">offsetFromField</span>. The offset can be a
                negative number.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">Required. The developer name used as a unique identifier for API
                access. The <span class="keyword parmname">fullName</span> can contain only
                underscores and alphanumeric characters. It must be unique, begin
                with a letter, not include spaces, not end with an underscore, and
                not contain two consecutive underscores. This field is inherited
                from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">notifyAssignee</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">Required. Set to send an email notification when the task is
                assigned.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">offsetFromField</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">Optional field reference of the date field from which the <samp class="codeph nolang">dueDate</samp> is computed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">priority</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">Required. The priority to assign the created task.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">protected</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">boolean</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">Required. Indicates whether this component is protected (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Protected components can’t
                be linked to or referenced by components created in the installing
                organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1991" data-title="Description">Required. The status to assign the created task.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e1985" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="subjectWorkflowTask"><a name="subjectWorkflowTask"><!-- --></a>subject</span></span></td>

              <td class="entry" headers="d1032074e1988" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e1991" data-title="Description"><span class="ph" id="subjectWorkflowTaskDescription"><a name="subjectWorkflowTaskDescription"><!-- --></a>Required. A subject for
                  the workflow task that’s used if an email notification is sent
                  when the task is assigned. Available in API version 16.0 and
                  later.</span></td>

            </tr>

          </tbody>

        </table>

## WorkflowTimeTrigger

Represents a set of Workflow actions, including Field Updates, Email Alerts, Outbound Messages, and Tasks, that execute before or after a specified interval of time.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1032074e2262">Field Name</th>

              <th class="featureTableHeader  " id="d1032074e2265">Field Type</th>

              <th class="featureTableHeader  " id="d1032074e2268">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1032074e2262" data-title="Field Name"><span class="keyword parmname">actions</span></td>

              <td class="entry" headers="d1032074e2265" data-title="Field Type">
                <a class="xref" href="#WorkflowActionReference">WorkflowActionReference</a>[]
              </td>

              <td class="entry" headers="d1032074e2268" data-title="Description">An array of references for the actions that happen when
                this trigger fires.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e2262" data-title="Field Name"><span class="keyword parmname" id="wf_offsetFromField"><a name="wf_offsetFromField"><!-- --></a>offsetFromField</span></td>

              <td class="entry" headers="d1032074e2265" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e2268" data-title="Description">The date type field name that the time-based workflow triggers
                from, such as <span class="keyword parmname">Created Date</span>, <span class="keyword parmname">Last
                  Modified Date</span>, <span class="keyword parmname">Rule Trigger Date</span>,
                or a custom date field on the object for which the workflow rule is defined.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e2262" data-title="Field Name"><span class="keyword parmname" id="wf_timeLength"><a name="wf_timeLength"><!-- --></a>timeLength</span></td>

              <td class="entry" headers="d1032074e2265" data-title="Field Type">string</td>

              <td class="entry" headers="d1032074e2268" data-title="Description">The numeric value of the time after or before the workflow
                triggers. A negative value represents the time length before the
                trigger fires. The <span class="keyword parmname">timeLength</span> is measured in
                either hours or days, as specified by
                <span class="keyword parmname"><u class="ph u">workflowTimeTriggerUnit</u></span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1032074e2262" data-title="Field Name"><span class="keyword parmname" id="workflowTimeTriggerUnit"><a name="workflowTimeTriggerUnit"><!-- --></a>workflowTimeTriggerUnit</span></td>

              <td class="entry" headers="d1032074e2265" data-title="Field Type">WorkflowTimeUnits (enumeration of type string)</td>

              <td class="entry" headers="d1032074e2268" data-title="Description">The unit of time before or after which the time-based workflow
                triggers. Valid string values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Hours</samp></li>

                  <li class="li"><samp class="codeph nolang">Days</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s the definition of a workflow rule.

<?xml version="1.0" encoding="UTF-8"?>
<Workflow xmlns="http://soap.sforce.com/2006/04/metadata">
    <alerts\>
        <fullName\>Another\_alert</fullName\>
        <description\>Another alert</description\>
        <protected\>false</protected\>
        <recipients\>
            <type\>accountOwner</type\>
        </recipients\>
        <recipients\>
            <field\>Contact\_\_c</field\>
            <type\>contactLookup</type\>
        </recipients\>
        <recipients\>
            <field\>Email\_\_c</field\>
            <type\>email</type\>
        </recipients\>
        <template\>TestEmail/Email Test</template\>
    </alerts\>
    <fieldUpdates\>
        <fullName\>Enum\_Field\_Update</fullName\>
        <description\>Blah</description\>
        <field\>EnumField\_\_c</field\>
        <name\>Enum Field Update</name\>
        <notifyAssignee\>true</notifyAssignee\>
        <operation\>NextValue</operation\>
        <protected\>false</protected\>
    </fieldUpdates\>
    <fieldUpdates\>
        <fullName\>Enum\_Field\_Update2</fullName\>
        <description\>Blah</description\>
        <field\>EnumField\_\_c</field\>
        <literalValue\>PLX2</literalValue\>
        <name\>Enum Field Update2</name\>
        <notifyAssignee\>true</notifyAssignee\>
        <operation\>Literal</operation\>
        <protected\>false</protected\>
    </fieldUpdates\>
    <fieldUpdates\>
        <fullName\>Field\_Update</fullName\>
        <description\>TestField update desc</description\>
        <field\>Name</field\>
        <formula\>Name &amp; &quot;Updated&quot;</formula\>
        <name\>Field Update</name\>
        <notifyAssignee\>false</notifyAssignee\>
        <operation\>Formula</operation\>
        <protected\>false</protected\>
    </fieldUpdates\>
    <fieldUpdates\>
        <fullName\>Lookup\_On\_Contact</fullName\>
        <field\>RealOwner\_\_c</field\>
        <lookupValue\>admin@acme.com</lookupValue\>
        <name\>Lookup On Contact</name\>
        <notifyAssignee\>false</notifyAssignee\>
        <operation\>LookupValue</operation\>
        <protected\>false</protected\>
    </fieldUpdates\>
    <outboundMessages\>
        <fullName\>Another\_Outbound\_message</fullName\>
        <description\>Another Random outbound.</description\>
        <endpointUrl\>http://www.test.com</endpointUrl\>
        <fields\>Email\_\_c</fields\>
        <fields\>Id</fields\>
        <fields\>Name</fields\>
        <includeSessionId\>true</includeSessionId\>
        <integrationUser\>admin@acme.com</integrationUser\>
        <name\>Another Outbound message</name\>
        <protected\>false</protected\>
    </outboundMessages\>
    <rules\>
        <fullName\>BooleanFilter</fullName\>
        <active\>false</active\>
        <booleanFilter\>1 AND 2 OR 3</booleanFilter\>
        <criteriaItems\>
            <field\>CustomObjectForWorkflow\_\_c.CreatedById</field\>
            <operation\>notEqual</operation\>
        </criteriaItems\>
        <criteriaItems\>
            <field\>CustomObjectForWorkflow\_\_c.CreatedById</field\>
            <operation\>notEqual</operation\>
            <value\>abc</value\>
        </criteriaItems\>
        <criteriaItems\>
            <field\>CustomObjectForWorkflow\_\_c.CreatedById</field\>
            <operation\>equals</operation\>
            <value\>xyz</value\>
        </criteriaItems\>
        <triggerType\>onCreateOrTriggeringUpdate</triggerType\>
    </rules\>
    <rules\>
        <fullName\>Custom Rule1</fullName\>
        <actions\>
            <name\>Another\_alert</name\>
            <type\>Alert</type\>
        </actions\>
        <actions\>
            <name\>Enum\_Field\_Update2</name\>
            <type\>FieldUpdate</type\>
        </actions\>
        <actions\>
            <fullName\>Field\_Update</name\>
                <type\>FieldUpdate</type\>
        </actions\>
        <actions\>
            <name\>Another\_Outbound\_message</name\>
            <type\>OutboundMessage</type\>
        </actions\>
        <actions\>
            <name\>Role\_task\_was\_completed</name\>
            <type\>Task</type\>
        </actions\>
        <active\>true</active\>
        <criteriaItems\>
            <field\>CustomObjectForWorkflow\_\_c.Name</field\>
            <operation\>startsWith</operation\>
            <value\>ABC</value\>
        </criteriaItems\>
        <description\>Custom Rule1 desc</description\>
        <triggerType\>onCreateOrTriggeringUpdate</triggerType\>
    </rules\>
    <rules\>
        <fullName\>IsChangedFunctionRule</fullName\>
        <active\>true</active\>
        <description\>IsChangedDesc</description\>
        <formula\>ISCHANGED(Name)</formula\>
        <triggerType\>onAllChanges</triggerType\>
    </rules\>
    <tasks\>
        <fullName\>Another\_task\_was\_completed</fullName\>
        <assignedToType\>owner</assignedToType\>
        <description\>Random Comment</description\>
        <dueDateOffset\>20</dueDateOffset\>
        <notifyAssignee\>true</notifyAssignee\>
        <priority\>High</priority\>
        <protected\>false</protected\>
        <status\>Completed</status\>
        <subject\>Another task was completed</subject\>
    </tasks\>
    <tasks\>
        <fullName\>Role\_task\_was\_completed</fullName\>
        <assignedTo\>R11</assignedTo\>
        <assignedToType\>role</assignedToType\>
        <dueDateOffset\>-2</dueDateOffset\>
        <notifyAssignee\>true</notifyAssignee\>
        <offsetFromField\>CustomObjectForWorkflow\_\_c.CreatedDate</offsetFromField\>
        <priority\>High</priority\>
        <protected\>false</protected\>
        <status\>Completed</status\>
        <subject\>Role task was completed</subject\>
    </tasks\>
    <tasks\>
        <fullName\>User\_task\_was\_completed</fullName\>
        <assignedTo\>admin@acme.com</assignedTo\>
        <assignedToType\>user</assignedToType\>
        <dueDateOffset\>-2</dueDateOffset\>
        <notifyAssignee\>true</notifyAssignee\>
        <offsetFromField\>User.CreatedDate</offsetFromField\>
        <priority\>High</priority\>
        <protected\>false</protected\>
        <status\>Completed</status\>
        <subject\>User task was completed</subject\>
    </tasks\>
</Workflow\>    

## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

<!-- document id=2f4682378ab609977780729a57d88df79f1f9adcfc9a84fa201e320121e0e801 url=/legacydeveloper/current/en-us/api_meta/meta_workforceengagementsettings.md -->

# WorkforceEngagementSettings

Represents settings for Workforce Engagement Management.

## File Suffix and Directory Location

WorkforceEngagementSettings components are stored in the WorkforceEngagement.settings folder.

## Version

WorkforceEngagementSettings is available in API version 52.0 and later.

## Special Access Rules

To use Workforce Engagement settings, the org requires a Workforce Engagement license.

## Fields

Field Type

<table class="featureTable sort_table" summary="">



            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d1039296e86">Field Name</th>

                <th class="featureTableHeader  " id="d1039296e89">Field Type</th>

                <th class="featureTableHeader  " id="d1039296e92">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableMachineLearningForecasting</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether machine learning-based forecasting is used (<samp class="codeph nolang">true</samp>) or not used (<samp class="codeph nolang">false</samp>).</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableWorkforceEngagement</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether Workforce Engagement is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>).</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableWorkforceEngagementConfiguration</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">
                  <p class="p">Indicates whether the Workforce Engagement Configuration App is installed or
                    enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If <samp class="codeph nolang">true</samp>, it grants access to the Lightning App as well as the app's Job
                    Profile Mapping tab. It also defaults the standard and custom profile tab settings
                    to On. If <samp class="codeph nolang">false</samp>, it removes access to the app
                    and tab but doesn’t delete the app metadata. This field is available in API
                    version 53.0 and later.</p>

                </td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableHistoricalAdherence</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether historical adherence is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>). This
                  field is available in API version 54.0 and later.</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableIndividualAdherence</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether individual adherence is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>). This
                  field is available in API version 54.0 and later.</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableIntradayManagement</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether the intraday management dashboard is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>). This field is available in API version 55.0 and later.</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableRealTimeAdherence</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether real-time adherence is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>). To
                  use real-time adherence, you must also enable Omni-Channel. This field is available
                  in API version 55.0 and later.</td>

              </tr>

            </tbody>

          </table>

## Declarative Metadata Sample Definition

The following is an example of a WorkforceEngagement.settings component.

<?xml version="1.0" encoding="UTF-8"?>
<WorkforceEngagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
   <enableMachineLearningForecasting\>true</enableMachineLearningForecasting\>
   <enableWorkforceEngagement\>true</enableWorkforceEngagement\>
   <enableWorkforceEngagementConfiguration\>true</enableWorkforceEngagementConfiguration\>
   <enableHistoricalAdherence\>true</enableHistoricalAdherence\>
   <enableenableIndividualAdherence\>true</enableIndividualAdherence\>
   <enableIntradayManagement\>true</enableIntradayManagement\>
   <enableRealTimeAdherence\>true</enableRealTimeAdherence\>
</WorkforceEngagementSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
2 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
3     <types\>
4         <members\>WorkforceEngagement</members\>
5         <name\>Settings</name\>
6     </types\>
7     <55.0>\[ftest\]</55.0>
8 </Package\>

## Usage

When enableMachineLearningForecasting is set to false, we clean up data from our Ofek forecasting platform. The original copy of the same set of data is stored in the Core app, so no data is lost.

<!-- document id=1945a761dd1c9742da9dfdab0b73763fd33f9fb006a2b4acbb1c247b1da67147 url=/legacydeveloper/current/en-us/api_meta/meta_workskillrouting.md -->

# WorkSkillRouting

Represents a setup object that stores a set of WorkSkillRoutingAttribute objects. These objects are used to route a work item to an agent who has the skills necessary to take the work. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

WorkSkillRouting components have the suffix workSkillRouting and are stored in the workSkillRoutings folder.

## Version

WorkSkillRouting components are available in API version 46.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
|  |  |  |
| isActive | boolean | Required. Indicates whether assignment rules are active and can be evaluated. |
| masterLabel | string | Required. The label for this object. This display value is the internal label that is not translated. |
| relatedEntity | string | Required. Type of Salesforce object that the attributes are associated with. |
| workSkillRoutingAttributes | [WorkSkillRoutingAttribute](#WorkSkillRoutingAttributes)\[\] | A set of mappings between work-item field values and skills. Create one attribute mapping set for each object. |

## WorkSkillRoutingAttribute

Represents the routing assignments between object attributes and skills. Attributes are used to route a work item to an agent who has the skills necessary to take the work.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| field | string | Required. Field that this attribute applies to. |
| isAdditionalSkill | boolean | After a designated timeout period, additional skills are dropped from Omni-Channel routing. The case is then routed to the best-matched agent even if they don’t have all the skills. |
| skill | string | Required. Skill used to route the work item when the attribute maps to the value selected. |
| skillLevel | int | Level of the skill required. This value can range from 0 to 10. |
| skillPriority | int | For additional skills, specify the order in which a skill is dropped if after the Drop Additional Skills Timeout on the routing configuration, no agent with that skill is available. Skills with a lower priority rank (9 or 10) are dropped first. Skills with a higher priority rank (0 or 1) are dropped last. Skills with the same priority value are dropped as a group. You can set skill priority using attribute setup for skills-based routing or Apex code. Available in API version 49.0 and later. |
| value | string | Attribute value that is assigned to the selected skill. |

## Declarative Metadata Sample Definition

The following is an example of a WorkSkillRouting component.

<?xml version="1.0" encoding="UTF-8"?>
<WorkSkillRouting xmlns="http://soap.sforce.com/2006/04/metadata">
  <isActive\>true</isActive\>
  <masterLabel\>Attribute setup for skills-based routing for Case object</masterLabel\>
  <relatedEntity\>Case</relatedEntity\>
  <workSkillRoutingAttributes\>
    <field\>Case.Origin</field\>
    <isAdditionalSkill\>false</isAdditionalSkill\>
    <skill\>Technical\_Skill</skill\>
    <skillLevel\>3</skillLevel\>
    <skillPriority\>2</skillPriority\>
    <value\>Web</value\>
  </workSkillRoutingAttributes\>
</WorkSkillRouting\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).